Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > GeometryCollectionEngine > GeometryCollection > UGeometryCollectionComponent

Light Theme

Dark Theme

UGeometryCollectionComponent

GeometryCollectionComponent

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

USceneComponent

UPrimitiveComponent

UMeshComponent

UGeometryCollectionComponent

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

	Name	Description
int32	BaseRigidBodyIndex
bool	bEnableAbandonAfterLevel	Enables use of ReplicationAbandonClusterLevel to stop providing network updates to clients when the updated particle is of a level higher then specified.
bool	bEnableReplication	Per-instance override to enable/disable replication for the geometry collection
bool	bNotifyBreaks	Call SetNotifyBreaks to set this at runtime.
bool	bNotifyCollisions	If true, this component will get Chaos-specific collision notification events (
FGeomComponentC...	CacheParameters
bool	CachePlayback
AChaosSolverAct...	ChaosSolverActor	Chaos RBD Solver override. Will use the world's default solver actor if null.
EClusterConnect...	ClusterConnectionType
int32	ClusterGroupIndex	Maximum level for cluster breaks.
int32	CollisionGroup
float	CollisionSampleFraction	Uniform Friction
TArray< float >	DamageThreshold	Damage threshold for clusters at different levels.
float	DesiredCacheTime
TArray< bool >	DisabledFlags	Mirrored from the proxy on a sync TManagedArray RigidBodyIds;
bool	EnableClustering
FVector	InitialAngularVelocity
TArray< const A...	InitializationFields
ESimulationInit...	InitializationState
FVector	InitialLinearVelocity
EInitialVelocit...	InitialVelocityType
int32	MaxClusterLevel	Maximum level for cluster breaks.
FNotifyGeometry...	NotifyGeometryCollectionPhysicsLoadingStateChange
FNotifyGeometry...	NotifyGeometryCollectionPhysicsStateChange
int32	NumParticlesAdded
EObjectStateTyp...	ObjectType	ObjectType defines how to initialize the rigid objects state, Kinematic, Sleeping, Dynamic.
FOnChaosBreakEv...	OnChaosBreakEvent
FOnChaosPhysics...	OnChaosPhysicsCollision
UPhysicalMateri...	PhysicalMaterialOverride
FGeometryCollec...	RepData
int32	ReplicationAbandonClusterLevel	If replicating - the cluster level to stop sending corrections for geometry collection chunks.
const UGeometry...	RestCollection
bool	Simulating	When Simulating is enabled the Component will initialize its rigid bodies within the solver.

Constructors

	Name	Description
	UGeometryCollectionComponent ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
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.
void	ApplyPhysicsField ( bool Enabled, EGeometryCollectionPhysicsTypeEnum ..., 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.
void	CalculateGlobalMatrices()
void	CalculateLocalBounds()
void	DispatchBreakEvent ( const FChaosBreakEvent& Event )
void	DispatchFieldCommand ( const FFieldSystemCommand& InComma... )	Issue a field command for the physics thread
FScopedColor...	EditBoneSelection()
FGeometryCol...	EditRestCollection ( GeometryCollection::EEditUpdate Edi... )
void	EnableTransformSelectionMode ( bool bEnable )	Enable/disable the scene proxy per transform selection mode.
void	ForceRenderUpdateConstantData()	Force render after constant data changes (such as visibility, or hitproxy subsections).
void	ForceRenderUpdateDynamicData()	Force render after dynamic data changes (such as transforms). Will also work while paused.
const TManag...	GetBoneColorArray()
TManagedArra...	GetBoneColorArrayCopyOnWrite()
const TManag...	GetBoneColorArrayRest()
const TManag...	GetBoneMapArray()
TManagedArra...	GetBoneMapArrayCopyOnWrite()
const TManag...	GetBoneMapArrayRest()
const TManag...	GetBoneNameArray()	Transform group.
TManagedArra...	GetBoneNameArrayCopyOnWrite()
const TManag...	GetBoneNameArrayRest()
const int	GetBoneSelectedMaterialID()
const TManag...	GetBoundingBoxArray()
TManagedArra...	GetBoundingBoxArrayCopyOnWrite()
const TManag...	GetBoundingBoxArrayRest()
const TManag...	GetChildrenArray()
TManagedArra...	GetChildrenArrayCopyOnWrite()
const TManag...	GetChildrenArrayRest()
const TManag...	GetColorArray()
TManagedArra...	GetColorArrayCopyOnWrite()
const TManag...	GetColorArrayRest()
const TArray...	GetDisabledFlags()
bool	GetEnableBoneSelection()
const TManag...	GetFaceCountArray()
TManagedArra...	GetFaceCountArrayCopyOnWrite()
const TManag...	GetFaceCountArrayRest()
const TManag...	GetFaceStartArray()
TManagedArra...	GetFaceStartArrayCopyOnWrite()
const TManag...	GetFaceStartArrayRest()
const TArray...	GetHighlightedBones()
const TManag...	GetIndicesArray()	Faces Group.
TManagedArra...	GetIndicesArrayCopyOnWrite()
const TManag...	GetIndicesArrayRest()
void	GetInitializationCommands ( TArray< FFieldSystemCommand >& Com... )	Combine the commands from the input field assets
FPhysScene_C...	GetInnerChaosScene()
const TManag...	GetInnerRadiusArray()
TManagedArra...	GetInnerRadiusArrayCopyOnWrite()
const TManag...	GetInnerRadiusArrayRest()
bool	GetIsObjectDynamic()
bool	GetIsObjectLoading()
const TManag...	GetMaterialIDArray()
TManagedArra...	GetMaterialIDArrayCopyOnWrite()
const TManag...	GetMaterialIDArrayRest()
const TManag...	GetMaterialIndexArray()
TManagedArra...	GetMaterialIndexArrayCopyOnWrite()
const TManag...	GetMaterialIndexArrayRest()
const TManag...	GetNormalArray()
TManagedArra...	GetNormalArrayCopyOnWrite()
const TManag...	GetNormalArrayRest()
int32	GetNumElements ( FName Group )	API for getting at geometry collection data
const TManag...	GetOuterRadiusArray()
TManagedArra...	GetOuterRadiusArrayCopyOnWrite()
const TManag...	GetOuterRadiusArrayRest()
const TManag...	GetParentArray()
TManagedArra...	GetParentArrayCopyOnWrite()
const TManag...	GetParentArrayRest()
UPhysicalMat...	GetPhysicalMaterial()	Gets the physical material to use for this geometry collection, taking into account instance overrides and render materials
const FGeome...	GetPhysicsProxy()
FGeometryCol...	GetPhysicsProxy()
AChaosSolver...	GetPhysicsSolverActor()
const UGeome...	GetRestCollection()
const TManag...	GetRigidBodyGuidArray()	Const TManagedArray& GetRigidBodyIdArray() const { return RigidBodyIds; }
const TManag...	GetSectionsArray()	Material Group.
TManagedArra...	GetSectionsArrayCopyOnWrite()
const TManag...	GetSectionsArrayRest()
const TArray...	GetSelectedBones()
bool	GetShowBoneColors()
const TManag...	GetSimulationTypeArray()
TManagedArra...	GetSimulationTypeArrayCopyOnWrite()
const TManag...	GetSimulationTypeArrayRest()
const TManag...	GetStatusFlagsArray()
TManagedArra...	GetStatusFlagsArrayCopyOnWrite()
const TManag...	GetStatusFlagsArrayRest()
const TManag...	GetTangentUArray()
TManagedArra...	GetTangentUArrayCopyOnWrite()
const TManag...	GetTangentUArrayRest()
const TManag...	GetTangentVArray()
TManagedArra...	GetTangentVArrayCopyOnWrite()
const TManag...	GetTangentVArrayRest()
const TManag...	GetTransformArray()
TManagedArra...	GetTransformArrayCopyOnWrite()
const TManag...	GetTransformArrayRest()
const TManag...	GetTransformIndexArray()	Geometry Group.
TManagedArra...	GetTransformIndexArrayCopyOnWrite()
const TManag...	GetTransformIndexArrayRest()
const TManag...	GetTransformToGeometryIndexArray()
TManagedArra...	GetTransformToGeometryIndexArrayCopyOnWrite()
const TManag...	GetTransformToGeometryIndexArrayRest()
const TManag...	GetUVArray()
TManagedArra...	GetUVArrayCopyOnWrite()
const TManag...	GetUVArrayRest()
const TManag...	GetVertexArray()	Vertices Group.
TManagedArra...	GetVertexArrayCopyOnWrite()
const TManag...	GetVertexArrayRest()
const TManag...	GetVertexCountArray()
TManagedArra...	GetVertexCountArrayCopyOnWrite()
const TManag...	GetVertexCountArrayRest()
const TManag...	GetVertexStartArray()
TManagedArra...	GetVertexStartArrayCopyOnWrite()
const TManag...	GetVertexStartArrayRest()
const TManag...	GetVisibleArray()
TManagedArra...	GetVisibleArrayCopyOnWrite()
const TManag...	GetVisibleArrayRest()
void	InitConstantData ( FGeometryCollectionConstantData... )	Populate the static geometry structures for the render thread.
void	InitDynamicData ( FGeometryCollectionDynamicData*... )	Populate the dynamic particle data for the render thread.
void	NotifyBreak ( const FChaosBreakEvent& Event )	Overrideable native notification
void	OnRep_RepData ( const FGeometryCollectionRepData& ... )	Called on non-authoritative clients when receiving new repdata from the server
void	ReceivePhysicsCollision ( const FChaosPhysicsCollisionInfo& ... )
void	RegisterForEvents()
void	ResetBoneColorArrayDynamic()
void	ResetBoneMapArrayDynamic()
void	ResetBoneNameArrayDynamic()
void	ResetBoundingBoxArrayDynamic()
void	ResetChildrenArrayDynamic()
void	ResetColorArrayDynamic()
void	ResetDynamicCollection()	Reset the dynamic collection from the current rest state.
void	ResetFaceCountArrayDynamic()
void	ResetFaceStartArrayDynamic()
void	ResetIndicesArrayDynamic()
void	ResetInnerRadiusArrayDynamic()
void	ResetMaterialIDArrayDynamic()
void	ResetMaterialIndexArrayDynamic()
void	ResetNormalArrayDynamic()
void	ResetOuterRadiusArrayDynamic()
void	ResetParentArrayDynamic()
void	ResetSectionsArrayDynamic()
void	ResetSimulationTypeArrayDynamic()
void	ResetStatusFlagsArrayDynamic()
void	ResetTangentUArrayDynamic()
void	ResetTangentVArrayDynamic()
void	ResetTransformArrayDynamic()
void	ResetTransformIndexArrayDynamic()
void	ResetTransformToGeometryIndexArrayDynamic()
void	ResetUVArrayDynamic()
void	ResetVertexArrayDynamic()
void	ResetVertexCountArrayDynamic()
void	ResetVertexStartArrayDynamic()
void	ResetVisibleArrayDynamic()
void	SetNotifyBreaks ( bool bNewNotifyBreaks )	Changes whether or not this component will get future break notifications.
void	SetRenderStateDirty()
void	SetRestCollection ( const UGeometryCollection* Res... )	RestCollection
void	SetShowBoneColors ( bool ShowBoneColorsIn )
void	UpdateBreakEventRegistration()
void	UpdateRBCollisionEventRegistration()
void	UpdateRepData()	Called post solve to allow authoritative components to update their replication data

Overridden from UPrimitiveComponent

	Name	Description
FPrimitiveSc...	CreateSceneProxy()	Creates a proxy to represent the primitive to the scene manager in the rendering thread.
bool	DoCustomNavigableGeometryExport ( FNavigableGeometryExport& GeomExpo... )	Collects custom navigable geometry of component.
FBodyInstanc...	GetBodyInstance ( FName BoneName, bool bGetWelded )	Returns BodyInstance of the component.
UMaterialInt...	GetMaterial ( int32 ElementIndex )	Returns the material used by the element at the specified index
int32	GetNumMaterials()	Return number of material elements in this primitive
void	SetNotifyRigidBodyCollision ( bool bNewNotifyRigidBodyCollision )	Changes the value of bNotifyRigidBodyCollision

Overridden from USceneComponent

	Name	Description
FBoxSphereBo...	CalcBounds ( const FTransform& LocalToWorld )	Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size.
FBoxSphereBo...	CalcLocalBounds()	Calculate the local bounds of the component.
bool	HasAnySockets()	Returns true if this component has any sockets

Overridden from UActorComponent

	Name	Description
void	BeginPlay()	Used to detach physics objects before simulation begins.
void	CreateRenderState_Concurrent ( FRegisterComponentContext* Con... )	Used to create any rendering thread information for this component
void	EndPlay ( const EEndPlayReason::Type EndPlayR... )	Ends gameplay for this component.
bool	HasValidPhysicsState()	Used to check that DestroyPhysicsState() is working correctly
void	InitializeComponent()	Initializes the component.
void	OnCreatePhysicsState()	Used to create any physics engine information for this component
void	OnDestroyPhysicsState()	Used to shut down and physics engine structure for this component
void	OnRegister()	Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.
void	SendRenderDynamicData_Concurrent()	Called to send dynamic data for this component to the rendering thread
bool	ShouldCreatePhysicsState()	Return true if CreatePhysicsState() should be called.
void	TickComponent ( float DeltaTime, enum ELevelTick TickType, FActorComponentTickFunction* T... )	Function called every frame on this ActorComponent.

Overridden from UObject

		Name	Description
	void	GetLifetimeReplicatedProps ( TArray< FLifetimeProperty >& OutLi... )	Returns properties that are replicated for the lifetime of the actor channel

Overridden from IChaosNotifyHandlerInterface

		Name	Description
	void	DispatchChaosPhysicsCollisionBlueprintEvents ( const FChaosPhysicsCollisionInfo& ... )	Implementing classes should override to dispatch whatever blueprint events they choose to offer

Classes

	Name	Description
	FNotifyGeometryCollectionPhysicsLoadingStateChange
	FNotifyGeometryCollectionPhysicsStateChange	Blueprint event

Deprecated Variables

	Name	Description
float	AngularEtherDrag_DEPRECATED	Uniform angular ether drag.
float	LinearEtherDrag_DEPRECATED	Uniform linear ether drag.
const UChaosPhy...	PhysicalMaterial_DEPRECATED	Physical Properties

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss