Navigation
API > API/Plugins > API/Plugins/ControlRig
Sweeps a sphere against the world and return the first blocking hit using a specific channel
| Name | FRigUnit_SphereTraceWorld |
| 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", Category="Collision", DocumentationPolicy="Strict", Keywords="Sweep,Raytrace,Collision,Collide,Trace", Varying, NodeColor="0.2 0.4 0.7", Deprecated="5.0"))
struct FRigUnit_SphereTraceWorld : public FRigUnit
Inheritance Hierarchy
- FRigVMStruct → FRigUnit → FRigUnit_SphereTraceWorld
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRigUnit_SphereTraceWorld() |
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 |
|
| Channel | TEnumAsByte< ECollisionChannel > | The 'channel' that this trace is in, used to determine which components to 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 |
|
| 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
Overridden from FRigVMStruct
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Execute() |
Units/Collision/RigUnit_WorldCollision.h | ||
virtual FRigVMStructUpgradeInfo GetUpgradeInfo() |
Units/Collision/RigUnit_WorldCollision.h |