UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | List of all members
UE::MovieScene::FEntityGroupBuilder Struct Reference

#include <MovieSceneEntityGroupingSystem.h>

Public Member Functions

UE_API FEntityGroupBuilder (UMovieSceneEntityGroupingSystem *InOwner, FEntityGroupingPolicyKey InPolicyKey)
 
FEntityGroupID MakeGroupID (int32 GroupIndex) const
 
FEntityGroupID MakeInvalidGroupID () const
 
UE_API void AddEntityToGroup (const FMovieSceneEntityID &InEntity, const FEntityGroupID &InNewGroupID)
 
UE_API void RemoveEntityFromGroup (const FMovieSceneEntityID &InEntity, const FEntityGroupID &InPreviousGroupID)
 
UE_API int32 AllocateGroupIndex ()
 
UE_API void ReportUsedGroupIndex (int32 GroupIndex)
 

Detailed Description

Utility class used by the grouping system's policies (see below) to manage groups.

Constructor & Destructor Documentation

◆ FEntityGroupBuilder()

UE::MovieScene::FEntityGroupBuilder::FEntityGroupBuilder ( UMovieSceneEntityGroupingSystem *  InOwner,
FEntityGroupingPolicyKey  InPolicyKey 
)

Member Function Documentation

◆ AddEntityToGroup()

void UE::MovieScene::FEntityGroupBuilder::AddEntityToGroup ( const FMovieSceneEntityID &  InEntity,
const FEntityGroupID &  InNewGroupID 
)

Add the entity to the given group. The entity must already have the group ID component.

◆ AllocateGroupIndex()

int32 UE::MovieScene::FEntityGroupBuilder::AllocateGroupIndex ( )

◆ MakeGroupID()

FEntityGroupID UE::MovieScene::FEntityGroupBuilder::MakeGroupID ( int32  GroupIndex) const
inline

Make a full group ID from an existing group index

◆ MakeInvalidGroupID()

FEntityGroupID UE::MovieScene::FEntityGroupBuilder::MakeInvalidGroupID ( ) const
inline

Make an invalid group ID that is associated with the policy key

◆ RemoveEntityFromGroup()

void UE::MovieScene::FEntityGroupBuilder::RemoveEntityFromGroup ( const FMovieSceneEntityID &  InEntity,
const FEntityGroupID &  InPreviousGroupID 
)

Remove the entity from the given group. The entity must already have the group ID component.

◆ ReportUsedGroupIndex()

void UE::MovieScene::FEntityGroupBuilder::ReportUsedGroupIndex ( int32  GroupIndex)
The documentation for this struct was generated from the following files: