Class ParticleDepthCollisionSettings

@}

@{

Hierarchy

FrameworkObject
- ParticleDepthCollisionSettings

Index

Constructors

Accessors

dampening isEnabled radiusScale restitution

Methods

markAsDirty modify

Constructors

constructor

new ParticleDepthCollisionSettings(isInternalConstructor?): ParticleDepthCollisionSettings
Parameters
- OptionalisInternalConstructor: boolean
Returns ParticleDepthCollisionSettings
Overrides FrameworkObject.constructor

Accessors

dampening

get dampening(): number
Determines how much velocity should a particle lose after a collision, in percent of its current velocity. In range [0, 1].

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

isEnabled

get isEnabled(): boolean
Determines if depth collisions are enabled.

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

radiusScale

get radiusScale(): number
Scale which to apply to particle size in order to determine the collision radius.

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

restitution

get restitution(): number
Determines the elasticity (bounciness) of the particle collision. Lower values make the collision less bouncy and higher values more.

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

Methods

markAsDirty

markAsDirty(dirtyFlags): void
Marks the object as dirty.
Parameters
- dirtyFlags: EnumValue<ManagedSettingsDirtyFlag, number>
  Flags specifying what kind of member was changed.
Returns void

modify

modify(action): void
Allows modifying this object multiple times in a row in a scope, without marking the object dirty immediately. Dirty flags are accumulated and the object is marked dirty at the end.
Parameters
- action: (() => void)
  The scope where the object is modified.
  - - (): void
    - Returns void
Returns void