UGeometryCollectionComponent

GeometryCollectionComponent

Windows
MacOS
Linux

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

Name Description

Public variable

int32

 

BaseRigidBodyIndex

Protected variable

bool

 

bNotifyBreaks

Call SetNotifyBreaks to set this at runtime.

Protected variable

bool

 

bNotifyCollisions

If true, this component will get Chaos-specific collision notification events (

Public variable

FGeomComponentC...

 

CacheParameters

Public variable

bool

 

CachePlayback

Public variable

AChaosSolverAct...

 

ChaosSolverActor

Chaos RBD Solver override. Will use the world's default solver actor if null.

Public variable

EClusterConnect...

 

ClusterConnectionType

ObjectType defines how to initialize the rigid objects state, Kinematic, Sleeping, Dynamic.

Public variable

int32

 

ClusterGroupIndex

Maximum level for cluster breaks

Public variable

int32

 

CollisionGroup

Uniform Friction

Public variable

float

 

CollisionSampleFraction

Uniform Friction

Public variable

TArray< float >

 

DamageThreshold

Damage threshold for clusters at different levels.

Public variable

float

 

DesiredCacheTime

Public variable

TArray< bool >

 

DisabledFlags

Public variable

bool

 

EnableClustering

Public variable

FVector

 

InitialAngularVelocity

Public variable

TArray< const A...

 

InitializationFields

Public variable

ESimulationInit...

 

InitializationState

Public variable

FVector

 

InitialLinearVelocity

Public variable

EInitialVelocit...

 

InitialVelocityType

Public variable

int32

 

MaxClusterLevel

Maximum level for cluster breaks

Public variable

FNotifyGeometry...

 

NotifyGeometryCollectionPhysicsLoadingStateChange

Public variable

FNotifyGeometry...

 

NotifyGeometryCollectionPhysicsStateChange

Public variable

int32

 

NumParticlesAdded

Public variable

EObjectStateTyp...

 

ObjectType

ObjectType defines how to initialize the rigid objects state, Kinematic, Sleeping, Dynamic.

Public variable

FOnChaosBreakEv...

 

OnChaosBreakEvent

Public variable

FOnChaosPhysics...

 

OnChaosPhysicsCollision

Public variable

const UChaosPhy...

 

PhysicalMaterial

Physical Properties

Public variable

const UGeometry...

 

RestCollection

Public variable

TManagedArray< ...

 

RigidBodyIds

Mirrored from the proxy on a sync.

Public variable

bool

 

Simulating

When Simulating is enabled the Component will initialize its rigid bodies within the solver.

Constructors

Name Description

Public function

UGeometryCollectionComponent

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function

void

 

ApplyKinematicField

(
    float Radius,
    FVector Position
)

Public function

void

 

ApplyPhysicsField

(
    bool Enabled,
    EGeometryCollectionPhysicsTypeEnum ...,
    UFieldSystemMetaData* MetaData,
    UFieldNodeBase* Field
)

Protected function

void

 

CalculateGlobalMatrices()

Protected function

void

 

CalculateLocalBounds()

Public function

void

 

DispatchBreakEvent

(
    const FChaosBreakEvent& Event
)

Protected function

void

 

DispatchCommand

(
    const FFieldSystemCommand& InComma...
)

Issue a field command for the physics thread

Public function

FScopedColor...

 

EditBoneSelection()

Public function

FGeometryCol...

 

EditRestCollection

Public function

void

 

EnableTransformSelectionMode

(
    bool bEnable
)

Enable/disable the scene proxy per transform selection mode.

Public function

void

 

ForceRenderUpdateConstantData()

Force render after constant data changes (such as visibility, or hitproxy subsections).

Public function

void

 

ForceRenderUpdateDynamicData()

Force render after dynamic data changes (such as transforms). Will also work while paused.

Public function Const

const TManag...

 

GetBoneColorArray()

Public function

TManagedArra...

 

GetBoneColorArrayCopyOnWrite()

Public function Const

const TManag...

 

GetBoneColorArrayRest()

Public function Const

const TManag...

 

GetBoneMapArray()

Public function

TManagedArra...

 

GetBoneMapArrayCopyOnWrite()

Public function Const

const TManag...

 

GetBoneMapArrayRest()

Public function Const

const TManag...

 

GetBoneNameArray()

Transform group.

Public function

TManagedArra...

 

GetBoneNameArrayCopyOnWrite()

Public function Const

const TManag...

 

GetBoneNameArrayRest()

Public function Const

const int

 

GetBoneSelectedMaterialID()

Public function Const

const TManag...

 

GetBoundingBoxArray()

Public function

TManagedArra...

 

GetBoundingBoxArrayCopyOnWrite()

Public function Const

const TManag...

 

GetBoundingBoxArrayRest()

Public function Const

const TManag...

 

GetChildrenArray()

Public function

TManagedArra...

 

GetChildrenArrayCopyOnWrite()

Public function Const

const TManag...

 

GetChildrenArrayRest()

Public function Const

const TManag...

 

GetColorArray()

Public function

TManagedArra...

 

GetColorArrayCopyOnWrite()

Public function Const

const TManag...

 

GetColorArrayRest()

Public function Const

const TArray...

 

GetDisabledFlags()

Public function Const

bool

 

GetEnableBoneSelection()

Public function Const

const TManag...

 

GetFaceCountArray()

Public function

TManagedArra...

 

GetFaceCountArrayCopyOnWrite()

Public function Const

const TManag...

 

GetFaceCountArrayRest()

Public function Const

const TManag...

 

GetFaceStartArray()

Public function

TManagedArra...

 

GetFaceStartArrayCopyOnWrite()

Public function Const

const TManag...

 

GetFaceStartArrayRest()

Public function Const

const TArray...

 

GetHighlightedBones()

Public function Const

const TManag...

 

GetIndicesArray()

Faces Group.

Public function

TManagedArra...

 

GetIndicesArrayCopyOnWrite()

Public function Const

const TManag...

 

GetIndicesArrayRest()

Protected function

void

 

GetInitializationCommands

(
    TArray< FFieldSystemCommand >& Com...
)

Combine the commands from the input field assets

Public function Const

const TManag...

 

GetInnerRadiusArray()

Public function

TManagedArra...

 

GetInnerRadiusArrayCopyOnWrite()

Public function Const

const TManag...

 

GetInnerRadiusArrayRest()

Public function

bool

 

GetIsObjectDynamic()

Public function

bool

 

GetIsObjectLoading()

Public function Const

const TManag...

 

GetMaterialIDArray()

Public function

TManagedArra...

 

GetMaterialIDArrayCopyOnWrite()

Public function Const

const TManag...

 

GetMaterialIDArrayRest()

Public function Const

const TManag...

 

GetMaterialIndexArray()

Public function

TManagedArra...

 

GetMaterialIndexArrayCopyOnWrite()

Public function Const

const TManag...

 

GetMaterialIndexArrayRest()

Public function Const

const TManag...

 

GetNormalArray()

Public function

TManagedArra...

 

GetNormalArrayCopyOnWrite()

Public function Const

const TManag...

 

GetNormalArrayRest()

Public function Const

int32

 

GetNumElements

(
    FName Group
)

API for getting at geometry collection data

Public function Const

const TManag...

 

GetOuterRadiusArray()

Public function

TManagedArra...

 

GetOuterRadiusArrayCopyOnWrite()

Public function Const

const TManag...

 

GetOuterRadiusArrayRest()

Public function Const

const TManag...

 

GetParentArray()

Public function

TManagedArra...

 

GetParentArrayCopyOnWrite()

Public function Const

const TManag...

 

GetParentArrayRest()

Public function Const

const UGeome...

 

GetRestCollection()

Public function Const

const TManag...

 

GetRigidBodyIdArray()

Public function Const

const TManag...

 

GetSectionsArray()

Material Group.

Public function

TManagedArra...

 

GetSectionsArrayCopyOnWrite()

Public function Const

const TManag...

 

GetSectionsArrayRest()

Public function Const

const TArray...

 

GetSelectedBones()

Public function Const

bool

 

GetShowBoneColors()

Public function Const

const TManag...

 

GetSimulationTypeArray()

Public function

TManagedArra...

 

GetSimulationTypeArrayCopyOnWrite()

Public function Const

const TManag...

 

GetSimulationTypeArrayRest()

Public function Const

const TManag...

 

GetStatusFlagsArray()

Public function

TManagedArra...

 

GetStatusFlagsArrayCopyOnWrite()

Public function Const

const TManag...

 

GetStatusFlagsArrayRest()

Public function Const

const TManag...

 

GetTangentUArray()

Public function

TManagedArra...

 

GetTangentUArrayCopyOnWrite()

Public function Const

const TManag...

 

GetTangentUArrayRest()

Public function Const

const TManag...

 

GetTangentVArray()

Public function

TManagedArra...

 

GetTangentVArrayCopyOnWrite()

Public function Const

const TManag...

 

GetTangentVArrayRest()

Public function Const

const TManag...

 

GetTransformArray()

Public function

TManagedArra...

 

GetTransformArrayCopyOnWrite()

Public function Const

const TManag...

 

GetTransformArrayRest()

Public function Const

const TManag...

 

GetTransformIndexArray()

Geometry Group.

Public function

TManagedArra...

 

GetTransformIndexArrayCopyOnWrite()

Public function Const

const TManag...

 

GetTransformIndexArrayRest()

Public function Const

const TManag...

 

GetTransformToGeometryIndexArray()

Public function

TManagedArra...

 

GetTransformToGeometryIndexArrayCopyOnWrite()

Public function Const

const TManag...

 

GetTransformToGeometryIndexArrayRest()

Public function Const

const TManag...

 

GetUVArray()

Public function

TManagedArra...

 

GetUVArrayCopyOnWrite()

Public function Const

const TManag...

 

GetUVArrayRest()

Public function Const

const TManag...

 

GetVertexArray()

Vertices Group.

Public function

TManagedArra...

 

GetVertexArrayCopyOnWrite()

Public function Const

const TManag...

 

GetVertexArrayRest()

Public function Const

const TManag...

 

GetVertexCountArray()

Public function

TManagedArra...

 

GetVertexCountArrayCopyOnWrite()

Public function Const

const TManag...

 

GetVertexCountArrayRest()

Public function Const

const TManag...

 

GetVertexStartArray()

Public function

TManagedArra...

 

GetVertexStartArrayCopyOnWrite()

Public function Const

const TManag...

 

GetVertexStartArrayRest()

Public function Const

const TManag...

 

GetVisibleArray()

Public function

TManagedArra...

 

GetVisibleArrayCopyOnWrite()

Public function Const

const TManag...

 

GetVisibleArrayRest()

Protected function Const

void

 

InitConstantData

(
    FGeometryCollectionConstantData...
)

Populate the static geometry structures for the render thread.

Protected function

void

 

InitDynamicData

(
    FGeometryCollectionDynamicData*...
)

Populate the dynamic particle data for the render thread.

Public function Virtual

void

 

NotifyBreak

(
    const FChaosBreakEvent& Event
)

Overrideable native notification

Public function

void

 

ReceivePhysicsCollision

(
    const FChaosPhysicsCollisionInfo& ...
)

Protected function

void

 

RegisterForEvents()

Public function

void

 

ResetBoneColorArrayDynamic()

Public function

void

 

ResetBoneMapArrayDynamic()

Public function

void

 

ResetBoneNameArrayDynamic()

Public function

void

 

ResetBoundingBoxArrayDynamic()

Public function

void

 

ResetChildrenArrayDynamic()

Public function

void

 

ResetColorArrayDynamic()

Protected function

void

 

ResetDynamicCollection()

Reset the dynamic collection from the current rest state.

Public function

void

 

ResetFaceCountArrayDynamic()

Public function

void

 

ResetFaceStartArrayDynamic()

Public function

void

 

ResetIndicesArrayDynamic()

Public function

void

 

ResetInnerRadiusArrayDynamic()

Public function

void

 

ResetMaterialIDArrayDynamic()

Public function

void

 

ResetMaterialIndexArrayDynamic()

Public function

void

 

ResetNormalArrayDynamic()

Public function

void

 

ResetOuterRadiusArrayDynamic()

Public function

void

 

ResetParentArrayDynamic()

Public function

void

 

ResetSectionsArrayDynamic()

Public function

void

 

ResetSimulationTypeArrayDynamic()

Public function

void

 

ResetStatusFlagsArrayDynamic()

Public function

void

 

ResetTangentUArrayDynamic()

Public function

void

 

ResetTangentVArrayDynamic()

Public function

void

 

ResetTransformArrayDynamic()

Public function

void

 

ResetTransformIndexArrayDynamic()

Public function

void

 

ResetTransformToGeometryIndexArrayDynamic()

Public function

void

 

ResetUVArrayDynamic()

Public function

void

 

ResetVertexArrayDynamic()

Public function

void

 

ResetVertexCountArrayDynamic()

Public function

void

 

ResetVertexStartArrayDynamic()

Public function

void

 

ResetVisibleArrayDynamic()

Public function

void

 

SetNotifyBreaks

(
    bool bNewNotifyBreaks
)

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

Public function

void

 

SetRenderStateDirty()

Public function

void

 

SetRestCollection

(
    const UGeometryCollection* Res...
)

RestCollection

Public function

void

 

SetShowBoneColors

(
    bool ShowBoneColorsIn
)

Protected function

void

 

UpdateBreakEventRegistration()

Protected function

void

 

UpdateRBCollisionEventRegistration()

Overridden from UPrimitiveComponent

Name Description

Public function Virtual

FPrimitiveSc...

 

CreateSceneProxy()

Creates a proxy to represent the primitive to the scene manager in the rendering thread.

Public function Virtual Const

FBodyInstanc...

 

GetBodyInstance

(
    FName BoneName,
    bool bGetWelded
)

Returns BodyInstance of the component.

Public function Virtual Const

UMaterialInt...

 

GetMaterial

(
    int32 ElementIndex
)

Returns the material used by the element at the specified index

Public function Virtual Const

int32

 

GetNumMaterials()

Return number of material elements in this primitive

Public function Virtual

void

 

SetNotifyRigidBodyCollision

(
    bool bNewNotifyRigidBodyCollision
)

Changes the value of bNotifyRigidBodyCollision

Overridden from USceneComponent

Name Description

Public function Virtual Const

FBoxSphereBo...

 

CalcBounds

(
    const FTransform& LocalToWorld
)

Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size.

Public function Virtual Const

FBoxSphereBo...

 

CalcLocalBounds()

Calculate the local bounds of the component.

Public function Virtual Const

bool

 

HasAnySockets()

Returns true if this component has any sockets

Overridden from UActorComponent

Name Description

Public function Virtual

void

 

BeginPlay()

Used to detach physics objects before simulation begins.

Public function Virtual

void

 

CreateRenderState_Concurrent()

Used to create any rendering thread information for this component

Public function Virtual

void

 

EndPlay

(
    EEndPlayReason::Type EndPlayReason
)

Ends gameplay for this component.

Public function Virtual Const

bool

 

HasValidPhysicsState()

Used to check that DestroyPhysicsState() is working correctly

Public function Virtual

void

 

OnCreatePhysicsState()

Used to create any physics engine information for this component

Public function Virtual

void

 

OnDestroyPhysicsState()

Used to shut down and physics engine structure for this component

Public function Virtual

void

 

OnRegister()

Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.

Public function Virtual

void

 

SendRenderDynamicData_Concurrent()

Called to send dynamic data for this component to the rendering thread

Public function Virtual Const

bool

 

ShouldCreatePhysicsState()

Return true if CreatePhysicsState() should be called.

Public function Virtual

void

 

TickComponent

(
    float DeltaTime,
    enum ELevelTick TickType,
    FActorComponentTickFunction* T...
)

Function called every frame on this ActorComponent.

Overridden from IChaosNotifyHandlerInterface

Name Description

Public function Virtual

void

 

DispatchChaosPhysicsCollisionBlueprintEvents

(
    const FChaosPhysicsCollisionInfo& ...
)

Implementing classes should override to dispatch whatever blueprint events they choose to offer

Classes

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback