1. Epic GamesDeveloper
  3. FConstraintsManagerController

FConstraintsManagerController

API > API/Runtime > API/Runtime/Constraints

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

Syntax

class FConstraintsManagerController

Typedefs

Name Type Remarks Include Path
FOnSceneComponentConstrained TMulticastDelegate_OneParam< void, USceneComponent * > 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 ConstraintsManager.h

Constants

Name Type Remarks Include Path
bDoNotRemoveConstraint bool 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 ConstraintsManager.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
World UWorld * The World that holds the ConstraintsManagerActor. ConstraintsManager.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool AddConstraint ( UTickableConstraint* InConstraint
) const

 Add this constraint to the manager ConstraintsManager.h  

UTickableConstraint * AddConstraintFromCopy ( UTickableConstraint* CopyOfConstraint
) const

 Make a copy of this constraint and add it to the manager, returns the copy mode if it was added ConstraintsManager.h  

TConstraint * AllocateConstraintT ( const FName& InBaseName,
const bool bUseDefault
) const

 Allocates a new constraint with the constraints manager as the owner. ConstraintsManager.h  

bool DoesExistInAnyWorld ( UTickableConstraint* InConstraint
)

 When PIEing/Simulating it's possible that the constraint isn't in the active manager but still lives ConstraintsManager.h  

void EvaluateAllConstraints()

 Go through each constraint in order and evaluate and tick them ConstraintsManager.h  

void FlushEvaluationGraph()

   ConstraintsManager.h  

TArray< TWeakObjectPtr< UTickableConstraint > > GetAllConstraints ( const bool bSorted
) const

 Returns systems' constraints array (sorted if needed). ConstraintsManager.h  

UTickableConstraint * GetConstraint ( const int32 InConstraintIndex
) const

 Returns the constraint based on it's index within the manager's constraints array. ConstraintsManager.h  

UTickableConstraint * GetConstraint ( const FGuid& InGuid
) const

 Returns the constraint based on it's ID within the manager's constraints array. ConstraintsManager.h  

int32 GetConstraintIndex ( const FGuid& InGuid
) const

 Get the index of the given constraint's ID. ConstraintsManager.h  

const TArray< TWeakObjectPtr< UTickableConstraint > > & GetConstraintsArray()

 Get read-only access to the array of constraints. ConstraintsManager.h  

TArray< TWeakObjectPtr< UTickableConstraint > > GetConstraintsByPredicate ( Predicate Pred,
const bool bSorted
) const

 Returns a filtered constraints array checking if the predicate for each element is true. ConstraintsManager.h  

TArray< TWeakObjectPtr< UTickableConstraint > > GetParentConstraints ( const uint32 InTargetHash,
const bool bSorted
) const

 Get parent constraints of the specified child. ConstraintsManager.h  

TArray< TWeakObjectPtr< UTickableConstraint > > GetStaticConstraints ( const bool bSorted
) const

 Returns the static/non-animated constraints ConstraintsManager.h  

void InvalidateEvaluationGraph()

   ConstraintsManager.h  

void MarkConstraintForEvaluation ( UTickableConstraint* InConstraint
) const

 Evaluation graph API. ConstraintsManager.h  

bool RemoveAllConstraints ( bool bDoNotCompensate
)

 Remove All Constraints ConstraintsManager.h  

bool RemoveConstraint ( const int32 InConstraintIndex,
bool bDoNotCompensate
)

 Remove the constraint at the given index. ConstraintsManager.h  

bool RemoveConstraint ( UTickableConstraint* InConstraint,
bool bDoNotCompensate
)

 Remove constraint by ptr ConstraintsManager.h  

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

 Set dependencies between two constraints. ConstraintsManager.h  

void SetConstraintsDependencies ( const FGuid& InGuidToTickBefore,
const FGuid& InGuidToTickAfter
) const

   ConstraintsManager.h  
If a static constraint is created, we call this, which stores it to the manager/actor ConstraintsManager.h  

void StaticConstraintCreated ( UWorld* InWorld,
UTickableConstraint* InConstraint
)

   ConstraintsManager.h  

bool UnregisterConstraint ( UTickableConstraint* InConstraint
)

 Disable a constraint and remove it from the subsystem. ConstraintsManager.h  

Static

Name Remarks Include Path Unreal Specifiers

static FConstraintsManagerController & Get ( UWorld* InWorld
)

 Get and Set Controller acive in this world ConstraintsManager.h  

static FConstraintsManagerNotifyDelegate & GetNotifyDelegate()

 Delegate to trigger changes in the constraints manager. ConstraintsManager.h  

static void Notify ( EConstraintsManagerNotifyType InNotifyType,
UObject* InObject
)

 Notify from changes in the constraints manager. ConstraintsManager.h  

static FOnSceneComponentConstrained & OnSceneComponentConstrained()

   ConstraintsManager.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page