References

behaviour

summary
public	C Alpha Behaviour that applies an alpha transition effect to particles.
public	C Attraction Behaviour that causes particles to be attracted to a target position.
public	C Behaviour The base behaviour class.
public	C Collision Behaviour that causes particles to move away from other particles they collide with.
public	C Color A behaviour which mutates the color of a particle over time.
public	C CrossZone Behaviour that allows for specific functions to be called on particles when they interact with a zone.
public	C Force Behaviour that forces particles along a specific axis.
public	C Gravity Behaviour that forces particles down the y axis.
public	C RandomDrift Behaviour that causes particles to drift to random coordinates in 3D space.
public	C Repulsion Behaviour that causes particles to be repelled from a target position.
public	C Rotate Behaviour that rotates particles.
public	C Scale Behaviour that scales particles.
public	C Spring Behaviour that causes particles to spring.
public	V DEFAULT_ATTRACITON_RADIUS: number
public	V DEFAULT_ATTRACTION_FORCE_SCALAR: number
public	V DEFAULT_BEHAVIOUR_EASING: *
public	V DEFAULT_BEHAVIOUR_EASING_TYPE: string
public	V DEFAULT_CROSS_TYPE: string
public	V DEFAULT_LIFE: *
public	V DEFAULT_RANDOM_DRIFT_DELAY: number
public	V PARTICLE_ALPHA_THRESHOLD: number
public	V PARTICLE_LENGTH_SQ_THRESHOLD: number
public	V BEHAVIOUR_TYPE_ABSTRACT: string
public	V BEHAVIOUR_TYPE_ALPHA: string
public	V BEHAVIOUR_TYPE_ATTRACTION: string
public	V BEHAVIOUR_TYPE_COLLISION: string
public	V BEHAVIOUR_TYPE_COLOR: string
public	V BEHAVIOUR_TYPE_CROSS_ZONE: string
public	V BEHAVIOUR_TYPE_FORCE: string
public	V BEHAVIOUR_TYPE_GRAVITY: string
public	V BEHAVIOUR_TYPE_RANDOM_DRIFT: string
public	V BEHAVIOUR_TYPE_REPULSION: string
public	V BEHAVIOUR_TYPE_ROTATE: string
public	V BEHAVIOUR_TYPE_SCALE: string
public	V BEHAVIOUR_TYPE_SPRING: string

constants

summary
private	F __DEV__(): boolean
public	V BIND_EMITTER_EVENT: boolean
public	V DR: *
public	V EULER: string
public	V MEASURE: number 1:100
public	V PI: number
public	V POOL_MAX: number The max particle number in pool.
public	V RK2: string
public	V RK4: string
public	V TIME_STEP: number
public	V VERLET: string

core

summary
public	C Particle A Particle is an object that is emitted by an emitter.
public	C Pool An object pool implementation.
public	C System The core of the three-system particle engine.
public	F fromJSON(json: object, THREE: object, System: function, Emitter: function): System this function was deprecated. Use fromJSONAsync instead. Creates a System instance from a JSON object.
public	F fromJSONAsync(json: object, THREE: object, System: function, Emitter: function, options: object): Promise<System> Creates a System instance from a JSON object.
public	V DEFAULT_AGE: number Default particle age
public	V DEFAULT_ALPHA: number Default particle alpha
public	V DEFAULT_BODY: object Default particle body
public	V DEFAULT_DEAD: boolean Default particle dead
public	V DEFAULT_EASING: function Default particle easing
public	V DEFAULT_ENERGY: number Default particle energy
public	V DEFAULT_INDEX: number Default particle index
public	V DEFAULT_LIFE: number Default particle life
public	V DEFAULT_MASS: number Default particle mass
public	V DEFAULT_PARENT: Emitter Default particle parent
public	V DEFAULT_RADIUS: number Default particle radius
public	V DEFAULT_SCALE: number Default particle scale
public	V DEFAULT_SLEEP: boolean Default particle sleep
public	V DEFAULT_SYSTEM_DELTA: number The default delta provided to the System instance
public	V DEFAULT_USE_ALPHA: boolean Default particle useAlpha
public	V DEFAULT_USE_COLOR: boolean Default particle useColor
public	V SUPPORTED_JSON_BEHAVIOUR_TYPES: array<string> The types of behaviours supported by the System.fromJSON method.
public	V SUPPORTED_JSON_INITIALIZER_TYPES: array<string> The types of initializers supported by the System.fromJSON method.
public	V SUPPORTED_JSON_RENDERER_TYPES: array<string> The types of renderers supported by the System.fromJSON method.
public	V SUPPORTED_JSON_ZONE_TYPES: array<string> The types of zones supported by the System.fromJSON method.
public	V CORE_TYPE_PARTICLE: string
public	V CORE_TYPE_POOL: string
public	V CORE_TYPE_SYSTEM: string

