Navigation
API > API/Runtime > API/Runtime/MovieScene
Utility class used by the grouping system's policies (see below) to manage groups.
| Name | FEntityGroupBuilder |
| Type | struct |
| Header File | /Engine/Source/Runtime/MovieScene/Public/EntitySystem/MovieSceneEntityGroupingSystem.h |
| Include Path | #include "EntitySystem/MovieSceneEntityGroupingSystem.h" |
Syntax
struct FEntityGroupBuilder
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FEntityGroupBuilder
(
UMovieSceneEntityGroupingSystem* InOwner, |
EntitySystem/MovieSceneEntityGroupingSystem.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Owner | UMovieSceneEntityGroupingSystem * | EntitySystem/MovieSceneEntityGroupingSystem.h | ||
| PolicyKey | FEntityGroupingPolicyKey | EntitySystem/MovieSceneEntityGroupingSystem.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddEntityToGroup
(
const FMovieSceneEntityID& InEntity, |
Add the entity to the given group. The entity must already have the group ID component. | EntitySystem/MovieSceneEntityGroupingSystem.h | |
int32 AllocateGroupIndex() |
EntitySystem/MovieSceneEntityGroupingSystem.h | ||
FEntityGroupID MakeGroupID
(
int32 GroupIndex |
Make a full group ID from an existing group index | EntitySystem/MovieSceneEntityGroupingSystem.h | |
FEntityGroupID MakeInvalidGroupID() |
Make an invalid group ID that is associated with the policy key | EntitySystem/MovieSceneEntityGroupingSystem.h | |
void RemoveEntityFromGroup
(
const FMovieSceneEntityID& InEntity, |
Remove the entity from the given group. The entity must already have the group ID component. | EntitySystem/MovieSceneEntityGroupingSystem.h | |
void ReportUsedGroupIndex
(
int32 GroupIndex |
EntitySystem/MovieSceneEntityGroupingSystem.h |