Aviatrix3D
2.0 Beta 2

org.j3d.aviatrix3d.rendering
Interface RenderPassCullable

All Superinterfaces:
Cullable
All Known Implementing Classes:
RenderPass, SimpleScene

public interface RenderPassCullable
extends Cullable

A cullable that represents a single rendering pass within a viewport.

The render pass cullable can be used for both single and multipass rendering.

Version:
$Revision: 2.2 $
Author:
Justin Couch

Method Summary
 BufferStateRenderable getAccumBufferRenderable()
          Fetch renderable information about the accumulation buffer.
 EnvironmentCullable getBackgroundCullable()
          Get the cullable object representing the active background that in this environment.
 BufferStateRenderable getColorBufferRenderable()
          Fetch renderable information about the colour buffer.
 BufferStateRenderable getDepthBufferRenderable()
          Fetch renderable information about the depth buffer.
 LeafCullable getFogCullable()
          Get the cullable object representing the active fog in this environment.
 Cullable getRootCullable()
          Get the primary cullable that represents the root of the scene graph.
 BufferStateRenderable getStencilBufferRenderable()
          Fetch renderable information about the stencil buffer.
 java.lang.Object getUserData()
          If there is any user-defined data given, fetch it through this method.
 ViewEnvironmentCullable getViewCullable()
          Get the primary view environment.
 EnvironmentCullable getViewpointCullable()
          Get the cullable object representing the active viewpoint that in this environment.
 boolean is2D()
          Check to see if this represents a 2D scene that has no 3D rendering capabilities.
 

Method Detail

getUserData

public java.lang.Object getUserData()
If there is any user-defined data given, fetch it through this method.

Returns:
Whatever object the user has set

is2D

public boolean is2D()
Check to see if this represents a 2D scene that has no 3D rendering capabilities. A purely 2D scene sets up the view environment quite different to a full 3D scene.

Returns:
true if this is a 2D scene rather than a 3D version

getViewCullable

public ViewEnvironmentCullable getViewCullable()
Get the primary view environment.


getViewpointCullable

public EnvironmentCullable getViewpointCullable()
Get the cullable object representing the active viewpoint that in this environment.

Returns:
The viewpoint renderable to use

getBackgroundCullable

public EnvironmentCullable getBackgroundCullable()
Get the cullable object representing the active background that in this environment. If no background is set, this will return null.

Returns:
The background renderable to use

getFogCullable

public LeafCullable getFogCullable()
Get the cullable object representing the active fog in this environment. If no fog is set or this is a pass in a multipass rendering, this will return null. If the underlying fog node is currently disabled or not labeled as global, then this method should return null.

Returns:
The fog renderable to use

getRootCullable

public Cullable getRootCullable()
Get the primary cullable that represents the root of the scene graph. If this is a multipass cullable, this should return null.


getColorBufferRenderable

public BufferStateRenderable getColorBufferRenderable()
Fetch renderable information about the colour buffer. If this is a single pass scene, this will return null.

Returns:
The state representation for the colour buffer

getDepthBufferRenderable

public BufferStateRenderable getDepthBufferRenderable()
Fetch renderable information about the depth buffer. If this is a single pass scene, this will return null.

Returns:
The state representation for the depth buffer

getStencilBufferRenderable

public BufferStateRenderable getStencilBufferRenderable()
Fetch renderable information about the stencil buffer. If this is a single pass scene, this will return null.

Returns:
The state representation for the stencil buffer

getAccumBufferRenderable

public BufferStateRenderable getAccumBufferRenderable()
Fetch renderable information about the accumulation buffer. If this is a single pass scene, this will return null.

Returns:
The state representation for the accumulation buffer

Aviatrix3D
2.0 Beta 2

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