#include <ConstraintsManager.h>

Inheritance diagram for FConstraintTickFunction:

Public Types
using	ConstraintFunction = TFunction< void()>

Public Member Functions
CONSTRAINTS_API	FConstraintTickFunction ()

CONSTRAINTS_API	~FConstraintTickFunction ()

CONSTRAINTS_API	FConstraintTickFunction (const FConstraintTickFunction &In)

virtual CONSTRAINTS_API void	ExecuteTick (float DeltaTime, ELevelTick TickType, ENamedThreads::Type CurrentThread, const FGraphEventRef &MyCompletionGraphEvent) override

virtual CONSTRAINTS_API FString	DiagnosticMessage () override

CONSTRAINTS_API void	RegisterFunction (ConstraintFunction InConstraint)

CONSTRAINTS_API void	EvaluateFunctions () const

Public Member Functions inherited from FTickFunction
	UPROPERTY (EditDefaultsOnly, Category="Tick", meta=(DisplayName="Tick Interval (secs)")) float TickInterval

ENGINE_API	FTickFunction ()

virtual ENGINE_API	~FTickFunction ()

ENGINE_API void	RegisterTickFunction (class ULevel *Level)

ENGINE_API void	UnRegisterTickFunction ()

bool	IsTickFunctionRegistered () const

ENGINE_API void	SetTickFunctionEnable (bool bInEnabled)

bool	IsTickFunctionEnabled () const

ENGINE_API void	UpdateTickIntervalAndCoolDown (float NewTickInterval)

ENGINE_API bool	IsCompletionHandleValid () const

ENGINE_API FGraphEventRef	GetCompletionHandle () const

virtual ENGINE_API bool	CanDispatchManually () const

virtual ENGINE_API bool	DispatchManually ()

TEnumAsByte< enum ETickingGroup >	GetActualTickGroup () const

TEnumAsByte< enum ETickingGroup >	GetActualEndTickGroup () const

ENGINE_API void	AddPrerequisite (UObject *TargetObject, struct FTickFunction &TargetTickFunction)

ENGINE_API void	RemovePrerequisite (UObject *TargetObject, struct FTickFunction &TargetTickFunction)

ENGINE_API void	SetPriorityIncludingPrerequisites (bool bInHighPriority)

TArray< struct FTickPrerequisite > &	GetPrerequisites ()

const TArray< struct FTickPrerequisite > &	GetPrerequisites () const

float	GetLastTickGameTime () const

ENGINE_API void	ExecuteNestedTick (float DeltaTime, ELevelTick TickType, ENamedThreads::Type CurrentThread, const FGraphEventRef &MyCompletionGraphEvent)

ENGINE_API float	CalculateDeltaTime (float DeltaTime, const class UWorld *TickingWorld)

ENGINE_API void	LogTickFunction (ENamedThreads::Type CurrentThread, bool bLogPrerequisites, int32 Indent=0)

ENGINE_API void	ShowPrerequistes (int32 Indent=1)

ENGINE_API void	ClearTaskInformation ()

virtual void virtual FString return	TEXT ("DiagnosticMessage() not implemented")

virtual FName	DiagnosticContext (bool bDetailed)

virtual void	ForEachNestedTick (TFunctionRef< void(FTickFunction &)> InFunc) const

FTickFunction &	operator= (const FTickFunction &)=delete

Public Attributes
TWeakObjectPtr< UTickableConstraint >	Constraint

TArray< ConstraintFunction >	ConstraintFunctions

Public Attributes inherited from FTickFunction
TEnumAsByte< enum ETickingGroup >	TickGroup

TEnumAsByte< enum ETickingGroup >	EndTickGroup

uint8	bTickEvenWhenPaused:1

uint8	bCanEverTick:1

uint8	bStartWithTickEnabled:1

uint8	bAllowTickOnDedicatedServer:1

uint8	bAllowTickBatching:1

uint8	bHighPriority:1

uint8	bRunOnAnyThread:1

uint8	bRunTransactionally:1

uint8	bDispatchManually: 1

Detailed Description

FConstraintTickFunction Represents the interface of constraint as a tick function. This allows both to evaluate a constraint in the UE ticking system but also to handle dependencies between parents/children and constraints between themselves using the tick prerequisites system.

Member Typedef Documentation

◆ ConstraintFunction

using FConstraintTickFunction::ConstraintFunction = TFunction<void()>

Callable function that represents the actual constraint.

Constructor & Destructor Documentation

◆ FConstraintTickFunction() [1/2]

FConstraintTickFunction::FConstraintTickFunction ( )

FConstraintTickFunction

◆ ~FConstraintTickFunction()

FConstraintTickFunction::~FConstraintTickFunction ( )

◆ FConstraintTickFunction() [2/2]

FConstraintTickFunction::FConstraintTickFunction ( const FConstraintTickFunction & In )

Member Function Documentation

◆ DiagnosticMessage()

FString FConstraintTickFunction::DiagnosticMessage ( )

overridevirtual

Abstract function to describe this tick. Used to print messages about illegal cycles in the dependency graph

Reimplemented from FTickFunction.

◆ EvaluateFunctions()

void FConstraintTickFunction::EvaluateFunctions ( ) const

Register a callable function.

◆ ExecuteTick()

void FConstraintTickFunction::ExecuteTick	(	float	DeltaTime,
		ELevelTick	TickType,
		ENamedThreads::Type	CurrentThread,
		const FGraphEventRef &	MyCompletionGraphEvent
	)

overridevirtual

Abstract function actually execute the tick. Batched tick managers should use ExecuteNestedTick

Parameters

DeltaTime	- frame time to advance, in seconds
TickType	- kind of tick for this frame
CurrentThread	- thread we are executing on, useful to pass along as new tasks are created
MyCompletionGraphEvent	- completion event for this task. Useful for holding the completetion of this task until certain child tasks are complete.

Reimplemented from FTickFunction.

◆ RegisterFunction()

void FConstraintTickFunction::RegisterFunction ( ConstraintFunction InConstraint )

Register a callable function.

Member Data Documentation

◆ Constraint

TWeakObjectPtr<UTickableConstraint> FConstraintTickFunction::Constraint

Weak ptr to the Constraint holding this tick function.

◆ ConstraintFunctions

TArray<ConstraintFunction> FConstraintTickFunction::ConstraintFunctions

The list of the constraint functions that will be called within the tick function.

The documentation for this struct was generated from the following files:

Engine/Source/Runtime/Experimental/Animation/Constraints/Public/ConstraintsManager.h
Engine/Source/Runtime/Experimental/Animation/Constraints/Private/ConstraintsManager.cpp

Public Types

Public Member Functions

Public Attributes