View source

class ParticleColorNode

package away3d.animators.nodes

extends ParticleNodeBase › AnimationNodeBase › NamedAssetBase

Available on all platforms

A particle animation node used to control the color variation of a particle over time.

Static variables

@:value("ColorEndColorTransform")staticinlineread onlyCOLOR_END_COLORTRANSFORM:String = "ColorEndColorTransform"

Reference for color node properties on a single particle (when in local property mode). Expects a ColorTransform object representing the end color transform applied to the particle.

@:value("ColorStartColorTransform")staticinlineread onlyCOLOR_START_COLORTRANSFORM:String = "ColorStartColorTransform"

Reference for color node properties on a single particle (when in local property mode). Expects a ColorTransform object representing the start color transform applied to the particle.

Constructor

@:value({ cyclePhase : 0, cycleDuration : 1, endColor : null, startColor : null, usesPhase : false, usesCycle : false, usesOffset : true, usesMultiplier : true })new(mode:Int, usesMultiplier:Bool = true, usesOffset:Bool = true, usesCycle:Bool = false, usesPhase:Bool = false, ?startColor:ColorTransform, ?endColor:ColorTransform, cycleDuration:Float = 1, cyclePhase:Float = 0)

Creates a new ParticleColorNode

Parameters:

mode

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

[optional]

usesMultiplier Defines whether the node uses multiplier data in the shader for its color transformations. Defaults to true.

[optional]

usesOffset Defines whether the node uses offset data in the shader for its color transformations. Defaults to true.

[optional]

usesCycle Defines whether the node uses the cycleDuration property in the shader to calculate the period of the animation independent of particle duration. Defaults to false.

[optional]

usesPhase Defines whether the node uses the cyclePhase property in the shader to calculate a starting offset to the cycle rotation of the particle. Defaults to false.

[optional]

startColor Defines the default start color transform of the node, when in global mode.

[optional]

endColor Defines the default end color transform of the node, when in global mode.

[optional]

cycleDuration Defines the duration of the animation in seconds, used as a period independent of particle duration when in global mode. Defaults to 1.

[optional]

cyclePhase Defines the phase of the cycle in degrees, used as the starting offset of the cycle when in global mode. Defaults to 0.

Methods

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

@inheritDoc

getAnimationState(animator:IAnimator):ParticleColorState

@inheritDoc

Inherited Variables

Defined by ParticleNodeBase

read onlydataLength:Int

read onlymode:Int

read onlyoneData:Vector<Float>

read onlypriority:Int

Defined by AnimationNodeBase

Defined by NamedAssetBase

read onlyassetFullPath:Array<Dynamic>

read onlyassetNamespace:String

id:String

name:String

read onlyoriginalName:String

Inherited Methods

Defined by ParticleNodeBase

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.

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