Class ParticleCollisions

Particle evolver that allows particles to collide with the world.

Hierarchy (View Summary)

ParticleEvolver
- ParticleCollisions

Index

Constructors

Accessors

options planeObjects planes

Constructors

constructor

new ParticleCollisions(
information: ParticleCollisionsOptions,
isInternalConstructor?: boolean,
): ParticleCollisions
Creates a new particle collision evolver.
Parameters
- information: ParticleCollisionsOptions
- OptionalisInternalConstructor: boolean
Returns ParticleCollisions

Overrides ParticleEvolver.constructor
new ParticleCollisions(): ParticleCollisions

Creates a new particle collision evolver.

Returns ParticleCollisions

Overrides ParticleEvolver.constructor

Accessors

options

get options(): ParticleCollisionsOptions

Options describing the evolver.

Returns ParticleCollisionsOptions
set options(value: ParticleCollisionsOptions): void
Parameters
- value: ParticleCollisionsOptions
Returns void

planeObjects

get planeObjects(): Iterable<SceneObject>

Determines a set of objects whose transforms to derive the collision planes from. Objects can move in the world and collision planes will be updated automatically. Object's negative Z axis is considered to be plane normal.

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

planes

get planes(): Iterable<Plane>

Determines a set of planes to use when using the Plane collision mode. Planes are expected to be in world space.

Returns Iterable<Plane>
set planes(value: Iterable<Plane> | readonly Immutable<Plane>[]): void
Parameters
- value: Iterable<Plane> | readonly Immutable<Plane>[]
Returns void