1. Epic GamesDeveloper
  3. UGeometryCollectionComponent

UGeometryCollectionComponent

GeometryCollectionComponent

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

Inheritance Hierarchy

References

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

Syntax

UCLASS (Meta=(BlueprintSpawnableComponent), MinimalAPI)  
class UGeometryCollectionComponent :  
    public UMeshComponent,  
    public IChaosNotifyHandlerInterface

Remarks

GeometryCollectionComponent

Variables

  Type Name Description
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter FName AbandonedCollisionProfileName Whether abandoned particles on the client should continue to have collision (i.e. still be in the external/internal acceleration structure).
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bAllowRemovalOnBreak Allow removal on break for the instance if the rest collection has it enabled
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bAllowRemovalOnSleep Allow removal on sleep for the instance if the rest collection has it enabled
Protected variable bool bAlreadyFullyDecayed  
Public variable int32 BaseRigidBodyIndex  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly bool bCrumblingEventIncludesChildren If this and bNotifyCrumblings are true, the crumbling events will contain released children indices.
Protected variable uint8: 1 bCustomRendererCanUseNativeFallback Custom renderer flag to specify if custom renderer can ever require native fallback.
Protected variable uint8: 1 bCustomRendererShouldUseNativeFallback Custom renderer flag to specify if custom renderer should use native fallback.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter bool bDensityFromPhysicsMaterial When true, density will be used to compute mass using the assigned physics material
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite bool bEnableAbandonAfterLevel Enables use of ReplicationAbandonAfterLevel to stop providing network updates to clients when the updated particle is of a level higher then specified.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter bool bEnableDamageFromCollision Whether or not collisions against this geometry collection will apply strain which could cause the geometry collection to fracture.
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite bool bEnableReplication Per-instance override to enable/disable replication for the geometry collection
Protected variable UProperty Category, EditAnywhere bool bEnableRunTimeDataCollection  
Protected variable uint8: 1 bForceBrokenForCustomRenderer Force the broken state for custom renderer rendering.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bForceMotionBlur If ForceMotionBlur is on, motion blur will always be active, even if the GeometryCollection is at rest.
Protected variable uint8: 1 bForceNativeRenderer Force native geometry collection rendering. This is used in the editor fracture mode.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bForceUpdateActiveTransforms Update transforms of active particles even when they are not moving.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly bool bGlobalCrumblingEventIncludesChildren If this and bNotifyGlobalCrumblings are true, the crumbling events will contain released children indices.
Public variable UProperty Transient bool bIsCurrentlyNavigationRelevant  
Public variable UProperty Category, EditAnywhere BlueprintReadOnly bool bNotifyBreaks If true, this component will generate breaking events that other systems may subscribe to.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly bool bNotifyCollisions If true, this component will generate collision events that other systems may subscribe to.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly bool bNotifyCrumblings If true, this component will generate crumbling events that other systems may subscribe to.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly bool bNotifyGlobalBreaks If true, this component will generate breaking events that will be listened by the global event relay.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly bool bNotifyGlobalCollisions If true, this component will generate collision events that will be listened by the global event relay.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly bool bNotifyGlobalCrumblings If true, this component will generate crumbling events that will be listened by the global event relay.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly bool bNotifyGlobalRemovals If true, this component will generate removal events that will be listened by the global event relay.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly bool bNotifyRemovals If true, this component will generate removal events that other systems may subscribe to.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly bool bNotifyTrailing If true, this component will generate trailing events that other systems may subscribe to.
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite bool bOverrideCustomRenderer If true, CustomRendererType will be used.
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite bool bShowBoneColors Display Bone Colors instead of assigned materials
Public variable UProperty Category, EditAnywhere BlueprintReadOnly bool bStoreVelocities If true, this component will save linear and angular velocities on its DynamicCollection.
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite bool bUpdateComponentTransformToRootBone Relocate the component so that the original offset to the root bone is maintained This only works when the root bone is moving whole being dynamically simulated Note: Once the root element is broken, the component will no longer update its position
Protected variable uint8: 1 bUpdateCustomRendererOnPostPhysicsSync Whether to refresh the custom renderer on physics updates.
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite Config bool bUpdateNavigationInTick  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite blueprintsetter bool bUseMaterialDamageModifiers When on , use the modifiers on the material to adjust the user defined damage threshold values
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite Config bool bUseRootProxyForNavigation  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite bool bUseSizeSpecificDamageThreshold Damage threshold for clusters at different levels.
Protected variable UProperty Category, EditAnywhere blueprintgetter, blueprintsetter bool bUseStaticMeshCollisionForTraces Todo(chaos): Remove the ability to change this at runtime, as we'll want to use this at cook time instead
Public variable UProperty FGeomComponentCacheParameters CacheParameters  
Public variable UProperty Category BlueprintReadWrite Transient visibleanywhere bool CachePlayback  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite blueprintgetter, blueprintsetter TObjectPtr< AChaosSolverActor > ChaosSolverActor Chaos RBD Solver override. Will use the world's default solver actor if null.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite int32 ClusterGroupIndex Maximum level for cluster breaks.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite int32 CollisionGroup  
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter TArray< FName > CollisionProfilePerLevel A per-level collision profile name.
Protected variable TArray< FName > CollisionProfilePerParticle A per-particle collision profile name.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite float CollisionSampleFraction Fraction of collision sample particles to keep
Protected variable UProperty skipserialization TScriptInterface< IGeometryCollectionExternalRenderInterface > CustomRenderer A custom renderer object created from CustomRenderType.
Protected 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 blueprintsetter EDamageModelTypeEnum DamageModel Damage model to use for evaluating destruction.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter FGeometryCollectionDamagePropagationData DamagePropagationData Data about how damage propagation shoudl behave.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite blueprintgetter, blueprintsetter TArray< float > DamageThreshold  
Public variable UProperty Category, Interp BlueprintReadWrite Transient visibleanywhere float DesiredCacheTime  
Public variable TArray< bool > DisabledFlags Mirrored from the proxy on a sync TManagedArray RigidBodyIds;
Protected variable int32 DynamicRepDataVersionProcessed  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool EnableClustering  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter int32 GravityGroupIndex  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FVector InitialAngularVelocity  
Public variable UProperty Category, EditAnywhere BlueprintReadOnly noclear TArray< TObjectPtr< const AFieldSystemActor > > InitializationFields  
Public variable ESimulationInitializationState InitializationState  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FVector InitialLinearVelocity  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite EInitialVelocityTypeEnum InitialVelocityType  
Protected variable int64 LastAsyncPhysicsTickMs The last time (in milliseconds) the async physics component tick fired.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite int32 MaxClusterLevel Maximum level for cluster breaks.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite int32 MaxSimulatedLevel The maximum level to create rigid bodies that could be simulated.
Public variable UProperty Category BlueprintAssignable FNotifyGeometryCollectionPhysicsLoadingStateChange NotifyGeometryCollectionPhysicsLoadingStateChange  
Public variable UProperty Category BlueprintAssignable FNotifyGeometryCollectionPhysicsStateChange NotifyGeometryCollectionPhysicsStateChange  
Public variable int32 NumParticlesAdded  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite EObjectStateTypeEnum ObjectType ObjectType defines how to initialize the rigid objects state, Kinematic, Sleeping, Dynamic.
Public variable UProperty Category BlueprintAssignable FOnChaosBreakEvent OnChaosBreakEvent  
Public variable UProperty Category BlueprintAssignable FOnChaosCrumblingEvent OnChaosCrumblingEvent  
Public variable UProperty Category BlueprintAssignable FOnChaosPhysicsCollision OnChaosPhysicsCollision  
Public variable UProperty Category BlueprintAssignable FOnChaosRemovalEvent OnChaosRemovalEvent  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter int32 OneWayInteractionLevel All bodies with a level greater than or equal to this will have One-Way Interaction enabled and act like debris (will not apply forces to non-debris bodies) Set to -1 to disable (no bodies will have One-Way Interaction enabled)
Public variable FOnGeometryCollectionFullyDecayedEvent OnFullyDecayedEvent  
Public variable FOnGeometryCollectionPropertyChangedMulticaster OnGeometryCollectionPropertyChanged  
Public variable FOnChaosBreakEvent OnRootBreakEvent Todo(chaos) remove when no longer necessary
Public variable FOnGeometryCollectionRootMovedEvent OnRootMovedEvent  
Public variable FOnGeometryCollectionRootMovedNativeEvent OnRootMovedNativeEvent  
Protected variable UProperty replicatedusing FGeometryCollectionRepData RepData  
Protected variable UProperty replicatedusing FGeometryCollectionRepDynamicData RepDynamicData  
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite int32 ReplicationAbandonAfterLevel If replicating - the cluster level after which replication will not happen
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite int32 ReplicationMaxPositionAndVelocityCorrectionLevel If replicating - the maximum level where clusters will have their position and velocity send over to the client for tracking and correcting When breaking, client will only receive the initial break velocity This helps save bandwidth where only the destruction state of the GC is to be replicated but the falling pieces do not need to be tracked precisely
Protected variable UProperty replicatedusing FGeometryCollectionRepStateData RepStateData  
Public variable UProperty Category, EditAnywhere BlueprintReadOnly noclear TObjectPtr< const UGeometryCollection > RestCollection  
Public variable UProperty TArray< FTransform > RestTransforms Optional transforms to initialize scene proxy if difference from the RestCollection.
Protected variable UProperty Category BlueprintReadOnly FGuid RunTimeDataCollectionGuid  
Protected variable int32 VersionProcessed  

