UE::MovieScene::IEntitySystemScheduler Class Reference

#include <IMovieSceneTaskScheduler.h>

Inheritance diagram for UE::MovieScene::IEntitySystemScheduler:

Public Member Functions
template<typename TaskType , typename ... TaskArgTypes>
FTaskID	AddTask (const FTaskParams &InParams, TaskArgTypes &&... Args)
template<typename TaskType >
FTaskID	AddMemberFunctionTask (const FTaskParams &InParams, TaskType *Instance, typename TMemberFunctionTaskWrapper< TaskType >::MemberFunctionPtr FunctionPtr)
MOVIESCENE_API FTaskID	AddNullTask ()
MOVIESCENE_API FTaskID	AddTask (const FTaskParams &InParams, TSharedPtr< ITaskContext > InTaskContext, TaskFunctionPtr InTaskFunction)
MOVIESCENE_API FTaskID	CreateForkedAllocationTask (const FTaskParams &InParams, TSharedPtr< ITaskContext > InTaskContext, TaskFunctionPtr InTaskFunction, TFunctionRef< void(FEntityAllocationIteratorItem, TArray< FPreLockedDataPtr > &)> InPreLockFunc, const FEntityComponentFilter &Filter, const FComponentMask &ReadDeps, const FComponentMask &WriteDeps)
MOVIESCENE_API void	AddPrerequisite (FTaskID Prerequisite, FTaskID Subsequent)
MOVIESCENE_API void	AddChildBack (FTaskID Parent, FTaskID Child)
MOVIESCENE_API void	AddChildFront (FTaskID Parent, FTaskID Child)

Friends
class	FEntitySystemScheduler

Member Function Documentation

AddChildBack()

void UE::MovieScene::IEntitySystemScheduler::AddChildBack	(	FTaskID	Parent,
		FTaskID	Child
	)

Add a child to the front of a previously created 'forked' task. Used for defining 'PreTask' work

AddChildFront()

void UE::MovieScene::IEntitySystemScheduler::AddChildFront	(	FTaskID	Parent,
		FTaskID	Child
	)

Add a child to the back of a previously created 'forked' task. Used for defining 'PostTask' work

AddMemberFunctionTask()

template<typename TaskType >

FTaskID UE::MovieScene::IEntitySystemScheduler::AddMemberFunctionTask ( const FTaskParams &  InParams, TaskType *  Instance, typename TMemberFunctionTaskWrapper< TaskType >::MemberFunctionPtr  FunctionPtr  )

inline

Add a new task that calls a member function of the type void (*)()

Example usage: TaskScheduler->AddTask(FTaskParams(GET_STAT_ID(StatId)), this, &UMyClass::ResetWeights);

AddNullTask()

FTaskID UE::MovieScene::IEntitySystemScheduler::AddNullTask

(

)

Add a 'null' task that can be used to join many tasks into a single dependency

AddPrerequisite()

void UE::MovieScene::IEntitySystemScheduler::AddPrerequisite	(	FTaskID	Prerequisite,
		FTaskID	Subsequent
	)

Define a prerequisite for the given task

AddTask() [1/2]

template<typename TaskType , typename ... TaskArgTypes>

FTaskID UE::MovieScene::IEntitySystemScheduler::AddTask ( const FTaskParams &  InParams, TaskArgTypes &&...  Args  )

inline

Add a new task of the specified type for the currently open node ID

Example usage: TaskScheduler->AddTask<FMyTaskType>(FTaskParams(GET_STAT_ID(StatId))); TaskScheduler->AddTask<FMyTaskType2>(FTaskParams(GET_STAT_ID(StatId)), ConstructorArg1, ConstructorArg2);

AddTask() [2/2]

FTaskID UE::MovieScene::IEntitySystemScheduler::AddTask	(	const FTaskParams &	InParams,
		TSharedPtr< ITaskContext >	InTaskContext,
		TaskFunctionPtr	InTaskFunction
	)

Add an anonymous unbound task for doing non-ecs work

CreateForkedAllocationTask()

FTaskID UE::MovieScene::IEntitySystemScheduler::CreateForkedAllocationTask	(	const FTaskParams &	InParams,
		TSharedPtr< ITaskContext >	InTaskContext,
		TaskFunctionPtr	InTaskFunction,
		TFunctionRef< void(FEntityAllocationIteratorItem, TArray< FPreLockedDataPtr > &)>	InPreLockFunc,
		const FEntityComponentFilter &	Filter,
		const FComponentMask &	ReadDeps,
		const FComponentMask &	WriteDeps
	)

Create one task for each of the entity allocations that match the specified filter

Friends And Related Symbol Documentation

FEntitySystemScheduler

friend class FEntitySystemScheduler

friend

---

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

• Engine/Source/Runtime/MovieScene/Public/EntitySystem/IMovieSceneTaskScheduler.h
• Engine/Source/Runtime/MovieScene/Private/EntitySystem/IMovieSceneTaskScheduler.cpp