1. Epic GamesDeveloper
  3. UTransformableControlHandle

UTransformableControlHandle

[UTransformableControlHandle](API\Plugins\ControlRig\Constraints\UTransformableControlHandle)

API > API/Plugins > API/Plugins/ControlRig > API/Plugins/ControlRig/Constraints

Inheritance Hierarchy

References

   
Module ControlRig
Header /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Constraints/ControlRigTransformableHandle.h
Include #include "Constraints/ControlRigTransformableHandle.h"

Syntax

UCLASS (Blueprintable)  
class UTransformableControlHandle : public UTransformableHandle

Remarks

UTransformableControlHandle

Variables

  Type Name Description
Public variable UProperty Category BlueprintReadOnly FName ControlName The ControlName of the control that this handle is pointing at.
Public variable UProperty Category BlueprintReadOnly TSoftObjectPtr< UControlRig > ControlRig The ControlRig that this handle is pointing at.

Destructors

  Type Name Description
Public function Virtual   UTransformableControlHandle

Functions

  Type Name Description
Public function Static uint32

ComputeHash ( const UControlRig* InControlRig,
const FName& InControlName
)

 Generates a hash value based on ControlRig and ControlName.
Public function void

OnControlModified ( UControlRig* InControlRig,
FRigControlElement* InControl,
const FRigControlModifiedContext& InContext
)

  
Public function Virtual void  
Public function void  
Public function Const void Registers/Unregisters useful delegates to track changes in the control's transform.

Overridden from UTransformableHandle

  Type Name Description
Public function Virtual Const bool

AddTransformKeys ( const TArray< FFrameNumber >& InFrames,
const TArray< FTransform >& InTransforms,
const EMovieSceneTransformChannel& InChannels,
const FFrameRate& InTickResolution,
UMovieSceneSection* InSection,
const bool bLocal
)

 Add Transform Keys at the specified times
Public function Virtual Const UTransformableHandle *

Duplicate ( UObject* NewOuter
)

 Make a duplicate of myself with this outer
Public function Virtual Const TArrayView< FMovieSceneDoubleChannel * >

GetDoubleChannels ( const UMovieSceneSection* InSection
)

 Get the array of double channels for the specified section
Public function Virtual Const TArrayView< FMovieSceneFloatChannel * >

GetFloatChannels ( const UMovieSceneSection* InSection
)

 Get the array of float channels for the specified section
Public function Virtual Const FString  
Public function Virtual Const FTransform Gets the global transform of the control.
Public function Virtual Const uint32

GetHash ()

 Generates a hash value of the underlying transformable object.
Public function Virtual Const FString Returns labels used for UI.
Public function Virtual Const FTransform Sets the local transform of the control.
Public function Virtual Const UObject * Returns the target object containing the tick function (e.i. SkeletalComponent bound to ControlRig).
Public function Virtual Const FTickPrerequisite Look for a possible tick function that can be used as a prerequisite.
Public function Virtual Const TWeakObjectPtr< UObject > Returns the underlying targeted object.
Public function Virtual Const FTickFunction * Returns ths SkeletalComponent tick function.
Public function Virtual Const bool Check for direct dependencies (ie hierarchy + skeletal mesh) with InOther.
Public function Virtual Const bool

IsValid ( const bool bDeepCheck
)

 Sanity check to ensure that ControlRig and ControlName are safe to use.
Public function Virtual Const void

PreEvaluate ( const bool bTick
)

 Perform any pre-evaluation of the handle to ensure that the transform data is up to date.
Public function Virtual void

ResolveBoundObjects ( FMovieSceneSequenceID LocalSequenceID,
TSharedRef< UE::MovieScene::FSharedPlaybackState > SharedPlaybackState,
UObject* SubObject
)

 Resolve the bound objects so that any object it references are resolved and correctly set up
Public function Virtual Const void

SetGlobalTransform ( const FTransform& InGlobal
)

 Sets the global transform of the control.
Public function Virtual Const void

SetLocalTransform ( const FTransform& InLocal
)

 Sets the local transform of the control.
Public function Virtual Const void Tick any skeletal mesh related to the bound component.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page