j3d.org Aviatrix3D

org.j3d.aviatrix3d.pipeline
Class MultiThreadRenderManager

java.lang.Object
  extended byorg.j3d.aviatrix3d.pipeline.MultiThreadRenderManager
All Implemented Interfaces:
NodeUpdateHandler, org.j3d.aviatrix3d.pipeline.PipelineStateObserver, RenderPipelineManager, java.lang.Runnable

public class MultiThreadRenderManager
extends java.lang.Object
implements java.lang.Runnable, NodeUpdateHandler, RenderPipelineManager, org.j3d.aviatrix3d.pipeline.PipelineStateObserver

Implementation of the RenderPipelineManager that uses separate threads for each of the pipelines that it is managing, allowing it to run multiple output surfaces simultaneously (eg Powerwall, CAVE etc).

By default the manager does not start of enabled. An explicit enable call will be needed to kick the rendering process off.

Version:
$Revision: 1.6 $
Author:
Justin Couch

Constructor Summary
MultiThreadRenderManager()
          Construct a new render manager with no pipelines or renderers registered.
MultiThreadRenderManager(int numPipes)
          Construct a new render manager with no pipelines or renderers registered, but with internal arrays setup for the given number of pipelines to be added.
 
Method Summary
 void addPipeline(RenderPipeline pipe)
          Add a pipeline to be rendered to the manager.
 boolean boundsChanged(NodeUpdateListener l, java.lang.Object src, InternalNodeUpdateListener intL)
          Notify the handler that you have updates to the SG that might alter a node's bounds.
 void dataChanged(NodeUpdateListener l, java.lang.Object src)
          Notify the handler that you have updates to the SG that will not alter a node's bounds.
 void frameFinished()
          Notification that the frame state has finished rendering.
 PickingHandler getPickHandler()
          Get the picking handler so that we can do some picking operations.
 boolean isBoundsWritePermitted(java.lang.Object src)
          Check to see if writing to the node is permitted currently.
 boolean isDataWritePermitted(java.lang.Object src)
          Check to see if writing to the node is permitted currently.
 boolean isEnabled()
          Get the current render state of the manager.
 boolean isPickingPermitted()
          Check to see if picking is permitted currently.
 void objectRemoved(DeletableSceneGraphObject obj)
          The object provided is no longer needed by its parent.
 void removePipeline(RenderPipeline pipe)
          Remove an already registered pipeline from the manager.
 void renderOnce()
          Force a single render of all pipelines now.
 void run()
          Run method used to synchronise the internal rendering state and the external state of the canvas.
 void setApplicationObserver(ApplicationUpdateObserver obs)
          Register an observer that can be used to know when the application is safe to update the scene graph.
 void setEnabled(boolean state)
          Tell render to start or stop rendering.
 void setMinimumFrameInterval(int cycleTime)
          Set the minimum duty cycle of the render manager.
 void setScene(Scene scene)
          Set the scene for this manager.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MultiThreadRenderManager

public MultiThreadRenderManager()
Construct a new render manager with no pipelines or renderers registered. Starts by allocating space for 2 pipelines to be handled.


MultiThreadRenderManager

public MultiThreadRenderManager(int numPipes)
Construct a new render manager with no pipelines or renderers registered, but with internal arrays setup for the given number of pipelines to be added.

Parameters:
numPipes - The initial number of pipelines to prepare
Method Detail

setEnabled

public void setEnabled(boolean state)
Tell render to start or stop rendering. If currently running, it will wait until all the pipelines have completed their current cycle and will then halt.

Specified by:
setEnabled in interface RenderPipelineManager
Parameters:
state - True if to enable rendering

isEnabled

public boolean isEnabled()
Get the current render state of the manager.

Specified by:
isEnabled in interface RenderPipelineManager
Returns:
true if the manager is currently running

renderOnce

public void renderOnce()
                throws java.lang.IllegalStateException
Force a single render of all pipelines now. Ignores the enabled and cycle time settings to cause a single render at this point in time. If a render is currently in progress, an exception is generated

Specified by:
renderOnce in interface RenderPipelineManager
Throws:
java.lang.IllegalStateException - The system is currently rendering and should be disabled first.

setMinimumFrameInterval

public void setMinimumFrameInterval(int cycleTime)
Set the minimum duty cycle of the render manager. This is the type in milliseconds that should be the minimum between frames and can be used to throttle the rendering loop to a maximum frame rate should other systems require CPU time.

