away3d.animators.nodes.ParticleSpriteSheetNode

A particle animation node used when a spritesheet texture is required to animate the particle. NB: to enable use of this node, the repeat property on the material has to be set to true.

Static variables

`@:value("UVVector3D")staticinlineread onlyUV_VECTOR3D:String = "UVVector3D"`

Reference for spritesheet node properties on a single particle (when in local property mode). Expects a Vector3D representing the cycleDuration (x), optional phaseTime (y).

Constructor

`@:value({ totalFrames : -1, cyclePhase : 0, cycleDuration : 1, numRows : 1, numColumns : 1 })new(mode:Int, usesCycle:Bool, usesPhase:Bool, numColumns:Int = 1, numRows:Int = 1, cycleDuration:Float = 1, cyclePhase:Float = 0, totalFrames:Int = -1)`

Creates a new ParticleSpriteSheetNode

Parameters:

`mode`	Defines whether the mode of operation acts on local properties of a particle or global properties of the node.
`[optional]`	numColumns Defines the number of columns in the spritesheet, when in global mode. Defaults to 1.
`[optional]`	numRows Defines the number of rows in the spritesheet, when in global mode. Defaults to 1.
`[optional]`	cycleDuration Defines the default cycle duration in seconds, when in global mode. Defaults to 1.
`[optional]`	cyclePhase Defines the default cycle phase, when in global mode. Defaults to 0.
`[optional]`	totalFrames Defines the total number of frames used by the spritesheet, when in global mode. Defaults to the number defined by numColumns and numRows.
`[optional]`	looping Defines whether the spritesheet animation is set to loop indefinitely. Defaults to true.

Variables

`read onlynumColumns:Float`

`read onlynumRows:Float`

`read onlytotalFrames:Float`

Methods

`getAGALUVCode(pass:MaterialPassBase, animationRegisterCache:AnimationRegisterCache):String`

@inheritDoc

`getAnimationState(animator:IAnimator):ParticleSpriteSheetState`

@inheritDoc

class ParticleSpriteSheetNode

package away3d.animators.nodes

extends ParticleNodeBase › AnimationNodeBase › NamedAssetBase

Static variables

`@:value("UVVector3D")staticinlineread onlyUV_VECTOR3D:String = "UVVector3D"`

Constructor

`@:value({ totalFrames : -1, cyclePhase : 0, cycleDuration : 1, numRows : 1, numColumns : 1 })new(mode:Int, usesCycle:Bool, usesPhase:Bool, numColumns:Int = 1, numRows:Int = 1, cycleDuration:Float = 1, cyclePhase:Float = 0, totalFrames:Int = -1)`

Variables

`read onlynumColumns:Float`

`read onlynumRows:Float`

`read onlytotalFrames:Float`

Methods

`getAGALUVCode(pass:MaterialPassBase, animationRegisterCache:AnimationRegisterCache):String`

`getAnimationState(animator:IAnimator):ParticleSpriteSheetState`

Inherited Variables

Defined by ParticleNodeBase

`read onlydataLength:Int`

`read onlymode:Int`

`read onlyoneData:Vector<Float>`

`read onlypriority:Int`

Defined by AnimationNodeBase

`read onlyassetType:String`

`read onlystateConstructor:(IAnimator, AnimationNodeBase) ‑> IAnimationState`

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`

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

Defined by AnimationNodeBase

`dispose():Void`

Defined by NamedAssetBase

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

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