Packageidv.cjcat.stardust.threeD.actions
Classpublic class VelocityField3D
InheritanceVelocityField3D Inheritance Action3D Inheritance Action Inheritance StardustElement

Alters a particle's velocity based on a vector field.

The returned value of a field is a MotionData3D object, which is a 3D value class. The particle's velocity X, Y, and Z components are set to the MotionData3D object's x, y, and z properties, respectively.

Default priority = -2;



Public Properties
 PropertyDefined by
 Inheritedactive : Boolean
Denotes if the action is active, true by default.
Action
  field : Field3D
VelocityField3D
 Inheritedmask : int
The action will affect a particle only if it's active and the bitwise AND of the action's mask and the particle's mask is non-zero, 1 by default.
Action
 Inheritedname : String
StardustElement
 InheritedneedsSortedParticles : Boolean
Tells the emitter whether this action requires that particles must be sorted before the update() calls.
Action
 InheritedonAdd : ISignal
Dispatched when the added to an emitter.
Action
 InheritedonPriorityChange : ISignal
Dispatched when the action's priority is changed.
Action
 InheritedonRemove : ISignal
Dispatched when the removed from an emitter.
Action
 Inheritedpriority : int
Actions will be sorted by the associated emitter according to their priorities.
Action
 InheritedskipThisAction : Boolean
Reset to false on each emitter step.
Action
 Inheritedsupports2D : Boolean
Whether this action supports 2D.
Action
 Inheritedsupports3D : Boolean
Whether this action supports 3D.
Action
Public Methods
 MethodDefined by
  
VelocityField3D(field:Field3D = null)
VelocityField3D
 Inherited
Action
 Inherited
[Abstract Method] Returns the related objects of the element.
StardustElement
 Inherited
getXMLTag():XML
Returns the root tag of the XML representation.
StardustElement
  
getXMLTagName():String
VelocityField3D
  
parseXML(xml:XML, builder:XMLBuilder = null):void
VelocityField3D
 Inherited
postUpdate(emitter:Emitter, time:Number):void
[Template Method] This method is called once after each Emitter.step() method call, after the update() calls with each particles in the emitter.
Action
  
toXML():XML
VelocityField3D
  
update(emitter:Emitter, particle:Particle, time:Number):void
VelocityField3D
Property detail
fieldproperty
public var field:Field3D
Constructor detail
VelocityField3D()constructor
public function VelocityField3D(field:Field3D = null)Parameters
field:Field3D (default = null)
Method detail
getXMLTagName()method
public override function getXMLTagName():String

Returns
String
parseXML()method 
public override function parseXML(xml:XML, builder:XMLBuilder = null):voidParameters
xml:XML
 
builder:XMLBuilder (default = null)
toXML()method 
public override function toXML():XML

Returns
XML
update()method 
public final override function update(emitter:Emitter, particle:Particle, time:Number):voidParameters
emitter:Emitter
 
particle:Particle
 
time:Number