| Package | sandy.core |
| Class | public class SceneLocator |
An application can only have one SceneLocator. Using the SceneLocator, scenes can be located, registered, and unregistered.
When scenes are created in an application, they aoutomatically register with the SceneLocator registry.
See also
| Method | Defined by | ||
|---|---|---|---|
|
SceneLocator(access:PrivateConstructorAccess)
Creates the SceneLocator registry.
| SceneLocator | ||
|
[static]
Returns a SceneLocator.
| SceneLocator | ||
|
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.
| SceneLocator | ||
|
unregisterScene(key:String):void
Unregisters a scene with the specified name.
| SceneLocator | ||
| 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().
Parametersaccess:PrivateConstructorAccess — A singleton access flag object
|
| getInstance | () | method |
public static function getInstance():SceneLocatorReturns a SceneLocator.
ReturnsSceneLocator —
The single locator.
|
| getScene | () | method |
public function getScene(key:String):Scene3DReturns the Scene3D object with the specified name.
Parameterskey:String — The name of the scene.
|
Scene3D —
The requested scene.
|
| isRegistered | () | method |
public function isRegistered(key:String):BooleanCheck if a scene with the specified name is registered.
Parameterskey:String — key The Name of the scene to check.
|
Boolean — true if a scene with that name is registered, false otherwise.
|
| registerScene | () | method |
public function registerScene(key:String, o:Scene3D):BooleanRegisters a scene.
Parameterskey:String — : String, name of the scene to register.
|
|
o:Scene3D — : Scene3D, object to register.
|
Boolean — true if the registration was successful, false otherwise.
|
| unregisterScene | () | method |
public function unregisterScene(key:String):voidUnregisters a scene with the specified name.
Parameterskey:String — The name of the scene to unregister.
|