1. Epic GamesDeveloper
  3. UTickableConstraint

UTickableConstraint

[UTickableConstraint](API\Runtime\Constraints\UTickableConstraint) Represents the basic interface of constraint within the constraints manager.

API > API/Runtime > API/Runtime/Constraints

Inheritance Hierarchy

References

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

Syntax

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

Remarks

UTickableConstraint Represents the basic interface of constraint within the constraints manager.

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere BlueprintReadWrite displayname bool Active  
Public variable UProperty bool bValid  
Public variable FGuid ConstraintID Unique id to be used to fine constraint in a particular world, may be shared
Protected variable TMap< TWeakObjectPtr< ULevel >, FConstraintTickFunction > ConstraintTicks Tick function that will be registered and evaluated.
Public variable void virtual InitConstraint(UWorld *InWorld) PURE_VIRTUAL(UTickableConstraint void virtual Teard... GetTickFunction Initialize and register the constraint with that world Teardown and unregister the constraint with that world Get Tick function in that world

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Virtual Const UTickableConstraint *

Duplicate ( UObject* NewOuter
)

 Create duplicate with new Outer
Public function Virtual Const void

Evaluate ( bool bTickHandlesAlso
)

 Evaluates the constraint in a context where it's mot done thru the ConstraintTick's tick function.
Public function Virtual Const FString  
Public function Virtual Const FConstraintTickFunction::ConstraintFunction Returns the actual function that the tick function needs to evaluate.
Public function Virtual Const FString Returns the constraint's label used for UI.
Public function Virtual Const uint32  
Public function Const const FConstraintTickFunction &

GetTickFunction ( UWorld* InWorld
)

  
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 Get whether or not it's fully active, it's set to active and all pieces are set up,e.g.
Public function Virtual Const bool

IsValid ( const bool bDeepCheck
)

 Whether or not it's valid for example it may not be fully loaded, missing handles or set to not be valid
Public function Virtual void

PostDuplicate ( bool bDuplicateForPIE
)

  
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual Const bool

ReferencesObject ( TWeakObjectPtr< UObject > InObject
)

 Whether or not this object references this object.
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.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page