unreal.RigUnit_HierarchySetDynamicsConfinerPlaneTM

class unreal.RigUnit_HierarchySetDynamicsConfinerPlaneTM(execute_pin: RigVMExecutePin = [], dynamics_confiner_component_key: RigComponentKey = Ellipsis, name: Name = 'None', tm: Transform = Ellipsis)

Bases: RigUnit_DynamicsBaseMutable

Sets the transform of a named plane shape on a Dynamics confiner. Extents are used for visualization only - the confiner treats each plane as an infinite +Z half-space.

C++ Source:

  • Plugin: ControlRigDynamics

  • Module: ControlRigDynamics

  • File: RigDynamicsConfinerExecution.h

Editor Properties: (see get_editor_property/set_editor_property)

  • dynamics_confiner_component_key (RigComponentKey): [Read-Write] The Dynamics Confiner to be updated

  • execute_pin (RigVMExecutePin): [Read-Write] This property is used to chain multiple mutable units together

  • name (Name): [Read-Write] The name of the plane shape to update

  • tm (Transform): [Read-Write] Position defines a point on the plane, plane faces +Z

property dynamics_confiner_component_key: RigComponentKey

[Read-Write] The Dynamics Confiner to be updated

Type:

(RigComponentKey)

property name: Name

[Read-Write] The name of the plane shape to update

Type:

(Name)

property tm: Transform

[Read-Write] Position defines a point on the plane, plane faces +Z

Type:

(Transform)