Provides an abstract base class for particle animation nodes.

Static methods

staticgetParticleNodeName(particleNodeClass:Dynamic, particleNodeMode:Int):String

  • @param particleNodeClass - class of ParticleNodeBase child e.g ParticleBillboardNode, ParticleFollowNode...

Parameters:

particleNodeMode
  • mode of particle node ParticlePropertiesMode.GLOBAL, ParticlePropertiesMode.LOCAL_DYNAMIC or ParticlePropertiesMode.LOCAL_STATIC

Returns:

particle node name

Constructor

@:value({ priority : 1 })new(name:String, mode:Int, dataLength:Int, priority:Int = 1)

Creates a new ParticleNodeBase object.

Parameters:

name

Defines the generic name of the particle animation node.

mode

Defines whether the mode of operation acts on local properties of a particle or global properties of the node.

dataLength

Defines the length of the data used by the node when in LOCAL_STATIC mode.

[optional]

priority the priority of the particle animation node, used to order the agal generated in a particle animation set. Defaults to 1.

Variables

read onlydataLength:Int

read onlymode:Int

read onlyoneData:Vector<Float>

read onlypriority:Int

Methods

getAGALFragmentCode(pass:MaterialPassBase, animationRegisterCache:AnimationRegisterCache):String

Returns the AGAL code of the particle animation node for use in the fragment shader.

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.

getAGALVertexCode(pass:MaterialPassBase, animationRegisterCache:AnimationRegisterCache):String

Returns the AGAL code of the particle animation node for use in the vertex shader.

Inherited Variables

Defined by AnimationNodeBase

Defined by NamedAssetBase

read onlyassetFullPath:Array<Dynamic>

read onlyassetNamespace:String

id:String

name:String

read onlyoriginalName:String

Inherited Methods

Defined by AnimationNodeBase

dispose():Void

@inheritDoc

Defined by NamedAssetBase

assetPathEquals(name:String, ns:String):Bool

@:value({ overrideOriginal : true, ns : null })resetAssetPath(name:String, ?ns:String, overrideOriginal:Bool = true):Void