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

class UGeometryCollectionComponent :  
    public UMeshComponent,  
    public IChaosNotifyHandlerInterface

Remarks

GeometryCollectionComponent

Variables

  Type Name Description
Protected variable 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 bool bAllowRemovalOnBreak Allow removal on break for the instance if the rest collection has it enabled
Public variable bool bAllowRemovalOnSleep Allow removal on sleep for the instance if the rest collection has it enabled
Public variable int32 BaseRigidBodyIndex  
Public variable bool bCrumblingEventIncludesChildren If this and bNotifyCrumblings are true, the crumbling events will contain released children indices.
Protected variable 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 bool bEnableDamageFromCollision Whether or not collisions against this geometry collection will apply strain which could cause the geometry collection to fracture.
Protected variable bool bEnableReplication Per-instance override to enable/disable replication for the geometry collection
Protected variable bool bEnableRunTimeDataCollection  
Public variable bool bForceMotionBlur If ForceMotionBlur is on, motion blur will always be active, even if the GeometryCollection is at rest.
Public variable bool bGlobalCrumblingEventIncludesChildren If this and bNotifyGlobalCrumblings are true, the crumbling events will contain released children indices.
Public variable bool bNotifyBreaks If true, this component will generate breaking events that other systems may subscribe to.
Public variable bool bNotifyCollisions If true, this component will generate collision events that other systems may subscribe to.
Public variable bool bNotifyCrumblings If true, this component will generate crumbling events that other systems may subscribe to.
Public variable bool bNotifyGlobalBreaks If true, this component will generate breaking events that will be listened by the global event relay.
Public variable bool bNotifyGlobalCollisions If true, this component will generate collision events that will be listened by the global event relay.
Public variable bool bNotifyGlobalCrumblings If true, this component will generate crumbling events that will be listened by the global event relay.
Public variable bool bNotifyGlobalRemovals If true, this component will generate removal events that will be listened by the global event relay.
Public variable bool bNotifyRemovals If true, this component will generate removal events that other systems may subscribe to.
Public variable bool bNotifyTrailing If true, this component will generate trailing events that other systems may subscribe to.
Protected variable bool bOverrideCustomRenderer If true, CustomRendererType will be used.
Protected variable bool bShowBoneColors Display Bone Colors instead of assigned materials
Public variable bool bStoreVelocities If true, this component will save linear and angular velocities on its DynamicCollection.
Protected variable bool bUpdateNavigationInTick  
Protected variable bool bUseRootProxyForNavigation  
Public variable bool bUseSizeSpecificDamageThreshold Damage threshold for clusters at different levels.
Public variable FGeomComponentCacheParameters CacheParameters  
Public variable bool CachePlayback  
Public variable TObjectPtr< AChaosSolverActor > ChaosSolverActor Chaos RBD Solver override. Will use the world's default solver actor if null.
Public variable int32 ClusterGroupIndex Maximum level for cluster breaks.
Public variable int32 CollisionGroup  
Protected variable TArray< FName > CollisionProfilePerLevel A per-level collision profile name.
Protected variable TArray< FName > CollisionProfilePerParticle A per-particle collision profile name.
Public variable float CollisionSampleFraction Fraction of collision sample particles to keep
Protected variable TObjectPtr< UGeometryCollectionExternalRenderInterface > CustomRenderer A custom renderer object created from CustomRenderType.
Protected 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  
Public variable float DesiredCacheTime  
Public variable TArray< bool > DisabledFlags Mirrored from the proxy on a sync TManagedArray RigidBodyIds;
Public variable bool EnableClustering  
Public variable int32 GravityGroupIndex  
Public variable FVector InitialAngularVelocity  
Public variable TArray< TObjectPtr< const AFieldSystemActor > > InitializationFields  
Public variable ESimulationInitializationState InitializationState  
Public variable FVector InitialLinearVelocity  
Public variable EInitialVelocityTypeEnum InitialVelocityType  
Protected variable int64 LastAsyncPhysicsTickMs The last time (in milliseconds) the async physics component tick fired.
Public variable int32 MaxClusterLevel Maximum level for cluster breaks.
Public variable int32 MaxSimulatedLevel The maximum level to create rigid bodies that could be simulated.
Public variable FNotifyGeometryCollectionPhysicsLoadingStateChange NotifyGeometryCollectionPhysicsLoadingStateChange  
Public variable FNotifyGeometryCollectionPhysicsStateChange NotifyGeometryCollectionPhysicsStateChange  
Public variable int32 NumParticlesAdded  
Public variable EObjectStateTypeEnum ObjectType ObjectType defines how to initialize the rigid objects state, Kinematic, Sleeping, Dynamic.
Public variable FOnChaosBreakEvent OnChaosBreakEvent  
Public variable FOnChaosCrumblingEvent OnChaosCrumblingEvent  
Public variable FOnChaosPhysicsCollision OnChaosPhysicsCollision  
Public variable FOnChaosRemovalEvent OnChaosRemovalEvent  
Public variable FOnGeometryCollectionPropertyChangedMulticaster OnGeometryCollectionPropertyChanged  
Public variable FOnChaosBreakEvent OnRootBreakEvent Todo(chaos) remove when no longer necessary
Protected variable FGeometryCollectionRepData RepData  
Protected variable int32 ReplicationAbandonAfterLevel If replicating - the cluster level after which replication will not happen
Protected variable 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
Public variable TObjectPtr< const UGeometryCollection > RestCollection  
Public variable TArray< FTransform > RestTransforms Optional transforms to initialize scene proxy if difference from the RestCollection.
Protected variable FGuid RunTimeDataCollectionGuid  
Protected variable int32 VersionProcessed  

