SceneObject3D

Kind of class:	public class
Package:	org.papervision3d.core.proto
Inherits from:	DisplayObjectContainer3D < EventDispatcher
Known subclasses:	Scene3D
Classpath:	org.papervision3d.core.proto.SceneObject3D
File last modified:	Sunday, 02 March 2008, 15:23:35

► View source

▼ Hide source

/*
 *  PAPER    ON   ERVIS  NPAPER ISION  PE  IS ON  PERVI IO  APER  SI  PA
 *  AP  VI  ONPA  RV  IO PA     SI  PA ER  SI NP PE     ON AP  VI ION AP
 *  PERVI  ON  PE VISIO  APER   IONPA  RV  IO PA  RVIS  NP PE  IS ONPAPE
 *  ER     NPAPER IS     PE     ON  PE  ISIO  AP     IO PA ER  SI NP PER
 *  RV     PA  RV SI     ERVISI NP  ER   IO   PE VISIO  AP  VISI  PA  RV3D
 *  ______________________________________________________________________
 *  papervision3d.org • blog.papervision3d.org • osflash.org/papervision3d
 */

/*
 * Copyright 2006 (c) Carlos Ulloa Matesanz, noventaynueve.com.
 *
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use,
 * copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following
 * conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 */

// ______________________________________________________________________
//                                                          SceneObject3D

package org.papervision3d.core.proto
{
    import org.papervision3d.Papervision3D;
    import org.papervision3d.core.animation.core.AnimationEngine;
    import org.papervision3d.materials.utils.MaterialsList;
    import org.papervision3d.objects.DisplayObject3D;
    
    /**
    * The SceneObject3D class is the base class for all scenes.
    * <p/>
    * A scene is the place where objects are placed, it contains the 3D environment.
    * <p/>
    * The scene manages all objects rendered in Papervision3D. It extends the DisplayObjectContainer3D class to arrange the display objects.
    * <p/>
    * SceneObject3D is an abstract base class; therefore, you cannot call SceneObject3D directly.
    */
    public class SceneObject3D extends DisplayObjectContainer3D
    {        
        // __________________________________________________________________________
        //                                                                     STATIC
        
    
        /**
        * It contains a list of DisplayObject3D objects in the scene.
        */
        public var objects :Array;
    
        /**
        * It contains a list of materials in the scene.
        */
        public var materials :MaterialsList;
        
        /**
         * A boolean flag indicating whether or not to use animation.
         */
        public var animated:Boolean = false;
    
        /**
         * A reference to the AnimationEngine. Only available if the scene3d is set to animated. @see org.papervision3d.animation.core.AnimationEngine 
         */
        public var animationEngine:AnimationEngine;
        
        
        
        // ___________________________________________________________________ N E W
        //
        // NN  NN EEEEEE WW    WW
        // NNN NN EE     WW WW WW
        // NNNNNN EEEE   WWWWWWWW
        // NN NNN EE     WWW  WWW
        // NN  NN EEEEEE WW    WW
    
        /**
        * The SceneObject3D class lets you create scene classes.
        *
        * @param    container    The Sprite that you draw into when rendering. If not defined, each object must have it's own private container.
        */
        public function SceneObject3D()
        {
            this.objects = new Array();
            this.materials = new MaterialsList();
    
            Papervision3D.log( Papervision3D.NAME + " " + Papervision3D.VERSION + " (" + Papervision3D.DATE + ")\n" );
            trace("PV3D 2.0a WARNING : DO NOT USE WITH BETA 9 PLAYERS. ONLY WITH OFFICIAL TO TEST.");
            trace("CHECK YOUR VERSION!");
            this.root = this;
        }
    
        // ___________________________________________________________________ A D D C H I L D
        //
        //   AA   DDDDD  DDDDD   CCCC  HH  HH II LL     DDDDD
        //  AAAA  DD  DD DD  DD CC  CC HH  HH II LL     DD  DD
        // AA  AA DD  DD DD  DD CC     HHHHHH II LL     DD  DD
        // AAAAAA DD  DD DD  DD CC  CC HH  HH II LL     DD  DD
        // AA  AA DDDDD  DDDDD   CCCC  HH  HH II LLLLLL DDDDD
    
        /**
        * Adds a child DisplayObject3D instance to the scene.
        *
        * If you add a GeometryObject3D symbol, a new DisplayObject3D instance is created.
        *
        * [TODO: If you add a child object that already has a different display object container as a parent, the object is removed from the child list of the other display object container.]
        *
        * @param    child    The GeometryObject3D symbol or DisplayObject3D instance to add as a child of the scene.
        * @param    name    An optional name of the child to add or create. If no name is provided, the child name will be used.
        * @return    The DisplayObject3D instance that you have added or created.
        */
        public override function addChild( child:DisplayObject3D, name:String=null ):DisplayObject3D
        {
            var newChild:DisplayObject3D =    super.addChild( child, name ? name : child.name );
            child.scene = this;
            this.objects.push( newChild );
            return newChild;
        }
    
        /**
        * Removes the specified child DisplayObject3D instance from the child and object list of the scene.
        * </p>
        * [TODO: The parent property of the removed child is set to null, and the object is garbage collected if no other references to the child exist.]
        * </p>
        * The garbage collector is the process by which Flash Player reallocates unused memory space. When a variable or object is no longer actively referenced or stored somewhere, the garbage collector sweeps through and wipes out the memory space it used to occupy if no other references to it exist.
        * </p>
        * @param    child    The DisplayObject3D instance to remove.
        * @return    The DisplayObject3D instance that you pass in the child parameter.
        */
        public override function removeChild( child:DisplayObject3D ):DisplayObject3D
        {
            super.removeChild( child );
    
            for (var i:int = 0; i < this.objects.length; i++ )
            {
                if (this.objects[i] === child )
                {
                    this.objects.splice(i, 1);
                    return child;
                }
            }
            return child;
        }
                
            
    }
}