core/three

summary
public	F Euler(x: , y: , z: , order: )
public	F Matrix4()
public	F Quaternion(x: , y: , z: , w: )
public	F Vector3(x: , y: , z: *)
private	V _Math: {"DEG2RAD": , "RAD2DEG": , "generateUUID": , "clamp": , "euclideanModulo": , "mapLinear": , "lerp": , "smoothstep": , "smootherstep": , "randInt": , "randFloat": , "randFloatSpread": , "degToRad": , "radToDeg": , "isPowerOfTwo": , "ceilPowerOfTwo": , "floorPowerOfTwo": *}
public	V ACESFilmicToneMapping: number
public	V AddEquation: number
public	V AddOperation: number
public	V AdditiveBlending: number
public	V AlphaFormat: number
public	V AlwaysDepth: number
public	V BackSide: number
public	V BasicDepthPacking: number
public	V BasicShadowMap: number
public	V ByteType: number
public	V CineonToneMapping: number
public	V ClampToEdgeWrapping: number
public	V CubeReflectionMapping: number
public	V CubeRefractionMapping: number
public	V CubeUVReflectionMapping: number
public	V CubeUVRefractionMapping: number
public	V CullFaceBack: number
public	V CullFaceFront: number
public	V CullFaceFrontBack: number
public	V CullFaceNone: number
public	V CustomBlending: number
public	V DepthFormat: number
public	V DepthStencilFormat: number
public	V DoubleSide: number
public	V DstAlphaFactor: number
public	V DstColorFactor: number
public	V EqualDepth: number
public	V EquirectangularReflectionMapping: number
public	V EquirectangularRefractionMapping: number
public	V FaceColors: number
public	V FlatShading: number
public	V FloatType: number
public	V FrontFaceDirectionCCW: number
public	V FrontFaceDirectionCW: number
public	V FrontSide: number
public	V GammaEncoding: number
public	V GreaterDepth: number
public	V GreaterEqualDepth: number
public	V HalfFloatType: number
public	V IntType: number
public	V InterpolateDiscrete: number
public	V InterpolateLinear: number
public	V InterpolateSmooth: number
public	V LessDepth: number
public	V LessEqualDepth: number
public	V LinearEncoding: number
public	V LinearFilter: number
public	V LinearMipMapLinearFilter: number
public	V LinearMipMapNearestFilter: number
public	V LinearToneMapping: number
public	V LogLuvEncoding: number
public	V LoopOnce: number
public	V LoopPingPong: number
public	V LoopRepeat: number
public	V LuminanceAlphaFormat: number
public	V LuminanceFormat: number
public	V MOUSE: {"LEFT": *, "MIDDLE": number, "RIGHT": number}
public	V MaxEquation: number
public	V MinEquation: number
public	V MirroredRepeatWrapping: number
public	V MixOperation: number
public	V MultiplyBlending: number
public	V MultiplyOperation: number
public	V NearestFilter: number
public	V NearestMipMapLinearFilter: number
public	V NearestMipMapNearestFilter: number
public	V NeverDepth: number
public	V NoBlending: number
public	V NoColors: number
public	V NoToneMapping: number
public	V NormalBlending: number
public	V NotEqualDepth: number
public	V ObjectSpaceNormalMap: number
public	V OneFactor: number
public	V OneMinusDstAlphaFactor: number
public	V OneMinusDstColorFactor: number
public	V OneMinusSrcAlphaFactor: number
public	V OneMinusSrcColorFactor: number
public	V PCFShadowMap: number
public	V PCFSoftShadowMap: number
public	V REVISION: string
public	V RGBADepthPacking: number
public	V RGBAFormat: number
public	V RGBA_ASTC_10x10_Format: number
public	V RGBA_ASTC_10x5_Format: number
public	V RGBA_ASTC_10x6_Format: number
public	V RGBA_ASTC_10x8_Format: number
public	V RGBA_ASTC_12x10_Format: number
public	V RGBA_ASTC_12x12_Format: number
public	V RGBA_ASTC_4x4_Format: number
public	V RGBA_ASTC_5x4_Format: number
public	V RGBA_ASTC_5x5_Format: number
public	V RGBA_ASTC_6x5_Format: number
public	V RGBA_ASTC_6x6_Format: number
public	V RGBA_ASTC_8x5_Format: number
public	V RGBA_ASTC_8x6_Format: number
public	V RGBA_ASTC_8x8_Format: number
public	V RGBA_PVRTC_2BPPV1_Format: number
public	V RGBA_PVRTC_4BPPV1_Format: number
public	V RGBA_S3TC_DXT1_Format: number
public	V RGBA_S3TC_DXT3_Format: number
public	V RGBA_S3TC_DXT5_Format: number
public	V RGBDEncoding: number
public	V RGBEEncoding: number
public	V RGBEFormat: *
public	V RGBFormat: number
public	V RGBM16Encoding: number
public	V RGBM7Encoding: number
public	V RGB_ETC1_Format: number
public	V RGB_PVRTC_2BPPV1_Format: number
public	V RGB_PVRTC_4BPPV1_Format: number
public	V RGB_S3TC_DXT1_Format: number
public	V RedFormat: number
public	V ReinhardToneMapping: number
public	V RepeatWrapping: number
public	V ReverseSubtractEquation: number
public	V ShortType: number
public	V SmoothShading: number
public	V SphericalReflectionMapping: number
public	V SrcAlphaFactor: number
public	V SrcAlphaSaturateFactor: number
public	V SrcColorFactor: number
public	V SubtractEquation: number
public	V SubtractiveBlending: number
public	V TangentSpaceNormalMap: number
public	V TriangleFanDrawMode: number
public	V TriangleStripDrawMode: number
public	V TrianglesDrawMode: number
public	V UVMapping: number
public	V Uncharted2ToneMapping: number
public	V UnsignedByteType: number
public	V UnsignedInt248Type: number
public	V UnsignedIntType: number
public	V UnsignedShort4444Type: number
public	V UnsignedShort5551Type: number
public	V UnsignedShort565Type: number
public	V UnsignedShortType: number
public	V VertexColors: number
public	V WrapAroundEnding: number
public	V ZeroCurvatureEnding: number
public	V ZeroFactor: number
public	V ZeroSlopeEnding: number
public	V sRGBEncoding: number

