Class StaticParticles

Simulates a static particle field in whichever base reference the simulation is in.

Hierarchy

StaticParticles

Implements

SimulationObject

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new StaticParticles(id: string, points: Coordinate3d[], options: StaticParticleOptions, simulation: Simulation): StaticParticles

- Defined in StaticParticles.ts:39
Parameters
- id: string
  
  Unique ID for this object
- points: Coordinate3d[]
  
  an array of X,Y,Z cartesian points, one for each particle
- options: StaticParticleOptions
  
  container
- simulation: Simulation
  
  Simulation object
Returns StaticParticles

Properties

Private id

id: string

Private options

options: StaticParticleOptions

Private Optional pointObject

pointObject: Points<BufferGeometry, Material | Material[]>

Private points

points: Coordinate3d[]

Private simulation

simulation: Simulation

Methods

get3jsObjects

get3jsObjects(): Object3D[]

Implementation of SimulationObject.get3jsObjects
- Defined in StaticParticles.ts:101
A list of THREE.js objects that are used to compose the particle system.

Returns Object3D[]

Point geometry

getId

getId(): string

Implementation of SimulationObject.getId
- Defined in StaticParticles.ts:112
Get the unique ID of this object.

Returns string

id

init

init(): void

- Defined in StaticParticles.ts:59
Returns void

update

update(): void

Implementation of SimulationObject.update
- Defined in StaticParticles.ts:116
Returns void

Generated using TypeDoc