Fork me on GitHub

API Documentation


Extends GLGE.Animatable, GLGE.Placeable.
A texture to be included in a material
Defined in: glge_particles.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Method Summary
Method Attributes Method Name and Description
 
The particles acceleration function used to generate the initial particles accelerations
 
The particles color function used to generate the initial colors
 
The particles life time function used to generate the initial lifetimes
 
The particles position function used to generate the initial positions
 
Resets the particle system
 
Sets a new acceleration function for this particle system
 
Sets a new color function for this particle system
 
Sets the ending acceleration in the all direction
 
setEndAccX(value)
Sets the ending acceleration in the X direction
 
setEndAccY(value)
Sets the ending acceleration in the Y direction
 
setEndAccZ(value)
Sets the ending acceleration in the Z direction
 
setEndColor(value)
Sets the ending color of the particle
 
setEndSize(value)
Sets the ending size of the particle
 
setImage(url)
Sets the particle image
 
setLifeTime(value)
Sets the particles lifetime
 
setLoop(value)
Show the paricle system loop
 
Sets the maximum ending acceleration in the all direction
 
Sets the maximum ending acceleration in the X direction
 
Sets the maximum ending acceleration in the Y direction
 
Sets the maximum ending acceleration in the Z direction
 
Sets the particles maximum lifetime
 
Sets the max starting acceleration in the all direction
 
Sets the max starting acceleration in the X direction
 
Sets the max starting acceleration in the Y direction
 
Sets the max starting acceleration in the Z direction
 
setMaxVelocity(x, y, z)
Sets the max velocity in the all direction
 
setMaxVelX(value)
Sets the max velocity in the X direction
 
setMaxVelY(value)
Sets the max velocity in the Y direction
 
setMaxVelZ(value)
Sets the max velocity in the Z direction
 
Sets the minimum ending acceleration in the all direction
 
Sets the minimum ending acceleration in the X direction
 
Sets the minimum ending acceleration in the Y direction
 
Sets the minimum ending acceleration in the Z direction
 
Sets the particles minimum lifetime
 
Sets the min starting acceleration in the all direction
 
Sets the min starting acceleration in the X direction
 
Sets the min starting acceleration in the Y direction
 
Sets the min starting acceleration in the Z direction
 
setMinVelocity(x, y, z)
Sets the min velocity in the all direction
 
setMinVelX(value)
Sets the min velocity in the X direction
 
setMinVelY(value)
Sets the min velocity in the Y direction
 
setMinVelZ(value)
Sets the min velocity in the Z direction
 
Sets the total number of particles
 
Sets a new position function for this particle system
 
Sets a new size function for this particle system
 
Sets the starting acceleration in the all direction
 
setStartAccX(value)
Sets the starting acceleration in the X direction
 
setStartAccY(value)
Sets the starting acceleration in the Y direction
 
setStartAccZ(value)
Sets the starting acceleration in the Z direction
 
Sets the starting color of the particle
 
setStartSize(value)
Sets the starting size of the particle
 
setVelocity(x, y, z)
Sets the velocity in the all direction
 
Sets a new velocity function for this particle system
 
setVelX(value)
Sets the velocity in the X direction
 
setVelY(value)
Sets the velocity in the Y direction
 
setVelZ(value)
Sets the velocity in the Z direction
 
The particles size function used to generate the initial sizes
 