debug

summary
public	F log(): * You can use this emit particles.
public	V DEFAULT_DEPTH: number
public	V DEFAULT_HEIGHT: number
public	V DEFAULT_POSITION: number
public	V DEFAULT_RADIUS: number
public	V DEFAULT_SIZE: number
public	V DEFAULT_WIDTH: number

ease

summary
public	F getEasingByName(name: *)
public	F setEasingByName(easeName: ):
public	V ease: {"easeLinear": , "easeInQuad": , "easeOutQuad": , "easeInOutQuad": , "easeInCubic": , "easeOutCubic": , "easeInOutCubic": , "easeInQuart": , "easeOutQuart": , "easeInOutQuart": , "easeInSine": , "easeOutSine": , "easeInOutSine": , "easeInExpo": , "easeOutExpo": , "easeInOutExpo": , "easeInCirc": , "easeOutCirc": , "easeInOutCirc": , "easeInBack": , "easeOutBack": , "easeInOutBack": } The Ease class provides a collection of easing functions for use with System
public	V easeLinear: *

emitter

summary
public	C Emitter Emitters are the System engine's particle factories. They cause particles to be rendered by emitting them, and store all particle initializers and behaviours.
public	C FollowEmitter
public	V DEFAULT_BIND_EMITTER: boolean
public	V DEFAULT_BIND_EMITTER_EVENT: boolean
public	V DEFAULT_DAMPING: number
public	V DEFAULT_EMITTER_INDEX: *
public	V DEFAULT_EMITTER_RATE: Rate
public	V EMITTER_TYPE_EMITTER: string
public	V EMITTER_TYPE_FOLLOW: string

