`unreal.RigVMFunction_MathTransformClampSpatially`¶

class unreal.RigVMFunction_MathTransformClampSpatially(value: Transform = 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: Transform = Ellipsis)¶

Bases: RigVMFunction_MathTransformBase

Clamps a transform’s position using a plane collision, cylindric collision or spherical collision.

C++ Source:

Plugin: RigVM
Module: RigVM
File: RigVMFunction_MathTransform.h

Editor Properties: (see get_editor_property/set_editor_property)

axis (AxisType): [Read-Write] The axis to use for the filter
debug_color (LinearColor): [Read-Write] The color to use for the debug draw
debug_thickness (float): [Read-Write] The thickness to use for the debug draw
draw_debug (bool): [Read-Write] Draws debug information if True
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 (Transform): [Read-Write] The resulting transform with a clamped position
space (Transform): [Read-Write] The space this spatial clamp happens within. The input position will be projected into this space.
type (RigVMClampSpatialMode): [Read-Write] The filter / spatial mode to use
value (Transform): [Read-Write] The input transform to clamp

property axis: AxisType¶

[Read-Write] The axis to use for the filter

Type:: (AxisType)

property debug_color: LinearColor¶

[Read-Write] The color to use for the debug draw

Type:: (LinearColor)

property debug_thickness: float¶

[Read-Write] The thickness to use for the debug draw

Type:: (float)

property draw_debug: bool¶

[Read-Write] Draws debug information if True

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.