1. Epic GamesDeveloper
  3. UGeometryCollection

UGeometryCollection

UGeometryCollectionObject ([UObject](API\Runtime\CoreUObject\UObject\UObject))

API > API/Runtime > API/Runtime/GeometryCollectionEngine > API/Runtime/GeometryCollectionEngine/GeometryCollection

Inheritance Hierarchy

References

   
Module GeometryCollectionEngine
Header /Engine/Source/Runtime/Experimental/GeometryCollectionEngine/Public/GeometryCollection/GeometryCollectionObject.h
Include #include "GeometryCollection/GeometryCollectionObject.h"

Syntax

class UGeometryCollection :  
    public UObject,  
    public IInterface_AssetUserData

Remarks

UGeometryCollectionObject (UObject)

UObject wrapper for the FGeometryCollection

Variables

  Type Name Description
Public variable TObjectPtr< class UAssetImportData > AssetImportData Importing data and options used for this geometry collection
Public variable TArray< FGeometryCollectionAutoInstanceMesh > AutoInstanceMeshes List of unique static mesh / materials pairs for auto instancing.
Public variable bool bConvertVertexColorsToSRGB Convert vertex colors to sRGB for rendering.
Public variable bool bDensityFromPhysicsMaterial Whether to use density ( for mass computation ) from physics material ( if physics material is not set, use the component one or defaults )
Public variable bool bImportCollisionFromSource Whether to import collision from the source asset
Public variable bool bManualDataCreate If this flag is set, we only regenerate simulation data when requested via CreateSimulationData()
Public variable bool bMassAsDensity Mass As Density, units are in kg/m^3 ( only enabled if physics material is not set )
Public variable bool bRemoveOnMaxSleep Remove particle from simulation and dissolve rendered geometry once sleep threshold has been exceeded.
Public variable bool bScaleOnRemoval When enabled, particle will scale down (shrink) when using being removed ( using both remove on sleep or remove on break ) - Enabled by default
Public variable bool bSlowMovingAsSleeping When on non-sleeping, slow moving pieces will be considered as sleeping, this helps removal of jittery but not really moving objects.
Public variable bool bStripOnCook Strip unnecessary data from the Geometry Collection to keep the memory footprint as small as possible.
Public variable bool bStripRenderDataOnCook Strip unnecessary render data from the Geometry Collection to keep the memory footprint as small as possible.
Public variable bool bUseFullPrecisionUVs Whether to use full precision UVs when rendering this geometry.
Public variable bool bUseSizeSpecificDamageThreshold Whether to use size specific damage threshold instead of level based ones ( see Size Specific Data array ).
Public variable EClusterConnectionTypeEnum ClusterConnectionType  
Public variable int32 ClusterGroupIndex Maximum level for cluster breaks.
Public variable float ConnectionGraphBoundsFilteringMargin  
Public variable TObjectPtr< UClass > CustomRendererType Custom class type that will be used to render the geometry collection instead of using the native rendering.
Public variable EDamageModelTypeEnum DamageModel Damage model to use for evaluating destruction.
Public variable FGeometryCollectionDamagePropagationData DamagePropagationData Data about how damage propagation shoudl behave.
Public variable TArray< float > DamageThreshold Damage threshold for clusters at different levels.
Public variable TObjectPtr< UDataflow > DataflowAsset Dataflow
Public variable FString DataflowTerminal  
Public variable TArray< FGeometryCollectionEmbeddedExemplar > EmbeddedGeometryExemplar References for embedded geometry generation
Public variable bool EnableClustering  
Public variable bool EnableNanite Enable support for Nanite.
Public variable TArray< FGeometryCollectionSource > GeometrySource  
Public variable float Mass Total Mass of Collection.
Public variable TArray< TObjectPtr< UMaterialInterface > > Materials  
Public variable int32 MaxClusterLevel Maximum level for cluster breaks.
Public variable FVector2D MaximumSleepTime How long may the particle sleep before initiating removal (in seconds).
Public variable float MinimumMassClamp Smallest allowable mass (def:0.1)
Public variable TMap< FString, FString > Overrides  
Public variable bool PerClusterOnlyDamageThreshold Compatibility check, when true, only cluster compute damage from parameters and propagate to direct children when false, each child will compute it's damage threshold allowing for more precise and intuitive destruction behavior
Public variable TObjectPtr< UPhysicalMaterial > PhysicsMaterial Physics material to use for the geometry collection
Public variable FVector2D RemovalDuration How long does the removal process take (in seconds).
Public variable TUniquePtr< FGeometryCollectionRenderData > RenderData Pointer to the data used to render this geometry collection.
Public variable FGeometryCollectionProxyMeshData RootProxyData Static mesh to use as a proxy for rendering until the geometry collection is broken.
Public variable TArray< FGeometryCollectionSizeSpecificData > SizeSpecificData Size Specfic Data reflects the default geometry to bind to rigid bodies smaller than the max size volume.
Public variable float SlowMovingVelocityThreshold When slow moving detection is on, this defines the linear velocity thresholds in cm/s to consider the object as sleeping .
Public variable TObjectPtr< class UThumbnailInfo > ThumbnailInfo Information for thumbnail rendering

Constructors

  Type Name Description
Public function  

UGeometryCollection ( const FObjectInitializer& ObjectInitializer
)

  
Public function  

UGeometryCollection ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function int32

AddNewMaterialSlot ( bool bCopyLastMaterial
)

 Add a material to the materials array and update the selected bone material to be at the end of the array
Public function int32

AppendGeometry ( const UGeometryCollection& Element,
bool ReindexAllMaterials,
const FTransform& TransformRoot
)

 AppendGeometry
Public function int32 Attach a Static Mesh exemplar for embedded geometry, if that mesh has not already been attached.
Public function Static TSharedPtr< FGeometryCollection, ESPMode::ThreadSafe >

CopyCollectionAndRemoveGeometry ( const TSharedPtr< const FGeometryCollection, ESPMode::ThreadSafe >& CollectionToCopy
)

 Copy a collection and remove geometry from it
Public function void Create the simulation data that can be shared among all instances (mass, volume, etc...) Note : this does not check if the simulation data is drty or not and will cause a load from the DDC use CreateSimulationDataIfNeeded() for avoiding extra runtime cost
Public function void Create the simulation data ( calls CreateSimulationData) only if the simulation data is dirty
Public function void

EnsureDataIsCooked ( bool bInitResources,
bool bIsTransacting,
bool bIsPersistant,
bool bAllowCopyFromDDC
)

  
Public function int32

FindOrAddAutoInstanceMesh ( const UStaticMesh* StaticMesh,
const TArray< UMaterialInterface* >& Materials
)

 Find or add a auto instance mesh from a mesh and alist of material and return its index
Public function int32 Find or add a auto instance mesh from another one and return its index
Public function Const TSharedPtr< FGeometryCollection, ESPMode::ThreadSafe > Produce a deep copy of GeometryCollection member, stripped of data unecessary for gameplay.
Public function Static FGeometryCollectionSizeSpecificData  
Public function Const const FGeometryCollectionAutoInstanceMesh &

GetAutoInstanceMesh ( int32 AutoInstanceMeshIndex
)

 Find or add a auto instance mesh and return its index
Public function Const UMaterialInterface *  
Public function Const const int32  
Public function FGeometryCollectionSizeSpecificData & Size Specific Data Access
Public function Const const FGeometryCollectionSizeSpecificData &  
Public function Const int  
Public function TSharedPtr< FGeometryCollection, ESPMode::ThreadSafe >  
Public function Const const TSharedPtr< FGeometryCollection, ESPMode::ThreadSafe >  
Public function Const FGuid Accessors for the two guids used to identify this collection
Public function Const float

GetMassOrDensity ( bool& bOutIsDensity
)

 Get Mass or density as set by the asset Mass is return in Kg and Density is returned in Kg/Cm3
Public function Const uint32  
Public function Const uint32