events

summary
public	C EventDispatcher
public	V EMITTER_ADDED: string
public	V EMITTER_DEAD: string
public	V EMITTER_REMOVED: string
public	V PARTICLE_CREATED: string
public	V PARTICLE_DEAD: string
public	V PARTICLE_UPDATE: string
public	V SYSTEM_UPDATE: string
public	V SYSTEM_UPDATE_AFTER: string

initializer

summary
public	C Body Sets the body property on initialized particles.
public	C BodySprite Sets the body property to be a THREE.Sprite on initialized particles.
public abstract	C Initializer The base Emitter / Particle property class.
public	C Life Sets the life property on initialized particles.
public	C Mass Sets the mass property on initialized particles.
public	C Position Sets the starting position property for initialized particles.
public	C Radius Sets the radius property on initialized particles.
public	C Rate Calculates the rate of particle emission.
public	C Rotation Sets the rotation property on initialized particles.
public	C Texture Sets the body property to be a THREE.Sprite with a texture map on initialized particles.
public	V DEFAULT_JSON_MATERIAL_PROPERTIES: {...DEFAULT_MATERIAL_PROPERTIES: Object, "blending": string}
public	V DEFAULT_MATERIAL_PROPERTIES: {"color": number, "blending": *, "fog": boolean}
public	V DEFAULT_RATE_NUM_PAN: number
public	V DEFAULT_RATE_TIME_PAN: number
public	V SUPPORTED_MATERIAL_BLENDING_MODES: {"AdditiveBlending": , "CustomBlending": , "MultiplyBlending": , "NoBlending": , "NormalBlending": , "SubtractiveBlending": }
public	V INITIALIZER_TYPES_THAT_REQUIRE_THREE: undefined[]
public	V INITIALIZER_TYPE_ABSTRACT: string
public	V INITIALIZER_TYPE_BODY: string
public	V INITIALIZER_TYPE_BODY_SPRITE: string
public	V INITIALIZER_TYPE_LIFE: string
public	V INITIALIZER_TYPE_MASS: string
public	V INITIALIZER_TYPE_POLAR_VELOCITY: string
public	V INITIALIZER_TYPE_POSITION: string
public	V INITIALIZER_TYPE_RADIAL_VELOCITY: string
public	V INITIALIZER_TYPE_RADIUS: string
public	V INITIALIZER_TYPE_RATE: string
public	V INITIALIZER_TYPE_ROTATION: string
public	V INITIALIZER_TYPE_TEXTURE: string
public	V INITIALIZER_TYPE_VECTOR_VELOCITY: string
public	V INITIALIZER_TYPE_ZONE: string

initializer/Velocity

summary
public	C PolarVelocity Sets the velocity property on initialized particles.
public	C RadialVelocity Sets the velocity property on initialized particles.
public	C VectorVelocity Sets the velocity property on initialized particles.
public	C Velocity Abstract class for Velocity initializers.

math

summary
public	C ArraySpan Class for storing items of mixed type and fetching a randomised value from these items.
public	C Box
public	C ColorSpan Class for storing and interacting with an array of colours.
public	C Polar3D
public	C Span
public	C Vector3D
public	F createArraySpan(items: mixed): ArraySpan Attempts to create an ArraySpan from the items provided.
public	F createColorSpan(colors: mixed): ColorSpan Attempts to create an ArraySpan from the colors provided.
public	F createSpan(a: , b: , c: ):
public	F integrate(particle: Particle, time: number, damping: number, type: string): * Performs the chosen integration on the particle.
public	V INTEGRATION_TYPE_EULER: string
public	V INTEGRATION_TYPE_RK2: string
public	V INTEGRATION_TYPE_RK4: string
public	V INTEGRATION_TYPE_VERLET: string
public	V MATH_TYPE_ARRAY_SPAN: string
public	V MATH_TYPE_BOX: string
public	V MATH_TYPE_COLOR_SPAN: string
public	V MATH_TYPE_POLAR_3D: string
public	V MATH_TYPE_SPAN: string
public	V MATH_TYPE_VECTOR_3D: string

renderer

