Packageaway3d.animators.nodes
Classpublic class ParticleUVNode
InheritanceParticleUVNode Inheritance ParticleNodeBase Inheritance AnimationNodeBase Inheritance NamedAssetBase Inheritance flash.events.EventDispatcher

A particle animation node used to control the UV offset and scale of a particle over time.



Public Properties
 PropertyDefined By
 InheritedassetFullPath : Array
[read-only]
NamedAssetBase
 InheritedassetNamespace : String
[read-only]
NamedAssetBase
 InheritedassetType : String
[read-only]
AnimationNodeBase
  axis : String
ParticleUVNode
  cycle : Number
ParticleUVNode
 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
  scale : Number
ParticleUVNode
 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
  
ParticleUVNode(mode:uint, cycle:Number = 1, scale:Number = 1, axis:String = x)
Creates a new ParticleTimeNode
ParticleUVNode
 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
  
getAGALUVCode(pass:MaterialPassBase, animationRegisterCache:AnimationRegisterCache):String
[override] Returns the AGAL code of the particle animation node for use in the fragment shader when UV coordinates are required.
ParticleUVNode
 Inherited
getAGALVertexCode(pass:MaterialPassBase, animationRegisterCache:AnimationRegisterCache):String
Returns the AGAL code of the particle animation node for use in the vertex shader.
ParticleNodeBase
  
ParticleUVNode
 Inherited
resetAssetPath(name:String, ns:String = null, overrideOriginal:Boolean = true):void
NamedAssetBase
Public Constants
 ConstantDefined By
 InheritedDEFAULT_NAMESPACE : String = default
[static]
NamedAssetBase
  GLOBAL : uint = 1
[static] Used to set the time node into global property mode.
ParticleUVNode
  U_AXIS : String = x
[static]
ParticleUVNode
  V_AXIS : String = y
[static]
ParticleUVNode
Property Detail
axisproperty
axis:String


Implementation
    public function get axis():String
    public function set axis(value:String):void
cycleproperty 
cycle:Number


Implementation
    public function get cycle():Number
    public function set cycle(value:Number):void
scaleproperty 
scale:Number


Implementation
    public function get scale():Number
    public function set scale(value:Number):void
Constructor Detail
ParticleUVNode()Constructor
public function ParticleUVNode(mode:uint, cycle:Number = 1, scale:Number = 1, axis:String = x)

Creates a new ParticleTimeNode

Parameters
mode:uint — Defines whether the mode of operation acts on local properties of a particle or global properties of the node.
 
cycle:Number (default = 1) — cycle Defines whether the time track is in loop mode. Defaults to false.
 
scale:Number (default = 1) — scale Defines whether the time track is in loop mode. Defaults to false.
 
axis:String (default = x) — axis Defines whether the time track is in loop mode. Defaults to false.
Method Detail
getAGALUVCode()method
override 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

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

Parameters

animator:IAnimator

Returns
ParticleUVState
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
GLOBALConstant
public static const GLOBAL:uint = 1

Used to set the time node into global property mode.

U_AXISConstant 
public static const U_AXIS:String = x

V_AXISConstant 
public static const V_AXIS:String = y