1. Epic GamesDeveloper
  3. UHierarchicalInstancedStaticMeshComponent

UHierarchicalInstancedStaticMeshComponent

Unreal Engine C++ API Reference > Runtime > Engine > Components

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Components/HierarchicalInstancedStaticMeshComponent.h
Include #include "Components/HierarchicalInstancedStaticMeshComponent.h"

Syntax

UCLASS (ClassGroup=Rendering, Meta=(BlueprintSpawnableComponent), MinimalAPI)  
class UHierarchicalInstancedStaticMeshComponent : public UInstancedStaticMeshComponent

Variables

  Type Name Description
Protected variable FBox AccumulatedNavigationDirtyArea  
Protected variable TArray< FBox > AccumulatedNavigationDirtyAreas  
Public variable bool: 1 bAutoRebuildTreeOnInstanceChanges  
Public variable bool: 1 bCanEnableDensityScaling In Editor mode we might disable the density scaling for edition
Public variable bool: 1 bConcurrentChanges  
Public variable UProperty uint32: 1 bEnableDensityScaling Enable for detail meshes that don't really affect the game.
Public variable bool: 1 bIsAsyncBuilding  
Public variable bool: 1 bIsOutOfDate  
Protected variable FGraphEventArray BuildTreeAsyncTasks  
Public variable UProperty FBox BuiltInstanceBounds Bounding box of any built instances (cached from the ClusterTree)
Public variable UProperty uint32: 1 bUseTranslatedInstanceSpace If true then we allow a translated space when building the cluster tree.
Public variable UProperty FBoxSphereBounds CacheMeshExtendedBounds The last mesh bounds that was cache.
Public variable TSharedPtr< TArray< FClusterNode >, ESPMode::ThreadSafe > ClusterTreePtr  
Public variable float CurrentDensityScaling Current value of density scaling applied to this component.
Protected variable friend FClusterBuilder  
Protected variable friend FInstancedLightMap2D  
Protected variable friend FInstancedShadowMap2D  
Protected variable friend FStaticLightingTextureMapping_InstancedStaticMesh  
Public variable UProperty int32 InstanceCountToRender Instances to render (including removed one until the build is complete)
Public variable UProperty int32 NumBuiltInstances The number of instances in the ClusterTree. Subsequent instances will always be rendered.
Public variable int32 NumBuiltRenderInstances Normally equal to NumBuiltInstances, but can be lower if density scaling is in effect.
Public variable UProperty int32 OcclusionLayerNumNodes The number of nodes in the occlusion layer.
Public variable UProperty TArray< int32 > SortedInstances Table for remapping instances from cluster tree to PerInstanceSMData order.
Public variable UProperty FVector TranslatedInstanceSpaceOrigin Origin of the translated space used when building the cluster tree.
Public variable UProperty FBox UnbuiltInstanceBounds Bounding box of any unbuilt instances.
Public variable UProperty TArray< FBox > UnbuiltInstanceBoundsList Bounds of each individual unbuilt instance, used for LOD calculation.
Protected variable EHISMViewRelevanceType ViewRelevanceType  

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Protected function float Average number of instances per leaf
Protected function void

ApplyBuildTree ( FClusterBuilder& Builder,
const bool bWasAsyncBuild
)

  
Public function void

ApplyBuildTreeAsync ( ENamedThreads::Type CurrentThread,
const FGraphEventRef& MyCompletionGraphEvent,
TSharedRef< FClusterBuilder, ESPMode::ThreadSafe > Builder,
double StartTime
)

 Apply the results of the async build.
Protected function void  
Protected function void  
Protected function void  
Public function bool

BuildTreeIfOutdated ( bool Async,
bool ForceUpdate
)

  
Protected function Const FVector  
Public function int32 Heuristic for the number of leaves in the tree
Protected function void  
Public function Const FVector  
Protected function Static FBox

GetClusterTreeBounds ( TArray< FClusterNode > const& InClusterTree,
const FVector& InOffset
)

  
Protected function Const void

GetInstanceTransforms ( TArray< FMatrix >& InstanceTransforms,
FVector const& Offset
)

  
Public function Const int32

GetOverlappingBoxCount ( const FBox& Box
)

 Get the number of instances that overlap a given box
Public function Const void

GetOverlappingBoxTransforms ( const FBox& Box,
TArray< FTransform >& OutTransforms
)

 Get the transforms of instances inside the provided box
Public function Const int32 Get the number of instances that overlap a given sphere
Public function Const void

GetTree ( TArray< FClusterNode >& OutClusterTree
)

  
Protected function int32

GetVertsForLOD ( int32 LODIndex
)

 Gets and approximate number of verts for each LOD to generate heuristics
Public function Const EHISMViewRelevanceType  
Protected function void  
Public function Const bool  
Public function Const bool  
Protected function void For testing, prints some stats after any kind of build
Protected function void

RemoveInstancesInternal ( TConstArrayView< int32 > InstanceIndices
)

 Removes specified instances
Protected function void  
Public function void Will apply current density scaling, if enabled

Overridden from UInstancedStaticMeshComponent

  Type Name Description
Public function Virtual int32

AddInstance ( const FTransform& InstanceTransform,
bool bWorldSpace
)

 Add an instance to this component.
Public function Virtual TArray< int32 >

AddInstances ( const TArray< FTransform >& InstanceTransforms,
bool bShouldReturnIndices,
bool bWorldSpace,
bool bUpdateNavigation
)

 Add multiple instances to this component.
