Navigation
API > API/Plugins > API/Plugins/ControlRig
Sweeps a sphere against the world and return the first blocking hit using a specific channel. Target objects can have different object types, but they need to have the same trace channel set to "block" in their collision response settings. You can create custom trace channels in Project Setting - Collision.
| Name | FRigUnit_SphereTraceByTraceChannel |
| 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 Trace Channel", Category="Collision", DocumentationPolicy="Strict", Keywords="Sweep,Raytrace,Collision,Collide,Trace", Varying, NodeColor="0.2 0.4 0.7"))
struct FRigUnit_SphereTraceByTraceChannel : public FRigUnit
Inheritance Hierarchy
- FRigVMStruct → FRigUnit → FRigUnit_SphereTraceByTraceChannel
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRigUnit_SphereTraceByTraceChannel() |
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 |
|
| 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 |
|
| TraceChannel | TEnumAsByte< ETraceTypeQuery > | The 'channel' that this trace is in, used to determine which components to hit | 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 |