Package | away3d.animators.nodes |
Class | public class ParticleNodeBase |
Inheritance | ParticleNodeBase AnimationNodeBase NamedAssetBase flash.events.EventDispatcher |
Subclasses | ParticleAccelerationNode, ParticleBezierCurveNode, ParticleBillboardNode, ParticleColorNode, ParticleFollowNode, ParticleOrbitNode, ParticleOscillatorNode, ParticlePositionNode, ParticleRotateToHeadingNode, ParticleRotationalVelocityNode, ParticleScaleNode, ParticleSpriteSheetNode, ParticleTimeNode, ParticleUVNode, ParticleVelocityNode |
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 | ||
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 |
Property | Defined By | ||
---|---|---|---|
_dataLength : uint = 3 | ParticleNodeBase | ||
_mode : uint | ParticleNodeBase | ||
_oneData : Vector.<Number> | ParticleNodeBase | ||
_stateClass : Class | AnimationNodeBase |
Method | Defined By | ||
---|---|---|---|
ParticleNodeBase(name:String, mode:uint, dataLength:uint, priority:int = 1)
Creates a new ParticleNodeBase object. | ParticleNodeBase | ||
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 | ||
Returns the AGAL code of the particle animation node for use in the fragment shader when UV coordinates are required. | ParticleNodeBase | ||
Returns the AGAL code of the particle animation node for use in the vertex shader. | ParticleNodeBase | ||
resetAssetPath(name:String, ns:String = null, overrideOriginal:Boolean = true):void | NamedAssetBase |
_dataLength | property |
protected var _dataLength:uint = 3
_mode | property |
protected var _mode:uint
_oneData | property |
protected var _oneData:Vector.<Number>
dataLength | property |
dataLength:int
[read-only]
Returns the length of the data used by the node when in LOCAL_STATIC
mode. Used to generate the local static data of the particle animation set.
public function get dataLength():int
See also
dataOffset | property |
arcane var dataOffset:uint
mode | property |
mode:uint
[read-only] Returns the property mode of the particle animation node. Typically set in the node constructor
public function get mode():uint
See also
oneData | property |
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.
public function get oneData():Vector.<Number>
See also
priority | property |
priority:int
[read-only] Returns the priority of the particle animation node, used to order the agal generated in a particle animation set. Set automatically on instantiation.
public function get priority():int
See also
ParticleNodeBase | () | Constructor |
public function ParticleNodeBase(name:String, mode:uint, dataLength:uint, priority:int = 1)
Creates a new ParticleNodeBase
object.
name:String — Defines the generic name of the particle animation node.
| |
mode:uint — Defines whether the mode of operation acts on local properties of a particle or global properties of the node.
| |
dataLength:uint — Defines the length of the data used by the node when in LOCAL_STATIC mode.
| |
priority:int (default = 1 ) — priority the priority of the particle animation node, used to order the agal generated in a particle animation set. Defaults to 1.
|
generatePropertyOfOneParticle | () | method |
arcane function generatePropertyOfOneParticle(param:ParticleProperties):void
Called internally by the particle animation set when assigning the set of static properties originally defined by the initParticleFunc of the set.
Parameters
param:ParticleProperties |
See also
getAGALFragmentCode | () | method |
public function getAGALFragmentCode(pass:MaterialPassBase, animationRegisterCache:AnimationRegisterCache):String
Returns the AGAL code of the particle animation node for use in the fragment shader.
Parameters
pass:MaterialPassBase | |
animationRegisterCache:AnimationRegisterCache |
String |
getAGALUVCode | () | method |
public function getAGALUVCode(pass:MaterialPassBase, animationRegisterCache:AnimationRegisterCache):String
Returns 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 |
getAGALVertexCode | () | method |
public function getAGALVertexCode(pass:MaterialPassBase, animationRegisterCache:AnimationRegisterCache):String
Returns the AGAL code of the particle animation node for use in the vertex shader.
Parameters
pass:MaterialPassBase | |
animationRegisterCache:AnimationRegisterCache |
String |
processAnimationSetting | () | method |
arcane function processAnimationSetting(particleAnimationSet:ParticleAnimationSet):void
Called internally by the particle animation set when determining the requirements of the particle animation node AGAL.
Parameters
particleAnimationSet:ParticleAnimationSet |