Navigation
API > API/Plugins > API/Plugins/ControlRig
| Name | UTransformableControlHandle |
| Type | class |
| Header File | /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Constraints/ControlRigTransformableHandle.h |
| Include Path | #include "Constraints/ControlRigTransformableHandle.h" |
Syntax
UCLASS (MinimalAPI, Blueprintable)
class UTransformableControlHandle : public UTransformableHandle
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UTransformableHandle → UTransformableControlHandle
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~UTransformableControlHandle() |
UTransformableControlHandle | Constraints/ControlRigTransformableHandle.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ControlName | FName | The ControlName of the control that this handle is pointing at. | Constraints/ControlRigTransformableHandle.h |
|
| ControlRig | TSoftObjectPtr< UControlRig > | The ControlRig that this handle is pointing at. | Constraints/ControlRigTransformableHandle.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Cache | FTransform | Constraints/ControlRigTransformableHandle.h | ||
| EvaluationTask | UE::Anim::FAnimationEvaluationTask | Constraints/ControlRigTransformableHandle.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void OnControlModified
(
UControlRig* InControlRig, |
Constraints/ControlRigTransformableHandle.h | ||
void RegisterDelegates() |
Constraints/ControlRigTransformableHandle.h | ||
void UnregisterDelegates() |
Registers/Unregisters useful delegates to track changes in the control's transform. | Constraints/ControlRigTransformableHandle.h |
Overridden from UTransformableHandle
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool AddTransformKeys
(
const TArray< FFrameNumber >& InFrames, |
Constraints/ControlRigTransformableHandle.h | ||
virtual UTransformableHandle * Duplicate
(
UObject* NewOuter |
Make a duplicate of myself with this outer | Constraints/ControlRigTransformableHandle.h | |
virtual TArrayView< FMovieSceneDoubleChannel * > GetDoubleChannels
(
const UMovieSceneSection* InSection |
Get the array of double channels for the specified section | Constraints/ControlRigTransformableHandle.h | |
virtual TArrayView< FMovieSceneFloatChannel * > GetFloatChannels
(
const UMovieSceneSection* InSection |
Get the array of float channels for the specified section | Constraints/ControlRigTransformableHandle.h | |
virtual FString GetFullLabel() |
Constraints/ControlRigTransformableHandle.h | ||
virtual FTransform GetGlobalTransform() |
Gets the global transform of the control. | Constraints/ControlRigTransformableHandle.h | |
virtual uint32 GetHash() |
Constraints/ControlRigTransformableHandle.h | ||
virtual FString GetLabel() |
Returns labels used for UI. | Constraints/ControlRigTransformableHandle.h | |
virtual FTransform GetLocalTransform() |
Sets the local transform of the control. | Constraints/ControlRigTransformableHandle.h | |
virtual UObject * GetPrerequisiteObject() |
Returns the target object containing the tick function (e.i. SkeletalComponent bound to ControlRig). | Constraints/ControlRigTransformableHandle.h | |
virtual FTickPrerequisite GetPrimaryPrerequisite
(
const bool bAllowThis |
Look for a possible tick function that can be used as a prerequisite. | Constraints/ControlRigTransformableHandle.h | |
virtual TWeakObjectPtr< UObject > GetTarget() |
Returns the underlying targeted object. | Constraints/ControlRigTransformableHandle.h | |
virtual FTickFunction * GetTickFunction() |
Returns ths SkeletalComponent tick function. | Constraints/ControlRigTransformableHandle.h | |
virtual bool HasDirectDependencyWith
(
const UTransformableHandle& InOther |
Check for direct dependencies (ie hierarchy + skeletal mesh) with InOther. | Constraints/ControlRigTransformableHandle.h | |
virtual bool IsValid
(
const bool bDeepCheck |
Sanity check to ensure that ControlRig and ControlName are safe to use. | Constraints/ControlRigTransformableHandle.h | |
virtual void PreEvaluate
(
const bool bTick |
Perform any pre-evaluation of the handle to ensure that the transform data is up to date. | Constraints/ControlRigTransformableHandle.h | |
virtual void ResolveBoundObjects
(
FMovieSceneSequenceID LocalSequenceID, |
Resolve the bound objects so that any object it references are resolved and correctly set up | Constraints/ControlRigTransformableHandle.h | |
virtual void SetGlobalTransform
(
const FTransform& InGlobal |
Sets the global transform of the control. | Constraints/ControlRigTransformableHandle.h | |
virtual void SetLocalTransform
(
const FTransform& InLocal |
Sets the local transform of the control. | Constraints/ControlRigTransformableHandle.h | |
virtual void TickTarget() |
Tick any skeletal mesh related to the bound component. | Constraints/ControlRigTransformableHandle.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostLoad() |
Constraints/ControlRigTransformableHandle.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static uint32 ComputeHash
(
const UControlRig* InControlRig, |
Generates a hash value based on ControlRig and ControlName. | Constraints/ControlRigTransformableHandle.h | |
static FControlEvaluationGraphBinding & GetEvaluationBinding() |
Constraints/ControlRigTransformableHandle.h |