summary
public	C BaseRenderer
public	C CustomRenderer
public	C MeshRenderer
public	C SpriteRenderer
public	V RENDERER_TYPE_BASE: string
public	V RENDERER_TYPE_CUSTOM: string
public	V RENDERER_TYPE_GPU: string
public	V RENDERER_TYPE_GPU_DESKTOP: string
public	V RENDERER_TYPE_GPU_MOBILE: string
public	V RENDERER_TYPE_MESH: string
public	V RENDERER_TYPE_SPRITE: string

renderer/GPURenderer

summary
public	C GPURenderer Performant particle renderer that uses THREE.Points to propagate particle (postiion, rgba etc.,) properties to vertices in a ParticleBufferGeometry.

renderer/GPURenderer/Desktop

summary
public	C DesktopGPURenderer GPURenderer for devices that support floating point textures.

renderer/GPURenderer/Desktop/shaders

summary
public	F fragmentShader(): string
public	F vertexShader(): string

renderer/GPURenderer/Mobile

summary
public	C MobileGPURenderer GPURenderer for mobile devices that do not support floating point textures.

renderer/GPURenderer/Mobile/shaders

summary
public	F fragmentShader(): string
public	F vertexShader(): string

renderer/GPURenderer/common

summary
public	V DEFAULT_RENDERER_OPTIONS: {"blending": string, "baseColor": number, "depthTest": boolean, "depthWrite": , "transparent": boolean, "maxParticles": , "shouldDebugTextureAtlas": , "shouldForceDesktopRenderer": , "shouldForceMobileRenderer": *}

renderer/GPURenderer/common/ParticleBuffer

summary
public	C ParticleBuffer Creates and provides performant buffers for mapping particle properties to geometry vertices.
public	V ALL_BYTE_SIZES: undefined[]
public	V ALPHA_ATTRIBUTE_BUFFER_SIZE: number
public	V ATTRIBUTE_TO_SIZE_MAP: {"position": , "rotation": , "size": , "color": , "alpha": , "texID": }
public	V DEFAULT_MAX_PARTICLES: number
public	V FLOAT_BYTE_SIZE: number
public	V PARTICLE_BYTE_SIZE: *
public	V PARTICLE_STRIDE: *
public	V POSITION_ATTRIBUTE_BUFFER_SIZE: *
public	V POSITION_BYTE_SIZE: *
public	V RGBA_ATTRIBUTE_BUFFER_SIZE: *
public	V RGBA_BYTE_SIZE: *
public	V RGBA_SIZE: *
public	V ROTATION_ATTRIBUTE_BUFFER_SIZE: number
public	V ROTATION_BYTE_SIZE: *
public	V SIZE_ATTRIBUTE_BUFFER_SIZE: number
public	V SIZE_BYTE_SIZE: *
public	V TEXID_ATTRIBUTE_BUFFER_SIZE: number
public	V VECTOR_3_SIZE: *

renderer/GPURenderer/common/TextureAtlas

summary
public	C TextureAtlas Dynamic texture atlas for performant support of systems with multiple emitters and textures.
public	V DATA_TEXTURE_SIZE: number

renderer/GPURenderer/common/shaders

summary
public	V SIZE_ATTENUATION_FACTOR: string

renderer/GPURenderer/common/stores

summary
public	C Target Simple class that stores the particle's "target" or "next" state.
public	C UniqueList Map of particle IDs to integer ids

utils

summary
public	F withDefaults(defaults: , properties: )

zone

summary
public	C BoxZone
public	C LineZone
public	C MeshZone Uses a three THREE.Geometry to determine the zone parameters.
public	C PointZone
public	C ScreenZone
public	C SphereZone A spherical zone for particles to be emitted within.
public abstract	C Zone A Zone determines the area in 3D space where an emitter's particles can position themselves. They are supplied to both the Position initializer and the CrossZone behaviour.
public	V ZONE_TYPE_ABSTRACT: string
public	V ZONE_TYPE_BOX: string
public	V ZONE_TYPE_LINE: string
public	V ZONE_TYPE_MESH: string
public	V ZONE_TYPE_POINT: string
public	V ZONE_TYPE_SCREEN: string
public	V ZONE_TYPE_SPHERE: string

Directories