| Package | flare.core |
| Class | public class Particles3D |
| Inheritance | Particles3D  Pivot3D flash.events.EventDispatcher |
| Implements | IDrawable |
| Property | Defined By | ||
|---|---|---|---|
| alphaRatios : Array [read-only]
Get the ratios used for the alpha channel. | Particles3D | ||
| alphas : Array [read-only]
Gets the alpha values of the alpha channel. | Particles3D | ||
 | animationEnabled : Boolean = true
Activates or deactivates the animation. | Pivot3D | |
| animationSmoothMode : int = 2
Sets or gets the animation method used to interpolate between frames. | Pivot3D | |
| area : Vector3D
Gets or sets the emitter area where the particles are born. | Particles3D | ||
| blendMode : int
Gets or sets the blend mode used for the particles. | Particles3D | ||
| blendTexture : Texture3D
Gets or sets a blending texture to use trough the particle's life. | Particles3D | ||
| castShadows : Boolean = true
Gets or sets if the object should cast shadows. | Pivot3D | |
| children : Vector.<Pivot3D> [read-only]
Returns a Pivot3D-type vector with its children. | Pivot3D | |
| collider : Collider | Pivot3D | |
| colorRatios : Array [read-only]
Gets the color ratios used for the gradient color channel. | Particles3D | ||
| colors : Array [read-only]
Gets the colors used for the gradient color channel. | Particles3D | ||
| components : Vector.<IComponent>
A collection vector that contains all the components of the object. | Pivot3D | |
| currentFrame : Number
Returns or sets the frame number where the pivot is situated. | Pivot3D | |
| currentLabel : Label3D [read-only] | Pivot3D | |
| delay : Number
Gets or sets a delay interval for the particles creation, expressed in seconds. | Particles3D | ||
| dirty : Boolean = true
Gets or sets when the object has changed his transform matrix by hand. | Pivot3D | |
| duration : Number = 1
Gets or sets the cycle length of the emitter. | Particles3D | ||
| endSize : Point
Gets or sets the final size of the particle. | Particles3D | ||
| energy : Vector3D
Gets or sets the starting velocity of the particles, working as a range value. | Particles3D | ||
| frames : Vector.<Frame3D>
Vector that contains all the animation frames. | Pivot3D | |
| frameSpeed : Number
Returns or sets animation speed. | Pivot3D | |
| gravity : Vector3D
Gets or sets the gravity vector of the emitter. | Particles3D | ||
| gravityPower : Number
Gets or sets the curve intensity to use for the gravity parameter. | Particles3D | ||
| hemisphere : Boolean
Gets or sets whatever the particles energy should dispatch in all directions or only up to the floor plane. | Particles3D | ||
| initParticleFunction : Function
Gets or sets a custom callback function to initializate the particles. | Particles3D | ||
| inView : Boolean [override] [read-only] | Particles3D | ||
| invWorld : Matrix3D [read-only]
Returns a matrix with the inverse global position, rotation and scale of the object. | Pivot3D | |
| isPlaying : Boolean [override] [read-only] | Particles3D | ||
| isStatic : Boolean | Pivot3D | |
| labels : Object
Returns or sets an object that contains the Labels3D objects used to play and manage animations. | Pivot3D | |
| layer : int = 0
Gets or sets the layer to render the object. | Pivot3D | |
| lock : Boolean
Sets the pivot lock mode. | Pivot3D | |
| loops : Number
Gets ot sets the number of cylces for the emitter. | Particles3D | ||
| material : FLSLMaterial [read-only] | Particles3D | ||
| name : String
Sets or returns the object name. | Pivot3D | |
| numParticles : int
Gets or sets the number of particles to be used. | Particles3D | ||
| parent : Pivot3D
Returns or sets the object’s parent. | Pivot3D | |
| paused : Boolean [read-only] | Particles3D | ||
| priority : int = 0
This value is for internal use to calculate the priority acording the distance from the camera during the render. | Pivot3D | |
| randomFrame : Boolean
Gets or sets whether the particles should use a random frame from the textureFrams property. | Particles3D | ||
| randomScale : Number
Gets or sets a random scale range value for each particle. | Particles3D | ||
| randomSeed : uint = 200
Defines a random seed to be used when generating the particles. | Particles3D | ||
| randomSpin : Number
Gets or sets a random spin range value for each particle. | Particles3D | ||
| randomVelocity : Number
Gets or sets a random velocity range value for each particle. | Particles3D | ||
| receiveShadows : Boolean = true
Gets or sets if the object should receive shadows. | Pivot3D | |
| reverse : Boolean | Particles3D | ||
| scaleX : Number
Increases or decreases the object scale on the X axis from its current scale. | Pivot3D | |
| scaleY : Number
Increases or decreases the object scale on the Y axis from its current scale. | Pivot3D | |
| scaleZ : Number
Increases or decreases the object scale on the Z axis from its current scale. | Pivot3D | |
| scene : Scene3D [read-only]
Gets a reference to the scene that contains the object. | Pivot3D | |
| shots : int
Gets or sets the number of particles interval to emit trough the emitter duration. | Particles3D | ||
| sortMode : int [override]
Gets or sets the sorting mode for the particles. | Particles3D | ||
| spin : Number
Gets or sets a start spin value for all particles. | Particles3D | ||
| startSize : Point
Gets or sets the start size of all particles. | Particles3D | ||
| texture : Texture3D
Gets or sets the base particle texture to use for all particles. | Particles3D | ||
| textureFrames : Point
Gets or sets the number of frames in x and y axis of the texture. | Particles3D | ||
| time : Number
Gets or sets the current emitter time, expressed in seconds. | Particles3D | ||
| tint : Vector.<Number> [read-only] | Particles3D | ||
| transform : Matrix3D
Sets or returns the matrix of local position, rotation and scale. | Pivot3D | |
| updatable : Boolean | Pivot3D | |
| useRandomColors : Boolean
Gets or sets whether the particles should use any random color based on the range provided in setColors method. | Particles3D | ||
| userData : Object
Sets or returns an object for free use by the user. | Pivot3D | |
| velocity : Vector3D
Gets or sets the initial velocity for all particles. | Particles3D | ||
| visible : Boolean = true
Sets or returns whether the object is visible. | Pivot3D | |
| world : Matrix3D
Returns a matrix with the global position, rotation and scale of the object. | Pivot3D | |
| worldPositions : Boolean
Gets or sets if the particles positions should be linked to the emitter as a regular child or they're parented the world coordinates. | Particles3D | ||
| worldVelocities : Boolean
Gets or sets if the particles velocities should be linked to the emitter as a regular child or they are parented the world coordinates. | Particles3D | ||
| x : Number
Returns or sets the position on the X axis. | Pivot3D | |
| y : Number
Returns or sets the position on the Y axis. | Pivot3D | |
| z : Number
Returns or sets the position on the Z axis. | Pivot3D | |
| Method | Defined By | ||
|---|---|---|---|
Particles3D(name:String = particles, texture:Texture3D = null)
Creates a new particles emitter. | Particles3D | ||
|
Add a new object as a child. | Pivot3D | |
| Pivot3D | ||
| addComponent(component:IComponent):Boolean
Adds a new component to the object. | Pivot3D | |
| addFrameScript(frame:int, callback:Function):void | Pivot3D | |
|
Adds a label that refers to a given animation. | Pivot3D | |
build():void
Builds and initializes the particles buffers. | Particles3D | ||
|
Creates a copy of the object and all its elements. | Pivot3D | |
|
Copy basic pivot properties to anotheer pivot. | Pivot3D | |
| copyTransformFrom(source:Pivot3D, local:Boolean = true):void
Copies all transformations (position, rotation and scale) from another Pivot3D object. | Pivot3D | |
| dispose():void
Disposes the pivot and all associated resources. | Pivot3D | |
| download(includeChildren:Boolean = true):void | Pivot3D | |
| draw(includeChildren:Boolean = true, material:Material3D = null):void
Draws the object. | Pivot3D | |
| forEach(callback:Function, filterClass:Class = null, params:Object = null, includeChildren:Boolean = true):void
Excecutes a calback functions for each of his children. | Pivot3D | |
| getBackward(local:Boolean = true, out:Vector3D = null):Vector3D
Returns the direction vector that points to the back of the object. | Pivot3D | |
| getChildByName(name:String, startIndex:int = 0, includeChildren:Boolean = true):Pivot3D
Returns the first child that matches the specified name. | Pivot3D | |
| getChildrenByClass(cl:Class, includeChildren:Boolean = true, out:Vector.<Pivot3D> = null):Vector.<Pivot3D> | Pivot3D | |
| getDir(local:Boolean = true, out:Vector3D = null):Vector3D
Returns the direction vector that points to the front of the object. | Pivot3D | |
| getDown(local:Boolean = true, out:Vector3D = null):Vector3D
Returns the direction vector that points to the bottom side of the object. | Pivot3D | |
| getLeft(local:Boolean = true, out:Vector3D = null):Vector3D
Returns the direction vector that points to the left side of the object. | Pivot3D | |
| getMaterialByName(name:String, includeChildren:Boolean = true):Material3D
Returns the first material that matches the specified name. | Pivot3D | |
|
Returns an unique vector of pivot materials currently in use. | Pivot3D | |
| getPosition(local:Boolean = true, out:Vector3D = null):Vector3D
Returns the current position of the object. | Pivot3D | |
| getRight(local:Boolean = true, out:Vector3D = null):Vector3D
Returns the direction vector that points to the right side of the object. | Pivot3D | |
| getRotation(local:Boolean = true, out:Vector3D = null):Vector3D
Returns the current rotation of the object in euler angles. | Pivot3D | |
| getScale(local:Boolean = true, out:Vector3D = null):Vector3D
Returns the current scale of the object. | Pivot3D | |
| getScreenCoords(out:Vector3D = null, camera:Camera3D = null, viewPort:Rectangle = null):Vector3D
Returns the coordinates of an object with respect to the screen. | Pivot3D | |
|
Returns an unique vector of surface objects used by the pivots. | Pivot3D | |
|
Returns an unique vector of textures objects used by the pivot materials. | Pivot3D | |
| getUp(local:Boolean = true, out:Vector3D = null):Vector3D
Returns the direction vector that points to the upper side of the object. | Pivot3D | |
| globalToLocal(point:Vector3D, out:Vector3D = null):Vector3D
Transforms a point of the global space of the object into a local space. | Pivot3D | |
| globalToLocalVector(vector:Vector3D, out:Vector3D = null):Vector3D
Transforms a point of the global space of the object into a local space without translation. | Pivot3D | |
| gotoAndPlay(frame:Object, blendFrames:Number = 0, animationMode:int, includeChildren:Boolean = true):void
Starts playing the animation at the specified frame
| Pivot3D | |
| gotoAndStop(frame:Object, blendFrames:Number = 0, includeChildren:Boolean = true):void
Stops the animation at the specified frame. | Pivot3D | |
| hide():void
Sets the visible property of this object and all its children recursively to false. | Pivot3D | |
| localToGlobal(point:Vector3D, out:Vector3D = null):Vector3D
Transforms a point of the local space into the global space. | Pivot3D | |
| localToGlobalVector(vector:Vector3D, out:Vector3D = null):Vector3D
Transforms a point of the local space of the object into a global space without translation. | Pivot3D | |
| lookAt(x:Number, y:Number, z:Number, up:Vector3D = null, smooth:Number = 1):void
Directs the object towards the specified position. | Pivot3D | |
| nextFrame():void | Pivot3D | |
pause():void
Pauses the emission of particles. | Particles3D | ||
| play(animationMode:int = 0, includeChildren:Boolean = true, resetAnimation:Boolean = true):void
Starts playing the animation. | Pivot3D | |
| prevFrame():void | Pivot3D | |
|
Removes a child of the object. | Pivot3D | |
| removeComponent(component:IComponent):Boolean
Removes a component from the object. | Pivot3D | |
|
Removes a label. | Pivot3D | |
|
Replaces an existing material of the object with another material. | Pivot3D | |
|
Replaces an existing surface of the object with another surface. | Pivot3D | |
|
Replaces an existing texture of the object materials with another texture. | Pivot3D | |
reset():void
Reset particle buffers to be builded again. | Particles3D | ||
| resetTransforms():void
Resets the object position, rotation and scale. | Pivot3D | |
resume():void
Resumes the emission of particles after being paused. | Particles3D | ||
| rotateAxis(angle:Number, axis:Vector3D, pivotPoint:Vector3D = null):void
Rotates the object on the specified axis from its current position. | Pivot3D | |
| rotateX(angle:Number, local:Boolean = true, pivotPoint:Vector3D = null):void
Rotates the object on the X axis from its current position. | Pivot3D | |
| rotateY(angle:Number, local:Boolean = true, pivotPoint:Vector3D = null):void
Rotates the object on the Y axis from its current position. | Pivot3D | |
| rotateZ(angle:Number, local:Boolean = true, pivotPoint:Vector3D = null):void
Rotates the pivot on the Z axis from its current position. | Pivot3D | |
setAlphas(alphas:Array, ratios:Array):void
Sets the values to use as an alpha channel for all particles to use over the time. | Particles3D | ||
| setAnimationLabel(label:Object, animationMode:int, includeChildren:Boolean = true):void
Sets the current animation label. | Pivot3D | |
| setAnimationSmooth(mode:int, includeChildren:Boolean = true):void
Sets the animation interpolation mode for this pivot and its children. | Pivot3D | |
setColors(colors:Array, ratios:Array):void
Set the colors for the particles over the time. | Particles3D | ||
| setLayer(value:int, includeChildren:Boolean = true):void
Sets the layer to render the object and all of his children. | Pivot3D | |
| setMaterial(material:Material3D, includeChildren:Boolean = true):void
Sets a material for the object and, optionally, all its descendants. | Pivot3D | |
| setNormalOrientation(normal:Vector3D, smooth:Number = 1):void
Aligns the object to a normal. | Pivot3D | |
| setOrientation(dir:Vector3D, up:Vector3D = null, smooth:Number = 1):void
Orients the object in a specific direction. | Pivot3D | |
| setPosition(x:Number, y:Number, z:Number, smooth:Number = 1, local:Boolean = true):void
Sets the position of the object. | Pivot3D | |
| setRotation(x:Number, y:Number, z:Number):void
Sets the object rotation using euler angles. | Pivot3D | |
| setScale(x:Number, y:Number, z:Number, smooth:Number = 1):void
Sets the object scale. | Pivot3D | |
| setShadowsProperties(cast:Boolean = false, receive:Boolean = false, includeChildren:Boolean = true):void
Sets whether the object should cast and receive shadows. | Pivot3D | |
| setStatic(value:Boolean, includeChildren:Boolean = true):void | Pivot3D | |
setTint(r:Number, g:Number, b:Number, a:Number = 1):void | Particles3D | ||
| setTranslation(x:Number = 0, y:Number = 0, z:Number = 0, local:Boolean = true):void
Translates the object from its current position to the specified distance. | Pivot3D | |
| show():void
Sets the visible property of this object and all its children recursively to true. | Pivot3D | |
start():void
Starts the emission of particles. | Particles3D | ||
| startDrag(lockCenter:Boolean = false, refPlaneNormal:Vector3D = null):void
Lets the user drag the specified Pivot3D. | Pivot3D | |
| stop(includeChildren:Boolean = true):void | Pivot3D | |
| stopDrag():void
Ends the startDrag() method. | Pivot3D | |
| translateAxis(distance:Number, axis:Vector3D):void
Translates the object on a certain axis from its current position. | Pivot3D | |
| translateX(distance:Number, local:Boolean = true):void
Translates the object on the X axis from its current position. | Pivot3D | |
| translateY(distance:Number, local:Boolean = true):void
Translates the object on the Y axis from its current position. | Pivot3D | |
| translateZ(distance:Number, local:Boolean = true):void
Translates the object on the Z axis from its current position. | Pivot3D | |
| update():void | Pivot3D | |
| updateTransforms(includeChildren:Boolean = false):void
This method is used to force the system to update the object in those cases where its matrices have been modified manually. | Pivot3D | |
| Pivot3D | ||
| Constant | Defined By | ||
|---|---|---|---|
| ADDED_EVENT : String = added [static]
Defines the value for the 'added' event. | Pivot3D | |
| ADDED_TO_SCENE_EVENT : String = addedToScene [static]
Defines the value for the 'addedToScene' event. | Pivot3D | |
| ANIMATION_COMPLETE_EVENT : String = animationComplete [static]
Defines the value for the 'animationComplete' event. | Pivot3D | |
| ANIMATION_LOOP_MODE : int = 0 [static] | Pivot3D | |
| ANIMATION_PING_PONG_MODE : int = 1 [static] | Pivot3D | |
| ANIMATION_SMOOTH_BEST : int = 2 [static] | Pivot3D | |
| ANIMATION_SMOOTH_NONE : int = 0 [static] | Pivot3D | |
| ANIMATION_SMOOTH_NORMAL : int = 1 [static] | Pivot3D | |
| ANIMATION_STOP_MODE : int = 2 [static] | Pivot3D | |
| BLEND_ADDITIVE : int = 1 [static] | Particles3D | ||
| BLEND_ALPHA_BLENDED : int = 2 [static] | Particles3D | ||
| BLEND_ALPHA_BLENDED2 : int = 5 [static] | Particles3D | ||
| BLEND_MULTIPLY : int = 3 [static] | Particles3D | ||
| BLEND_NONE : int = 0 [static] | Particles3D | ||
| BLEND_SCREEN : int = 4 [static] | Particles3D | ||
| ENTER_DRAG_EVENT : String = enterDrag [static]
Defines the value for the 'enterDrag' event. | Pivot3D | |
| ENTER_DRAW_EVENT : String = enterDraw [static]
Defines the value for the 'enterDraw' event. | Pivot3D | |
| ENTER_FRAME_EVENT : String = enterFrame [static]
Defines the value for the 'enterFrame' event. | Pivot3D | |
| EXIT_DRAG_EVENT : String = exitDrag [static]
Defines the value for the 'exitDrag' event. | Pivot3D | |
| EXIT_DRAW_EVENT : String = exitDraw [static]
Defines the value for the 'exitDraw' event. | Pivot3D | |
| EXIT_FRAME_EVENT : String = exitFrame [static]
Defines the value for the 'exitFrame' event. | Pivot3D | |
| REMOVED_EVENT : String = removed [static]
Defines the value for the 'removed' event. | Pivot3D | |
| REMOVED_FROM_SCENE_EVENT : String = removedFromScene [static]
Defines the value for the 'removedFromScene' event. | Pivot3D | |
| SORT_CENTER : int = 1 [static] | Pivot3D | |
| SORT_FAR : int = 4 [static] | Pivot3D | |
| SORT_NEAR : int = 2 [static] | Pivot3D | |
| SORT_NONE : int = 0 [static] | Particles3D | ||
| SORT_OLDEST_FIRST : int = 2 [static] | Particles3D | ||
| SORT_YOUNGEST_FIRST : int = 1 [static] | Particles3D | ||
| UNLOAD_EVENT : String = unload [static]
Defines the value for the 'unload' event. | Pivot3D | |
| UPDATE_TRANSFORM_EVENT : String = updateTransform [static]
Defines the value for the 'updateTransform' event. | Pivot3D | |
| alphaRatios | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesalphaRatios:Array [read-only] Get the ratios used for the alpha channel.
public function get alphaRatios():ArraySee also
| alphas | property |
alphas:Array [read-only] Gets the alpha values of the alpha channel.
public function get alphas():ArraySee also
| area | property |
area:Vector3DGets or sets the emitter area where the particles are born. Big values might be needed for the effect to be noticeable.
public function get area():Vector3D public function set area(value:Vector3D):void| blendMode | property |
blendMode:intGets or sets the blend mode used for the particles. Should be one of the blending constants defined in Particle3D class.
public function get blendMode():int public function set blendMode(value:int):voidSee also
| blendTexture | property |
blendTexture:Texture3DGets or sets a blending texture to use trough the particle's life.
public function get blendTexture():Texture3D public function set blendTexture(value:Texture3D):void| colorRatios | property |
colorRatios:Array [read-only] Gets the color ratios used for the gradient color channel.
public function get colorRatios():ArraySee also
| colors | property |
colors:Array [read-only] Gets the colors used for the gradient color channel.
public function get colors():ArraySee also
| delay | property |
delay:NumberGets or sets a delay interval for the particles creation, expressed in seconds.
public function get delay():Number public function set delay(value:Number):void| duration | property |
public var duration:Number = 1Gets or sets the cycle length of the emitter. In seconds.
| endSize | property |
endSize:PointGets or sets the final size of the particle.
public function get endSize():Point public function set endSize(value:Point):void| energy | property |
energy:Vector3DGets or sets the starting velocity of the particles, working as a range value. For example a value of 100, 0, 0 means that particles will be dispatched in a range of -100 to 100 in x-axis.
public function get energy():Vector3D public function set energy(value:Vector3D):voidSee also
| gravity | property |
gravity:Vector3DGets or sets the gravity vector of the emitter.
public function get gravity():Vector3D public function set gravity(value:Vector3D):voidSee also
| gravityPower | property |
gravityPower:NumberGets or sets the curve intensity to use for the gravity parameter.
public function get gravityPower():Number public function set gravityPower(value:Number):voidSee also
| hemisphere | property |
hemisphere:BooleanGets or sets whatever the particles energy should dispatch in all directions or only up to the floor plane.
public function get hemisphere():Boolean public function set hemisphere(value:Boolean):voidSee also
| initParticleFunction | property |
public var initParticleFunction:FunctionGets or sets a custom callback function to initializate the particles. The function should receive the emitter, the particle index and the init properties objects. For example: myCustomParticles( emitter:Particles3D, index:int, init:ParticleInit3D ):void Inside the function, you can change the init particle properties such as position, velocity, etc.
| inView | property |
inView:Boolean [read-only] [override] public function get inView():Boolean| isPlaying | property |
isPlaying:Boolean [read-only] [override] public function get isPlaying():Boolean| loops | property |
loops:NumberGets ot sets the number of cylces for the emitter.
public function get loops():Number public function set loops(value:Number):void| material | property |
| numParticles | property |
numParticles:intGets or sets the number of particles to be used.
public function get numParticles():int public function set numParticles(value:int):void| paused | property |
paused:Boolean [read-only] public function get paused():Boolean| randomFrame | property |
randomFrame:BooleanGets or sets whether the particles should use a random frame from the textureFrams property.
public function get randomFrame():Boolean public function set randomFrame(value:Boolean):voidSee also
| randomScale | property |
randomScale:NumberGets or sets a random scale range value for each particle.
public function get randomScale():Number public function set randomScale(value:Number):void| randomSeed | property |
public var randomSeed:uint = 200Defines a random seed to be used when generating the particles.
| randomSpin | property |
randomSpin:NumberGets or sets a random spin range value for each particle.
public function get randomSpin():Number public function set randomSpin(value:Number):void| randomVelocity | property |
randomVelocity:NumberGets or sets a random velocity range value for each particle.
public function get randomVelocity():Number public function set randomVelocity(value:Number):void| reverse | property |
reverse:Boolean public function get reverse():Boolean public function set reverse(value:Boolean):void| shots | property |
shots:intGets or sets the number of particles interval to emit trough the emitter duration. A value of zero means that particles are dispatched continuously.
public function get shots():int public function set shots(value:int):void| sortMode | property |
sortMode:int[override] Gets or sets the sorting mode for the particles. Should be one of the constants defined in Particles3D.
public function get sortMode():int public function set sortMode(value:int):voidSee also
| spin | property |
spin:NumberGets or sets a start spin value for all particles.
public function get spin():Number public function set spin(value:Number):void| startSize | property |
startSize:PointGets or sets the start size of all particles.
public function get startSize():Point public function set startSize(value:Point):void| texture | property |
texture:Texture3DGets or sets the base particle texture to use for all particles.
public function get texture():Texture3D public function set texture(value:Texture3D):void| textureFrames | property |
textureFrames:PointGets or sets the number of frames in x and y axis of the texture.
public function get textureFrames():Point public function set textureFrames(value:Point):voidSee also
| time | property |
time:NumberGets or sets the current emitter time, expressed in seconds.
public function get time():Number public function set time(value:Number):void| tint | property |
tint:Vector.<Number> [read-only] public function get tint():Vector.<Number>| useRandomColors | property |
useRandomColors:BooleanGets or sets whether the particles should use any random color based on the range provided in setColors method.
public function get useRandomColors():Boolean public function set useRandomColors(value:Boolean):voidSee also
| velocity | property |
velocity:Vector3DGets or sets the initial velocity for all particles.
public function get velocity():Vector3D public function set velocity(value:Vector3D):void| worldPositions | property |
worldPositions:BooleanGets or sets if the particles positions should be linked to the emitter as a regular child or they're parented the world coordinates.
public function get worldPositions():Boolean public function set worldPositions(value:Boolean):void| worldVelocities | property |
worldVelocities:BooleanGets or sets if the particles velocities should be linked to the emitter as a regular child or they are parented the world coordinates.
public function get worldVelocities():Boolean public function set worldVelocities(value:Boolean):void| Particles3D | () | Constructor |
public function Particles3D(name:String = particles, texture:Texture3D = null)Creates a new particles emitter.
Parametersname:String (default = particles) | |
texture:Texture3D (default = null) |
| build | () | method |
public function build():voidBuilds and initializes the particles buffers. You should not call to this method unless you explicity want to build the buffers manually.
| pause | () | method |
| reset | () | method |
public function reset():voidReset particle buffers to be builded again. The build process is not inmediate, the engine will build the particles as soon as they need to be render. To force also the build process, call to build() method.
See also
| resume | () | method |
public function resume():voidResumes the emission of particles after being paused.
See also
| setAlphas | () | method |
public function setAlphas(alphas:Array, ratios:Array):voidSets the values to use as an alpha channel for all particles to use over the time.
Parameters
alphas:Array — alphas: An array of alpha values for the corresponding colors in the colors array; valid values go from 0 to 1. The value will be clamped between 0 and 1.
| |
ratios:Array — An array of color distribution ratios; valid values go from 0 to 255. This value defines the percentage of the width where the color is sampled at 100%. The value 0 represents the initial position, and 255 represents the final position.
|
| setColors | () | method |
public function setColors(colors:Array, ratios:Array):voidSet the colors for the particles over the time.
Parameters
colors:Array — An array of RGB hexadecimal color values to be used in the gradient; for example, red is 0xFF0000, blue is 0x0000FF, and so on. You can specify up to 15 colors. For each color, be sure you specify a corresponding value in the alphas and ratios parameters.
| |
ratios:Array — An array of color distribution ratios; valid values are 0 to 255. This value defines the percentage of the width where the color is sampled at 100%. The value 0 represents the initial position, and 255 represents the final position.
|
| setTint | () | method |
public function setTint(r:Number, g:Number, b:Number, a:Number = 1):voidParameters
r:Number | |
g:Number | |
b:Number | |
a:Number (default = 1) |
| start | () | method |
public function start():voidStarts the emission of particles. This method reinitializes the buffers when worldPositions or worldVelocities are set to true, and may affect performance when using it with large amount of particles.
See also
| BLEND_ADDITIVE | Constant |
public static const BLEND_ADDITIVE:int = 1| BLEND_ALPHA_BLENDED | Constant |
public static const BLEND_ALPHA_BLENDED:int = 2| BLEND_ALPHA_BLENDED2 | Constant |
public static const BLEND_ALPHA_BLENDED2:int = 5| BLEND_MULTIPLY | Constant |
public static const BLEND_MULTIPLY:int = 3| BLEND_NONE | Constant |
public static const BLEND_NONE:int = 0| BLEND_SCREEN | Constant |
public static const BLEND_SCREEN:int = 4| SORT_NONE | Constant |
public static const SORT_NONE:int = 0| SORT_OLDEST_FIRST | Constant |
public static const SORT_OLDEST_FIRST:int = 2| SORT_YOUNGEST_FIRST | Constant |
public static const SORT_YOUNGEST_FIRST:int = 1