org.j3d.aviatrix3d.pipeline.graphics
Interface GraphicsRenderPipeline

All Superinterfaces:

RenderPipeline

All Known Implementing Classes:

DefaultGraphicsPipeline

public interface GraphicsRenderPipeline
extends 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: 3.0 $

Author:

Justin Couch

Method Summary

GraphicsOutputDevice	getGraphicsOutputDevice() Get the currently registered drawable surface instance.
void	setEyePointOffset(float x, float y, float z) Set the eyepoint offset from the centre position.
void	setGraphicsOutputDevice(GraphicsOutputDevice device) Register a drawing surface that this pipeline will send its output to.
void	setScreenOrientation(float x, float y, float z, float a) Set the orientation of this screen relative to the user's normal view direction.
void	swapBuffers() Instruct the drawable at the end of this pipeline to swap the buffers now.

Methods inherited from interface org.j3d.aviatrix3d.pipeline.RenderPipeline

displayOnly, halt, render, setErrorReporter, setRenderableLayers, setRequestData

Method Detail

setGraphicsOutputDevice

void setGraphicsOutputDevice(GraphicsOutputDevice device)

Register a drawing surface that this pipeline will send its output to. Setting a null value will remove the current drawable surface.

Parameters:

device - The device instance to use or replace

getGraphicsOutputDevice

GraphicsOutputDevice getGraphicsOutputDevice()

Get the currently registered drawable surface instance. If none is set, return null.

Returns:

The currently set device instance or null

setEyePointOffset

void setEyePointOffset(float x,
                       float y,
                       float z)

Set the eyepoint offset from the centre position. This is used to model offset view frustums, such as multiple displays or a powerwall. Positive values will move the eyepoint to the right, up and back, relative to the screen's center, effectively moving the screen to the left, down and away from the user.

Parameters:

x - The x axis offset

y - The y axis offset

z - The z axis offset

setScreenOrientation

void setScreenOrientation(float x,
                          float y,
                          float z,
                          float a)

Set the orientation of this screen relative to the user's normal view direction. The normal orientation of the screen is along the negative Z axis. This method provides and axis-angle reorientation of that direction to one that is facing the screen. Typically this will just involve a rotation around the Y axis of some amount (45 and 90 deg being the most common used in walls and caves).

Parameters:

x - The x axis component

y - The y axis component

z - The z axis component

a - The angle to rotate around the axis in radians

swapBuffers

void swapBuffers()

Instruct the drawable at the end of this pipeline to swap the buffers now.