Constructors

  Type Name Description
Public function  

UGeometryCollectionComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual void

AddForce ( FVector Force,
FName BoneName,
bool bAccelChange
)

  
Public function Virtual void

AddForceAtLocation ( FVector Force,
FVector WorldLocation,
FName BoneName
)

  
Public function Virtual void

AddImpulse ( FVector Impulse,
FName BoneName,
bool bVelChange
)

  
Public function Virtual void

AddImpulseAtLocation ( FVector Impulse,
FVector WorldLocation,
FName BoneName
)

  
Public function Virtual void

AddRadialForce ( FVector Origin,
float Radius,
float Strength,
ERadialImpulseFalloff Falloff,
bool bAccelChange
)

  
Public function Virtual void

AddRadialImpulse ( FVector Origin,
float Radius,
float Strength,
enum ERadialImpulseFalloff Falloff,
bool bVelChange
)

  
Public function Virtual void

AddTorqueInRadians ( FVector Torque,
FName BoneName,
bool bAccelChange
)

  
Public function UFunction BlueprintCallable, Category void

ApplyAngularVelocity ( int32 ItemIndex,
const FVector& AngularVelocity
)

 Apply angular velocity on specific piece
Public function UFunction BlueprintCallable, Category, Meta callineditor void Apply default values from asset ( damage related data and physics material )
Public function UFunction BlueprintCallable, Category void

