Aviatrix3D
2.0 Dev

org.j3d.aviatrix3d.rendering
Class MultiThreadRenderManager

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

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

Implementation of the RenderManager 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.

Change List processing will process bounds changed items before data changed.

Version:
$Revision: 2.12 $
Author:
Justin Couch

Constructor Summary
MultiThreadRenderManager()
          Construct a new render manager with no pipelines or renderers registered.
MultiThreadRenderManager(int numPipes, int numAudioPipes)
          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 disableInternalShutdown()
          Disable the internal shutdown hook system.
 void frameFinished()
          Notification that the frame state has finished rendering.
 void getLayers(Layer[] layers)
          Fetch the current layers that are set.
 int getMinimumFrameInterval()
          Fetch the currently set duty cycle value.
 PickingManager getPickingManager()
          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 isHaltingOnError()
          Check to see the current halt on error state.
 boolean isPickingPermitted()
          Check to see if picking is permitted currently.
 void notifyUpdateRequired()
          Feedback to the internals that a data object has changed and it requires re-rendering.
 int numLayers()
          Get the number of layers that are currently set.
 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 requestFullSceneRender()
          Request that the manager perform a full scene render pass and update, ignoring any usual optimisations that it may take.
 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 setErrorReporter(ErrorReporter reporter)
          Register an error reporter with the engine so that any errors generated by the node's internals can be reported in a nice, pretty fashion.
 void setHaltOnError(boolean state)
          Set whether the manager should automatically halt rendering if an error or exception is detected during the user callback processing.
 void setLayers(Layer[] layers, int numLayers)
          Set the set of layers for this manager.
 void setMinimumFrameInterval(int cycleTime)
          Set the minimum duty cycle of the render manager.
 void shaderRequiresInit(ShaderSceneGraphObject shader, boolean updateResponse)
          The shader object passed requires an initialisation be performed.
 void shaderRequiresLogInfo(ShaderSceneGraphObject shader, boolean updateResponse)
          The shader object passed requires updating the log info.
 void shutdown()
          Notification to shutdown the internals of the renderer because the application is about to exit.
 
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 render pipes and 1 audio pipe to be handled.


MultiThreadRenderManager

public MultiThreadRenderManager(int numPipes,
                                int numAudioPipes)
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
numAudioPipes - The initial number of audio pipelines to prepare
Method Detail

setErrorReporter

public void setErrorReporter(ErrorReporter reporter)
Register an error reporter with the engine so that any errors generated by the node's internals can be reported in a nice, pretty fashion. Setting a value of null will clear the currently set reporter. If one is already set, the new value replaces the old.

Specified by:
setErrorReporter in interface RenderManager
Parameters:
reporter - The instance to use or null

setHaltOnError

public void setHaltOnError(boolean state)
Set whether the manager should automatically halt rendering if an error or exception is detected during the user callback processing. If this is set to true (the default) then processing immediately halts and sets the state to disabled as soon as an error is detected. The rendering contexts are not disposed of. We just terminate the current rendering process if this is detected.

If the value is set to false, then the error is caught, but rendering continues on regardless.

In both states, the error that is caught is reported through the currently registered ErrorReporter instance as an error message.

Specified by:
setHaltOnError in interface RenderManager
Parameters:
state - true to enable halting, false to disable

isHaltingOnError

public boolean isHaltingOnError()
Check to see the current halt on error state.

Specified by:
isHaltingOnError in interface RenderManager
Returns:
true if the system halts on an error condition
See Also:
#haltOnError

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 RenderManager
Parameters:
state - True if to enable rendering

isEnabled

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

Specified by:
isEnabled in interface RenderManager
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 RenderManager
Throws:
java.lang.IllegalStateException - The system is currently rendering and should be disabled first.

requestFullSceneRender

public void requestFullSceneRender()
Request that the manager perform a full scene render pass and update, ignoring any usual optimisations that it may take. For performance reasons, a render manager may elect to not run or update some portions of the scene graph. This method requests that the next frame only should ignore those optimisations and process the full scene graph.

This method will work both in automated rendering and with the renderOnce() method.

Specified by:
requestFullSceneRender in interface RenderManager

setLayers

