1. Epic GamesDeveloper
  3. FConstraintsManagerController

FConstraintsManagerController

API > API/Runtime > API/Runtime/Constraints

References

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

Syntax

class FConstraintsManagerController

Functions

  Type Name Description
Public function Const bool Add this constraint to the manager
Public function Const UTickableConstraint * Make a copy of this constraint and add it to the manager, returns the copy mode if it was added
Public function Const TConstraint *

AllocateConstraintT ( const FName& InBaseName
)

 Allocates a new constraint with the constraints manager as the owner.
Public function bool When PIEing/Simulating it's possible that the constraint isn't in the active manager but still lives
Public function Const void Go through each constraint in order and evaluate and tick them
Public function Static FConstraintsManagerController &

Get ( UWorld* InWorld
)

 Get and Set Controller acive in this world
Public function Const TArray< TObjectPtr< UTickableConstraint > >

GetAllConstraints ( const bool bSorted
)

 Returns manager's constraints array (sorted if needed).
Public function Const UTickableConstraint *

GetConstraint ( const int32 InConstraintIndex
)

 Returns the constraint based on it's index within the manager's constraints array.
Public function Const UTickableConstraint *

GetConstraint ( const FName& InConstraintName
)

 Returns the constraint based on it's name within the manager's constraints array.
Public function Const int32

GetConstraintIndex ( const FName& InConstraintName
)

 Get the index of the given constraint's name.
Public function Const const TArray< TObjectPtr< UTickableConstraint > > & Get read-only access to the array of constraints.
Public function Const TArray< TObjectPtr< UTickableConstraint > >

GetConstraintsByPredicate ( Predicate Pred,
const bool bSorted
)

 Returns a filtered constraints array checking if the predicate for each element is true.
Public function FConstraintsManagerNotifyDelegate & Delegate to trigger changes in the constraints manager.
Public function Const TArray< TObjectPtr< UTickableConstraint > >

GetParentConstraints ( const uint32 InTargetHash,
const bool bSorted
)

 Get parent constraints of the specified child.
Public function Const void

Notify ( EConstraintsManagerNotifyType InNotifyType,
UObject* InObject
)

 Notify from changes in the constraints manager.
Public function FOnSceneComponentConstrained & Delegate that's fired when a scene component is constrained, this is needed to make sure things like gizmo's get updated after the constraint tick happens
Public function Const bool

RemoveConstraint ( const int32 InConstraintIndex,
bool bDoNotCompensate
)

 Remove the constraint at the given index.
Public function Const bool

RemoveConstraint ( const FName& InConstraintName,
bool bDoNotCompensate
)

 Remove the constraint by name.
Public function Const bool

RemoveConstraint ( UTickableConstraint* InConstraint,
bool bDoNotCompensate
)

 Remove constraint by ptr
Public function Const void

SetConstraintsDependencies ( const FName& InNameToTickBefore,
const FName& InNameToTickAfter
)

 Set dependencies between two constraints.

Typedefs

Name Description
FOnSceneComponentConstrained Delegeate that's fired when a scene component is constrained, this is needed to make sure things like gizmo's get updated after the constraint tick happens

Constants

Name Description
bDoNotRemoveConstraint Static to control if we should remove constraints or not, may not want to do some when compensating since we may be deleting spawnables while doing so

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page