FRigVMFunction_MathTransformClampSpatially

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

API > API/Plugins > API/Plugins/RigVM

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

   
Name FRigVMFunction_MathTransformClampSpatially
Type struct
Header File /Engine/Plugins/Runtime/RigVM/Source/RigVM/Public/RigVMFunctions/Math/RigVMFunction_MathTransform.h
Include Path #include "RigVMFunctions/Math/RigVMFunction_MathTransform.h"

Syntax

USTRUCT (  
        Meta=(DisplayName="Clamp Spatially", TemplateName="ClampSpatially", Keywords="Collide,Collision"))  
struct FRigVMFunction_MathTransformClampSpatially : public FRigVMFunction_MathTransformBase

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FRigVMFunction_MathTransformClampSpatially()

   RigVMFunctions/Math/RigVMFunction_MathTransform.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
Axis TEnumAsByte< EAxis::Type > The axis to use for the filter. RigVMFunctions/Math/RigVMFunction_MathTransform.h
  • Meta=(Input)
bDrawDebug bool Draws debug information if True. RigVMFunctions/Math/RigVMFunction_MathTransform.h
  • Meta=(Input)
DebugColor FLinearColor The color to use for the debug draw. RigVMFunctions/Math/RigVMFunction_MathTransform.h
  • Meta=(Input)
DebugThickness float The thickness to use for the debug draw. RigVMFunctions/Math/RigVMFunction_MathTransform.h
  • Meta=(Input)
Maximum float This maximum allowed distance. RigVMFunctions/Math/RigVMFunction_MathTransform.h
  • Meta=(Input)
Minimum float The minimum allowed distance at which a collision occurs. RigVMFunctions/Math/RigVMFunction_MathTransform.h
  • Meta=(Input)
Result FTransform The resulting transform with a clamped position. RigVMFunctions/Math/RigVMFunction_MathTransform.h
  • Meta=(Output)
Space FTransform The space this spatial clamp happens within. The input position will be projected into this space. RigVMFunctions/Math/RigVMFunction_MathTransform.h
  • Meta=(Input)
Type TEnumAsByte< ERigVMClampSpatialMode::Type > The filter / spatial mode to use. RigVMFunctions/Math/RigVMFunction_MathTransform.h
  • Meta=(Input)
Value FTransform The input transform to clamp. RigVMFunctions/Math/RigVMFunction_MathTransform.h
  • Meta=(Input)

Functions

Public

Public Virtual

Overridden from FRigVMStruct

Name Remarks Include Path Unreal Specifiers

virtual void Execute()

 Execute logic for this struct RigVMFunctions/Math/RigVMFunction_MathTransform.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page