Packagesandy.core
Classpublic class SceneLocator

The SceneLocator serves as a registry of all scenes in the application.

You can only have one SceneLocator in an application.
You can find, register and unregister scenes by their name.

When scenes (Scene3D ) are created in an application, they aoutomatically register with the SceneLocator registry


Public Methods
 MethodDefined by
  
SceneLocator(access:PrivateConstructorAccess)
Creates the SceneLocator registry

This constructor is never called directly.
Instead you get the registry instance by calling SceneLocator.getInstance().

SceneLocator
  
getInstance():SceneLocator
[static] Returns a SceneLocator.
SceneLocator
  
getScene(key:String):Scene3D
Returns the Scene3D object with the specified name.
SceneLocator
  
isRegistered(key:String):Boolean
Check if a scene with the specified name is registered.
SceneLocator
  
registerScene(key:String, o:Scene3D):Boolean
Registers a scene with this SceneLocator
SceneLocator
  
unregisterScene(key:String):void
Unregisters a scene with the specified name
SceneLocator
Constructor detail
SceneLocator()constructor
public function SceneLocator(access:PrivateConstructorAccess)

Creates the SceneLocator registry

This constructor is never called directly.
Instead you get the registry instance by calling SceneLocator.getInstance().

Parameters
access:PrivateConstructorAccess — A singleton access flag object
Method detail
getInstance()method
public static function getInstance():SceneLocator

Returns a SceneLocator.

Returns
SceneLocator — The single locator
getScene()method 
public function getScene(key:String):Scene3D

Returns the Scene3D object with the specified name.

Parameters
key:String — The name of the scene

Returns
Scene3D — The requested scene
isRegistered()method 
public function isRegistered(key:String):Boolean

Check if a scene with the specified name is registered.

Parameters
key:String — key The Name of the scene to check

Returns
Boolean — true if a scene with that name is registered, false otherwise
registerScene()method 
public function registerScene(key:String, o:Scene3D):Boolean

Registers a scene with this SceneLocator

Parameters
key:String — : String, name of the scene to register
 
o:Scene3D — : Scene3D, object to register

Returns
Boolean — true if the registration was successful, false otherwise
unregisterScene()method 
public function unregisterScene(key:String):void

Unregisters a scene with the specified name

Parameters
key:String — Th name of the scene to unregister



ASDoc: Preliminary documentation for the Sandy 3D Engine, version 3.0.1