Navigation
API > API/Plugins > API/Plugins/ControlRig
Sweeps a sphere against the world and return the first blocking hit. The trace is filtered by object types only, the collision response settings are ignored. You can create custom object types in Project Setting - Collision
| Name | FRigUnit_SphereTraceByObjectTypes |
| 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 Object Types", Category="Collision", DocumentationPolicy="Strict", Keywords="Sweep,Raytrace,Collision,Collide,Trace", Varying, NodeColor="0.2 0.4 0.7"))
struct FRigUnit_SphereTraceByObjectTypes : public FRigUnit
Inheritance Hierarchy
- FRigVMStruct → FRigUnit → FRigUnit_SphereTraceByObjectTypes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRigUnit_SphereTraceByObjectTypes() |
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 |
|
| ObjectTypes | TArray< TEnumAsByte< EObjectTypeQuery > > | The types of objects that this trace can hit | 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 |