unreal.RigUnit_HierarchyGetDynamicsConfinerPlane

class unreal.RigUnit_HierarchyGetDynamicsConfinerPlane(dynamics_confiner_component_key: RigComponentKey = Ellipsis, name: Name = 'None', plane: RigDynamicsShapePlane = Ellipsis)

Bases: RigUnit_DynamicsBase

Gets the properties of a named plane shape on a Dynamics confiner. The shape is looked up by Name.

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 query

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

  • plane (RigDynamicsShapePlane): [Read-Write] The plane shape data. If no matching shape is found, the output is left at its default.

property dynamics_confiner_component_key: RigComponentKey

[Read-Write] The Dynamics Confiner to query

Type:

(RigComponentKey)

property name: Name

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

Type:

(Name)

property plane: RigDynamicsShapePlane

[Read-Only] The plane shape data. If no matching shape is found, the output is left at its default.

Type:

(RigDynamicsShapePlane)