Packageaway3d.animators.nodes
Classpublic class ParticleScaleNode
InheritanceParticleScaleNode Inheritance ParticleNodeBase Inheritance AnimationNodeBase Inheritance NamedAssetBase Inheritance flash.events.EventDispatcher

A particle animation node used to control the scale variation of a particle over time.


Public Properties
 PropertyDefined By
 InheritedassetFullPath : Array
[read-only]
NamedAssetBase
 InheritedassetNamespace : String
[read-only]
NamedAssetBase
 InheritedassetType : String
[read-only]
AnimationNodeBase
 InheriteddataLength : int
[read-only] Returns the length of the data used by the node when in LOCAL_STATIC mode.
ParticleNodeBase
 Inheritedmode : uint
[read-only] Returns the property mode of the particle animation node.
ParticleNodeBase
 Inheritedname : String
NamedAssetBase
 InheritedoneData : 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
 InheritedoriginalName : String
[read-only] The original name used for this asset in the resource (e.g.
NamedAssetBase
 Inheritedpriority : int
[read-only] Returns the priority of the particle animation node, used to order the agal generated in a particle animation set.
ParticleNodeBase
 InheritedstateClass : Class
[read-only]
AnimationNodeBase
Protected Properties
 PropertyDefined By
 Inherited_dataLength : uint = 3
ParticleNodeBase
 Inherited_mode : uint
ParticleNodeBase
 Inherited_oneData : Vector.<Number>
ParticleNodeBase
 Inherited_stateClass : Class
AnimationNodeBase
Public Methods
 MethodDefined By
  
ParticleScaleNode(mode:uint, usesCycle:Boolean, usesPhase:Boolean, minScale:Number = 1, maxScale:Number = 1, cycleDuration:Number = 1, cyclePhase:Number = 0)
Creates a new ParticleScaleNode
ParticleScaleNode
 Inherited
assetPathEquals(name:String, ns:String):Boolean
NamedAssetBase
 Inherited
dispose():void
Cleans up resources used by this asset.
AnimationNodeBase
 Inherited
getAGALFragmentCode(pass:MaterialPassBase, animationRegisterCache:AnimationRegisterCache):String
Returns the AGAL code of the particle animation node for use in the fragment shader.
ParticleNodeBase
 Inherited
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.
ParticleNodeBase
  
getAGALVertexCode(pass:MaterialPassBase, animationRegisterCache:AnimationRegisterCache):String
[override] Returns the AGAL code of the particle animation node for use in the vertex shader.
ParticleScaleNode
  
getAnimationState(animator:IAnimator):ParticleScaleState
ParticleScaleNode
 Inherited
resetAssetPath(name:String, ns:String = null, overrideOriginal:Boolean = true):void
NamedAssetBase
Public Constants
 ConstantDefined By
 InheritedDEFAULT_NAMESPACE : String = default
[static]
NamedAssetBase
  SCALE_VECTOR3D : String = ScaleVector3D
[static] Reference for scale node properties on a single particle (when in local property mode).
ParticleScaleNode
Constructor Detail
ParticleScaleNode()Constructor
public function ParticleScaleNode(mode:uint, usesCycle:Boolean, usesPhase:Boolean, minScale:Number = 1, maxScale:Number = 1, cycleDuration:Number = 1, cyclePhase:Number = 0)

Creates a new ParticleScaleNode

Parameters
mode:uint — Defines whether the mode of operation acts on local properties of a particle or global properties of the node.
 
usesCycle:Boolean — usesCycle Defines whether the node uses the cycleDuration property in the shader to calculate the period of animation independent of particle duration. Defaults to false.
 
usesPhase:Boolean — usesPhase Defines whether the node uses the cyclePhase property in the shader to calculate a starting offset to the animation cycle. Defaults to false.
 
minScale:Number (default = 1) — minScale Defines the default min scale transform of the node, when in global mode. Defaults to 1.
 
maxScale:Number (default = 1) — maxScale Defines the default max color transform of the node, when in global mode. Defaults to 1.
 
cycleDuration:Number (default = 1) — cycleDuration Defines the default duration of the animation in seconds, used as a period independent of particle duration when in global mode. Defaults to 1.
 
cyclePhase:Number (default = 0) — cyclePhase Defines the default phase of the cycle in degrees, used as the starting offset of the cycle when in global mode. Defaults to 0.
Method Detail
generatePropertyOfOneParticle()method
override 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

getAGALVertexCode()method 
override 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

Returns
String
getAnimationState()method 
public function getAnimationState(animator:IAnimator):ParticleScaleState

Parameters

animator:IAnimator

Returns
ParticleScaleState
Constant Detail
SCALE_VECTOR3DConstant
public static const SCALE_VECTOR3D:String = ScaleVector3D

Reference for scale node properties on a single particle (when in local property mode). Expects a Vector3D representing the min scale (x), max scale(y), optional cycle speed (z) and phase offset (w) applied to the particle.





Thu Nov 15 2012, 12:08 PM Z