Navigation
API > API/Plugins > API/Plugins/ControlRig
Performs a sphere trace against the world and return the first blocking hit. The trace is filtered by specifying a collision profile.
| Name | FRigUnit_SphereTraceByProfile |
| Type | struct |
| Header File | /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Units/Collision/RigUnit_WorldCollision.h |
| Include Path | #include "Units/Collision/RigUnit_WorldCollision.h" |
Syntax
USTRUCT (
Meta=(DisplayName="Sphere Trace By Profile", Category="Collision", DocumentationPolicy="Strict", Keywords="Sweep,Raytrace,Collision,Collide,Trace,Profile", Varying, NodeColor="0.2 0.4 0.7"))
struct FRigUnit_SphereTraceByProfile : public FRigUnit
Inheritance Hierarchy
- FRigVMStruct → FRigUnit → FRigUnit_SphereTraceByProfile
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRigUnit_SphereTraceByProfile() |
Units/Collision/RigUnit_WorldCollision.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bHit | bool | Returns true if there was a hit | Units/Collision/RigUnit_WorldCollision.h |
|
| End | FVector | End of the trace in rig / global space | Units/Collision/RigUnit_WorldCollision.h |
|
| HitLocation | FVector | Hit location in rig / global Space | Units/Collision/RigUnit_WorldCollision.h |
|
| HitNormal | FVector | Hit normal in rig / global Space | Units/Collision/RigUnit_WorldCollision.h |
|
| ProfileName | FName | The profile to use | Units/Collision/RigUnit_WorldCollision.h |
|
| Radius | float | Radius of the sphere to use for sweeping / tracing | Units/Collision/RigUnit_WorldCollision.h |
|
| Start | FVector | Start of the trace in rig / global space | Units/Collision/RigUnit_WorldCollision.h |
|
| WorkData | FRigUnit_SphereTrace_WorkData | Cache / workstate | Units/Collision/RigUnit_WorldCollision.h |
Functions
Public
Public Virtual
Overridden from FRigVMStruct
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Execute() |
Units/Collision/RigUnit_WorldCollision.h |