Packageaway3d.animators.nodes
Classpublic class ParticleColorNode
InheritanceParticleColorNode Inheritance ParticleNodeBase Inheritance AnimationNodeBase Inheritance NamedAssetBase Inheritance flash.events.EventDispatcher

A particle animation node used to control the color 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
  
ParticleColorNode(mode:uint, usesMultiplier:Boolean = true, usesOffset:Boolean = true, usesCycle:Boolean = false, usesPhase:Boolean = false, startColor:ColorTransform = null, endColor:ColorTransform = null, cycleDuration:Number = 1, cyclePhase:Number = 0)
Creates a new ParticleColorNode
ParticleColorNode
 Inherited
assetPathEquals(name:String, ns:String):Boolean
NamedAssetBase
 Inherited
dispose():void
Cleans up resources used by this asset.
AnimationNodeBase
  
getAGALFragmentCode(pass:MaterialPassBase, animationRegisterCache:AnimationRegisterCache):String
[override] Returns the AGAL code of the particle animation node for use in the fragment shader.
ParticleColorNode
 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.
ParticleColorNode
  
getAnimationState(animator:IAnimator):ParticleColorState
ParticleColorNode
 Inherited
resetAssetPath(name:String, ns:String = null, overrideOriginal:Boolean = true):void
NamedAssetBase
Public Constants
 ConstantDefined By
  COLOR_END_COLORTRANSFORM : String = ColorEndColorTransform
[static] Reference for color node properties on a single particle (when in local property mode).
ParticleColorNode
  COLOR_START_COLORTRANSFORM : String = ColorStartColorTransform
[static] Reference for color node properties on a single particle (when in local property mode).
ParticleColorNode
 InheritedDEFAULT_NAMESPACE : String = default
[static]
NamedAssetBase
Constructor Detail
ParticleColorNode()Constructor
public function ParticleColorNode(mode:uint, usesMultiplier:Boolean = true, usesOffset:Boolean = true, usesCycle:Boolean = false, usesPhase:Boolean = false, startColor:ColorTransform = null, endColor:ColorTransform = null, cycleDuration:Number = 1, cyclePhase:Number = 0)

Creates a new ParticleColorNode

Parameters
mode:uint — Defines whether the mode of operation acts on local properties of a particle or global properties of the node.
 
usesMultiplier:Boolean (default = true) — usesMultiplier Defines whether the node uses multiplier data in the shader for its color transformations. Defaults to true.
 
usesOffset:Boolean (default = true) — usesOffset Defines whether the node uses offset data in the shader for its color transformations. Defaults to true.
 
usesCycle:Boolean (default = false) — usesCycle Defines whether the node uses the cycleDuration property in the shader to calculate the period of the animation independent of particle duration. Defaults to false.
 
usesPhase:Boolean (default = false) — usesPhase Defines whether the node uses the cyclePhase property in the shader to calculate a starting offset to the cycle rotation of the particle. Defaults to false.
 
startColor:ColorTransform (default = null) — startColor Defines the default start color transform of the node, when in global mode.
 
endColor:ColorTransform (default = null) — endColor Defines the default end color transform of the node, when in global mode.
 
cycleDuration:Number (default = 1) — cycleDuration Defines the 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 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

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

Returns
String
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):ParticleColorState

Parameters

animator:IAnimator

Returns
ParticleColorState
processAnimationSetting()method 
override 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

Constant Detail
COLOR_END_COLORTRANSFORMConstant
public static const COLOR_END_COLORTRANSFORM:String = ColorEndColorTransform

Reference for color node properties on a single particle (when in local property mode). Expects a ColorTransform object representing the end color transform applied to the particle.

COLOR_START_COLORTRANSFORMConstant 
public static const COLOR_START_COLORTRANSFORM:String = ColorStartColorTransform

Reference for color node properties on a single particle (when in local property mode). Expects a ColorTransform object representing the start color transform applied to the particle.





Thu Nov 15 2012, 12:08 PM Z