j3d.org Aviatrix3D

org.j3d.aviatrix3d.pipeline
Class DefaultRenderPipeline

java.lang.Object
  extended byorg.j3d.aviatrix3d.pipeline.DefaultRenderPipeline
All Implemented Interfaces:
RenderPipeline

public class DefaultRenderPipeline
extends java.lang.Object
implements RenderPipeline

The default implementation of the rendering pipeline usable by most applications.

This implementation is targeted towards single threaded architectures. After setting the stages, the render command will not return until everything is complete.

Version:
$Revision: 1.4 $
Author:
Justin Couch

Constructor Summary
DefaultRenderPipeline()
          Create an instance of the pipeline with nothing registered.
DefaultRenderPipeline(CullStage cs, SortStage ss)
          Construct a pipeline with the sort and cull stages provided.
 
Method Summary
 DrawableSurface getDrawableSurface()
          Get the currently registered drawable surface instance.
 void render()
          Start the pipeline functioning now.
 void setCuller(CullStage cs)
          Set the cull instance to be used.
 void setDrawableSurface(DrawableSurface surface)
          Register a drawing surface that this pipeline will send its output to.
 void setRenderableScene(Scene scene)
          Set the root of the scene graph to be used by this pipeline.
 void setSorter(SortStage ss)
          Set the sorter instance to be used.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DefaultRenderPipeline

public DefaultRenderPipeline()
Create an instance of the pipeline with nothing registered.


DefaultRenderPipeline

public DefaultRenderPipeline(CullStage cs,
                             SortStage ss)
Construct a pipeline with the sort and cull stages provided.

Parameters:
ss - The sort stage instance to use
cs - The cull stage instance to use
Method Detail

setDrawableSurface

public void setDrawableSurface(DrawableSurface surface)
Register a drawing surface that this pipeline will send its output to. Setting a null value will remove the current drawable surface.

Specified by:
setDrawableSurface in interface RenderPipeline
Parameters:
surface - The surface instance to use or replace

getDrawableSurface

public DrawableSurface getDrawableSurface()
Get the currently registered drawable surface instance. If none is set, return null.

Specified by:
getDrawableSurface in interface RenderPipeline
Returns:
The currently set surface instance or null

render

public void render()
Start the pipeline functioning now. All steps will be called and this method will not return until all are completed and the surface has swapped.

Specified by:
render in interface RenderPipeline

setRenderableScene

public void setRenderableScene(Scene scene)
Set the root of the scene graph to be used by this pipeline. A value of null will remove the scene from being rendered, causing the pipeline to function as a no-op when rendered.

Specified by:
setRenderableScene in interface RenderPipeline
Parameters:
scene - The scene to be rendered

setSorter

public void setSorter(SortStage ss)
Set the sorter instance to be used. If the instance is null, the current sorter is removed.

Parameters:
ss - The sorter instance to use or null

setCuller

public void setCuller(CullStage cs)
Set the cull instance to be used. If the instance is null, the current culler is removed.

Parameters:
cs - The cull instance to use or null

j3d.org Aviatrix3D

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