public void setLayers(Layer[] layers,
                      int numLayers)
               throws java.lang.IllegalArgumentException,
                      InvalidWriteTimingException
Set the set of layers for this manager. Setting a value of null will remove the currently set of layers. If this is set while a current scene is set, then the scene will be cleared. Layers are presented in depth order - layers[0] is rendered before layers[1] etc.

Specified by:
setLayers in interface RenderManager
Parameters:
layers - The collection of layers, in order, to render
numLayers - The number of valid layers to use
Throws:
java.lang.IllegalArgumentException - The length of the layers array is less than numLayers
InvalidWriteTimingException - The method was called with the system enabled and not during the app observer callback

numLayers

public int numLayers()
Get the number of layers that are currently set. If no layers are set, or a scene is set, this will return zero.

Specified by:
numLayers in interface RenderManager
Returns:
a value greater than or equal to zero

getLayers

public void getLayers(Layer[] layers)
Fetch the current layers that are set. The values will be copied into the user-provided array. That array must be at least numLayers() in length. If not, this method does nothing (the provided array will be unchanged).

Specified by:
getLayers in interface RenderManager
Parameters:
layers - An array to copy the values into

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 RenderManager
Parameters:
cycleTime - The minimum time in milliseconds between frames

getMinimumFrameInterval

public int getMinimumFrameInterval()
Fetch the currently set duty cycle value.

Specified by:
getMinimumFrameInterval in interface RenderManager
Returns:
The duty cycle time, in milliseconds

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 RenderManager
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 RenderManager
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 RenderManager
Parameters:
obs - The observer instance to use

disableInternalShutdown

public void disableInternalShutdown()
Disable the internal shutdown hook system. It will be up to the calling application to make sure the shutdown() method is called to turn off the OpenGL rendering system. If it does not, there is a good possibility of a crash of the system.

If the internal shutdown is disabled, then the shutdown callback of the ApplicationUpdateObserver will not be called.

Specified by:
disableInternalShutdown in interface RenderManager

shutdown

public void shutdown()
Notification to shutdown the internals of the renderer because the application is about to exit.

Specified by:
shutdown in interface RenderManager

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.rendering.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

notifyUpdateRequired

public void notifyUpdateRequired()
Feedback to the internals that a data object has changed and it requires re-rendering. This should only be called by classes that can effect the rendering but don't normally use the data/bounds write listeners (ie changes are made during the app update portion of the scene graph). Typically this would be used for things like the ViewEnvironment changing the aspect ratio etc.

Specified by:
notifyUpdateRequired in interface NodeUpdateHandler

boundsChanged

public boolean boundsChanged(NodeUpdateListener l,
                             java.lang.Object src,
                             InternalNodeUpdateListener intL)
                      throws InvalidListenerSetTimingException
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.
Throws:
InvalidListenerSetTimingException - If called when the node called during one of the bounds/data changed callbacks

dataChanged

public void dataChanged(NodeUpdateListener l,
                        java.lang.Object src)
                 throws InvalidListenerSetTimingException
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.
Throws:
InvalidListenerSetTimingException - If called when the node called during one of the bounds/data changed callbacks

shaderRequiresInit

public void shaderRequiresInit(ShaderSceneGraphObject shader,
                               boolean updateResponse)
The shader object passed requires an initialisation be performed. Queue the shader up for processing now.

Specified by:
shaderRequiresInit in interface NodeUpdateHandler
Parameters:
shader - The shader instance to queue
updateResponse - true if this is being made as a response to a node's setUpdateHandler() method

shaderRequiresLogInfo

public void shaderRequiresLogInfo(ShaderSceneGraphObject shader,
                                  boolean updateResponse)
The shader object passed requires updating the log info. Queue the shader up for processing now so that at the next oppourtunity it can call glGetLogInfoARB.

Specified by:
shaderRequiresLogInfo in interface NodeUpdateHandler
Parameters:
shader - The shader instance to queue
updateResponse - true if this is being made as a response to a node's setUpdateHandler() method

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

getPickingManager

public PickingManager getPickingManager()
Get the picking handler so that we can do some picking operations.

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

Aviatrix3D
2.0 Dev

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