Packageaway3d.animators.nodes
Classpublic class ParticleOscillatorNode
InheritanceParticleOscillatorNode Inheritance ParticleNodeBase Inheritance AnimationNodeBase Inheritance NamedAssetBase Inheritance flash.events.EventDispatcher

A particle animation node used to control the position of a particle over time using simple harmonic motion.


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
  
ParticleOscillatorNode(mode:uint, oscillator:Vector3D = null)
Creates a new ParticleOscillatorNode
ParticleOscillatorNode
 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.
ParticleOscillatorNode
  
getAnimationState(animator:IAnimator):ParticleOscillatorState
ParticleOscillatorNode
 Inherited
resetAssetPath(name:String, ns:String = null, overrideOriginal:Boolean = true):void
NamedAssetBase
Public Constants
 ConstantDefined By
 InheritedDEFAULT_NAMESPACE : String = default
[static]
NamedAssetBase
  OSCILLATOR_VECTOR3D : String = OscillatorVector3D
[static] Reference for ocsillator node properties on a single particle (when in local property mode).
ParticleOscillatorNode
Constructor Detail
ParticleOscillatorNode()Constructor
public function ParticleOscillatorNode(mode:uint, oscillator:Vector3D = null)

Creates a new ParticleOscillatorNode

Parameters
mode:uint — Defines whether the mode of operation acts on local properties of a particle or global properties of the node.
 
oscillator:Vector3D (default = null) — oscillator Defines the default oscillator axis (x, y, z) and cycleDuration (w) of the node, used when in global mode.
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):ParticleOscillatorState

Parameters

animator:IAnimator

Returns
ParticleOscillatorState
Constant Detail
OSCILLATOR_VECTOR3DConstant
public static const OSCILLATOR_VECTOR3D:String = OscillatorVector3D

Reference for ocsillator node properties on a single particle (when in local property mode). Expects a Vector3D object representing the axis (x,y,z) and cycle speed (w) of the motion on the particle.





Thu Nov 15 2012, 12:08 PM Z