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

UCLASS (BlueprintType, CustomConstructor, MinimalAPI)  
class UGeometryCollection :  
    public UObject ,  
    public IInterface_AssetUserData,  
    public IDataflowContentOwner

Remarks

UGeometryCollectionObject (UObject)

UObject wrapper for the FGeometryCollection

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere BlueprintReadWrite instanced TObjectPtr< class UAssetImportData > AssetImportData Importing data and options used for this geometry collection
Public variable UProperty Category, EditAnywhere TArray< FGeometryCollectionAutoInstanceMesh > AutoInstanceMeshes List of unique static mesh / materials pairs for auto instancing.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter bool bConvertVertexColorsToSRGB Convert vertex colors to sRGB for rendering.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite 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 UProperty Category, EditAnywhere, Meta bool bEnableNaniteFallback Enable Non-Nanite fallback mesh when Nanite support is enabled.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite 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 UProperty Category, EditAnywhere, Meta BlueprintReadWrite bool bMassAsDensity Mass As Density, units are in kg/m^3 ( only enabled if physics material is not set )
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bOptimizeConvexes Whether to optimize convexes for collisions.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly bool bRemoveOnMaxSleep Remove particle from simulation and dissolve rendered geometry once sleep threshold has been exceeded.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite 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 UProperty Category, EditAnywhere, Meta BlueprintReadOnly 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 UProperty Category, EditAnywhere, Meta BlueprintReadWrite bool bStripOnCook Strip unnecessary data from the Geometry Collection to keep the memory footprint as small as possible.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bStripRenderDataOnCook Strip unnecessary render data from the Geometry Collection to keep the memory footprint as small as possible.
Public variable UProperty Category, EditAnywhere bool bUseFullPrecisionUVs Whether to use full precision UVs when rendering this geometry.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite bool bUseMaterialDamageModifiers When on , use the modifiers on the material to adjust the user defined damage threshold values
Public variable UProperty Category, EditAnywhere, Meta bool bUseSizeSpecificDamageThreshold Whether to use size specific damage threshold instead of level based ones ( see Size Specific Data array ).
Public variable UProperty float CachedDensityFromPhysicsMaterialInGCm3 Cached Material density value used to compute the Mass attribute ( In gram per cm3 ) this is necessary because the material properties could be changed after without causing the mass attribute to be recomputed ( because the GC asset will not get notified )
Public variable UProperty Category, EditAnywhere EClusterConnectionTypeEnum ClusterConnectionType  
Public variable UProperty Category, EditAnywhere int32 ClusterGroupIndex Maximum level for cluster breaks.
Public variable UProperty Category, EditAnywhere float ConnectionGraphBoundsFilteringMargin  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite TObjectPtr< UClass > CustomRendererType Custom class type that will be used to render the geometry collection instead of using the native rendering.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite EDamageModelTypeEnum DamageModel Damage model to use for evaluating destruction.
Public variable UProperty Category, EditAnywhere FGeometryCollectionDamagePropagationData DamagePropagationData Data about how damage propagation shoudl behave.
Public variable UProperty Category, EditAnywhere, Meta TArray< float > DamageThreshold Damage threshold for clusters at different levels.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite TObjectPtr< UDataflow > DataflowAsset Dataflow
Public variable UProperty Category, EditAnywhere FString DataflowTerminal  
Public variable UProperty Category, EditAnywhere TArray< FGeometryCollectionEmbeddedExemplar > EmbeddedGeometryExemplar References for embedded geometry generation
Public variable UProperty Category, EditAnywhere bool EnableClustering  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter bool EnableNanite Enable support for Nanite.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite TArray< FGeometryCollectionSource > GeometrySource  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite float Mass Total Mass of Collection.
Public variable UProperty Category, EditAnywhere TArray< TObjectPtr< UMaterialInterface > > Materials  
Public variable UProperty Category, EditAnywhere int32 MaxClusterLevel Maximum level for cluster breaks.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly FVector2D MaximumSleepTime How long may the particle sleep before initiating removal (in seconds).
Public variable UProperty Category, EditAnywhere BlueprintReadOnly float MinimumMassClamp Smallest allowable mass (def:0.1)
Public variable UProperty Category, EditAnywhere BlueprintReadWrite displayname TMap< FString, FString > Overrides  
Public variable UProperty Category, EditAnywhere 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 UProperty Category, EditAnywhere BlueprintReadOnly TObjectPtr< UPhysicalMaterial > PhysicsMaterial Physics material to use for the geometry collection
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly 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 UProperty Category, EditAnywhere BlueprintReadWrite FGeometryCollectionProxyMeshData RootProxyData Static mesh to use as a proxy for rendering until the geometry collection is broken.
Public variable UProperty Category, EditAnywhere TArray< FGeometryCollectionSizeSpecificData > SizeSpecificData Size Specfic Data reflects the default geometry to bind to rigid bodies smaller than the max size volume.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly 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 UProperty Category, AdvancedDisplay instanced, visibleanywhere 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 Virtual void