Specified by:
setMinimumFrameInterval in interface RenderPipelineManager
Parameters:
cycleTime - The minimum time in milliseconds between frames

addPipeline

public void addPipeline(RenderPipeline pipe)
                 throws java.lang.IllegalStateException
Add a pipeline to be rendered to the manager. A duplicate registration or null value is ignored. For this implementation, a call to this method will replace the existing pipeline rather than add an additional one.

Specified by:
addPipeline in interface RenderPipelineManager
Parameters:
pipe - The new pipe instance to be added
Throws:
java.lang.IllegalStateException - The system is currently rendering and should be disabled first.

removePipeline

public void removePipeline(RenderPipeline pipe)
                    throws java.lang.IllegalStateException
Remove an already registered pipeline from the manager. A or null value or one that is not currently registered is ignored. For this implementation, a call to this method will remove the existing pipeline if it is the same instance rather than remove an additional one.

Specified by:
removePipeline in interface RenderPipelineManager
Parameters:
pipe - The pipe instance to be removed
Throws:
java.lang.IllegalStateException - The system is currently rendering and should be disabled first.

setApplicationObserver

public void setApplicationObserver(ApplicationUpdateObserver obs)
Register an observer that can be used to know when the application is safe to update the scene graph. A value of null will remove the currently set value.

Specified by:
setApplicationObserver in interface RenderPipelineManager
Parameters:
obs - The observer instance to use

setScene

public void setScene(Scene scene)
Set the scene for this manager. null will remove the set scene.

Specified by:
setScene in interface RenderPipelineManager
Parameters:
scene - The new scene

run

public void run()
Run method used to synchronise the internal rendering state and the external state of the canvas. Should never be called directly.

Specified by:
run in interface java.lang.Runnable

frameFinished

public void frameFinished()
Notification that the frame state has finished rendering.

Specified by:
frameFinished in interface org.j3d.aviatrix3d.pipeline.PipelineStateObserver

isDataWritePermitted

public boolean isDataWritePermitted(java.lang.Object src)
Check to see if writing to the node is permitted currently.

Specified by:
isDataWritePermitted in interface NodeUpdateHandler
Parameters:
src - The object that is requesting the check
Returns:
true if the end user can write, false if not

isBoundsWritePermitted

public boolean isBoundsWritePermitted(java.lang.Object src)
Check to see if writing to the node is permitted currently.

Specified by:
isBoundsWritePermitted in interface NodeUpdateHandler
Parameters:
src - The object that is requesting the check
Returns:
true if the end user can write, false if not

isPickingPermitted

public boolean isPickingPermitted()
Check to see if picking is permitted currently.

Specified by:
isPickingPermitted in interface NodeUpdateHandler
Returns:
true if the end user can pick, false if not

boundsChanged

public boolean boundsChanged(NodeUpdateListener l,
                             java.lang.Object src,
                             InternalNodeUpdateListener intL)
Notify the handler that you have updates to the SG that might alter a node's bounds.

Specified by:
boundsChanged in interface NodeUpdateHandler
Parameters:
l - The change requestor
src - The object that is passing this listener through.
intL - Internal listener for making callbacks at a later time to propogate the bounds changes.
Returns:
Was the notification accepted. Duplicates will return false.

dataChanged

public void dataChanged(NodeUpdateListener l,
                        java.lang.Object src)
Notify the handler that you have updates to the SG that will not alter a node's bounds.

Specified by:
dataChanged in interface NodeUpdateHandler
Parameters:
l - The change requestor
src - The object that is passing this listener through.

objectRemoved

public void objectRemoved(DeletableSceneGraphObject obj)
The object provided is no longer needed by its parent. Put this on a queue for objects that could potentially be deleted next frame. Used for any scene graph object type that must be explicitly cleaned up during the OpenGL render cycle, such as textures and pBuffers.

Specified by:
objectRemoved in interface NodeUpdateHandler
Parameters:
obj - The object that is registering itself for deletion

getPickHandler

public PickingHandler getPickHandler()
Get the picking handler so that we can do some picking operations.

Specified by:
getPickHandler in interface NodeUpdateHandler
Returns:
the current instance of the picking system

j3d.org Aviatrix3D

Latest Info from http://aviatrix3d.j3d.org/
Copyright © 2003 - j3d.org