ApplyBreakingAngularVelocity ( int32 ItemIndex,
const FVector& AngularVelocity
)

 Apply linear velocity on breaking pieces for a specific cluster If ItemIndex does not represent a cluster this will do nothing
Public function UFunction BlueprintCallable, Category void

ApplyBreakingLinearVelocity ( int32 ItemIndex,
const FVector& LinearVelocity
)

 Apply linear velocity on breaking pieces for a specific cluster If ItemIndex does not represent a cluster this will do nothing
Public function UFunction BlueprintCallable, Category void

ApplyExternalStrain ( int32 ItemIndex,
const FVector& Location,
float Radius,
int32 PropagationDepth,
float PropagationFactor,
float Strain
)

 Apply an external strain to specific piece of the geometry collection
Public function UFunction BlueprintCallable, Category void

ApplyInternalStrain ( int32 ItemIndex,
const FVector& Location,
float Radius,
int32 PropagationDepth,
float PropagationFactor,
float Strain
)

 Apply an internal strain to specific piece of the geometry collection
Public function UFunction BlueprintCallable, Category displayname void

ApplyKinematicField ( UPARAM(DisplayName="Field Radius") float Radius,
UPARAM(DisplayName="Center Position") FVector Position
)

 SetDynamicState This function will dispatch a command to the physics thread to apply a kinematic to dynamic state change for the geo collection particles within the field.
Public function UFunction BlueprintCallable, Category void

ApplyLinearVelocity ( int32 ItemIndex,
const FVector& LinearVelocity
)

 Apply linear velocity on specific piece
