Class FractureSettings

Settings that control how a mesh is fractured into pieces.

Constructors

constructor

new FractureSettings(
    mode?: EnumValue<FractureGenerationMode>,
    thickness?: number,
    generateHollow?: boolean,
    pieceCount?: number,
    seedMode?: EnumValue<FractureSeedMode>,
    randomSeed?: number,
    noiseStrength?: number,
    clusterCenterPoint?: Immutable<Vector3>,
    clusterRadius?: number,
    minimumPieceVolume?: number,
    maximumPieceVolume?: number,
    interiorUVScale?: number,
    lodLevelCount?: number,
    lodReductionFactor?: number,
    hierarchyLevels?: number,
    childrenPerPiece?: number,
): FractureSettings
Parameters
- Optionalmode: EnumValue<FractureGenerationMode>
- Optionalthickness: number
- OptionalgenerateHollow: boolean
- OptionalpieceCount: number
- OptionalseedMode: EnumValue<FractureSeedMode>
- OptionalrandomSeed: number
- OptionalnoiseStrength: number
- OptionalclusterCenterPoint: Immutable<Vector3>
- OptionalclusterRadius: number
- OptionalminimumPieceVolume: number
- OptionalmaximumPieceVolume: number
- OptionalinteriorUVScale: number
- OptionallodLevelCount: number
- OptionallodReductionFactor: number
- OptionalhierarchyLevels: number
- OptionalchildrenPerPiece: number
Returns FractureSettings

Properties

`Protected`_childrenPerPiece

_childrenPerPiece: number

`Protected`_clusterCenterPoint

_clusterCenterPoint: Vector3

`Protected`_clusterRadius

_clusterRadius: number

`Protected`_generateHollow

_generateHollow: boolean

`Protected`_hierarchyLevels

_hierarchyLevels: number

`Protected`_interiorUVScale

_interiorUVScale: number

`Protected`_lodLevelCount

_lodLevelCount: number

`Protected`_lodReductionFactor

_lodReductionFactor: number

`Protected`_maximumPieceVolume

_maximumPieceVolume: number

`Protected`_minimumPieceVolume

_minimumPieceVolume: number

`Protected`_mode

_mode: EnumValue<FractureGenerationMode>

`Protected`_noiseStrength

_noiseStrength: number

`Protected`_pieceCount

_pieceCount: number

`Protected`_randomSeed

_randomSeed: number

`Protected`_seedMode

_seedMode: EnumValue<FractureSeedMode>

`Protected`_thickness

_thickness: number

Accessors

childrenPerPiece

get childrenPerPiece(): number

Target number of children per piece when using hierarchical fracturing.

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

clusterCenterPoint

get clusterCenterPoint(): Vector3

If SeedMode is Clustered, the center point for the cluster seed points.

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

clusterRadius

get clusterRadius(): number

If SeedMode is Clustered, the cluster radius for seed points.

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

generateHollow

get generateHollow(): boolean

If Mode is Solid, fracture pieces that do not intersect the exterior will be discarded.

Returns boolean
set generateHollow(value: boolean): void
Parameters
- value: boolean
Returns void

hierarchyLevels

get hierarchyLevels(): number

Number of hierarchy levels for recursive fracturing. 1 = flat (no nesting), 2+ = nested pieces.

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

interiorUVScale

get interiorUVScale(): number

Interior UV scale for cut faces.

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

lodLevelCount

get lodLevelCount(): number

Number of LOD levels to generate for each piece. 1 = no additional LODs.

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

lodReductionFactor

get lodReductionFactor(): number

Reduction factor for each successive LOD level. E.g., 0.5 means each LOD has 50% of the triangles of the previous level.

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

maximumPieceVolume

get maximumPieceVolume(): number

Maximum volume for a piece (larger pieces are subdivided). Range: 0.0 to 1.0 (relative to original).

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

minimumPieceVolume

get minimumPieceVolume(): number

Minimum volume for a piece (smaller pieces are discarded). Range: 0.0 to 1.0 (relative to original).

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

mode

