Packageaway3d.animators.nodes
Classpublic class ParticleBezierCurveNode
InheritanceParticleBezierCurveNode Inheritance ParticleNodeBase Inheritance AnimationNodeBase Inheritance NamedAssetBase Inheritance flash.events.EventDispatcher

A particle animation node used to control the position of a particle over time along a bezier curve.



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
  
ParticleBezierCurveNode(mode:uint, controlPoint:Vector3D = null, endPoint:Vector3D = null)
Creates a new ParticleBezierCurveNode
ParticleBezierCurveNode
 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.
ParticleBezierCurveNode
  
ParticleBezierCurveNode
 Inherited
resetAssetPath(name:String, ns:String = null, overrideOriginal:Boolean = true):void
NamedAssetBase
Public Constants
 ConstantDefined By
  BEZIER_CONTROL_VECTOR3D : String = BezierControlVector3D
[static] Reference for bezier curve node properties on a single particle (when in local property mode).
ParticleBezierCurveNode
  BEZIER_END_VECTOR3D : String = BezierEndVector3D
[static] Reference for bezier curve node properties on a single particle (when in local property mode).
ParticleBezierCurveNode
 InheritedDEFAULT_NAMESPACE : String = default
[static]
NamedAssetBase
Constructor Detail
ParticleBezierCurveNode()Constructor
public function ParticleBezierCurveNode(mode:uint, controlPoint:Vector3D = null, endPoint:Vector3D = null)

Creates a new ParticleBezierCurveNode

Parameters
mode:uint — Defines whether the mode of operation acts on local properties of a particle or global properties of the node.
 
controlPoint:Vector3D (default = null) — controlPoint Defines the default control point of the node, used when in global mode.
 
endPoint:Vector3D (default = null) — endPoint Defines the default end point 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):ParticleBezierCurveState

Parameters

animator:IAnimator

Returns
ParticleBezierCurveState
Constant Detail
BEZIER_CONTROL_VECTOR3DConstant
public static const BEZIER_CONTROL_VECTOR3D:String = BezierControlVector3D

Reference for bezier curve node properties on a single particle (when in local property mode). Expects a Vector3D object representing the control point position (0, 1, 2) of the curve.

BEZIER_END_VECTOR3DConstant 
public static const BEZIER_END_VECTOR3D:String = BezierEndVector3D

Reference for bezier curve node properties on a single particle (when in local property mode). Expects a Vector3D object representing the end point position (0, 1, 2) of the curve.