Public function UFunction BlueprintCallable, Category displayname void

ApplyPhysicsField ( UPARAM(DisplayName="Enable Field") bool Enabled,
UPARAM(DisplayName="Physics Type") EGeometryCollectionPhysicsTypeEnum Target,
UPARAM(DisplayName="Meta Data") UFieldSystemMetaData* MetaData,
UPARAM(DisplayName="Field Node") UFieldNodeBase* Field
)

 AddPhysicsField This function will dispatch a command to the physics thread to apply a generic evaluation of a user defined transient field network.
Public function Virtual void

AsyncPhysicsTickComponent ( float DeltaTime,
float SimTime
)

  
Public function Virtual void  
Public function Virtual Const FBoxSphereBounds

CalcBounds ( const FTransform& LocalToWorld
)

  
Public function Virtual Const FBoxSphereBounds  
Protected function void  
Public function Virtual float

CalculateMass ( FName BoneName
)

 Returns the calculated mass in kg.
Protected function Virtual Const bool  
Public function Virtual bool  
Protected function void  
Public function void Clear all the root proxies local transforms - all proxies will now have the same default transform
Protected function Virtual void

CollectPSOPrecacheData ( const FPSOPrecacheParams& BasePrecachePSOParams,
FMaterialInterfacePSOPrecacheParamsList& OutParams
)

 Collect all the PSO precache data used by the geometry collection
Protected function Const FBox

ComputeBounds ( const FTransform& LocalToWorldWithScale
)

  
Protected function Const FBox

ComputeBounds ( const FMatrix& LocalToWorldWithScale
)

  
Protected function Const FBox

ComputeBoundsFromComponentSpaceTransforms ( const FTransform& LocalToWorldWithScale,
const TArray< FTransform3f >& ComponentSpaceTransformsArray
)

  
Protected function Const FBox

ComputeBoundsFromComponentSpaceTransforms ( const FTransform& LocalToWorldWithScale,
const TArray< FTransform >& ComponentSpaceTransformsArray
)

  
Protected function Const FBox

ComputeBoundsFromGlobalMatrices ( const FMatrix& LocalToWorldWithScale,
const TArray< FMatrix >& GlobalMatricesArray
)

  
Public function Virtual void

CreateRenderState_Concurrent ( FRegisterComponentContext* Context
)

  
Public function Virtual FPrimitiveSceneProxy *  
Public function UFunction BlueprintCallable, Category void Crumbe active clusters for this entire geometry collection this will apply to internal and regular clusters
Public function UFunction BlueprintCallable, Category void

CrumbleCluster ( int32 ItemIndex
)

 Crumbe a cluster into all its pieces
Public function void

DispatchBreakEvent ( const FChaosBreakEvent& Event
)

  
Public function void

DispatchCrumblingEvent ( const FChaosCrumblingEvent& Event
)

  
Protected function void

DispatchFieldCommand ( const FFieldSystemCommand& InCommand
)

 Issue a field command for the physics thread
Public function void

DispatchRemovalEvent ( const FChaosRemovalEvent& Event
)

  
Public function Const bool

DoCustomNavigableGeometryExport ( FNavigableGeometryExport& GeomExport
)

  
Public function Virtual Const bool

DoesSocketExist ( FName InSocketName
)

  
Public function FScopedColorEdit

EditBoneSelection ( bool bForceUpdate
)

  
Public function FGeometryCollectionEdit

EditRestCollection ( GeometryCollection::EEditUpdate EditUpdate,
bool bShapeIsUnchanged
)

  
Public function Const int32

EmbeddedIndexToTransformIndex ( const UInstancedStaticMeshComponent* ISMComponent,
int32 InstanceIndex
)

  
Public function UFunction BlueprintCallable, Category, Meta void  
Public function void

EnableTransformSelectionMode ( bool bEnable
)

 Enable/disable the scene proxy per transform selection mode.
Public function Virtual void

EndPlay ( const EEndPlayReason::Type ReasonEnd
)

  
Public function UFunction BlueprintCallable, Category void

ForceBrokenForCustomRenderer ( bool bForceBroken
)

 Force any custom renderer to render using the broken/decayed path. This can be set at runtime
