1. Epic GamesDeveloper
  3. UTickableTransformConstraint

UTickableTransformConstraint

[UTickableTransformConstraint](API\Runtime\Constraints\UTickableTransformConstraint)

API > API/Runtime > API/Runtime/Constraints

UTickableTransformConstraint

   
Name UTickableTransformConstraint
Type class
Header File /Engine/Source/Runtime/Experimental/Animation/Constraints/Public/Transform/TransformConstraint.h
Include Path #include "Transform/TransformConstraint.h"

Syntax

UCLASS (Abstract, Blueprintable, MinimalAPI)  
class UTickableTransformConstraint : public UTickableConstraint

Inheritance Hierarchy

Derived Classes

UTickableTransformConstraint derived class hierarchy

Typedefs

Name Type Remarks Include Path
FOnConstraintChanged TMulticastDelegate_TwoParams< void, UTickableTransformConstraint *, const FPropertyChangedEvent & > Returns a delegate that can be used to monitor for property changes. Transform/TransformConstraint.h

Constants

Name Type Remarks Include Path
OnConstraintChanged FOnConstraintChanged UTickableTransformConstraint Transform/TransformConstraint.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bDynamicOffset bool Should the child be able to change it's offset dynamically. Transform/TransformConstraint.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Offset"
  • Meta=(EditCondition="(Type!=ETransformConstraintType::LookAt) && bMaintainOffset")
bMaintainOffset bool Should that constraint maintain the default offset. Transform/TransformConstraint.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Offset"
  • Meta=(EditCondition="Type!=ETransformConstraintType::LookAt")
bUseCurrentOffset bool Used at creation to define whether the current relative offset should be used instead of the provided one. Transform/TransformConstraint.h
  • EditAnywhere
  • Transient
  • Category="Offset"
  • Meta=(DisplayPriority=0)
ChildTRSHandle TObjectPtr< UTransformableHandle > The transformable handle representing the child of that constraint. Transform/TransformConstraint.h
  • BlueprintReadWrite
  • Category="Handle"
ParentTRSHandle TObjectPtr< UTransformableHandle > The transformable handle representing the parent of that constraint. Transform/TransformConstraint.h
  • BlueprintReadWrite
  • Category="Handle"
Weight float Defines how much the constraint will be applied. Transform/TransformConstraint.h
  • Meta=(Input, ClampMin="0.0", ClampMax="1.0", UIMin="0.0", UIMax="1.0")

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void AddedToWorld ( UWorld* InWorld
)

   Transform/TransformConstraint.h  

void EnsurePrimaryDependency ( const UWorld* InWorld
) const

 Sets up dependencies with the first primary prerequisite available if the parent does not tick. Transform/TransformConstraint.h  

EMovieSceneTransformChannel GetChannelsToKey()

 Returns the channels to key based on the constraint's type. Transform/TransformConstraint.h  

FTransform GetChildGlobalTransform()

 Get the current child's global transform. Transform/TransformConstraint.h  

FTickFunction * GetChildHandleTickFunction()

 Returns the handles tick function (ensuring it lives in the same world). Transform/TransformConstraint.h  

FTransform GetChildLocalTransform()

 Get the current child's local transform. Transform/TransformConstraint.h  

FTransform GetParentGlobalTransform()

 Get the current parent's global transform. Transform/TransformConstraint.h  

FTickFunction * GetParentHandleTickFunction()

   Transform/TransformConstraint.h  

FTransform GetParentLocalTransform()

 Get the current parent's local transform. Transform/TransformConstraint.h  

int64 GetType()

 Returns the constraint type (Position, Parent, Aim...). Transform/TransformConstraint.h  

virtual void InitConstraint ( UWorld* InWorld
)

 (Re-)Registers the constraint function and (re-)binds the required delegates Transform/TransformConstraint.h  

virtual bool NeedsCompensation()

 If that constraint needs to be handled by the compensation system. Transform/TransformConstraint.h  