The SceneObject3D class is the base class for all scenes.

A scene is the place where objects are placed, it contains the 3D environment.

The scene manages all objects rendered in Papervision3D. It extends the DisplayObjectContainer3D class to arrange the display objects.

SceneObject3D is an abstract base class; therefore, you cannot call SceneObject3D directly.

Summary

Constructor

SceneObject3D

Instance properties

objects : Array
- It contains a list of DisplayObject3D objects in the scene.
materials : MaterialsList
- It contains a list of materials in the scene.
animated : Boolean
- A boolean flag indicating whether or not to use animation.
animationEngine : AnimationEngine
- A reference to the AnimationEngine.

Instance properties inherited from DisplayObjectContainer3D

_children _childrenByName _childrenTotal children numChildren root

Instance methods

addChild (child:DisplayObject3D, name:String = null) : DisplayObject3D
- Adds a child DisplayObject3D instance to the scene.
removeChild (child:DisplayObject3D) : DisplayObject3D
- Removes the specified child DisplayObject3D instance from the child and object list of the scene.

Instance methods inherited from DisplayObjectContainer3D

addChild addChildren addCollada childrenList getChildByName removeChild removeChildByName toString

Constructor

SceneObject3D

public function SceneObject3D (

)

The SceneObject3D class lets you create scene classes.

Parameters:

container:

The Sprite that you draw into when rendering. If not defined, each object must have it's own private container.

Instance properties

animated

public animated:Boolean = false

(read,write)

A boolean flag indicating whether or not to use animation.

animationEngine

public animationEngine:AnimationEngine

(read,write)

A reference to the AnimationEngine. Only available if the scene3d is set to animated. @see org.papervision3d.animation.core.AnimationEngine

materials

public materials:MaterialsList

(read,write)

It contains a list of materials in the scene.

objects

public objects:Array

(read,write)

It contains a list of DisplayObject3D objects in the scene.

Instance methods

addChild

override public function addChild (

child:DisplayObject3D, name:String = null) : DisplayObject3D

Adds a child DisplayObject3D instance to the scene.

If you add a GeometryObject3D symbol, a new DisplayObject3D instance is created.

[TODO: If you add a child object that already has a different display object container as a parent, the object is removed from the child list of the other display object container.]

Parameters:

child:

The GeometryObject3D symbol or DisplayObject3D instance to add as a child of the scene.

name :

An optional name of the child to add or create. If no name is provided, the child name will be used.

Returns:

The DisplayObject3D instance that you have added or created.

Overrides:

DisplayObjectContainer3D.addChild

removeChild

override public function removeChild (

child:DisplayObject3D) : DisplayObject3D

Removes the specified child DisplayObject3D instance from the child and object list of the scene.

[TODO: The parent property of the removed child is set to null, and the object is garbage collected if no other references to the child exist.]

The garbage collector is the process by which Flash Player reallocates unused memory space. When a variable or object is no longer actively referenced or stored somewhere, the garbage collector sweeps through and wipes out the memory space it used to occupy if no other references to it exist.

Parameters:

child:

The DisplayObject3D instance to remove.

Returns:

The DisplayObject3D instance that you pass in the child parameter.

Overrides:

DisplayObjectContainer3D.removeChild