unreal.RigUnit_SpawnDynamicsConeLimit

class unreal.RigUnit_SpawnDynamicsConeLimit(execute_pin: RigVMExecutePin = [], owner: RigElementKey = Ellipsis, dynamics_solver_component_key: RigComponentKey = Ellipsis, cone_limit_component_name: Name = 'None', grandparent_component_key: RigComponentKey = Ellipsis, parent_component_key: RigComponentKey = Ellipsis, child_component_key: RigComponentKey = Ellipsis, strength: float = 0.0, damping_ratio: float = 0.0, angle: float = 0.0, dynamics_cone_limit_component_key: RigComponentKey = Ellipsis)

Bases: RigUnit_DynamicsBaseMutable

Spawns a new dynamics cone limit component. Note: This node only runs as part of the construction event.

C++ Source:

  • Plugin: ControlRigDynamics

  • Module: ControlRigDynamics

  • File: RigDynamicsConeLimitExecution.h

Editor Properties: (see get_editor_property/set_editor_property)

  • angle (float): [Read-Write] The (full) cone angle in degrees

  • child_component_key (RigComponentKey): [Read-Write] The child particle for the cone limit

  • cone_limit_component_name (Name): [Read-Write] The name to give the new cone limit component. Only used as a starting point - if another component with this name already exists on the owner element, the hierarchy will append a unique suffix. Read DynamicsConeLimitComponentKey to find the name that was actually assigned.

  • damping_ratio (float): [Read-Write] DampingRatio for the cone limit

  • dynamics_cone_limit_component_key (RigComponentKey): [Read-Write] The Dynamics Cone Limit component key that was created

  • dynamics_solver_component_key (RigComponentKey): [Read-Write] Optional solver - if set, it will be added to this solver component

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

  • grandparent_component_key (RigComponentKey): [Read-Write] The grandparent particle for the cone limit

  • owner (RigElementKey): [Read-Write] The owner of the newly created component (must be set/valid)

  • parent_component_key (RigComponentKey): [Read-Write] The parent particle for the cone limit

  • strength (float): [Read-Write] The strength which we drive towards the target limit (when outside). This is the oscillation frequency, so low values will be soft and springy, but values significantly above 1/timestep will impose the limit strongly.

property angle: float

[Read-Write] The (full) cone angle in degrees

Type:

(float)

property child_component_key: RigComponentKey

[Read-Write] The child particle for the cone limit

Type:

(RigComponentKey)

property cone_limit_component_name: Name

[Read-Write] The name to give the new cone limit component. Only used as a starting point - if another component with this name already exists on the owner element, the hierarchy will append a unique suffix. Read DynamicsConeLimitComponentKey to find the name that was actually assigned.

Type:

(Name)

property damping_ratio: float

[Read-Write] DampingRatio for the cone limit

Type:

(float)

property dynamics_cone_limit_component_key: RigComponentKey

[Read-Only] The Dynamics Cone Limit component key that was created

Type:

(RigComponentKey)

property dynamics_solver_component_key: RigComponentKey

[Read-Write] Optional solver - if set, it will be added to this solver component

Type:

(RigComponentKey)

property grandparent_component_key: RigComponentKey

[Read-Write] The grandparent particle for the cone limit

Type:

(RigComponentKey)

property owner: RigElementKey

[Read-Write] The owner of the newly created component (must be set/valid)

Type:

(RigElementKey)

property parent_component_key: RigComponentKey

[Read-Write] The parent particle for the cone limit

Type:

(RigComponentKey)

property strength: float

[Read-Write] The strength which we drive towards the target limit (when outside). This is the oscillation frequency, so low values will be soft and springy, but values significantly above 1/timestep will impose the limit strongly.

Type:

(float)