Constructors

  Type Name Description
Public function  

UGeometryCollectionComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function void

ApplyAngularVelocity ( int32 ItemIndex,
const FVector& AngularVelocity
)

 Apply angular velocity on specific piece
Public function void Apply default values from asset ( damage related data and physics material )
Public function 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 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 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 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 void

ApplyKinematicField ( float Radius,
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 void

ApplyLinearVelocity ( int32 ItemIndex,
const FVector& LinearVelocity
)

 Apply linear velocity on specific piece
Public function void

ApplyPhysicsField ( bool Enabled,
EGeometryCollectionPhysicsTypeEnum Target,
UFieldSystemMetaData* MetaData,
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.
Protected function void  
Protected function void  
Protected function Const FBox

ComputeBounds ( const FTransform& LocalToWorldWithScale
)

  
Protected function Const FBox

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

  
Public function Const TArray< UStaticMeshComponent * >  
Public function void Crumbe active clusters for this entire geometry collection this will apply to internal and regular clusters
Public function void

CrumbleCluster ( int32 ItemIndex
)

 Crumbe a cluster into all its pieces
Public function void  
Public function void  
Protected function void Issue a field command for the physics thread
Public function void  
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 void

EnableTransformSelectionMode ( bool bEnable
)

 Enable/disable the scene proxy per transform selection mode.
Public function void Force render after constant data changes (such as visibility, or hitproxy subsections).
Public function void Force render after dynamic data changes (such as transforms). Will also work while paused.
Public function Const const TManagedArray< FLinearColor > &  
Public function TManagedArray< FLinearColor > &  
Public function Const const TManagedArray< FLinearColor > &  
Public function Const void

GetBoneColors ( TArray< FColor >& OutColors
)

  
Public function Const const TManagedArray< int32 > &  
Public function TManagedArray< int32 > &  
Public function Const const TManagedArray< int32 > &  
Public function Const const TManagedArray< FString > & Transform group
Public function TManagedArray< FString > &  
Public function Const const TManagedArray< FString > &  
Public function Const const int  
Public function Const const TManagedArray< FBox > &  
Public function TManagedArray< FBox > &  
Public function Const const TManagedArray< FBox > &  
Public function Const const TManagedArray< TSet< int32 > > &  
Public function TManagedArray< TSet< int32 > > &  
Public function Const const TManagedArray< TSet< int32 > > &  
Public function Const const TManagedArray< FLinearColor > &  
Public function TManagedArray< FLinearColor > &  
Public function Const const TManagedArray< FLinearColor > &  
Public function const TArray< FTransform >  
Public function Const TArray< float >  
Public function FString RestCollection
Public function Const const TArray< bool > &  
Public function FGeometryDynamicCollection *  
Public function Const const FGeometryDynamicCollection *  
Public function Const bool  
Public function Const const TManagedArray< int32 > &  
Public function TManagedArray< int32 > &  
Public function Const const TManagedArray< int32 > &  
Public function Const const TManagedArray< int32 > &  
Public function TManagedArray< int32 > &  
Public function Const const TManagedArray< int32 > &  
Public function Const const TManagedArray< int32 > &  
Public function TManagedArray< int32 > &  
Public function Const const TManagedArray< int32 > &  
Public function Const void

GetHiddenTransforms ( TArray< bool >& OutHiddenTransforms
)

  
Public function Const const TArray< int32 > &  
Public function Const const TManagedArray< FIntVector > & Faces Group
Public function TManagedArray< FIntVector > &  
Public function Const const TManagedArray< FIntVector > &  
Protected function void Combine the commands from the input field assets
Public function 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 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 const TManagedArray< float > &  
Public function TManagedArray< float > &  
Public function Const const TManagedArray< float > &  
Public function Const const TManagedArray< bool > &  
Public function TManagedArray< bool > &  
Public function Const const TManagedArray< bool > &  
Public function Const bool  
Public function bool  
Public function Const bool  
Public function Const FBox Get local bounds of the geometry collection
Public function void

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

 Get mass and extent of a specific piece
Public function Const const TManagedArray< int32 > &  
Public function TManagedArray< int32 > &  
Public function Const const TManagedArray< int32 > &  
Public function Const const TManagedArray< int32 > &  
Public function TManagedArray< int32 > &  
Public function Const const TManagedArray< int32 > &  
Public function Const const TManagedArray< FVector3f > &  
Public function TManagedArray< FVector3f > &  
Public function Const const TManagedArray< FVector3f > &  
Public function Const bool  
Public function Const int32

GetNumElements ( FName Group
)

 API for getting at geometry collection data
Public function Const const TManagedArray< float > &  
Public function TManagedArray< float > &  
Public function Const const TManagedArray< float > &  
Public function Const const TManagedArray< int32 > &  
Public function TManagedArray< int32 > &  
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 Const const FGeometryCollectionPhysicsProxy *  
Public function FGeometryCollectionPhysicsProxy *  
Public function Const AChaosSolverActor *  
Public function Const const UGeometryCollection *  
Public function Const void

GetRestTransforms ( TArray< FMatrix44f >& OutRestTransforms
)

  
Public function Const FTransform Get the root item current world transform
Public function Const int32 Get the root item index of the hierarchy
Public function Const FTransform Get the root item initial transform in world space
Public function Const const FDamageCollector *  
Public function Const const TManagedArray< FGeometryCollectionSection > & Material Group
Public function TManagedArray< FGeometryCollectionSection > &  
Public function Const const TManagedArray< FGeometryCollectionSection > &  
Public function Const const TArray< int32 > &  
Public function Const bool  
Public function Const const TManagedArray< int32 > &  
Public function TManagedArray< int32 > &  
Public function Const const TManagedArray< int32 > &  
Protected function Chaos::FPhysicsSolver *

GetSolver ( const UGeometryCollectionComponent& GeometryCollectionComponent
)

  
Public function Const const TManagedArray< int32 > &  
Public function TManagedArray< int32 > &  
Public function Const const TManagedArray< int32 > &  
Public function Const bool  
Public function Const const TManagedArray< FVector3f > &  
Public function TManagedArray< FVector3f > &  
Public function Const const TManagedArray< FVector3f > &  
Public function Const const TManagedArray< FVector3f > &  
Public function TManagedArray< FVector3f > &  
Public function Const const TManagedArray< FVector3f > &  
Public function Const const TManagedArray< FTransform > &  
Public function TManagedArray< FTransform > &  
Public function Const const TManagedArray< FTransform > &  
Public function Const const TManagedArray< int32 > & Geometry Group
Public function TManagedArray< int32 > &  
Public function Const const TManagedArray< int32 > &  
Public function Const const TManagedArray< int32 > &  
Public function TManagedArray< int32 > &  
Public function Const const TManagedArray< int32 > &  
Public function Const const TManagedArray< FVector3f > & Declare all the methods.
Public function TManagedArray< FVector3f > &  
Public function Const const TManagedArray< FVector3f > &  
Public function Const const TManagedArray< int32 > &  
Public function TManagedArray< int32 > &  
Public function Const const TManagedArray< int32 > &  
Public function Const const TManagedArray< int32 > &  
Public function TManagedArray< int32 > &  
Public function Const const TManagedArray< int32 > &  
Public function Const const TManagedArray< bool > &  
Public function TManagedArray< bool > &  
Public function Const const TManagedArray< 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 Virtual void

NotifyBreak ( const FChaosBreakEvent& Event
)

 Overrideable native notification
Public function Virtual void Overrideable native notification
Protected function void Called post solve to allow authoritative components to update their replication data
Protected function Virtual bool

ProcessRepData ( float DeltaTime,
float SimTime
)

  
Public function void  
Public function void Update instanced static mesh components to reflect internal embedded geometry state.
Public function void  
Protected function void  
Public function FDelegateHandle Register / Unregister delegates called when the skeletal mesh property is changed
Public function 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.
Public function void  
Public function void  
Public function void  
Public function void  
Public function void  
Public function void  
Protected function void Reset the dynamic collection from the current rest state.
Public function void  
Public function void  
Public function void  
Public function void  
Public function void  
Public function void  
Public function void  
Public function void  
Public function void  
Public function void  
Public function void  
Protected function Virtual void Clear all rep data, this is required if the physics proxy has been recreated
Public function void  
Public function void  
Public function void  
Public function void  
Public function void  
Public function void  
Public function void  
Public function void  
Public function void  
Public function void  
Public function void  
Public function void  
Public function void Propagate bone selection to embedded geometry components.
Public function void  
Public function void

SetAnchoredByBox ( FBox WorldSpaceBox,
bool bAnchored,
int32 MaxLevel
)

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

SetAnchoredByIndex ( int32 Index,
bool bAnchored
)

 Set a piece or cluster to be anchored or not
Public function 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 void

SetDamageThreshold ( const TArray< float >& InDamageThreshold
)

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

SetNotifyBreaks ( bool bNewNotifyBreaks
)

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

SetNotifyCrumblings ( bool bNewNotifyCrumblings,
bool bNewCrumblingEventIncludesChildren
)

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

SetNotifyGlobalBreaks ( bool bNewNotifyGlobalBreaks
)

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

SetNotifyGlobalCollision ( bool bNewNotifyGlobalCollisions
)

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

SetNotifyGlobalCrumblings ( bool bNewNotifyGlobalCrumblings,
bool bGlobalNewCrumblingEventIncludesChildren
)

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

SetNotifyGlobalRemovals ( bool bNewNotifyGlobalRemovals
)

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

SetNotifyRemovals ( bool bNewNotifyRemovals
)

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

SetPerLevelCollisionProfileNames ( const TArray< FName >& ProfileNames
)

  
Public function void

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

  
Public function void  
Public function 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 void

SetShowBoneColors ( bool ShowBoneColorsIn
)

  
Public function void  
Protected 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 void  
Protected function void  
Protected function Virtual void  

Overridden from UMeshComponent

  Type Name Description
Public function Virtual Const FMaterialRelevance Accesses the scene relevance information for the materials applied to the mesh.

Overridden from UPrimitiveComponent

  Type Name Description
Public function Virtual void

AddForce ( FVector Force,
FName BoneName,
bool bAccelChange
)

 Add a force to a single rigid body.
Public function Virtual void

AddForceAtLocation ( FVector Force,
FVector Location,
FName BoneName
)

 Add a force to a single rigid body at a particular location in world space.
Public function Virtual void

AddImpulse ( FVector Impulse,
FName BoneName,
bool bVelChange
)

 Add an impulse to a single rigid body. Good for one time instant burst.
Public function Virtual void

AddImpulseAtLocation ( FVector Impulse,
FVector Location,
FName BoneName
)

 Add an impulse to a single rigid body at a specific location.
Public function Virtual void

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

 Add a force to all bodies in this component, originating from the supplied world-space location.
Public function Virtual void

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

 Add an impulse to all rigid bodies in this component, radiating out from the specified position.
Public function Virtual void

AddTorqueInRadians ( FVector Torque,
FName BoneName,
bool bAccelChange
)

 Add a torque to a single rigid body.
Public function Virtual bool Determines whether or not the simulate physics setting can be edited interactively on this component
Public function Virtual FPrimitiveSceneProxy * Creates a proxy to represent the primitive to the scene manager in the rendering thread.
Public function Virtual Const bool Collects custom navigable geometry of component.
Public function Virtual Const FBodyInstance *

GetBodyInstance ( FName BoneName,
bool bGetWelded,
int32 Index
)

 Returns BodyInstance of the component.
Public function Virtual Const UMaterialInterface *

GetMaterial ( int32 ElementIndex
)

 Returns the material used by the element at the specified index
Public function Virtual Const int32 Return number of material elements in this primitive
Public function Virtual Const void

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

 Retrieves the materials used in this component
Public function Virtual void

SetCollisionObjectType ( ECollisionChannel Channel
)

 Changes the collision channel that this object uses when it moves
Public function Virtual void

SetNotifyRigidBodyCollision ( bool bNewNotifyRigidBodyCollision
)

 Changes the value of bNotifyRigidBodyCollision
Public function Virtual void

SetSimulatePhysics ( bool bSimulate
)

 Sets whether or not a single body should use physics simulation, or should be 'fixed' (kinematic).

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 Const FBoxSphereBounds Calculate the local bounds of the component.
Public function Virtual Const bool

DoesSocketExist ( FName InSocketName
)

 Return true if socket with the given name exists
Public function Virtual Const FTransform

GetSocketTransform ( FName InSocketName,
ERelativeTransformSpace TransformSpace
)

 Get world-space socket transform.
Public function Virtual Const bool Returns true if this component has any sockets
Public function Virtual void Overridable internal function to respond to changes in the hidden in game value of the component.
Public function Virtual void

OnUpdateTransform ( EUpdateTransformFlags UpdateTransformFlags,
ETeleportType Teleport
)

 Native callback when this component is moved
Public function Virtual Const void Get a list of sockets this component contains

Overridden from UActorComponent

  Type Name Description
Public function Virtual void

AsyncPhysicsTickComponent ( float DeltaTime,
float SimTime
)

 Override this function to implement custom logic to be executed every physics step.
Public function Virtual void Used to detach physics objects before simulation begins.
Public function Virtual void Used to create any rendering thread information for this component
Public function Virtual void

EndPlay ( const EEndPlayReason::Type EndPlayReason
)

 Ends gameplay for this component.
Public function Virtual Const bool Used to check that DestroyPhysicsState() is working correctly
Public function Virtual void Initializes the component.
Public function Virtual Const bool Override to specify that a component is relevant to the HLOD generation.
Public function Virtual void Called on each component when the Actor's bEnableCollisionChanged flag changes
Public function Virtual void Used to create any physics engine information for this component
Public function Virtual void Used to shut down and physics engine structure for this component
Public function Virtual void Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.
Public function Virtual void Called when a component is unregistered.
Public function Virtual void Called to send dynamic data for this component to the rendering thread
Public function Virtual Const bool Return true if CreatePhysicsState() should be called.
Public function Virtual void

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

 Function called every frame on this ActorComponent.

Overridden from UObject

  Type Name Description
Public function Virtual Const void Returns properties that are replicated for the lifetime of the actor channel
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

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.

Overridden from IPhysicsComponent

  Type Name Description
Public function Virtual Const TArray< Chaos::FPhysicsObject * >  
Public function Virtual Const Chaos::FPhysicsObjectId  
Public function Virtual Const Chaos::FPhysicsObject *  
Public function Virtual Const Chaos::FPhysicsObject *

GetPhysicsObjectByName ( const FName& Name
)

  

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  

Typedefs

Name Description
FOnGeometryCollectionPropertyChanged  
FOnGeometryCollectionPropertyChangedMulticaster  

Deprecated Variables

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

Deprecated Functions

  Type Name Description
Protected function Const FBox

ComputeBounds ( const FMatrix& LocalToWorldWithScale
)

 Use FTransform version of ComputeBounds instead
Protected function Const FBox

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

 Use ComputeBoundsFromComponentSpaceTransforms instead
Public function TArray< FMatrix > Use GetComponentSpaceTransforms instead
Protected function Virtual void The argument-free version of ProcessRepData will be removed. Please use the version which takes DeltaTime and SimTime instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page