org.xith3d.render
Interface CanvasBag

All Known Subinterfaces:
RenderableSceneGraph
All Known Implementing Classes:
Xith3DEnvironment

public interface CanvasBag

A class implementing this interface can hold several Canvas3Ds.


Method Summary
 Canvas3D addCanvas(Canvas3D canvas)
          Adds a Canvas3D to the list of canveses.
 Canvas3D addCanvas(Canvas3D canvas, View view)
          Adds a Canvas3D to the list of canveses.
 Canvas3DWrapper addCanvas(Canvas3DWrapper canvasWrapper)
          Adds a Canvas3D to the list of canveses.
 Canvas3DWrapper addCanvas(Canvas3DWrapper canvasWrapper, View view)
          Adds a Canvas3D to the list of canveses.
 Canvas3D getCanvas()
           
 Canvas3D getCanvas(int index)
           
 boolean isCanvasAlive(Canvas3D canvas)
          Checkes if a Canvas3D is currently to be rendered.
 boolean isCanvasAlive(Canvas3DWrapper canvasWrapper)
          Checkes if a Canvas3DPanel is currently to be rendered.
 void removeAllCanvas3Ds()
          Removes all Canvas3Ds from the View
 void removeCanvas(Canvas3D canvas)
          Removes a Canvas3D from the list of canveses.
 void removeCanvas(Canvas3DWrapper canvasWrapper)
          Removes a Canvas3D from the list of canveses.
 void reviveCanvas(Canvas3D canvas)
          (Re-)activates a Canvas3D to be rendered by the RenderLoop
 void reviveCanvas(Canvas3DWrapper canvasWrapper)
          (Re-)activates a Canvas3D to be rendered by the RenderLoop
 void suspendCanvas(Canvas3D canvas)
          Suspends a Canvas3D do not be rendered for the moment.
 void suspendCanvas(Canvas3DWrapper canvasWrapper)
          Suspends a Canvas3D do not be rendered for the moment.
 

Method Detail

removeCanvas

void removeCanvas(Canvas3D canvas)
Removes a Canvas3D from the list of canveses. It won't be rendered anymore.

Parameters:
canvas - the Canvas3D to be removed

removeCanvas

void removeCanvas(Canvas3DWrapper canvasWrapper)
Removes a Canvas3D from the list of canveses. It won't be rendered anymore.

Parameters:
canvasWrapper - the Canvas3D to be removed

removeAllCanvas3Ds

void removeAllCanvas3Ds()
Removes all Canvas3Ds from the View


addCanvas

Canvas3D addCanvas(Canvas3D canvas,
                   View view)
Adds a Canvas3D to the list of canveses. It will be rendered from now on.

Parameters:
canvas - the Canvas3D to be added
view - the view to add the Canvas3D to
Returns:
the given Canvas3D back again

addCanvas

Canvas3D addCanvas(Canvas3D canvas)
Adds a Canvas3D to the list of canveses. It will be rendered from now on.

Parameters:
canvas - the Canvas3D to be added
Returns:
the given Canvas3D back again

addCanvas

Canvas3DWrapper addCanvas(Canvas3DWrapper canvasWrapper,
                          View view)
Adds a Canvas3D to the list of canveses. It will be rendered from now on.

Parameters:
canvasWrapper - the Canvas3D to be added
view - the view to add the Canvas3D to
Returns:
the given Canvas3DWrapper back again

addCanvas

Canvas3DWrapper addCanvas(Canvas3DWrapper canvasWrapper)
Adds a Canvas3D to the list of canveses. It will be rendered from now on.

Parameters:
canvasWrapper - the Canvas3D to be added
Returns:
the given Canvas3DWrapper back again

getCanvas

Canvas3D getCanvas()
Returns:
the Canvas3D added first to the Xith3DEnvironment or null

getCanvas

Canvas3D getCanvas(int index)
Parameters:
index - the desired Canvas3D's index
Returns:
the Canvas3D added first to the Xith3DEnvironment or null

suspendCanvas

void suspendCanvas(Canvas3D canvas)
Suspends a Canvas3D do not be rendered for the moment.

Parameters:
canvas - the arguable Canvas3D

suspendCanvas

void suspendCanvas(Canvas3DWrapper canvasWrapper)
Suspends a Canvas3D do not be rendered for the moment.

Parameters:
canvasWrapper - the arguable Canvas3D containing Canvas3DWrapper

reviveCanvas

void reviveCanvas(Canvas3D canvas)
(Re-)activates a Canvas3D to be rendered by the RenderLoop

Parameters:
canvas - the arguable Canvas3D

reviveCanvas

void reviveCanvas(Canvas3DWrapper canvasWrapper)
(Re-)activates a Canvas3D to be rendered by the RenderLoop

Parameters:
canvasWrapper - the arguable Canvas3D containing Canvas3DWrapper

isCanvasAlive

boolean isCanvasAlive(Canvas3D canvas)
Checkes if a Canvas3D is currently to be rendered.

Parameters:
canvas - the arguable Canvas3D
Returns:
true, if the Canvas3D is currently rendered.

isCanvasAlive

boolean isCanvasAlive(Canvas3DWrapper canvasWrapper)
Checkes if a Canvas3DPanel is currently to be rendered.

Parameters:
canvasWrapper - the arguable Canvas3DWrapper
Returns:
true, if the Canvas3D is currently rendered.