Particles

Kind of class:	public class
Package:	org.papervision3d.core.geom
Inherits from:	Vertices3D < DisplayObject3D < DisplayObjectContainer3D < EventDispatcher
Known subclasses:	ParticleField
Classpath:	org.papervision3d.core.geom.Particles
File last modified:	Sunday, 02 March 2008, 15:23:39

► View source

▼ Hide source

package org.papervision3d.core.geom
{
    /**
     * @Author Ralph Hauwert
     * 
     * -     updated by Seb Lee-Delisle to allow the updating of a renderRect property of a particle
     *         used for smart culling of particles
     */
    
    import org.papervision3d.core.geom.renderables.Particle;
    import org.papervision3d.core.render.data.RenderSessionData;
    import org.papervision3d.objects.DisplayObject3D;
    
    public class Particles extends Vertices3D
    {
        
        private var vertices:Array;
        public var particles:Array;
        
        /**
         * VertexParticles
         * 
         * A simple Particle Renderer for Papervision3D.
         * 
         * Renders added particles to a given container using Flash's drawing API.
         */
        public function Particles(name:String = "VertexParticles")
        {
            this.vertices = new Array();
            this.particles = new Array();
            super(vertices, name);
        }
        
        /**
         * Project
         */
        public override function project( parent :DisplayObject3D, renderSessionData:RenderSessionData ):Number
        {
            super.project(parent,renderSessionData);
            var p:Particle;
            var fz:Number = (renderSessionData.camera.focus*renderSessionData.camera.zoom);
             
            for each(p in particles)
            {
                
                p.renderScale = fz / (renderSessionData.camera.focus + p.vertex3D.vertex3DInstance.z);
                p.updateRenderRect();
                    
                
                if(renderSessionData.viewPort.particleCuller.testParticle(p)){
                    
                    p.renderCommand.screenDepth = p.vertex3D.vertex3DInstance.z;
                    renderSessionData.renderer.addToRenderList(p.renderCommand);    
                }else{
                    renderSessionData.renderStatistics.culledParticles++;
                }
            }
            return 1;
        }
        
        /**
         * addParticle(particle);
         * 
         * @param    particle    partical to be added and rendered by to this VertexParticles Object.
         */
        public function addParticle(particle:Particle):void
        {
            particle.instance = this;
            particles.push(particle);
            vertices.push(particle.vertex3D);
        }
        
        /**
         * removeParticle(particle);
         * 
         * @param    particle    particle to be removed from this VertexParticles Object.
         */
        public function removeParticle(particle:Particle):void
        {
            particle.instance = null;
            particles.splice(particles.indexOf(particle,0));
            vertices.splice(vertices.indexOf(particle.vertex3D,0));
        }
        
        /**
         * removeAllParticles()
         * 
         * removes all particles in this VertexParticles Object.
         */
        public function removeAllParticles():void
        {
            particles = new Array();
            vertices = new Array();
            geometry.vertices = vertices;
        }
        
        
    }
}

Summary

Constructor

Particles (name:String = "VertexParticles")
- VertexParticles A simple Particle Renderer for Papervision3D.

Namespaces

DisplayObject3D

pv3dview

Constants

Constants inherited from DisplayObject3D

MESH_SORT_CENTER MESH_SORT_CLOSE MESH_SORT_FAR

Class properties

Class properties inherited from DisplayObject3D

_totalDisplayObjects BACKWARD DOWN entry_count faceLevelMode FORWARD LEFT RIGHT sortedArray toDEGREES toRADIANS UP ZERO

Instance properties

particles : Array

Instance methods

project (parent:DisplayObject3D) : Number
- Project
addParticle (particle:Particle) : void
- addParticle(particle);
removeParticle (particle:Particle) : void
- removeParticle(particle);
removeAllParticles : void
- removeAllParticles() removes all particles in this VertexParticles Object.

Instance methods inherited from Vertices3D

boundingBox project projectFrustum transformVertices

Instance methods inherited from DisplayObjectContainer3D

addChild addChildren addCollada childrenList getChildByName removeChild removeChildByName toString

Constructor

Particles

public function Particles (

name:String = "VertexParticles")

VertexParticles

A simple Particle Renderer for Papervision3D.

Renders added particles to a given container using Flash's drawing API.

Instance properties

particles

public particles:Array

(read,write)

Instance methods

addParticle

public function addParticle (

particle:Particle) : void

addParticle(particle);

Parameters:

particle:

partical to be added and rendered by to this VertexParticles Object.

project

override public function project (

parent:DisplayObject3D, renderSessionData:RenderSessionData) : Number

Project

Parameters:

parent :

The DisplayObject3D object that contains this display object.

renderSessionData:

Data for the current render.

Overrides:

Vertices3D.project

removeAllParticles

public function removeAllParticles (

) : void

removeAllParticles()

removes all particles in this VertexParticles Object.

removeParticle

public function removeParticle (

particle:Particle) : void

removeParticle(particle);

Parameters:

particle:

particle to be removed from this VertexParticles Object.