Public function Virtual void Applies the cached component instance data to a newly blueprint constructed component.
Public function Virtual bool

BatchUpdateInstancesData ( int32 StartInstanceIndex,
int32 NumInstances,
FInstancedStaticMeshInstanceData* StartInstanceData,
bool bMarkRenderStateDirty,
bool bTeleport
)

  
Public function Virtual bool

BatchUpdateInstancesTransform ( int32 StartInstanceIndex,
int32 NumInstances,
const FTransform& NewInstancesTransform,
bool bWorldSpace,
bool bMarkRenderStateDirty,
bool bTeleport
)

 Update the transform for a number of instances.
Public function Virtual bool

BatchUpdateInstancesTransforms ( int32 StartInstanceIndex,
TArrayView< const FTransform > NewInstancesTransforms,
bool bWorldSpace,
bool bMarkRenderStateDirty,
bool bTeleport
)

 This is array view version of the UFUNCTION, blueprints do not support ArrayViews at the time of adding this one
Public function Virtual bool

BatchUpdateInstancesTransforms ( int32 StartInstanceIndex,
const TArray< FTransform >& NewInstancesTransforms,
bool bWorldSpace,
bool bMarkRenderStateDirty,
bool bTeleport
)

 Update the transform for an array of instances.
Protected function Virtual void  
Public function Virtual void Clear all instances being rendered by this component.
Public function Virtual Const TArray< int32 >

GetInstancesOverlappingBox ( const FBox& Box,
bool bBoxInWorldSpace
)

 Returns the instances with instance bounds overlapping the specified box.
Public function Virtual Const TArray< int32 >

GetInstancesOverlappingSphere ( const FVector& Center,
float Radius,
bool bSphereInWorldSpace
)

 Returns the instances with instance bounds overlapping the specified sphere.
Protected function Virtual Const void

GetNavigationPerInstanceTransforms ( const FBox& AreaBox,
TArray< FTransform >& InstanceData
)

 Handles request from navigation system to gather instance transforms in a specific area box.
Public function Virtual Const int32 Number of instances in the render-side instance buffer.
Protected function Virtual Const FVector Get the translated space for instance transforms to be passed to the renderer.
Protected function Virtual void Creates rendering buffer from serialized data, if any
Protected function Virtual void

PartialNavigationUpdate ( int32 InstanceIdx
)

 Request to navigation system to update only part of navmesh occupied by specified instance.
Public function Virtual void

PreAllocateInstancesMemory ( int32 AddedInstanceCount
)

 Preallocated memory to include the new added instances count, to prevent reallloc during the add operation.
Public function Virtual bool

RemoveInstance ( int32 InstanceIndex
)

 Remove the instance specified. Returns True on success.
Public function Virtual bool

RemoveInstances ( const TArray< int32 >& InstancesToRemove
)

 Remove the instances specified. Returns True on success.
Public function Virtual bool

RemoveInstances ( const TArray< int32 >& InstancesToRemove,
bool bInstanceArrayAlreadySortedInReverseOrder
)

 Remove the instances specified. Returns True on success.
Public function Virtual bool

SetCustomData ( int32 InstanceIndex,
TArrayView< const float > CustomDataFloats,
bool bMarkRenderStateDirty
)

 Per Instance Custom Data
Public function Virtual bool

SetCustomDataValue ( int32 InstanceIndex,
int32 CustomDataIndex,
float CustomDataValue,
bool bMarkRenderStateDirty
)

 Update custom data for specific instance
Protected function Virtual Const bool Does this component support partial navigation updates
Public function Virtual Const bool Returns true if RemoveAtSwap is enabled.
Public function Virtual bool

UpdateInstanceTransform ( int32 InstanceIndex,
const FTransform& NewInstanceTransform,
bool bWorldSpace,
bool bMarkRenderStateDirty,
bool bTeleport
)

 Update the transform for the instance specified.

Overridden from UStaticMeshComponent

  Type Name Description
Protected function Virtual FPrimitiveSceneProxy *

CreateStaticMeshSceneProxy ( Nanite::FMaterialAudit& NaniteMaterials,
bool bCreateNanite
)

 Overload this in child implementations that wish to extend Static Mesh or Nanite scene proxy implementations.
Public function Virtual void  

Overridden from UPrimitiveComponent

  Type Name Description
Public function Virtual FPrimitiveSceneProxy * Creates a proxy to represent the primitive to the scene manager in the rendering thread.

Overridden from USceneComponent

  Type Name Description
Public function Virtual Const FBoxSphereBounds

CalcBounds ( const FTransform& LocalToWorld
)

 Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size.
Public function Virtual void Updates any visuals after the lighting has changed

Overridden from UObject

  Type Name Description
Public function Virtual void

GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize
)

 Get the size of the object/resource for use in memory tools or to display to artists/LDs in the Editor This is the extended version which separates up the used memory into different memory regions (the actual definition of which may be platform specific).
Public function Virtual void This alternate version of PostEditChange is called when properties inside structs are modified.
Public function Virtual void Called after importing property values for this object (paste, duplicate or .t3d import) Allow the object to perform any cleanup for properties which shouldn't be duplicated or are unsupported by the script serialization
Public function Virtual void Called after applying a transaction to the object.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Classes

  Type Name Description
Public class FClusterBuilder    
Public struct FClusterTree    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page