| Package | away3d.animators.nodes |
| Class | public class ParticleSpriteSheetNode |
| Inheritance | ParticleSpriteSheetNode  ParticleNodeBase AnimationNodeBase NamedAssetBase flash.events.EventDispatcher |
repeat property on the material has to be set to true.
| Property | Defined By | ||
|---|---|---|---|
 | assetFullPath : Array [read-only] | NamedAssetBase | |
| assetNamespace : String [read-only] | NamedAssetBase | |
| assetType : String [read-only]
| AnimationNodeBase | |
| dataLength : int [read-only]
Returns the length of the data used by the node when in LOCAL_STATIC mode. | ParticleNodeBase | |
| mode : uint [read-only]
Returns the property mode of the particle animation node. | ParticleNodeBase | |
| name : String | NamedAssetBase | |
| numColumns : Number [read-only]
Defines the number of columns in the spritesheet, when in global mode. | ParticleSpriteSheetNode | ||
| numRows : Number [read-only]
Defines the number of rows in the spritesheet, when in global mode. | ParticleSpriteSheetNode | ||
| oneData : Vector.<Number> [read-only]
Returns the generated data vector of the node after one particle pass during the generation of all local static data of the particle animation set. | ParticleNodeBase | |
| originalName : String [read-only]
The original name used for this asset in the resource (e.g. | NamedAssetBase | |
| priority : int [read-only]
Returns the priority of the particle animation node, used to order the agal generated in a particle animation set. | ParticleNodeBase | |
| stateClass : Class [read-only] | AnimationNodeBase | |
| totalFrames : Number [read-only]
Defines the total number of frames used by the spritesheet, when in global mode. | ParticleSpriteSheetNode | ||
| Method | Defined By | ||
|---|---|---|---|
ParticleSpriteSheetNode(mode:uint, usesCycle:Boolean, usesPhase:Boolean, numColumns:int = 1, numRows:uint = 1, cycleDuration:Number = 1, cyclePhase:Number = 0, totalFrames:uint)
Creates a new ParticleSpriteSheetNode
| ParticleSpriteSheetNode | ||
| assetPathEquals(name:String, ns:String):Boolean | NamedAssetBase | |
| dispose():void
Cleans up resources used by this asset. | AnimationNodeBase | |
|
Returns the AGAL code of the particle animation node for use in the fragment shader. | ParticleNodeBase | |
[override]
Returns the AGAL code of the particle animation node for use in the fragment shader when UV coordinates are required. | ParticleSpriteSheetNode | ||
|
Returns the AGAL code of the particle animation node for use in the vertex shader. | ParticleNodeBase | |
| ParticleSpriteSheetNode | |||
| resetAssetPath(name:String, ns:String = null, overrideOriginal:Boolean = true):void | NamedAssetBase | |
| Constant | Defined By | ||
|---|---|---|---|
| DEFAULT_NAMESPACE : String = default [static] | NamedAssetBase | |
| UV_VECTOR3D : String = UVVector3D [static]
Reference for spritesheet node properties on a single particle (when in local property mode). | ParticleSpriteSheetNode | ||
| numColumns | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesnumColumns:Number [read-only] Defines the number of columns in the spritesheet, when in global mode. Defaults to 1. Read only.
public function get numColumns():Number| numRows | property |
numRows:Number [read-only] Defines the number of rows in the spritesheet, when in global mode. Defaults to 1. Read only.
public function get numRows():Number| totalFrames | property |
totalFrames:Number [read-only] Defines the total number of frames used by the spritesheet, when in global mode. Defaults to the number defined by numColumns and numRows. Read only.
public function get totalFrames():Number| ParticleSpriteSheetNode | () | Constructor |
public function ParticleSpriteSheetNode(mode:uint, usesCycle:Boolean, usesPhase:Boolean, numColumns:int = 1, numRows:uint = 1, cycleDuration:Number = 1, cyclePhase:Number = 0, totalFrames:uint)
Creates a new ParticleSpriteSheetNode
mode:uint — Defines whether the mode of operation acts on local properties of a particle or global properties of the node.
| |
usesCycle:Boolean — numColumns Defines the number of columns in the spritesheet, when in global mode. Defaults to 1.
| |
usesPhase:Boolean — numRows Defines the number of rows in the spritesheet, when in global mode. Defaults to 1.
| |
numColumns:int (default = 1) | |
numRows:uint (default = 1) | |
cycleDuration:Number (default = 1) | |
cyclePhase:Number (default = 0) | |
totalFrames:uint (default = NaN) |
| generatePropertyOfOneParticle | () | method |
override arcane function generatePropertyOfOneParticle(param:ParticleProperties):voidCalled internally by the particle animation set when assigning the set of static properties originally defined by the initParticleFunc of the set.
Parameters
param:ParticleProperties |
| getAGALUVCode | () | method |
override public function getAGALUVCode(pass:MaterialPassBase, animationRegisterCache:AnimationRegisterCache):StringReturns the AGAL code of the particle animation node for use in the fragment shader when UV coordinates are required.
Parameters
pass:MaterialPassBase | |
animationRegisterCache:AnimationRegisterCache |
String |
| getAnimationState | () | method |
public function getAnimationState(animator:IAnimator):ParticleSpriteSheetState
Parameters
animator:IAnimator |
ParticleSpriteSheetState |
| processAnimationSetting | () | method |
override arcane function processAnimationSetting(particleAnimationSet:ParticleAnimationSet):voidCalled internally by the particle animation set when determining the requirements of the particle animation node AGAL.
Parameters
particleAnimationSet:ParticleAnimationSet |
| UV_VECTOR3D | Constant |
public static const UV_VECTOR3D:String = UVVector3D
Reference for spritesheet node properties on a single particle (when in local property mode).
Expects a Vector3D representing the cycleDuration (x), optional phaseTime (y).