Public function void

ForceNativeRendering ( bool bForce
)

  
Public function Virtual Const TArray< Chaos::FPhysicsObject * >  
Public function Virtual Const FBodyInstance *

GetBodyInstance ( FName BoneName,
bool bGetWelded,
int32 Index
)

  
Public function Const void

GetBoneColors ( TArray< FColor >& OutColors
)

  
Public function Const const int  
Public function TArray< FTransform >  
Public function const TArray< FTransform3f > &  
Public function IGeometryCollectionExternalRenderInterface * Get any custom renderer. Returns nullptr if none is set.
Public function Const UFunction BlueprintPure blueprintinternaluseonly TArray< float >  
Public function UFunction BlueprintCallable, Category FString RestCollection
Public function Const const TArray< bool > &  
Public function FGeometryDynamicCollection *  
Public function Const const FGeometryDynamicCollection *  
Public function Const bool  
Public function TArray< FMatrix > Used by Niagara DI to query global matrices rather than recalculating them again
Public function Const void

GetHiddenTransforms ( TArray< bool >& OutHiddenTransforms
)

  
Public function Const const TArray< int32 > &  
Public function Virtual Const TArray< UActorComponent * >  
Public function Virtual Const Chaos::FPhysicsObjectId

GetIdFromGTParticle ( Chaos::FGeometryParticle* Particle
)

  
Protected function void

GetInitializationCommands ( TArray< FFieldSystemCommand >& CombinedCommmands
)

 Combine the commands from the input field assets
Public function UFunction BlueprintCallable, Category int32

GetInitialLevel ( int32 ItemIndex
)

 Get the initial level of a specific piece Initial level means the level as it is in the unbroken state
Public function Const UFunction BlueprintCallable, Category TArray< FTransform > Get the initial rest transforms in component (local) space space, they are the transforms as defined in the rest collection asset
Public function Const FPhysScene_Chaos *  
Public function Const bool  
Public function bool  
Public function Const bool  
Public function Virtual Const void  
Public function Const UFunction BlueprintCallable, Category FBox Get local bounds of the geometry collection
Public function Const UFunction BlueprintCallable, Category TArray< FTransform >

GetLocalRestTransforms ( bool bInitialTransforms
)

 Get the rest transforms in component (local) space space, if none have been set by SetLocalRestTransforms or if RestTransform property is empty , then the initial ones are returned
Public function Virtual Const float

GetMass ()

 Returns the mass of this component in kg.
Public function UFunction BlueprintCallable, Category void

GetMassAndExtents ( int32 ItemIndex,
float& OutMass,
FBox& OutExtents
)

 Get mass and extent of a specific piece
Public function Virtual Const UMaterialInterface *

GetMaterial ( int32 MaterialIndex
)

  
Public function Virtual Const FMaterialRelevance  
Public function Const bool  
Public function Const int32

GetNumElements ( FName Group
)

 API for getting at geometry collection data
Public function Virtual Const int32  
Public function Const int32

GetParent ( int32 Index
)

 Declare all the methods.
Public function Const const TManagedArray< int32 > &  
Public function Const UPhysicalMaterial * Gets the physical material to use for this geometry collection, taking into account instance overrides and render materials
Public function Virtual Const Chaos::FPhysicsObject *

GetPhysicsObjectById ( Chaos::FPhysicsObjectId Id
)

  
Public function Virtual Const Chaos::FPhysicsObject *

GetPhysicsObjectByName ( const FName& Name
)

  
Public function FGeometryCollectionPhysicsProxy *  
Public function Const const FGeometryCollectionPhysicsProxy *  
Public function Const AChaosSolverActor *  
Public function Const const FTransform &  
Public function Virtual void

GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize
)

  
Public function Const const UGeometryCollection *  
Public function Const void

GetRestTransforms ( TArray< FMatrix44f >& OutRestTransforms
)

  
Public function Const double  
Public function Const FTransform  
Public function Const UFunction BlueprintCallable, Category FTransform Get the root item current world transform
Public function Const UFunction BlueprintCallable, Category int32 Get the root item index of the hierarchy
Public function Const UFunction BlueprintCallable, Category FTransform Get the root item initial transform in world space
Public function Const FTransform  
Public function Const const FDamageCollector *  
Public function Const const TArray< int32 > &  
Public function Const bool  
Public function Virtual Const FTransform

GetSocketTransform ( FName InSocketName,
ERelativeTransformSpace TransformSpace
)

  
Protected function Static Chaos::FPhysicsSolver *

GetSolver ( const UGeometryCollectionComponent& GeometryCollectionComponent
)

  
Public function Const bool  
Public function Const bool  
Public function Virtual Const void

GetUsedMaterials ( TArray< UMaterialInterface* >& OutMaterials,
bool bGetDebugMaterials
)

  
Public function Const UFunction BlueprintPure, Category blueprintinternaluseonly bool Todo(chaos): Remove this and move to a cook time approach of the SM data based on the GC property
Public function Virtual Const bool  
Public function Virtual Const bool  
Protected function FGeometryCollectionDynamicData *

InitDynamicData ( bool bInitialization
)

 Populate the dynamic particle data for the render thread.
Public function void Update component structure to reflect any changes to the embedded geometry
Public function Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Const UFunction BlueprintCallable, Category bool Return true if the root cluster is not longer active at runtime
Public function Virtual bool

MoveComponentImpl ( const FVector& Delta,
const FQuat& NewRotation,
bool bSweep,
FHitResult* Hit,
EMoveComponentFlags MoveFlags,
ETeleportType Teleport
)

  
Public function Virtual void

NotifyBreak ( const FChaosBreakEvent& Event
)

 Overrideable native notification
Public function Virtual void

NotifyRemoval ( const FChaosRemovalEvent& Event
)

 Overrideable native notification
Public function Virtual void  
Public function Virtual void  
Protected function Virtual void

OnComponentCollisionSettingsChanged ( bool bUpdateOverlaps
)

  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Protected function UFunction void Called post solve to allow authoritative components to update their replication data
Protected function UFunction void  
Protected function UFunction void  
Public function Virtual void  
Public function Virtual void

OnUpdateTransform ( EUpdateTransformFlags UpdateTransformFlags,
ETeleportType Teleport
)

  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

  
Public function Virtual void  
Protected function Virtual bool

ProcessRepData ( float DeltaTime,
float SimTime
)

  
Protected function Virtual void  
Public function Virtual Const void

QuerySupportedSockets ( TArray< FComponentSocketDescription >& OutSockets
)

  
Public function void Currently, component space transforms for every particle is compute relative to the component transform.
Public function UFunction Category, Meta, BlueprintImplementableEvent void  
Public function void Updates the custom renderer to the reflect the current state of the Geometry Collection
Public function void Update instanced static mesh components to reflect internal embedded geometry state.
Public function void Refresh root proxies whether they are drawn through the custom renderer or normal static mesh components
Public function void  
Protected function void  
Public function FDelegateHandle Register / Unregister delegates called when the skeletal mesh property is changed
Public function UFunction BlueprintCallable, Category void This will remove anchors on all the pieces ( including the static and kinematic initial states ones ) of the geometry colection
Protected function void  
Public function Static void Force all GC components to reregister their custom renderer objects.
Protected function void Reset the dynamic collection from the current rest state.
Protected function Virtual void Clear all rep data, this is required if the physics proxy has been recreated
Public function void This reset the rest transform to use the rest collection asset ones
Public function void Propagate bone selection to embedded geometry components.
Public function Virtual void  
Public function Virtual void  
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void

SetAnchoredByBox ( FBox WorldSpaceBox,
bool bAnchored,
int32 MaxLevel
)

 Set all pieces within a world space bounding box to be anchored or not
Public function UFunction BlueprintCallable, Category void

SetAnchoredByIndex ( int32 Index,
bool bAnchored
)

 Set a piece or cluster to be anchored or not
Public function UFunction BlueprintCallable, Category void

SetAnchoredByTransformedBox ( FBox Box,
FTransform Transform,
bool bAnchored,
int32 MaxLevel
)

 Set all pieces within a world transformed bounding box to be anchored or not
Public function Virtual void

SetCollisionObjectType ( ECollisionChannel Channel
)

  
Public function UFunction BlueprintCallable blueprintinternaluseonly void

