Class FracturePiece

Represents a single fractured piece of a mesh. Contains both rendering and physics data for the piece.

Physics and render meshes are stored directly, allowing them to be serialized and deserialized without reconstruction at activation time.

Constructors

`Protected`constructor

new FracturePiece(isInternalConstructor?: boolean): FracturePiece
Parameters
- OptionalisInternalConstructor: boolean
Returns FracturePiece

Overrides FrameworkObject.constructor

Accessors

childCount

get childCount(): number

Gets the direct child count.

Returns number

children

get children(): Iterable<FracturePiece>

Sets the children of this piece.

Returns Iterable<FracturePiece>
set children(value: Iterable<FracturePiece> | readonly FracturePiece[]): void
Parameters
- value: Iterable<FracturePiece> | readonly FracturePiece[]
Returns void

hierarchyLevel

get hierarchyLevel(): number

Sets the hierarchy level.

Returns number
set hierarchyLevel(value: number): void
Parameters
- value: number
Returns void

isDataActivated

get isDataActivated(): boolean

Returns true if the meshes have been activated.

Returns boolean

isPhysicsMeshDataAvailable

get isPhysicsMeshDataAvailable(): boolean

Returns true if the piece has valid physics data.

Returns boolean

localBounds

get localBounds(): Immutable<AABox>

Sets the local bounds.

Returns Immutable<AABox>
set localBounds(value: Immutable<AABox>): void
Parameters
- value: Immutable<AABox>
Returns void

localCenter

get localCenter(): Immutable<Vector3>

Sets the local center.

Returns Immutable<Vector3>
set localCenter(value: Immutable<Vector3>): void
Parameters
- value: Immutable<Vector3>
Returns void

lodMeshes

get lodMeshes(): Iterable<ResourceHandle<Mesh>>

Gets the activated LOD mesh handles.

Returns Iterable<ResourceHandle<Mesh>>

Note
Index 0 is highest detail, subsequent indices are lower detail. Only valid after ActivateMeshes() has been called.

mass

get mass(): number

Sets the mass.

Returns number
set mass(value: number): void
Parameters
- value: number
Returns void

physicsMesh

get physicsMesh(): PhysicsMesh

Gets the activated physics mesh handle.

Returns PhysicsMesh

Note
Only valid after ActivateMeshes() has been called.

physicsMeshHandle

get physicsMeshHandle(): ResourceHandle<PhysicsMesh>

Gets the activated physics mesh handle.

Returns ResourceHandle<PhysicsMesh>

Note
Only valid after ActivateMeshes() has been called.

renderMesh

get renderMesh(): Mesh

Gets the activated render mesh handle (LOD 0).

Returns Mesh

Note
Only valid after ActivateMeshes() has been called.

renderMeshHandle

get renderMeshHandle(): ResourceHandle<Mesh>

Gets the activated render mesh handle (LOD 0).

Returns ResourceHandle<Mesh>

Note
Only valid after ActivateMeshes() has been called.

volume

get volume(): number

Sets the volume.

Returns number
set volume(value: number): void
Parameters
- value: number
Returns void

Methods

activateChildMeshes

activateChildMeshes(): void

Activates meshes for all immediate children.

Returns void

Note
Call this when this piece is about to break to prepare the next level of hierarchy for rendering/physics. This is the lazy activation pattern - only activate one level ahead.

activateMeshes

activateMeshes(): void

Activates the render and physics meshes from the stored mesh data. Creates HMesh handles for rendering and HPhysicsMesh for collision.

Returns void

Note
This must be called before assigning to Renderable or Collider components.

addChild

addChild(child: FracturePiece): void
Adds a child piece.
Parameters
- child: FracturePiece
Returns void

getMeshDataForLODIndex

getMeshDataForLODIndex(lodIndex: number): MeshData
Gets the mesh data for the specified lod level.
Parameters
- lodIndex: number
Returns MeshData

Note
Index 0 is highest detail (base mesh), subsequent indices are lower detail.

getTotalDescendantCount

getTotalDescendantCount(): number

Gets the child count including children of children.

Returns number

hasChildren

hasChildren(): boolean

Returns true if this piece has children.

Returns boolean