GetNaniteHierarchyOffset ( int32 GeometryIndex,
bool bFlattened
)

  
Public function Const uint32  
Public function Const FGeometryCollectionRenderResourceSizeInfo Get the size of the render data resources associated with this collection
Public function Const int32 Get the cached root index
Public function Static const TCHAR * Returns the asset path for the automatically populated selected material.
Public function Const void Fills params struct with parameters used for precomputing content.
Public function Const FGuid  
Public function Const bool Has data for static mesh rendering.
Public function Const bool Has data for nanite rendering.
Public function Const bool Returns true if there is anything to render
Public function void

InitializeMaterials ( bool bHasLegacyInternalMaterialsPairs
)

 Appends the standard materials to this UObject
Public function void  
Public function void Invalidates this collection signaling a structural change and renders any previously recorded caches unable to play with this collection
Public function Const bool Check to see if Simulation Data requires regeneration
Public function Const int32

NumElements ( const FName& Group
)

 NumElements
Public function void

PostSerialize ( const FArchive& Ar
)

 End UObject InterfaceSerialize
Public function Const void Propogate render state dirty to components
Public function Const void Propogate the fact that transform have been updated to all components
Public function void Rebuild the render data.
Public function void ReindexMaterialSections
Public function void  
Public function void

RemoveElements ( const FName& Group,
const TArray< int32 >& SortedDeletionList
)

 RemoveElements
Public function void

RemoveExemplars ( const TArray< int32 >& SortedRemovalIndices
)

 Remove embedded geometry exemplars with indices matching the sorted removal list.
Public function bool Remove a material from the materials array, keeping the selected bone material at the end of the array.
Public function void

Reset ()

 Return collection to initial (ie. empty) state.
Public function void

ResetFrom ( const FManagedArrayCollection& InCollection,
const TArray< UMaterial* >& InMaterials,
bool bHasInternalMaterials
)

 Reset the collection from another set of attributes and materials.
Public function void  
Public function void

SetEnableNanite ( bool bValue
)

  
Public function void

SetGeometryCollection ( TSharedPtr< FGeometryCollection, ESPMode::ThreadSafe > GeometryCollectionIn
)

 Accessors for internal geometry collection
Public function void Update the convex geometry on the collection.
Public function void Update the convex geometry on the collection.
Public function void Update properties that depend on the geometry and clustering: Proximity, Convex Hulls, Volume and Size data.

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual bool

Modify ( bool bAlwaysMarkDirty
)

 Note that the object will be modified.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 UObject Interface
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void End UObject InterfaceSerialize

Overridden from IInterface_AssetUserData

  Type Name Description
Public function Virtual void  
Public function Virtual Const const TArray< UAssetUserData * > *  
Public function Virtual UAssetUserData *  
Public function Virtual void  

Deprecated Variables

  Type Name Description
Public variable float CollisionObjectReductionPercentage_DEPRECATED Resolution on the smallest axes for the level set. (def: 10)
Public variable float CollisionParticlesFraction_DEPRECATED Number of particles on the triangulated surface to use for collisions.
Public variable ECollisionTypeEnum CollisionType_DEPRECATED CollisionType defines how to initialize the rigid collision structures.
Public variable bool EnableRemovePiecesOnFracture_DEPRECATED Enable remove pieces on fracture
Public variable EImplicitTypeEnum ImplicitType_DEPRECATED CollisionType defines how to initialize the rigid collision structures.
Public variable int32 MaxClusterLevelSetResolution_DEPRECATED Resolution on the smallest axes for the level set. (def: 10)
Public variable int32 MaximumCollisionParticles_DEPRECATED Max number of particles.
Public variable int32 MaxLevelSetResolution_DEPRECATED Resolution on the smallest axes for the level set. (def: 10)
Public variable int32 MinClusterLevelSetResolution_DEPRECATED Resolution on the smallest axes for the level set. (def: 5)
Public variable int32 MinLevelSetResolution_DEPRECATED Resolution on the smallest axes for the level set. (def: 5)
Public variable TArray< TObjectPtr< UMaterialInterface > > RemoveOnFractureMaterials_DEPRECATED Materials relating to remove on fracture
Public variable FSoftObjectPath RootProxy_DEPRECATED Static mesh to use as a proxy for rendering until the geometry collection is broken

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page