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.6 $

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.
BufferStateRenderable	getGeneralBufferRenderable() Fetch renderable information about the general buffer.
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.
ViewportRenderable	getViewportRenderable() Fetch the renderable used to control the viewport setting.
boolean	is2D() Check to see if this represents a 2D scene that has no 3D rendering capabilities.
boolean	isAudioSource() Check to see if this render pass is the one that also has the spatialised audio to be rendered for this frame.
boolean	isEnabled() Check to see if this render pass is valid to render for this frame.

Method Detail

getUserData

java.lang.Object getUserData()

If there is any user-defined data given, fetch it through this method.

Returns:

Whatever object the user has set

isEnabled

boolean isEnabled()

Check to see if this render pass is valid to render for this frame.

Returns:

true if this is valid to process

is2D

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

isAudioSource

boolean isAudioSource()

Check to see if this render pass is the one that also has the spatialised audio to be rendered for this frame. See the package documentation for more information about how this state is managed.

Returns:

true if this is the source that should be rendered this this frame.

getViewCullable

ViewEnvironmentCullable getViewCullable()

Get the primary view environment.

getViewpointCullable

EnvironmentCullable getViewpointCullable()

Get the cullable object representing the active viewpoint that in this environment.

Returns:

The viewpoint renderable to use

getBackgroundCullable

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

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

Cullable getRootCullable()

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

getViewportRenderable

ViewportRenderable getViewportRenderable()

Fetch the renderable used to control the viewport setting. If the default environment is to be used, this will return null.

Returns:

A renderable instance if custom viewport handling is need or null if not

getGeneralBufferRenderable

BufferStateRenderable getGeneralBufferRenderable()

Fetch renderable information about the general buffer. If this is a single pass scene, this will return null.

Returns:

The state representation for the general buffer

getColorBufferRenderable

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

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

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

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