UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::MovieScene::FMutualInclusivityGraphCommandBuffer Struct Reference

#include <MovieSceneMutualComponentInclusivity.h>

Public Member Functions

int32 ComputeMutuallyInclusiveComponents (EMutuallyInclusiveComponentType TypesToCompute, const FComponentMask &InMask, FComponentMask &OutMask, FMutualComponentInitializers &OutInitializers) const
 
void CheckInvariants () const
 

Detailed Description

Command buffer used for computing mutually inclusive components based on a complex set of rules and dependencies

Member Function Documentation

◆ CheckInvariants()

void UE::MovieScene::FMutualInclusivityGraphCommandBuffer::CheckInvariants ( ) const

Check this buffer's invariants are satisfied

◆ ComputeMutuallyInclusiveComponents()

int32 UE::MovieScene::FMutualInclusivityGraphCommandBuffer::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.
TypesToComputeAllows computation of mandatory, optional or all rules
OutMaskComponent mask to receieve the result. May point to the same mask as InMask in order to add the mutual components directly.
OutInitializersArray to receieve initializers that must be called on the resulting entity range(s)
Returns
The number of new components added to OutMask. Only components that did not exist before are considered.

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