SetDamageModel ( EDamageModelTypeEnum InDamageModel
)

  
Public function UFunction BlueprintCallable blueprintinternaluseonly void  
Public function UFunction BlueprintCallable blueprintinternaluseonly void

SetDamageThreshold ( const TArray< float >& InDamageThreshold
)

  
Public function UFunction BlueprintCallable blueprintinternaluseonly void

SetDensityFromPhysicsMaterial ( bool bInDensityFromPhysicsMaterial
)

  
Public function void

SetDynamicState ( const Chaos::EObjectStateType& NewDynamicState
)

 Set the dynamic state for all bodies in the DynamicCollection.
Public function void

SetEmbeddedGeometrySelectable ( bool bSelectableIn
)

  
Public function UFunction BlueprintCallable, Category void  
Public function Virtual void

SetEnableGravity ( bool bGravityEnabled
)

  
Public function void

SetEnableReplication ( bool bInEnableReplication
)

 Attn: these replication methods are helpers meant to be called before the component is fully registered, like a constructor!
Public function UFunction BlueprintCallable blueprintinternaluseonly void

SetGravityGroupIndex ( int32 InGravityGroupIndex
)

  
Public function void

SetInitialClusterBreaks ( const TArray< int32 >& ReleaseIndices
)

 Modify DynamicCollection transform hierarchy to effect cluster breaks releasing the specified indices.
Public function void

SetInitialTransforms ( const TArray< FTransform >& InitialTransforms
)

 Set transforms for all bodies in the DynamicCollection.
Public function UFunction BlueprintCallable, Category void

SetLocalRestTransforms ( const TArray< FTransform >& Transforms,
bool bOnlyLeaves
)

 Set the local rest transform, this may be different from the rest collection If the geometry collection is already simulating those matrices will be overriden by the physics state updates
Public function UFunction BlueprintCallable, Category void

SetNotifyBreaks ( bool bNewNotifyBreaks
)

 Changes whether or not this component will get future break notifications.
Public function UFunction BlueprintCallable, Category void

SetNotifyCrumblings ( bool bNewNotifyCrumblings,
bool bNewCrumblingEventIncludesChildren
)

 Changes whether or not this component will get future crumbling notifications.
Public function UFunction BlueprintCallable, Category void

SetNotifyGlobalBreaks ( bool bNewNotifyGlobalBreaks
)

 Changes whether or not this component will get future global break notifications.
Public function UFunction BlueprintCallable, Category void

SetNotifyGlobalCollision ( bool bNewNotifyGlobalCollisions
)

 Changes whether or not this component will get future global collision notifications.
Public function UFunction BlueprintCallable, Category void

SetNotifyGlobalCrumblings ( bool bNewNotifyGlobalCrumblings,
bool bGlobalNewCrumblingEventIncludesChildren
)

 Changes whether or not this component will get future global crumbling notifications.
Public function UFunction BlueprintCallable, Category void

SetNotifyGlobalRemovals ( bool bNewNotifyGlobalRemovals
)

 Changes whether or not this component will get future global removal notifications.
Public function UFunction BlueprintCallable, Category void

SetNotifyRemovals ( bool bNewNotifyRemovals
)

 Changes whether or not this component will get future removal notifications.
Public function Virtual void

SetNotifyRigidBodyCollision ( bool bNewNotifyRigidBodyCollision
)

  
Public function UFunction BlueprintCallable blueprintinternaluseonly void

SetOneWayInteractionLevel ( int32 InOneWayInteractionLevel
)

  
Public function void

SetParticleCollisionProfileName ( int32 BoneId,
FName ProfileName,
FGCCollisionProfileScopedTransaction& InProfileNameUpdateTransaction
)

  
Public function UFunction BlueprintCallable, Category void

SetPerLevelCollisionProfileNames ( const TArray< FName >& ProfileNames
)

  
Public function UFunction BlueprintCallable, Category void

SetPerParticleCollisionProfileName ( const TArray< int32 >& BoneIds,
FName ProfileName
)

  
Public function void

SetPerParticleCollisionProfileName ( const TSet< int32 >& BoneIds,
FName ProfileName
)

  
Public function Virtual void

SetPhysMaterialOverride ( UPhysicalMaterial* NewPhysMaterial
)

  
Public function void  
Public function void

