Package | flare.core |
Class | public class SpriteParticles3D |
Inheritance | SpriteParticles3D Pivot3D flash.events.EventDispatcher |
Implements | IDrawable |
Property | Defined By | ||
---|---|---|---|
animationEnabled : Boolean = true
Activates or deactivates the animation. | Pivot3D | ||
animationSmoothMode : int = 2
Sets or gets the animation method used to interpolate between frames. | Pivot3D | ||
autoSort : int = 0 | SpriteParticles3D | ||
blendMode : int | SpriteParticles3D | ||
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 | ||
colorTexture : Texture3D [read-only] | SpriteParticles3D | ||
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 | ||
dirty : Boolean = true
Gets or sets when the object has changed his transform matrix by hand. | Pivot3D | ||
frames : Vector.<Frame3D>
Vector that contains all the animation frames. | Pivot3D | ||
frameSpeed : Number
Returns or sets animation speed. | Pivot3D | ||
inView : Boolean [override] [read-only] | SpriteParticles3D | ||
invWorld : Matrix3D [read-only]
Returns a matrix with the inverse global position, rotation and scale of the object. | Pivot3D | ||
isPlaying : Boolean [read-only]
Returns true if an animation is being played. | Pivot3D | ||
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 | ||
length : int [read-only] | SpriteParticles3D | ||
lock : Boolean
Sets the pivot lock mode. | Pivot3D | ||
material : FLSLMaterial [read-only] | SpriteParticles3D | ||
name : String
Sets or returns the object name. | Pivot3D | ||
parent : Pivot3D
Returns or sets the object’s parent. | Pivot3D | ||
priority : int = 0
This value is for internal use to calculate the priority acording the distance from the camera during the render. | Pivot3D | ||
receiveShadows : Boolean = true
Gets or sets if the object should receive shadows. | Pivot3D | ||
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 | ||
sortMode : int
Gets ot sets the sorting mode for the object. | Pivot3D | ||
sprites : Vector.<Sprite3D> | SpriteParticles3D | ||
texture : Texture3D | SpriteParticles3D | ||
transform : Matrix3D
Sets or returns the matrix of local position, rotation and scale. | Pivot3D | ||
updatable : Boolean | Pivot3D | ||
userData : Object
Sets or returns an object for free use by the user. | Pivot3D | ||
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 | ||
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 | ||
---|---|---|---|
SpriteParticles3D(texture:Texture3D, enableRotations:Boolean = false, tiles:Point = null) | SpriteParticles3D | ||
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 | ||
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 [override] | SpriteParticles3D | ||
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 | ||
play(animationMode:int = 0, includeChildren:Boolean = true, resetAnimation:Boolean = true):void
Starts playing the animation. | Pivot3D | ||
prevFrame():void | Pivot3D | ||
SpriteParticles3D | |||
removeByIndex(index:int):Sprite3D
Removes the specified index and push the instance to the end while decreasing the maxInstances property. | SpriteParticles3D | ||
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 | ||
resetTransforms():void
Resets the object position, rotation and scale. | Pivot3D | ||
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. | SpriteParticles3D | ||
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. | SpriteParticles3D | ||
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 | ||
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 | ||
sort(sortMode:int):void
Forces to sort particles. | SpriteParticles3D | ||
Spanws a new particle and increaases the maxInstances count using an efficient pooling systtem. | SpriteParticles3D | ||
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 | ||
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_BACK_TO_FRONT : int = 2 [static] | SpriteParticles3D | ||
SORT_CENTER : int = 1 [static] | Pivot3D | ||
SORT_FAR : int = 4 [static] | Pivot3D | ||
SORT_FRONT_TO_BACK : int = 1 [static] | SpriteParticles3D | ||
SORT_NEAR : int = 2 [static] | Pivot3D | ||
SORT_NONE : int = 0 [static] | SpriteParticles3D | ||
SORT_REVERSE : int = 3 [static] | SpriteParticles3D | ||
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 |
autoSort | property |
public var autoSort:int = 0
blendMode | property |
blendMode:int
public function get blendMode():int
public function set blendMode(value:int):void
colorTexture | property |
inView | property |
inView:Boolean
[read-only] [override] public function get inView():Boolean
length | property |
length:int
[read-only] public function get length():int
material | property |
sprites | property |
public var sprites:Vector.<Sprite3D>
texture | property |
public var texture:Texture3D
SpriteParticles3D | () | Constructor |
public function SpriteParticles3D(texture:Texture3D, enableRotations:Boolean = false, tiles:Point = null)
texture:Texture3D | |
enableRotations:Boolean (default = false )
| |
tiles:Point (default = null )
|
draw | () | method |
override public function draw(includeChildren:Boolean = true, material:Material3D = null):void
Parameters
includeChildren:Boolean (default = true )
| |
material:Material3D (default = null )
|
remove | () | method |
removeByIndex | () | method |
public function removeByIndex(index:int):Sprite3D
Removes the specified index and push the instance to the end while decreasing the maxInstances property. This metrhod allows for an efficient pooling system, moving the unused objects at the end for later use. The maxInstances is drecreased only when its value is different than -1.
Parameters
index:int — The index of the instance.
|
Sprite3D |
See also
setAlphas | () | method |
public function setAlphas(alphas:Array, ratios:Array):void
Sets 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):void
Set 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.
|
sort | () | method |
public function sort(sortMode:int):void
Forces to sort particles. If autoSort property is set to a value different than 0, this method is called automatically when rendering.
Parameters
sortMode:int — One of the sorting constants defined in SpriteParticles3D classs.
|
See also
spawn | () | method |
public function spawn(spriteClass:Class = null):Sprite3D
Spanws a new particle and increaases the maxInstances count using an efficient pooling systtem. IF maxInstances is -1, this method always creates a new particule and pooling is deactivated.
Parameters
spriteClass:Class (default = null ) — An optional custom sprite class. This class should extends Sprite3D class.
|
Sprite3D — A new or a previously avilable Sprite3D instance.
|
See also
SORT_BACK_TO_FRONT | Constant |
public static const SORT_BACK_TO_FRONT:int = 2
SORT_FRONT_TO_BACK | Constant |
public static const SORT_FRONT_TO_BACK:int = 1
SORT_NONE | Constant |
public static const SORT_NONE:int = 0
SORT_REVERSE | Constant |
public static const SORT_REVERSE:int = 3