Packageorg.papervision3d.core.geom.renderables
Classpublic class Particle
InheritanceParticle Inheritance AbstractRenderable
ImplementsIRenderable

This is the single renderable Particle object, used by Particles.as See Particles.as for a full explanation.


Public Properties
 PropertyDefined by
 Inheritedinstance : DisplayObject3D
AbstractRenderable
  material : ParticleMaterial
Particle
  renderCommand : RenderParticle
Particle
  renderRect : Rectangle
The rectangle containing the particles visible area in 2D.
Particle
  renderScale : Number
Particle
  size : Number
The size or scale factor of the particle.
Particle
 Inherited_userData : UserData
AbstractRenderable
 InheriteduserData : UserData
AbstractRenderable
  vertex3D : Vertex3D
Particle
  x : Number
Particle
  y : Number
Particle
  z : Number
Particle
Public Methods
 MethodDefined by
  
Particle(material:ParticleMaterial, size:Number = 1, x:Number = 0, y:Number = 0, z:Number = 0)
Particle
  
getRenderListItem():IRenderListItem
Particle
  
updateRenderRect():void
This is called during the projection cycle.
Particle
Property detail
materialproperty
public var material:ParticleMaterial
renderCommandproperty 
public var renderCommand:RenderParticle
renderRectproperty 
public var renderRect:Rectangle

The rectangle containing the particles visible area in 2D.

renderScaleproperty 
public var renderScale:Number
sizeproperty 
public var size:Number

The size or scale factor of the particle.

vertex3Dproperty 
public var vertex3D:Vertex3D
xproperty 
x:Number  [read-write]Implementation
    public function get x():Number
    public function set x(value:Number):void
yproperty 
y:Number  [read-write]Implementation
    public function get y():Number
    public function set y(value:Number):void
zproperty 
z:Number  [read-write]Implementation
    public function get z():Number
    public function set z(value:Number):void
Constructor detail
Particle()constructor
public function Particle(material:ParticleMaterial, size:Number = 1, x:Number = 0, y:Number = 0, z:Number = 0)

Parameters
material:ParticleMaterial — The ParticleMaterial used for rendering the Particle
 
size:Number (default = 1) — The size of the particle. For some materials (ie BitmapParticleMaterial) this is used as a scale factor.
 
x:Number (default = 0) — x position of the particle
 
y:Number (default = 0) — y position of the particle
 
z:Number (default = 0) — z position of the particle
Method detail
getRenderListItem()method
public override function getRenderListItem():IRenderListItem

Returns
IRenderListItem
updateRenderRect()method 
public function updateRenderRect():void

This is called during the projection cycle. It updates the rectangular area that the particle is drawn into. It's important for the culling phase, and changes dependent on the type of material used.