1. Epic GamesDeveloper
  3. FPrimitiveInstanceDataManager

FPrimitiveInstanceDataManager

Manager class that tracks changes to instance data within the component, and is responsible for dispatching updates of the proxy.

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/InstancedStaticMesh

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Public/InstancedStaticMesh/ISMInstanceDataManager.h
Include #include "InstancedStaticMesh/ISMInstanceDataManager.h"

Syntax

class FPrimitiveInstanceDataManager : public FInstanceIdIndexMap

Remarks

Manager class that tracks changes to instance data within the component, and is responsible for dispatching updates of the proxy. Tracks instance index changes to be able to maintain a persistent ID mapping for use on the render thread. The ID mapping is not serialized and will be reset when the proxy is recreated. Not responsible for storing the component representation of the instance data. NOTE/TODO: This is tied to the ISM use-case, mostly because of legacy (HISM) interactions. Will be refactored and sub-classed or something. Also: Still somewhat tied to the UComponent, which also can be refactored a bit to make it more general.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void

Add ( int32 InInstanceAddAtIndex,
bool bInsert
)

  
Public function void

BakedLightingDataChanged ( int32 InstanceIndex
)

  
Public function void  
Public function void

BeginCacheForCookedPlatformData ( const ITargetPlatform* TargetPlatform,
FInstanceUpdateComponentDesc&& ComponentData,
TStridedView< FMatrix > InstanceTransforms
)

  
Public function void Clear all tracked changes (will result in a full update when next one is flushed)
Public function void

ClearIdTracking ( int32 InNumInstances
)

 Clear the ID/Index association and reset the mapping to identity & number of instances to the given number.
Public function void  
Public function void

CustomDataChanged ( int32 InstanceIndex
)

  
Public function void  
Public function bool

FlushChanges ( FInstanceUpdateComponentDesc&& ComponentData,
bool bNewPrimitiveProxy
)

  
Public function Const SIZE_T  
Public function Const int32  
Public function Const int32  
Public function Const EMode

GetMode ()

  
Public function TSharedPtr< FISMCInstanceDataSceneProxy, ESPMode::ThreadSafe >  
Public function Const ETrackingState  
Public function Const bool Returns true if there are explicitly tracked instance changes, or the state is not tracked (because no proxy has been created yet), and the tracking state is not Disabled.
Public function Const bool  
Public function void

Invalidate ( int32 InNumInstances
)

  
Public function void

MarkForRebuildFromLegacy ( TUniquePtr< FStaticMeshInstanceData >&& LegacyInstanceData,
const TArray< int32 >& InstanceReorderTable,
const TArray< TRefCountPtr< HHitProxy > >& HitProxies
)

 Call to mark the manager as needing a full rebuild & having an external driver for this.
Public function void  
Public function void

OnRegister ( int32 InNumInstances
)

 Called by the corresponding function in the owner UPrimitiveComponent Because of the multifarious ways the engine shoves data into the properties it is possible for the count to get out of sync.
Public function void

PostLoad ( int32 InNumInstances
)

  
Public function void  
Public function void  
Public function void

RemoveAt ( int32 InstanceIndex
)

  
Public function void

RemoveAtSwap ( int32 InstanceIndex
)

  
Public function void  
Public function void

SetMode ( EMode InMode
)

  
Public function void

TransformChanged ( int32 InstanceIndex
)

  
Public function void  
Public function void  
Public function Const void  
Public function void

WriteCookedRenderData ( FArchive& Ar,
FInstanceUpdateComponentDesc&& ComponentData,
TStridedView< FMatrix > InstanceTransforms
)

  

Enums

  Type Name Description
Public enum EMode    
Public enum ETrackingState Current tracking state,  

Typedefs

Name Description
EChangeFlag  
PrecomputedOptimizationDataPtr  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page