away3d.animators.nodes.ParticleOrbitNode

A particle animation node used to control the position of a particle over time around a circular orbit.

Static variables

`@:value("OrbitVector3D")staticinlineread onlyORBIT_VECTOR3D:String = "OrbitVector3D"`

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

Constructor

`@:value({ eulers : null, cyclePhase : 0, cycleDuration : 1, radius : 100, usesPhase : false, usesCycle : false, usesEulers : true })new(mode:Int, usesEulers:Bool = true, usesCycle:Bool = false, usesPhase:Bool = false, radius:Float = 100, cycleDuration:Float = 1, cyclePhase:Float = 0, ?eulers:Vector3D)`

Creates a new ParticleOrbitNode object.

Parameters:

`mode`	Defines whether the mode of operation acts on local properties of a particle or global properties of the node.
`[optional]`	usesEulers Defines whether the node uses the `eulers` property in the shader to calculate a rotation on the orbit. Defaults to true.
`[optional]`	usesCycle Defines whether the node uses the `cycleDuration` property in the shader to calculate the period of the orbit 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]`	radius Defines the radius of the orbit when in global mode. Defaults to 100.
`[optional]`	cycleDuration Defines the duration of the orbit in seconds, used as a period independent of particle duration when in global mode. Defaults to 1.
`[optional]`	cyclePhase Defines the phase of the orbit in degrees, used as the starting offset of the cycle when in global mode. Defaults to 0.
`[optional]`	eulers Defines the euler rotation in degrees, applied to the orientation of the orbit when in global mode.

Methods

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

@inheritDoc

`getAnimationState(animator:IAnimator):ParticleOrbitState`

@inheritDoc

class ParticleOrbitNode

package away3d.animators.nodes

extends ParticleNodeBase › AnimationNodeBase › NamedAssetBase

Static variables

`@:value("OrbitVector3D")staticinlineread onlyORBIT_VECTOR3D:String = "OrbitVector3D"`

Constructor

Methods

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

`getAnimationState(animator:IAnimator):ParticleOrbitState`

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`

`getAGALUVCode(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`