j3d.org Aviatrix3D

org.j3d.aviatrix3d
Interface RenderPipeline

All Known Implementing Classes:
DefaultRenderPipeline

public interface RenderPipeline

A marker interface that represents a single complete rendering pipeline.

A pipeline represents all of the drawing steps that may be accomplished within a rendering cycle - culling, sorting and drawing. While an end-user may wish to directly call the methods on this interface directly to control their own rendering, it is recommended that a dedicated pipeline manager be used for this task.

If the pipeline does not have a drawable surface registered, it will still complete all the steps up to that point. If no scene is registered, no functionality is performed - render() will return immediately.

Version:
$Revision: 1.3 $
Author:
Justin Couch

Method Summary
 DrawableSurface getDrawableSurface()
          Get the currently registered drawable surface instance.
 void render()
          Start the pipeline functioning now.
 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.
 

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.

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.

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.


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.

Parameters:
scene - The scene instance to render

j3d.org Aviatrix3D

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