1. Epic GamesDeveloper
  3. FISMCInstanceDataSceneProxy

FISMCInstanceDataSceneProxy

Proxy class that represents scene instance data to the renderer.

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

Inheritance Hierarchy

References

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

Syntax

class FISMCInstanceDataSceneProxy : public FInstanceDataSceneProxy

Remarks

Proxy class that represents scene instance data to the renderer. Responsible for preparing data for render use per-platform & serializing such data for cooked builds. Supplies a persistent ID mapping for use in FScene. The ID mapping is reset when the proxy is recreated. Thus the FScene will generate full remove/add handling for proxy recreate events. Not responsible for storing the component representation of the instance data.

TODO: Add concept of async update and needing to sync the proxy before use. Probably split between immutable data (e.g, flags and stuff that don't depend on a data conversion process) and the bulk of the data. The immutable part is always valid & up to date on the RT (set in command, or before it is added).

Variables

  Type Name Description
Protected variable bool bBuildOptimized This should be set when constructing for a static primitive that wants pre-built instances.
Protected variable bool bIsNew True when it has never been updated before.
Protected variable bool bUseLegacyRenderingPath  
Protected variable ERHIFeatureLevel::Type FeatureLevel  
Protected variable TPimplPtr< FOpaqueHitProxyContainer > HitProxyContainer Container for hitproxies that are used by the instances, uses the FDeferredCleanupInterface machinery to delete itself back on the game thread when replaced.
Protected variable FInstanceDataUpdateTaskInfo InstanceDataUpdateTaskInfo  
Protected variable FInstanceIdIndexMap InstanceIdIndexMap  
Protected variable FISMPrecomputedSpatialHashDataPtr PrecomputedOptimizationData  
Protected variable FStaticShaderPlatform ShaderPlatform  
Protected variable TBitArray ValidInstanceIdMask Id allocation tracking.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Protected function void

ApplyAttributeChanges ( FISMInstanceUpdateChangeSet& ChangeSet,
const IndexRemapType& IndexRemap,
FInstanceSceneDataBuffers::FWriteView& ProxyData
)

  
Protected function void

ApplyDataChanges ( FISMInstanceUpdateChangeSet& ChangeSet,
const IndexRemapType& IndexRemap,
int32 PostUpdateNumInstances,
FInstanceSceneDataBuffers::FWriteView& ProxyData
)

  
Public function Virtual void  
Public function Virtual void

BuildFromLegacyData ( TUniquePtr< FStaticMeshInstanceData >&& ExternalLegacyData,
const FRenderBounds& InstanceLocalBounds,
TArray< int32 >&& InLegacyInstanceReorderTable
)

  
Protected function void Build an optimized instance buffer, where the order is sorted such that instances with the same spatial hash are consecutive.
Public function bool Make sure the shader platform & feature levels match.
Public function Const const FInstanceSceneDataBuffers &

GetData ()

  
Public function Static FVector3f

GetLocalBoundsPadExtent ( const FRenderTransform& LocalToWorld,
float PadAmount
)

  
Protected function void

TestAndApplyInstanceBufferSizeFixup ( int32 PostUpdateNumInstances
)

  
Public function Virtual void Overridable functions to update / build proxy data from a change set.
Protected function void

UpdateIdMapping ( FISMInstanceUpdateChangeSet& ChangeSet,
const IndexRemapType& IndexRemap
)

 Update the InstanceIdIndexMap given the change set.
Public function Virtual void Handle only updating the primitive transform, could make use of special cases such as translation only if implemented properly.

Overridden from FInstanceDataSceneProxy

  Type Name Description
Public function Virtual void  
Public function Virtual FInstanceDataUpdateTaskInfo * Implement to provide syncable task info, if this returns a nullptr it is required that GeInstanceSceneDataBuffers() performs any needed synchronization.

Typedefs

Name Description
FISMPrecomputedSpatialHashDataPtr  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page