SetReplicationAbandonAfterLevel ( int32 InReplicationAbandonAfterLevel
)

  
Public function void

SetReplicationMaxPositionAndVelocityCorrectionLevel ( int32 InReplicationMaxPositionAndVelocityCorrectionLevel
)

  
Public function UFunction BlueprintCallable, Category void

SetRestCollection ( const UGeometryCollection* RestCollectionIn,
bool bApplyAssetDefaults
)

 RestCollection
Public function void

SetRestState ( TArray< FTransform >&& InRestTransforms
)

 #todo should this only be available in editor?
Public function UFunction BlueprintCallable, Category void

SetRootProxyComponentSpaceTransform ( int32 Index,
const FTransform& RootProxyTransform
)

 Blueprint function to set a specific root proxy local transform warning: when called from C++ and calling it on multiple root proxies it is recommended to use SetRootProxyLocalTransform instead and then call RefreshCustomRenderer to avoid the cost of refreshing the renderer each time
Public function void

SetRootProxyLocalTransform ( int32 Index,
const FTransform3f& RootProxyTransform
)

 Set a specific root proxy local transform
Public function void

SetShowBoneColors ( bool ShowBoneColorsIn
)

  
Public function Virtual void

SetSimulatePhysics ( bool bEnabled
)

  
Public function void

SetUpdateCustomRenderer ( bool bValue
)

  
Public function void Update of the custom renderer when post physics sync callback is executing ( valid if custom redner is being used ) - true by default
Public function void

SetUpdateNavigationInTick ( const bool bUpdateInTick
)

  
Public function UFunction BlueprintCallable blueprintinternaluseonly void

SetUseMaterialDamageModifiers ( bool bInUseMaterialDamageModifiers
)

  
Public function UFunction BlueprintCallable, Category blueprintinternaluseonly void

SetUseStaticMeshCollisionForTraces ( bool bInUseStaticMeshCollisionForTraces
)

 Todo(chaos): Remove this and move to a cook time approach of the SM data based on the GC property
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Const bool  
Public function Virtual void

TickComponent ( float DeltaTime,
enum ELevelTick TickType,
FActorComponentTickFunction* ThisTickFunction
)

  
Public function void  
Public function void Update cached bounds; used e.g. when updating the exploded view of the geometry collection.
Protected function void  
Protected function void  
Protected function void  
Protected function Virtual void  
Protected function Virtual void  

Overridden from IChaosNotifyHandlerInterface

  Type Name Description
Public function Virtual void Implementing classes should override to dispatch whatever blueprint events they choose to offer

Classes

  Type Name Description
Public class FNotifyGeometryCollectionPhysicsLoadingStateChange    
Public class FNotifyGeometryCollectionPhysicsStateChange Blueprint event  

Enums

  Type Name Description
Private enum ENetAwakeningMode    

Typedefs

Name Description
FOnGeometryCollectionPropertyChanged  
FOnGeometryCollectionPropertyChangedMulticaster  

Constants

Name Description
DefaultCollisionProfileName Collision profile name that indicates we should use the geometry collection's default collision profile.

Deprecated Variables

  Type Name Description
Public variable UProperty Meta float AngularEtherDrag_DEPRECATED Uniform angular ether drag.
Protected variable UProperty bool bAutoAssignISMPool_DEPRECATED Deprecated for CustomRendererType.
Public variable UProperty Meta EClusterConnectionTypeEnum ClusterConnectionType_DEPRECATED  
Protected variable UProperty TObjectPtr< AGeometryCollectionISMPoolActor > ISMPool_DEPRECATED Deprecated for CustomRendererType.
Public variable UProperty Meta float LinearEtherDrag_DEPRECATED Uniform linear ether drag.
Public variable UProperty Meta TObjectPtr< const UChaosPhysicalMaterial > PhysicalMaterial_DEPRECATED Physical Properties
Public variable UProperty Meta TObjectPtr< UPhysicalMaterial > PhysicalMaterialOverride_DEPRECATED  
Protected variable UProperty Meta int32 ReplicationAbandonClusterLevel_DEPRECATED If replicating - the cluster level to stop sending corrections for geometry collection chunks.
Public variable UProperty Meta bool Simulating_DEPRECATED  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page