Packageartcustomer.framework.engines.layers
Classpublic class Layer3D
InheritanceLayer3D Inheritance Object
Implements ILayer

Layer3D : Stage3D Layer



Public Methods
 MethodDefined By
  
Constructor
Layer3D
  
addScene(sceneClass:Class):AbstractScene3D
Add new AbstractScene3D.
Layer3D
  
attachTemplate(templateClass:Class):void
Attach an engine template to layer.
Layer3D
  
destroy():void
Destroy Layer3D.
Layer3D
  
Get AbstractScene3D at index
Layer3D
  
Get template.
Layer3D
  
hasSceneAt(index:int):Boolean
Test if Scene3D exist in the stack
Layer3D
  
onRender():void
Called when RenderEngine is on.
Layer3D
  
onResize():void
Called when player window is resized.
Layer3D
  
Remove instance of AbstractScene3D
Layer3D
  
removeSceneAt(index:int):void
Remove instance of AbstractScene3D at index.
Layer3D
  
Remove template if attached.
Layer3D
  
setup():void
Setup Layer3D.
Layer3D
  
update():void
Update Layer3D.
Layer3D
Protected Methods
 MethodDefined By
  
create():void
Called when Context3D is created.
Layer3D
  
render():void
Called when RenderEngine is on.
Layer3D
  
resize():void
Called when Stage is resized.
Layer3D
Events
 Event Summary Defined By
  Layer3D
  Layer3D
  Layer3D
  Layer3D
Constructor Detail
Layer3D()Constructor
public function Layer3D()

Constructor

Method Detail
addScene()method
public final function addScene(sceneClass:Class):AbstractScene3D

Add new AbstractScene3D.

Parameters

sceneClass:Class — : Class of the instance of AbstractScene3D.

Returns
AbstractScene3D — ths instance created.
attachTemplate()method 
public final function attachTemplate(templateClass:Class):void

Attach an engine template to layer.

Parameters

templateClass:Class

create()method 
protected function create():void

Called when Context3D is created. Override it !

destroy()method 
public function destroy():void

Destroy Layer3D. Must be overrided and call at last in child.

getSceneAt()method 
public final function getSceneAt(index:int):AbstractScene3D

Get AbstractScene3D at index

Parameters

index:int — : Index of the AbstractScene3D in order to find it in the stack

Returns
AbstractScene3D — the AbstractScene3D corresponding to the index or null if index ins't exist in the stack
getTemplate()method 
public final function getTemplate():AbstractEngineTemplate

Get template.

Returns
AbstractEngineTemplate
hasSceneAt()method 
public final function hasSceneAt(index:int):Boolean

Test if Scene3D exist in the stack

Parameters

index:int — : Index of the AbstractScene3D in order to find it in the stack

Returns
Boolean — True if Scene3D exist, False is not exist
onRender()method 
public final function onRender():void

Called when RenderEngine is on. Don't call it !

onResize()method 
public final function onResize():void

Called when player window is resized. Don't call it !

removeScene()method 
public final function removeScene(scene3d:AbstractScene3D):void

Remove instance of AbstractScene3D

Parameters

scene3d:AbstractScene3D — : Instance of AbstractScene3D

removeSceneAt()method 
public final function removeSceneAt(index:int):void

Remove instance of AbstractScene3D at index.

Parameters

index:int — : Index of the AbstractScene3D in order to find it in the stack

removeTemplate()method 
public final function removeTemplate():void

Remove template if attached.

render()method 
protected function render():void

Called when RenderEngine is on. Override it !

resize()method 
protected function resize():void

Called when Stage is resized. Override it !

setup()method 
public function setup():void

Setup Layer3D. Must be overrided and called at first in child.

update()method 
public function update():void

Update Layer3D. Must be overrided and call at last in child.

Event Detail
layer3dCreate Event
Event Object Type: artcustomer.framework.events.Layer3DEvent

layer3dDestroy Event  
Event Object Type: artcustomer.framework.events.Layer3DEvent

layer3dError Event  
Event Object Type: artcustomer.framework.events.Layer3DEvent

layer3dSetup Event  
Event Object Type: artcustomer.framework.events.Layer3DEvent