virtual void OnHandleModified ( UTransformableHandle* InHandle,
EHandleEvent InEvent
)

 Manages changes on the child/parent transformable handle. Transform/TransformConstraint.h  

void Setup()

 Sets up the constraint so that the initial offset is set and dependencies and handles managed. Transform/TransformConstraint.h  

virtual void TeardownConstraint ( UWorld* InWorld
)

   Transform/TransformConstraint.h  

Overridden from UTickableConstraint

Name Remarks Include Path Unreal Specifiers

virtual UTickableConstraint * Duplicate ( UObject* NewOuter
) const

 Create duplicate with new Outer Transform/TransformConstraint.h  

virtual void Evaluate ( bool bTickHandlesAlso
) const

 Override the evaluate so we can tick our handles Transform/TransformConstraint.h  

virtual FString GetFullLabel()

   Transform/TransformConstraint.h  

virtual FString GetLabel()

 Returns the constraint's label used for UI. Transform/TransformConstraint.h  

virtual uint32 GetTargetHash()

 Returns the target hash value (i.e. the child handle's hash). Transform/TransformConstraint.h  

virtual FString GetTypeLabel()

 Returns the constraint's type label used for UI. Transform/TransformConstraint.h  

virtual bool HasBoundObjects()

 If true it contains objects bound to an external system, like sequencer so we don't do certain things, like remove constraints when they don't resolve Transform/TransformConstraint.h  

virtual bool IsFullyActive()

 If Active and the handles and targets are valid, and tick function is registered Transform/TransformConstraint.h  

virtual bool IsValid ( const bool bDeepCheck
) const

 Whether or not it's valid for example it may not be fully loaded Transform/TransformConstraint.h  

virtual bool ReferencesObject ( TWeakObjectPtr< UObject > InObject
) const

 Test whether an InObject is referenced by that constraint. (i.e. is it's parent or child). Transform/TransformConstraint.h  

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

 Resolve the bound objects so that any object it references are resovled and correctly set up Transform/TransformConstraint.h  

virtual void SetActive ( const bool bIsActive
)

 Sets the Active value and enable/disable the tick function. Transform/TransformConstraint.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual bool CanEditChange ( const FProperty* InProperty
) const

   Transform/TransformConstraint.h  

virtual void PostDuplicate ( bool bDuplicateForPIE
)

   Transform/TransformConstraint.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Transform/TransformConstraint.h  

virtual void PostEditUndo()

   Transform/TransformConstraint.h  

virtual void PostLoad()

 UObjects overrides. Transform/TransformConstraint.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void ComputeOffset ()

 Computes the initial offset that is needed to keep the child's global transform unchanged when creating the constraint. Transform/TransformConstraint.h  

FTickFunction * GetHandleTickFunction ( const TObjectPtr< UTransformableHandle >& InHandle
) const

 Returns the handle's tick function (ensuring it lives in the same world). Transform/TransformConstraint.h  

void OnActiveStateChanged()

 Handle active state modification if needed. Transform/TransformConstraint.h  

void PostEvaluate()

 Perform necessary post-evaluation steps after calculating the constraint's result. Transform/TransformConstraint.h  

void PreEvaluate()

 Perform necessary pre-evaluation steps before calculating the constraint's result. Transform/TransformConstraint.h  

void RegisterDelegates()

   Transform/TransformConstraint.h  

void SetChildGlobalTransform ( const FTransform& InGlobal
) const

 Set the current child's global transform. Transform/TransformConstraint.h  

void SetChildLocalTransform ( const FTransform& InLocal
) const

 Set the current child's local transform. Transform/TransformConstraint.h  

void SetupDependencies ( const UWorld* InWorld
)

 Sets up dependencies between the parent, the constraint and the child using their respective tick functions. Transform/TransformConstraint.h  

void UnregisterDelegates()

 Registers/Unregisters useful delegates for both child and parent handles. Transform/TransformConstraint.h  

Static

Name Remarks Include Path Unreal Specifiers

static FOnConstraintChanged & GetOnConstraintChanged()

   Transform/TransformConstraint.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page