The particles velocity function used to generate the initial particles velocities
Methods borrowed from class GLGE.Placeable:
clearStaticMatrix, getDLocX, getDLocY, getDLocZ, getDRotX, getDRotY, getDRotZ, getDScaleX, getDScaleY, getDScaleZ, getId, getInverseModelMatrix, getLocalMatrix, getLocX, getLocY, getLocZ, getLookat, getModelMatrix, getPosition, getQuatW, getQuatX, getQuatY, getQuatZ, getRef, getRoot, getRotation, getRotMatrix, getRotOrder, getRotX, getRotY, getRotZ, getScale, getScaleMatrix, getScaleX, getScaleY, getScaleZ, getTranslateMatrix, getTransposeInverseModelMatrix, getTransposeModelMatrix, getUpAxis, Lookat, move, setDLoc, setDLocX, setDLocY, setDLocZ, setDRot, setDRotX, setDRotY, setDRotZ, setDScale, setDScaleX, setDScaleY, setDScaleZ, setId, setLoc, setLocX, setLocY, setLocZ, setLookat, setQuat, setQuatW, setQuatX, setQuatY, setQuatZ, setRot, setRotMatrix, setRotOrder, setRotX, setRotY, setRotZ, setScale, setScaleX, setScaleY, setScaleZ, setStaticMatrix, setTransformMode, setUpAxis
Methods borrowed from class GLGE.Animatable:
animate, blendTo, getAnimation, getBlendFunction, getFrameNumber, getFrameRate, getLoop, getName, getPaused, isLooping, setAnimation, setBlendFunction, setFrameRate, setName, setPaused, setStartFrame, togglePaused
Methods borrowed from class GLGE.Events:
addEventListener, fireEvent, removeEventListener
Events borrowed from class GLGE.Placeable:
appened, childMatrixUpdate, matrixUpdate, removed
Events borrowed from class GLGE.Animatable:
animFinished
Class Detail
GLGE.ParticleSystem(uid)
Parameters:
{string} uid
the unique id for this texture
Method Detail
accelerationFunction(i)
The particles acceleration function used to generate the initial particles accelerations
Parameters:
i

colorFunction(i)
The particles color function used to generate the initial colors
Parameters:
i

lifeTimeFunction(i)
The particles life time function used to generate the initial lifetimes
Parameters:
i

positionFunction(i)
The particles position function used to generate the initial positions
Parameters:
i

reset()
Resets the particle system

setAccelerationFunction(func)
Sets a new acceleration function for this particle system
Parameters:
{function} func
the new function

setColorFunction(func)
Sets a new color function for this particle system
Parameters:
{function} func
the new function

setEndAccelertaion(x, y, z)
Sets the ending acceleration in the all direction
Parameters:
{number} x
the minimum velocity in x axis
{number} y
the minimum velocity in y axis
{number} z
the minimum velocity in z axis

setEndAccX(value)
Sets the ending acceleration in the X direction
Parameters:
{number} value
the acceleration

setEndAccY(value)
Sets the ending acceleration in the Y direction
Parameters:
{number} value
the acceleration

setEndAccZ(value)
Sets the ending acceleration in the Z direction
Parameters:
{number} value
the acceleration

setEndColor(value)
Sets the ending color of the particle
Parameters:
{number} value
the end color

setEndSize(value)
Sets the ending size of the particle
Parameters:
{number} value
the end size

setImage(url)
Sets the particle image
Parameters:
{string} url
the image url

setLifeTime(value)
Sets the particles lifetime
Parameters:
{number} value
the particles life time

setLoop(value)
Show the paricle system loop
Parameters:
{boolean} value
the lopping flag

setMaxEndAccelertaion(x, y, z)
Sets the maximum ending acceleration in the all direction
Parameters:
{number} x
the maximum velocity in x axis
{number} y
the maximum velocity in y axis
{number} z
the maximum velocity in z axis

setMaxEndAccX(value)
Sets the maximum ending acceleration in the X direction
Parameters:
{number} value
the maximum acceleration

setMaxEndAccY(value)
Sets the maximum ending acceleration in the Y direction
Parameters:
{number} value
the maximum acceleration

setMaxEndAccZ(value)
Sets the maximum ending acceleration in the Z direction
Parameters:
{number} value
the maximum acceleration

setMaxLifeTime(value)
Sets the particles maximum lifetime
Parameters:
{number} value
the particles life time

setMaxStartAccelertaion(x, y, z)
Sets the max starting acceleration in the all direction
Parameters:
{number} x
the minimum velocity in x axis
{number} y
the minimum velocity in y axis
{number} z
the minimum velocity in z axis

setMaxStartAccX(value)
Sets the max starting acceleration in the X direction
Parameters:
{number} value
the maximum acceleration

setMaxStartAccY(value)
Sets the max starting acceleration in the Y direction
Parameters:
{number} value
the maximum acceleration

setMaxStartAccZ(value)
Sets the max starting acceleration in the Z direction
Parameters:
{number} value
the maximum acceleration

setMaxVelocity(x, y, z)
Sets the max velocity in the all direction
Parameters:
{number} x
the maximum velocity in x axis
{number} y
the maximum velocity in y axis
{number} z
the maximum velocity in z axis

