1. Epic GamesDeveloper
  3. UMassVisualizationComponent

UMassVisualizationComponent

This component handles all the static mesh instances for a MassRepresentationProcessor and is an actor component off a MassVisualizer actor.

API > API/Plugins > API/Plugins/MassRepresentation

Inheritance Hierarchy

  • UActorComponent
  • UMassVisualizationComponent

References

   
Module MassRepresentation
Header /Engine/Plugins/Runtime/MassGameplay/Source/MassRepresentation/Public/MassVisualizationComponent.h
Include #include "MassVisualizationComponent.h"

Syntax

UCLASS ()  
class UMassVisualizationComponent : public UActorComponent

Remarks

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.

Variables

  Type Name Description
Protected variable TArray< FStaticMeshInstanceVisualizationDescHandle > InstancedSMComponentsRequiringConstructing Indicies to InstancedStaticMeshInfos that need their SMComponent constructed
Protected variable UProperty Transient TArray< FMassInstancedStaticMeshInfo > InstancedStaticMeshInfos The information of all the instanced static meshes.
Protected variable TArray< FStaticMeshInstanceVisualizationDescHandle > InstancedStaticMeshInfosFreeIndices Indices to InstancedStaticMeshInfos that have been released and can be reused
Protected variable TMap< FISMCSharedDataKey, FStaticMeshInstanceVisualizationDescHandle > ISMComponentMap Mapping from ISMComponent (indicated by FISMCSharedDataKey) to corresponding VisualDescHandle
Protected variable FMassISMCSharedDataMap ISMCSharedData  
Protected variable TMap< uint32, FISMCSharedDataKey > MeshDescToISMCMap Mapping FMassStaticMeshInstanceVisualizationMeshDesc hash to FMassISMCSharedData entries for all FMassStaticMeshInstanceVisualizationMeshDesc that didn't come with ISMC explicitly provided.

Functions

  Type Name Description
Protected function FStaticMeshInstanceVisualizationDescHandle Either adds an element to InstancedStaticMeshInfos or reuses an existing entry based on InstancedStaticMeshInfosFreeIndices
Public function FStaticMeshInstanceVisualizationDescHandle

AddVisualDescWithISMComponent ( const FStaticMeshInstanceVisualizationDesc& Desc,
UInstancedStaticMeshComponent& ISMComponent
)

 Creates a dedicated visual type described by host Desc and ties ISMComponent to it.
Public function FStaticMeshInstanceVisualizationDescHandle

AddVisualDescWithISMComponents ( const FStaticMeshInstanceVisualizationDesc& Desc,
TArrayView< TObjectPtr< UInstancedStaticMeshComponent > > ISMComponents
)

 Creates a dedicated visual type described by host Desc and ties given ISMComponents to it.
Public function void Signal the beginning of the static mesh instance changes, used to prepare the batching update of the static mesh instance transforms
Protected function void  
Protected function void

BuildLODSignificanceForInfo ( FMassInstancedStaticMeshInfo& Info,
TConstArrayView< UInstancedStaticMeshComponent* > StaticMeshRefKeys
)

 Creates LODSignificance ranges for all the meshes indicated by Info
Protected function void

BuildLODSignificanceForInfo ( FMassInstancedStaticMeshInfo& Info,
const uint32 ForcedStaticMeshRefKey
)

  
Public function void Destroy all visual instances
Protected function void Recreate all the static mesh components from the InstancedStaticMeshInfos
Public function void Dirty render state on all static mesh components
Public function void Signal the end of the static mesh instance changes, used to batch apply the transforms on the static mesh instances
Public function FStaticMeshInstanceVisualizationDescHandle Get the index of the visual type, will add a new one if does not exist
Public function Const const FMassISMCSharedData *

GetISMCSharedDataForDescriptionIndex ( const int32 DescriptionIndex
)

 Fetches FMassISMCSharedData indicated by DescriptionIndex, or nullptr if it's not a valid index
Public function FMassInstancedStaticMeshInfoArrayView Get the array of all visual instance informations
Protected function void

HandleChangesWithExternalIDTracking ( UInstancedStaticMeshComponent& ISMComponent,
FMassISMCSharedData& SharedData
)

 Applies changes accumulated in SharedData while manually updating the Instance ID mapping.
Protected function Virtual void Overridden to make sure this component is only added to a MassVisualizer actor
Protected function void

ProcessRemoves ( UInstancedStaticMeshComponent& ISMComponent,
FMassISMCSharedData& SharedData,
bool bUpdateNavigation
)

 Process all removed IDs in FMassISMCSharedData and apply to the ISM component.
Public function void

RemoveISMComponent ( UInstancedStaticMeshComponent& ISMComponent
)

 Removes all the visualization data associated with the given ISM component.
Public function void Removes all data associated with a given VisualizationIndex.
Public function void

RemoveVisualDescByIndex ( const int32 VisualizationIndex
)

 Removes all data associated with a given VisualizationIndex.
Protected function  

UE_MT_DECLARE_RW_RECURSIVE_ACCESS_DETECTOR ( InstancedStaticMeshInfosDetector
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page