Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

> Unreal Engine API Reference > Plugins > ControlRig > Units > FRigUnitContext

Light Theme

Dark Theme

FRigUnitContext

Execution context that rig units use

Choose your operating system:

Windows

macOS

Linux

References

Module	ControlRig
Header	/Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Units/RigUnitContext.h
Include	#include "Units/RigUnitContext.h"

Syntax

struct FRigUnitContext

Remarks

Execution context that rig units use

Variables

		Name	Description
	float	AbsoluteTime	The current delta time
	bool	bDuringInteraction	True if the rig is executing during an interaction
	const UAnimatio...	DataSourceRegistry	The registry to access data source
	float	DeltaTime	The current delta time
	FControlRigDraw...	DrawContainer	The draw container for the units to use
	FControlRigDraw...	DrawInterface	The draw interface for the units to use
	float	FramesPerSecond	The current frames per second
	URigHierarchy &...	Hierarchy	The current hierarchy being executed
	FControlRigLog ...	Log	A handle to the compiler log
	FRigNameCache &...	NameCache	A container to store all names
	const AActor &#...	OwningActor	The current actor this rig is owned by
	USceneComponent...	OwningComponent	The current component this rig is owned by
	EControlRigStat...	State	Current execution context
	FTransform	ToWorldSpaceTransform	The current transform going from rig (global) space to world space
	const UWorld &#...	World	The world this rig is running in

Constructors

	Name	Description
	FRigUnitContext()	Default constructor

Functions

		Name	Description
	T *	RequestDataSource ( const FName& InName )	Returns a given data source and cast it to the expected class.
	FTransform	ToRigSpace ( const FTransform& InTransform )	Converts a transform from world space to rig (global) space
	FVector	ToRigSpace ( const FVector& InLocation )	Converts a location from world space to rig (global) space
	FQuat	ToRigSpace ( const FQuat& InRotation )	Converts a rotation from world space to rig (global) space
	FTransform	ToWorldSpace ( const FTransform& InTransform )	Converts a transform from rig (global) space to world space
	FVector	ToWorldSpace ( const FVector& InLocation )	Converts a location from rig (global) space to world space
	FQuat	ToWorldSpace ( const FQuat& InRotation )	Converts a rotation from rig (global) space to world space