setMaxVelX(value)
Sets the max velocity in the X direction
Parameters:
{number} value
the maximum velocity

setMaxVelY(value)
Sets the max velocity in the Y direction
Parameters:
{number} value
the maximum velocity

setMaxVelZ(value)
Sets the max velocity in the Z direction
Parameters:
{number} value
the maximum velocity

setMinEndAccelertaion(x, y, z)
Sets the minimum ending acceleration in the all direction
Parameters:
{number} x
the minimum velocity in x axis
{number} y
the minimum velocity in y axis
{number} z
the minimum velocity in z axis

setMinEndAccX(value)
Sets the minimum ending acceleration in the X direction
Parameters:
{number} value
the minimum acceleration

setMinEndAccY(value)
Sets the minimum ending acceleration in the Y direction
Parameters:
{number} value
the minimum acceleration

setMinEndAccZ(value)
Sets the minimum ending acceleration in the Z direction
Parameters:
{number} value
the minimum acceleration

setMinLifeTime(value)
Sets the particles minimum lifetime
Parameters:
{number} value
the particles life time

setMinStartAccelertaion(x, y, z)
Sets the min starting acceleration in the all direction
Parameters:
{number} x
the minimum velocity in x axis
{number} y
the minimum velocity in y axis
{number} z
the minimum velocity in z axis

setMinStartAccX(value)
Sets the min starting acceleration in the X direction
Parameters:
{number} value
the minimum acceleration

setMinStartAccY(value)
Sets the min starting acceleration in the Y direction
Parameters:
{number} value
the minimum acceleration

setMinStartAccZ(value)
Sets the min starting acceleration in the Z direction
Parameters:
{number} value
the minimum acceleration

setMinVelocity(x, y, z)
Sets the min velocity in the all direction
Parameters:
{number} x
the minimum velocity in x axis
{number} y
the minimum velocity in y axis
{number} z
the minimum velocity in z axis

setMinVelX(value)
Sets the min velocity in the X direction
Parameters:
{number} value
the minimum velocity

setMinVelY(value)
Sets the min velocity in the Y direction
Parameters:
{number} value
the minimum velocity

setMinVelZ(value)
Sets the min velocity in the Z direction
Parameters:
{number} value
the minimum velocity

setNumParticles(value)
Sets the total number of particles
Parameters:
{number} value
the number of particles

setPositionFunction(func)
Sets a new position function for this particle system
Parameters:
{function} func
the new function

setSizeFunction(func)
Sets a new size function for this particle system
Parameters:
{function} func
the new function

setStartAccelertaion(x, y, z)
Sets the starting acceleration in the all direction
Parameters:
{number} x
the minimum velocity in x axis
{number} y
the minimum velocity in y axis
{number} z
the minimum velocity in z axis

setStartAccX(value)
Sets the starting acceleration in the X direction
Parameters:
{number} value
the minimum acceleration

setStartAccY(value)
Sets the starting acceleration in the Y direction
Parameters:
{number} value
the minimum acceleration

setStartAccZ(value)
Sets the starting acceleration in the Z direction
Parameters:
{number} value
the minimum acceleration

setStartColor(value)
Sets the starting color of the particle
Parameters:
{number} value
the start color

setStartSize(value)
Sets the starting size of the particle
Parameters:
{number} value
the start size

setVelocity(x, y, z)
Sets the velocity in the all direction
Parameters:
{number} x
the minimum velocity in x axis
{number} y
the minimum velocity in y axis
{number} z
the minimum velocity in z axis

setVelocityFunction(func)
Sets a new velocity function for this particle system
Parameters:
{function} func
the new function

setVelX(value)
Sets the velocity in the X direction
Parameters:
{number} value
the minimum velocity

setVelY(value)
Sets the velocity in the Y direction
Parameters:
{number} value
the minimum velocity

setVelZ(value)
Sets the velocity in the Z direction
Parameters:
{number} value
the minimum velocity

sizeFunction(i)
The particles size function used to generate the initial sizes
Parameters:
i

velocityFunction(i)
The particles velocity function used to generate the initial particles velocities
Parameters:
i

Documentation generated by JsDoc Toolkit 2.4.0 on Sun Feb 12 2012 14:20:23 GMT+0000 (GMT)