Navigation
API > API/Plugins > API/Plugins/RigVM
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.
| Name | FRigVMFunction_MathVectorClampSpatially |
| Type | struct |
| Header File | /Engine/Plugins/Runtime/RigVM/Source/RigVM/Public/RigVMFunctions/Math/RigVMFunction_MathVector.h |
| Include Path | #include "RigVMFunctions/Math/RigVMFunction_MathVector.h" |
Syntax
USTRUCT (
Meta=(DisplayName="Clamp Spatially", TemplateName="ClampSpatially", Keywords="Collide,Collision"))
struct FRigVMFunction_MathVectorClampSpatially : public FRigVMFunction_MathVectorBase
Inheritance Hierarchy
- FRigVMStruct → FRigVMFunction_MathBase → FRigVMFunction_MathVectorBase → FRigVMFunction_MathVectorClampSpatially
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRigVMFunction_MathVectorClampSpatially() |
RigVMFunctions/Math/RigVMFunction_MathVector.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Axis | TEnumAsByte< EAxis::Type > | RigVMFunctions/Math/RigVMFunction_MathVector.h |
|
|
| bDrawDebug | bool | RigVMFunctions/Math/RigVMFunction_MathVector.h |
|
|
| DebugColor | FLinearColor | RigVMFunctions/Math/RigVMFunction_MathVector.h |
|
|
| DebugThickness | float | RigVMFunctions/Math/RigVMFunction_MathVector.h |
|
|
| Maximum | float | This maximum allowed distance. | RigVMFunctions/Math/RigVMFunction_MathVector.h |
|
| Minimum | float | The minimum allowed distance at which a collision occurs. | RigVMFunctions/Math/RigVMFunction_MathVector.h |
|
| Result | FVector | RigVMFunctions/Math/RigVMFunction_MathVector.h |
|
|
| Space | FTransform | The space this spatial clamp happens within. The input position will be projected into this space. | RigVMFunctions/Math/RigVMFunction_MathVector.h |
|
| Type | TEnumAsByte< ERigVMClampSpatialMode::Type > | RigVMFunctions/Math/RigVMFunction_MathVector.h |
|
|
| Value | FVector | RigVMFunctions/Math/RigVMFunction_MathVector.h |
|
Functions
Public
Overridden from FRigVMStruct
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Execute() |
Execute logic for this struct | RigVMFunctions/Math/RigVMFunction_MathVector.h |