unreal.RigUnit_SetPhysicsSolverExternalVelocity

class unreal.RigUnit_SetPhysicsSolverExternalVelocity(execute_pin: RigVMExecutePin = [], physics_solver_component_key: RigComponentKey = Ellipsis, external_linear_velocity: Vector = Ellipsis, external_angular_velocity: Vector = Ellipsis, external_turbulence_velocity: Vector = Ellipsis)

Bases: RigUnit_PhysicsBaseMutable

Sets the external velocity of the simulation - used for adding wind effects

C++ Source:

  • Plugin: ControlRigPhysics

  • Module: ControlRigPhysics

  • File: RigPhysicsExecution.h

Editor Properties: (see get_editor_property/set_editor_property)

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

  • external_angular_velocity (Vector): [Read-Write] Additional angular velocity that is added to the component angular velocity. This can be used to make the simulation act as if the actor is rotating even when it is not. E.g., to apply physics to a character on a podium as the camera rotates around it, to emulate the podium itself rotating. Vector is in world space. Units are deg/s.

  • external_linear_velocity (Vector): [Read-Write] Additional velocity that is added to the component velocity so the simulation acts as if the actor is moving at speed, even when stationary. The vector is in world space. This could be used for wind effects etc. Typical values are similar to the velocity of the object or effect, and usually around or less than 1000 for characters/wind.

  • external_turbulence_velocity (Vector): [Read-Write] This will treat the external velocity like a wind field and add turbulence to it. Units are the same as velocity, so this is the approximate magnitude of the turbulence.

  • physics_solver_component_key (RigComponentKey): [Read-Write] The physics solver

property external_angular_velocity: Vector

[Read-Write] Additional angular velocity that is added to the component angular velocity. This can be used to make the simulation act as if the actor is rotating even when it is not. E.g., to apply physics to a character on a podium as the camera rotates around it, to emulate the podium itself rotating. Vector is in world space. Units are deg/s.

Type:

(Vector)

property external_linear_velocity: Vector

[Read-Write] Additional velocity that is added to the component velocity so the simulation acts as if the actor is moving at speed, even when stationary. The vector is in world space. This could be used for wind effects etc. Typical values are similar to the velocity of the object or effect, and usually around or less than 1000 for characters/wind.

Type:

(Vector)

property external_turbulence_velocity: Vector

[Read-Write] This will treat the external velocity like a wind field and add turbulence to it. Units are the same as velocity, so this is the approximate magnitude of the turbulence.

Type:

(Vector)

property physics_solver_component_key: RigComponentKey

[Read-Write] The physics solver

Type:

(RigComponentKey)