get mode(): EnumValue<FractureGenerationMode>

Control how geometry for fracture pieces is generated.

Returns EnumValue<FractureGenerationMode>
set mode(value: EnumValue<FractureGenerationMode>): void
Parameters
- value: EnumValue<FractureGenerationMode>
Returns void

noiseStrength

get noiseStrength(): number

If SeedMode is Uniform, the amount of noise/irregularity applied to fracture cuts. Range: 0.0 to 1.0.

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

pieceCount

get pieceCount(): number

Target number of pieces to generate.

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

randomSeed

get randomSeed(): number

Random seed for reproducible fracturing. Use 0 for random results each time.

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

seedMode

get seedMode(): EnumValue<FractureSeedMode>

How seed points are distributed for Voronoi decomposition.

Returns EnumValue<FractureSeedMode>
set seedMode(value: EnumValue<FractureSeedMode>): void
Parameters
- value: EnumValue<FractureSeedMode>
Returns void

thickness

get thickness(): number

Thickness of the skin when using Skin generation mode.

Returns number

Note
For proper rendering results, it is important to ensure that the skin thickness does not exceed the minimum distance between two opposite faces.
set thickness(value: number): void
Parameters
- value: number
Returns void

Methods

assign

assign(other: Immutable<FractureSettings>): FractureSettings
Copies all properties defined by the prototype of FractureSettings from other to this instance.
Parameters
- other: Immutable<FractureSettings>
Returns FractureSettings

clone

clone(): FractureSettings

Clones this instance and returns a new FractureSettings with identical values.

Returns FractureSettings

isEqual

isEqual(
this: Immutable<FractureSettings>,
other: Immutable<FractureSettings>,
): boolean
Determines if this FractureSettings instance is equal to the other instance.
Parameters
- this: Immutable<FractureSettings>
- other: Immutable<FractureSettings>
Returns boolean

`Static`isEqual

isEqual(
lhs: Immutable<FractureSettings>,
rhs: Immutable<FractureSettings>,
): boolean
Determines if both FractureSettings instances are equal.
Parameters
- lhs: Immutable<FractureSettings>
- rhs: Immutable<FractureSettings>
Returns boolean

Class FractureSettings

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns FractureSettings

Properties

Protected_childrenPerPiece

Protected_clusterCenterPoint

Protected_clusterRadius

Protected_generateHollow

Protected_hierarchyLevels

Protected_interiorUVScale

Protected_lodLevelCount

Protected_lodReductionFactor

Protected_maximumPieceVolume

Protected_minimumPieceVolume

Protected_mode

Protected_noiseStrength

Protected_pieceCount

Protected_randomSeed

Protected_seedMode

Protected_thickness

Accessors

childrenPerPiece

Returns number

Parameters

Returns void

clusterCenterPoint

Returns Vector3

Parameters

Returns void

clusterRadius

Returns number

Parameters

Returns void

generateHollow

Returns boolean

Parameters

Returns void

hierarchyLevels

Returns number

Parameters

Returns void

interiorUVScale

Returns number

Parameters

Returns void

lodLevelCount

Returns number

Parameters

Returns void

lodReductionFactor

Returns number

Parameters

Returns void

maximumPieceVolume

Returns number

Parameters

Returns void

minimumPieceVolume

Returns number

Parameters

Returns void

mode

Returns EnumValue<FractureGenerationMode>

Parameters

Returns void

noiseStrength

Returns number

Parameters

Returns void

pieceCount

Returns number

Parameters

Returns void

`Protected`_childrenPerPiece

`Protected`_clusterCenterPoint

`Protected`_clusterRadius

`Protected`_generateHollow

`Protected`_hierarchyLevels

`Protected`_interiorUVScale

`Protected`_lodLevelCount

`Protected`_lodReductionFactor

`Protected`_maximumPieceVolume

`Protected`_minimumPieceVolume

`Protected`_mode

`Protected`_noiseStrength

`Protected`_pieceCount

`Protected`_randomSeed

`Protected`_seedMode

`Protected`_thickness

`Static`isEqual