Packageorg.papervision3d.core.proto
Classpublic class SceneObject3D
InheritanceSceneObject3D Inheritance DisplayObjectContainer3D Inheritance flash.events.EventDispatcher
SubclassesScene3D

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.


Public Properties
 PropertyDefined by
 Inheritedchildren : Object
Returns the children object.
DisplayObjectContainer3D
  container : Sprite
The Sprite that you draw into when rendering.
SceneObject3D
  materials : MaterialsList
It contains a list of materials in the scene.
SceneObject3D
 InheritednumChildren : int
Returns the number of children of this object.
DisplayObjectContainer3D
  objects : Array
It contains a list of DisplayObject3D objects in the scene.
SceneObject3D
 Inheritedroot : DisplayObjectContainer3D
[read-only] [read-only] The scene, which is the top-most displayObjectContainer3D in the tree structure.
DisplayObjectContainer3D
  stats : Object
An object that contains total and current statistics.
SceneObject3D
Protected Properties
 PropertyDefined by
 Inherited_children : Dictionary
[internal-use] Names indexed by children.
DisplayObjectContainer3D
 Inherited_childrenByName : Object
[internal-use] Children indexed by name.
DisplayObjectContainer3D
Public Methods
 MethodDefined by
  
SceneObject3D(container:Sprite)
The SceneObject3D class lets you create scene classes.
SceneObject3D
  
addChild(child:DisplayObject3D, name:String = null):DisplayObject3D
Adds a child DisplayObject3D instance to the scene.
SceneObject3D
 Inherited
addChildren(parent:DisplayObject3D):DisplayObjectContainer3D
Adds all the children of a DisplayObject3D instance to this DisplayObjectContainer instance.
DisplayObjectContainer3D
 Inherited
addCollada(filename:String, materials:MaterialsList = null, scale:Number = 1):void
This method has been deprecated.
DisplayObjectContainer3D
 Inherited
childrenList():String
Returns a string value with the list of objects.
DisplayObjectContainer3D
 Inherited
getChildByName(name:String):DisplayObject3D
Returns the child display object that exists with the specified name.
DisplayObjectContainer3D
  
removeChild(child:DisplayObject3D):DisplayObject3D
Removes the specified child DisplayObject3D instance from the child and object list of the scene.
SceneObject3D
 Inherited
removeChildByName(name:String):DisplayObject3D
Removes the child DisplayObject3D instance that exists with the specified name, from the child list of the DisplayObjectContainer3D instance.
DisplayObjectContainer3D
  
renderCamera(camera:CameraObject3D):void
Generates an image from the camera's point of view and the visible models of the scene.
SceneObject3D
 Inherited
toString():String
Returns a string value with the list of objects.
DisplayObjectContainer3D
Protected Methods
 MethodDefined by
  
renderObjects(sort:Boolean):void
[internal-use]
SceneObject3D
Property detail
containerproperty
public var container:Sprite

The Sprite that you draw into when rendering.

materialsproperty 
public var materials:MaterialsList

It contains a list of materials in the scene.

objectsproperty 
public var objects:Array

It contains a list of DisplayObject3D objects in the scene.

statsproperty 
public var stats:Object

An object that contains total and current statistics.

Constructor detail
SceneObject3D()constructor
public function SceneObject3D(container:Sprite)

The SceneObject3D class lets you create scene classes.

Parameters
container:Sprite — The Sprite that you draw into when rendering. If not defined, each object must have it's own private container.
Method detail
addChild()method
public override 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:DisplayObject3D — The GeometryObject3D symbol or DisplayObject3D instance to add as a child of the scene.
 
name:String (default = null) — An optional name of the child to add or create. If no name is provided, the child name will be used.

Returns
DisplayObject3D — The DisplayObject3D instance that you have added or created.
removeChild()method 
public override 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:DisplayObject3D — The DisplayObject3D instance to remove.

Returns
DisplayObject3D — The DisplayObject3D instance that you pass in the child parameter.
renderCamera()method 
public function renderCamera(camera:CameraObject3D):void

Generates an image from the camera's point of view and the visible models of the scene.

Parameters
camera:CameraObject3D — camera to render from.
renderObjects()method 
protected function renderObjects(sort:Boolean):void

[internal-use]

Parameters
sort:Boolean




Wed Mar 28 2007, 5:46 PM GMT+01:00