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

#include <MovieSceneMutualComponentInclusivity.h>

Public Member Functions

void DefineMutualInclusionRule (FComponentTypeID Predicate, std::initializer_list< FComponentTypeID > Dependents)
 
void DefineMutualInclusionRule (FComponentTypeID Predicate, std::initializer_list< FComponentTypeID > Dependents, FMutuallyInclusiveComponentParams &&InParams)
 
void DefineComplexInclusionRule (const FComplexInclusivityFilter &InFilter, std::initializer_list< FComponentTypeID > Dependents)
 
void DefineComplexInclusionRule (const FComplexInclusivityFilter &InFilter, std::initializer_list< FComponentTypeID > Dependents, FMutuallyInclusiveComponentParams &&InParams)
 
int32 ComputeMutuallyInclusiveComponents (EMutuallyInclusiveComponentType TypesToCompute, const FComponentMask &InMask, FComponentMask &OutMask, FMutualComponentInitializers &OutInitializers) const
 

Detailed Description

A mutual inclusion graph for adding components to an entity based on the presence of other components

Member Function Documentation

◆ ComputeMutuallyInclusiveComponents()

int32 UE::MovieScene::FMutualInclusivityGraph::ComputeMutuallyInclusiveComponents ( EMutuallyInclusiveComponentType  TypesToCompute,
const FComponentMask &  InMask,
FComponentMask &  OutMask,
FMutualComponentInitializers &  OutInitializers 
) const

Populate a component mask with all the necessary mutually inclusive components given an input type. Mutual components that already existed in InMask will not be added or counted. Can be used to populate a new mask with only the mutual components, or to add the components to an existing mask.

Parameters
InMaskThe input component type. Rules that are relevant to this type (directly or indirectly) will be applied to the output.
OutMaskComponent mask to receieve the result. May point to the same mask as InMask in order to add the mutual components directly.
OutInitializersInitializers that must be run for any new entities created from OutMask
Returns
The number of new components added to OutMask. Only components that did not exist before are considered.

◆ DefineComplexInclusionRule() [1/2]

void UE::MovieScene::FMutualInclusivityGraph::DefineComplexInclusionRule ( const FComplexInclusivityFilter &  InFilter,
std::initializer_list< FComponentTypeID >  Dependents 
)

Define a new complex rule specifying that all of Dependents should exist if InFilter is matched

◆ DefineComplexInclusionRule() [2/2]

void UE::MovieScene::FMutualInclusivityGraph::DefineComplexInclusionRule ( const FComplexInclusivityFilter &  InFilter,
std::initializer_list< FComponentTypeID >  Dependents,
FMutuallyInclusiveComponentParams &&  InParams 
)

◆ DefineMutualInclusionRule() [1/2]

void UE::MovieScene::FMutualInclusivityGraph::DefineMutualInclusionRule ( FComponentTypeID  Predicate,
std::initializer_list< FComponentTypeID >  Dependents 
)

Define a new rule specifying that all of Dependents should always exist if Predicate exists

◆ DefineMutualInclusionRule() [2/2]

void UE::MovieScene::FMutualInclusivityGraph::DefineMutualInclusionRule ( FComponentTypeID  Predicate,
std::initializer_list< FComponentTypeID >  Dependents,
FMutuallyInclusiveComponentParams &&  InParams 
)
The documentation for this struct was generated from the following files: