Packagesandy.core
Classpublic class World3D
InheritanceWorld3D Inheritance Scene3D Inheritance flash.events.EventDispatcher

The Sandy 3D world.

The World3D object is the central point of a Sandy world.
World3D is a singleton class, which means that you can have only one World3D instance.
It contains the object tree with groups, a camera, a light source and a canvas to draw on


Example
To create the world instance, you call the getInstance() class method.
To make the world visible, you add a canvas to draw on ( normally a Sprite ), and add a camera.
The rendering of the world is driven by a "heart beat", which may be a Timer or the Event.ENTER_FRAME event. 
       var world:World3D = World3D.getInstance();
  world.container = this; // The document calss is a Sprite or MovieClip
  world.camera = new Camera3D( 200, 200 );
  world.root.addChild( world.camera );
  // Go on to create the 3D objects and transforms
  world.root = createScene();
  // Listen for the ENTER-FRAME event.
  //The handler calls the world.render() method to render the world for each frame.
  addEventListener( Event.ENTER_FRAME, enterFrameHandler );


Public Properties
 PropertyDefined by
 Inheritedcamera : Camera3D
The camera looking at this scene.
Scene3D
 Inheritedcontainer : Sprite
The container that stores all displayabel objects for this scene.
Scene3D
 Inheritedlight : Light3D
The simple light of this scene.
Scene3D
 InheritedmaterialManager : MaterialManager
The material manager for the scene.
Scene3D
 Inheritedname : String
Returns the scene's name as a string value.
Scene3D
 InheritedrectClipping : Boolean
Enable this property (default value is true!) to perfectly clip your 3D scene to the viewport dimension.
Scene3D
 Inheritedroot : Group
The root of the scene graph for this scene.
Scene3D
Public Methods
 MethodDefined by
  
World3D()
Creates a specific Scene3D called World3D.
World3D
 Inherited
dispose():Boolean
Dispose all the resources of this given scene.
Scene3D
  
getInstance():World3D
[static] Returns an instance of World3D.
World3D
 Inherited
render(p_oEvt:SandyEvent = null):void
Renders this scene into its display object container.
Scene3D
  
toString():String
Returns the string representation of the World3D object.
World3D
Events
 EventSummaryDefined by
 Inherited
lightAdded
Dispatched when a light is added to the scene.Scene3D
 Inherited
scene_cull
Dispatched when the scene is culled.Scene3D
 Inherited
scene_render
Dispatched when the scene is rendered.Scene3D
 Inherited
scene_render_display_list
Dispatched when the display list is rendered.Scene3D
 Inherited
scene_update
Dispatched when the scene is updated.Scene3D
Constructor detail
World3D()constructor
public function World3D()

Creates a specific Scene3D called World3D. This is done for backward compatibility

You can have only one World3D instance ( singleton ) in a Flash movie.
You should not call this constructor directly, but use the static getInstance() method

Method detail
getInstance()method
public static function getInstance():World3D

Returns an instance of World3D.

Returns
World3D — The single World3D instance
toString()method 
public override function toString():String

Returns the string representation of the World3D object.

Returns
String



Sandy 3.0 Documentation