UMassVisualizationComponent | Unreal Engine 5.6 Documentation

API > API/Plugins > API/Plugins/MassRepresentation

This component handles all the static mesh instances for a MassRepresentationProcessor and is an actor component off a MassVisualizer actor. Meant to be created at runtime and owned by an MassVisualizer actor. Will ensure if placed on a different type of actor.


Name	UMassVisualizationComponent
Type	class
Header File	/Engine/Plugins/Runtime/MassGameplay/Source/MassRepresentation/Public/MassVisualizationComponent.h
Include Path	#include "MassVisualizationComponent.h"

Syntax

UCLASS (MinimalAPI)  
class UMassVisualizationComponent : public UActorComponent

Inheritance Hierarchy

UObjectBase → UObjectBaseUtility → UObject → UActorComponent → UMassVisualizationComponent

Implements Interfaces

Functions

Public

Name	Remarks	Include Path
FStaticMeshInstanceVisualizationDescHandle AddVisualDescWithISMComponent ( const FStaticMeshInstanceVisualizationDesc& Desc, UInstancedStaticMeshComponent& ISMComponent )	Creates a dedicated visual type described by host Desc and ties ISMComponent to it.	MassVisualizationComponent.h
FStaticMeshInstanceVisualizationDescHandle AddVisualDescWithISMComponents ( const FStaticMeshInstanceVisualizationDesc& Desc, TArrayView< TObjectPtr< UInstancedStaticMeshComponent > > ISMComponents )	Creates a dedicated visual type described by host Desc and ties given ISMComponents to it.	MassVisualizationComponent.h
void BeginVisualChanges()	Signal the beginning of the static mesh instance changes, used to prepare the batching update of the static mesh instance transforms	MassVisualizationComponent.h
void ClearAllVisualInstances()	Destroy all visual instances	MassVisualizationComponent.h
void DirtyVisuals()	Dirty render state on all static mesh components	MassVisualizationComponent.h
void EndVisualChanges()	Signal the end of the static mesh instance changes, used to batch apply the transforms on the static mesh instances	MassVisualizationComponent.h
FStaticMeshInstanceVisualizationDescHandle FindOrAddVisualDesc ( const FStaticMeshInstanceVisualizationDesc& Desc )	Get the index of the visual type, will add a new one if does not exist	MassVisualizationComponent.h
const FMassISMCSharedData * GetISMCSharedDataForDescriptionIndex ( const int32 DescriptionIndex ) const	Fetches FMassISMCSharedData indicated by DescriptionIndex, or nullptr if it's not a valid index	MassVisualizationComponent.h
const FMassISMCSharedData * GetISMCSharedDataForInstancedStaticMesh ( const UInstancedStaticMeshComponent* ISMC ) const	Fetches FMassISMCSharedData indicated by an ISMC, or nullptr if the ISMC is not represented by any shared data.	MassVisualizationComponent.h
FMassInstancedStaticMeshInfoArrayView GetMutableVisualInfos()	Get the array of all visual instance informations	MassVisualizationComponent.h
void RemoveISMComponent ( UInstancedStaticMeshComponent& ISMComponent )	Removes all the visualization data associated with the given ISM component.	MassVisualizationComponent.h
void RemoveVisualDesc ( const FStaticMeshInstanceVisualizationDescHandle VisualizationHandle )	Removes all data associated with a given VisualizationIndex.	MassVisualizationComponent.h
void RemoveVisualDescByIndex ( const int32 VisualizationIndex )	Removes all data associated with a given VisualizationIndex.	MassVisualizationComponent.h

Protected

Name	Remarks	Include Path
FStaticMeshInstanceVisualizationDescHandle AddInstancedStaticMeshInfo ( const FStaticMeshInstanceVisualizationDesc& Desc )	Either adds an element to InstancedStaticMeshInfos or reuses an existing entry based on InstancedStaticMeshInfosFreeIndices	MassVisualizationComponent.h
void BuildLODSignificanceForInfo ( FMassInstancedStaticMeshInfo& Info )		MassVisualizationComponent.h
void BuildLODSignificanceForInfo ( FMassInstancedStaticMeshInfo& Info, TConstArrayView< UInstancedStaticMeshComponent* > StaticMeshRefKeys )	Creates LODSignificance ranges for all the meshes indicated by Info	MassVisualizationComponent.h
void BuildLODSignificanceForInfo ( FMassInstancedStaticMeshInfo& Info, const uint32 ForcedStaticMeshRefKey )		MassVisualizationComponent.h
void ConstructStaticMeshComponents()	Recreate all the static mesh components from the InstancedStaticMeshInfos	MassVisualizationComponent.h
void HandleChangesWithExternalIDTracking ( UInstancedStaticMeshComponent& ISMComponent, FMassISMCSharedData& SharedData )	Applies changes accumulated in SharedData while manually updating the Instance ID mapping.	MassVisualizationComponent.h
void ProcessRemoves ( UInstancedStaticMeshComponent& ISMComponent, FMassISMCSharedData& SharedData, bool bUpdateNavigation )	Process all removed IDs in FMassISMCSharedData and apply to the ISM component.	MassVisualizationComponent.h

Overridden from UObject

Name	Remarks	Include Path	Unreal Specifiers
virtual void PostInitProperties()	Overridden to make sure this component is only added to a MassVisualizer actor	MassVisualizationComponent.h

Navigation