AddAssetUserData ( UAssetUserData* InUserData
)

  
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

AttachEmbeddedGeometryExemplar ( const UStaticMesh* Exemplar
)

 Attach a Static Mesh exemplar for embedded geometry, if that mesh has not already been attached.
Public function void Cache the material density used to compute attribute Warning : this should only be called after recomputing the mass based on those values
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 Virtual Const const TArray< UAssetUserData * > *  
Public function Virtual UAssetUserData *

GetAssetUserDataOfClass ( TSubclassOf< UAssetUserData > InUserDataClass
)

  
Public function Const const FGeometryCollectionAutoInstanceMesh &

GetAutoInstanceMesh ( int32 AutoInstanceMeshIndex
)

 Find or add a auto instance mesh and return its index
Public function Const const TArray< int32 > &  
Public function Static UMaterialInterface * Get the material to use for rendering bone selections in the editor, or nullptr.
Public function Const const int32  
Public function Const const TArray< 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 ( this is the value used by to compute the cached attributes ) 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

GetSharedSimulationParams ( FSharedSimulationParameters& OutParams
)

 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

IsEmpty ()

 Return true if the collection is "Empty" ( has no transforms at all )
Public function Const bool Check to see if Simulation Data requires regeneration
Public function Const int32

NumElements ( const FName& Group
)

 NumElements
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 Virtual void

RemoveUserDataOfClass ( TSubclassOf< UAssetUserData > InUserDataClass
)

  
Public function void

Reset ()

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

ResetFrom ( const FManagedArrayCollection& InCollection,
const TArray< UMaterialInterface* >& InMaterialInstances,
bool bHasInternalMaterials
)

  
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 Assign an auto instanced meshes array if there's duplicate entry in the array , they will be collapsed as one and the index attribute will be adjusted acoordingly
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category 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  
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 Const bool

CanEditChange ( const FProperty* InProperty
)

 Called by the editor to query whether a property of this object is allowed to be modified.
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 applying a transaction to the object.
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

PreSave ( FObjectPreSaveContext SaveContext
)

 Presave function.
Public function Virtual void End UObject InterfaceSerialize

Overridden from IDataflowContentOwner

  Type Name Description
Public function Virtual TObjectPtr< UDataflowBaseContent > Interface to create a dataflow content instance from that owner
Public function Virtual void

ReadDataflowContent ( const TObjectPtr< UDataflowBaseContent >& DataflowContent
)

 Interface to update a dataflow content instance from that owner
Public function Virtual Const void

WriteDataflowContent ( const TObjectPtr< UDataflowBaseContent >& DataflowContent
)

 Interface to update a dataflow content instance from that owner

Deprecated Variables

  Type Name Description
Public variable UProperty Meta float CollisionObjectReductionPercentage_DEPRECATED Resolution on the smallest axes for the level set. (def: 10)
Public variable UProperty Meta float CollisionParticlesFraction_DEPRECATED Number of particles on the triangulated surface to use for collisions.
Public variable UProperty Meta ECollisionTypeEnum CollisionType_DEPRECATED CollisionType defines how to initialize the rigid collision structures.
Public variable UProperty Meta bool EnableRemovePiecesOnFracture_DEPRECATED Enable remove pieces on fracture
Public variable UProperty Meta EImplicitTypeEnum ImplicitType_DEPRECATED CollisionType defines how to initialize the rigid collision structures.
Public variable UProperty Meta int32 MaxClusterLevelSetResolution_DEPRECATED Resolution on the smallest axes for the level set. (def: 10)
Public variable UProperty Meta int32 MaximumCollisionParticles_DEPRECATED Max number of particles.
Public variable UProperty Meta int32 MaxLevelSetResolution_DEPRECATED Resolution on the smallest axes for the level set. (def: 10)
Public variable UProperty Meta int32 MinClusterLevelSetResolution_DEPRECATED Resolution on the smallest axes for the level set. (def: 5)
Public variable UProperty Meta int32 MinLevelSetResolution_DEPRECATED Resolution on the smallest axes for the level set. (def: 5)
Public variable UProperty Meta TArray< TObjectPtr< UMaterialInterface > > RemoveOnFractureMaterials_DEPRECATED Materials relating to remove on fracture
Public variable UProperty Meta 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