1. Epic GamesDeveloper
  3. UTickableTransformConstraint

UTickableTransformConstraint

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

API > API/Runtime > API/Runtime/Constraints

Inheritance Hierarchy

References

   
Module Constraints
Header /Engine/Source/Runtime/Experimental/Animation/Constraints/Public/TransformConstraint.h
Include #include "TransformConstraint.h"

Syntax

class UTickableTransformConstraint : public UTickableConstraint

Remarks

UTickableTransformConstraint

Variables

  Type Name Description
Public variable bool bDynamicOffset Should the child be able to change it's offset dynamically.
Public variable bool bMaintainOffset Should that constraint maintain the default offset.
Public variable TObjectPtr< UTransformableHandle > ChildTRSHandle The transformable handle representing the child of that constraint.
Public variable TObjectPtr< UTransformableHandle > ParentTRSHandle The transformable handle representing the parent of that constraint.
Protected variable ETransformConstraintType Type Defines the constraint's type (Position, Parent, Aim...).
Public variable float Weight Defines how much the constraint will be applied.

Functions

  Type Name Description
Protected function Virtual void Computes the initial offset that is needed to keep the child's global transform unchanged when creating the constraint.
Public function void Sets up dependencies with the first primary prerequisite available if the parent does not tick.
Public function Const EMovieSceneTransformChannel Returns the channels to key based on the constraint's type.
Public function Const FTransform Get the current child's global transform.
Public function Const FTickFunction * Returns the handles tick function (ensuring it lives in the same world).
Public function Const FTransform Get the current child's local transform.
Protected function Const FTickFunction * Returns the handle's tick function (ensuring it lives in the same world).
Public function Static FOnConstraintChanged &  
Public function Const FTransform Get the current parent's global transform.
Public function Const FTickFunction *  
Public function Const FTransform Get the current parent's local transform.
Public function Const int64

GetType ()

 Returns the constraint type (Position, Parent, Aim...).
Protected function void (Re-)Registers the constraint function and (re-)binds the required delegates
Public function Virtual Const bool If that constraint needs to be handled by the compensation system.
Protected function Const void Handle active state modification if needed.
Public function Virtual void

OnHandleModified ( UTransformableHandle* InHandle,
EHandleEvent InEvent
)

 Manages changes on the child/parent transformable handle.
Protected function void  
Protected function Const void

SetChildGlobalTransform ( const FTransform& InGlobal
)

 Set the current child's global transform.
Protected function Const void

SetChildLocalTransform ( const FTransform& InLocal
)

 Set the current child's local transform.
Public function void

Setup ()

 Sets up the constraint so that the initial offset is set and dependencies and handles managed.
Protected function void Sets up dependencies between the parent, the constraint and the child using their respective tick functions.
Protected function Const void Registers/Unregisters useful delegates for both child and parent handles.

Overridden from UTickableConstraint

  Type Name Description
Public function Virtual Const UTickableConstraint *

Duplicate ( UObject* NewOuter
)

 Create duplicate with new Outer
Public function Virtual Const void

Evaluate ( bool bTickHandlesAlso
)

 Override the evaluate so we can tick our handles
Public function Virtual Const FString  
Public function Virtual Const FString Returns the constraint's label used for UI.
Public function Virtual Const uint32 Returns the target hash value (i.e. the child handle's hash).
Public function Virtual Const FString Returns the constraint's type label used for UI.
Public function Virtual Const bool 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
Public function Virtual Const bool If Active and the handles and targets are valid
Public function Virtual Const bool Test whether an InObject is referenced by that constraint. (i.e. is it's parent or child).
Public function Virtual void

ResolveBoundObjects ( FMovieSceneSequenceID LocalSequenceID,
IMovieScenePlayer& Player,
UObject* SubObject
)

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

SetActive ( const bool bIsActive
)

 Sets the Active value and enable/disable the tick function.

Overridden from UObject

  Type Name Description
Public function Virtual void

PostDuplicate ( bool bDuplicateForPIE
)

 Called after duplication & serialization and before PostLoad.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Called after applying a transaction to the object.
Public function Virtual void UObjects overrides.

Typedefs

Name Description
FOnConstraintChanged Returns a delegate that can be used to monitor for property changes.

Constants

Name Description
OnConstraintChanged UTickableTransformConstraint

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page