Packageaway3d.animators.nodes
Classpublic class ParticleTimeNode
InheritanceParticleTimeNode Inheritance ParticleNodeBase Inheritance AnimationNodeBase Inheritance NamedAssetBase Inheritance flash.events.EventDispatcher

A particle animation node used as the base node for timekeeping inside a particle. Automatically added to a particle animation set on instatiation.



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
  
ParticleTimeNode(usesDuration:Boolean = false, usesLooping:Boolean = false, usesDelay:Boolean = false)
Creates a new ParticleTimeNode
ParticleTimeNode
 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.
ParticleTimeNode
  
ParticleTimeNode
 Inherited
resetAssetPath(name:String, ns:String = null, overrideOriginal:Boolean = true):void
NamedAssetBase
Public Constants
 ConstantDefined By
 InheritedDEFAULT_NAMESPACE : String = default
[static]
NamedAssetBase
Constructor Detail
ParticleTimeNode()Constructor
public function ParticleTimeNode(usesDuration:Boolean = false, usesLooping:Boolean = false, usesDelay:Boolean = false)

Creates a new ParticleTimeNode

Parameters
usesDuration:Boolean (default = false) — usesDuration Defines whether the node uses the duration data in the static properties function to determine how long a particle is visible for. Defaults to false.
 
usesLooping:Boolean (default = false) — usesDelay Defines whether the node uses the delay data in the static properties function to determine how long a particle is hidden for. Defaults to false. Requires usesDuration to be true.
 
usesDelay:Boolean (default = false) — usesLooping Defines whether the node creates a looping timeframe for each particle determined by the startTime, duration and delay data in the static properties function. Defaults to false. Requires usesLooping to be true.
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):ParticleTimeState

Parameters

animator:IAnimator

Returns
ParticleTimeState