unreal.RigVMFunction_MathVectorClampSpatially

class unreal.RigVMFunction_MathVectorClampSpatially(value: Vector = Ellipsis, axis: AxisType = Ellipsis, type: RigVMClampSpatialMode = Ellipsis, minimum: float = 0.0, maximum: float = 0.0, space: Transform = Ellipsis, draw_debug: bool = False, debug_color: LinearColor = Ellipsis, debug_thickness: float = 0.0, result: Vector = Ellipsis)

Bases: RigVMFunction_MathVectorBase

Clamps a position using a plane collision, cylindric collision or spherical collision. The collision happens both towards an inner envelope (minimum) and towards an outer envelope (maximum). You can disable the inner / outer envelope / collision by setting the minimum / maximum to 0.0.

C++ Source:

  • Plugin: RigVM

  • Module: RigVM

  • File: RigVMFunction_MathVector.h

Editor Properties: (see get_editor_property/set_editor_property)

  • axis (AxisType): [Read-Write]

  • debug_color (LinearColor): [Read-Write]

  • debug_thickness (float): [Read-Write]

  • draw_debug (bool): [Read-Write]

  • maximum (float): [Read-Write] This maximum allowed distance. A collision will occur towards the center at this wall. Note: For capsule this represents the length. Disable by setting to 0.0.

  • minimum (float): [Read-Write] The minimum allowed distance at which a collision occurs. Note: For capsule this represents the radius. Disable by setting to 0.0.

  • result (Vector): [Read-Write]

  • space (Transform): [Read-Write] The space this spatial clamp happens within. The input position will be projected into this space.

  • type (RigVMClampSpatialMode): [Read-Write]

  • value (Vector): [Read-Write]

property axis: AxisType

[Read-Write]

Type:

(AxisType)

property debug_color: LinearColor

[Read-Write]

Type:

(LinearColor)

property debug_thickness: float

[Read-Write]

Type:

(float)

property draw_debug: bool

[Read-Write]

Type:

(bool)

property maximum: float

[Read-Write] This maximum allowed distance. A collision will occur towards the center at this wall. Note: For capsule this represents the length. Disable by setting to 0.0.

Type:

(float)

property minimum: float

[Read-Write] The minimum allowed distance at which a collision occurs. Note: For capsule this represents the radius. Disable by setting to 0.0.

Type:

(float)

property result: Vector

[Read-Only]

Type:

(Vector)

property space: Transform

[Read-Write] The space this spatial clamp happens within. The input position will be projected into this space.

Type:

(Transform)

property type: RigVMClampSpatialMode

[Read-Write]

Type:

(RigVMClampSpatialMode)

property value: Vector

[Read-Write]

Type:

(Vector)