org.j3d.aviatrix3d.rendering
Interface SceneCullable

All Superinterfaces:

Cullable

All Known Implementing Classes:

MultipassScene, SimpleScene

public interface SceneCullable
extends Cullable

A cullable that represents the scene contained in a viewport or viewport layer.

The scene can represent either a single or multipass scene instance. In either case, at least one render pass cullable should be made available.

Version:

$Revision: 2.2 $

Author:

Justin Couch

Method Summary

RenderPassCullable	getCullablePass(int passIndex) Get the cullable layer child that for the given layer index.
RenderEffectsProcessor	getRenderEffectsProcessor() Get the rendering effects processing user interface that applies to this frame.
java.lang.Object	getUserData() If there is any user-defined data given, fetch it through this method.
ViewEnvironmentCullable	getViewCullable() Get the primary view environment information.
boolean	isMultipassScene() Check to see if this is a multipass cullable or single pass.
int	numCullableChildren() Returns the number of valid cullable rendering passes to process.

Method Detail

getUserData

java.lang.Object getUserData()

If there is any user-defined data given, fetch it through this method. In a single-pass scene this will return the same object as the first pass cullable instance.

Returns:

Whatever object the user has set

isMultipassScene

boolean isMultipassScene()

Check to see if this is a multipass cullable or single pass.

Returns:

true if this is a multipass cullable

getViewCullable

ViewEnvironmentCullable getViewCullable()

Get the primary view environment information. This applies to the whole scene before any multipass processing is done. If this is a multipass scene, the frustum information is ignored as each pass applies separately.

getRenderEffectsProcessor

RenderEffectsProcessor getRenderEffectsProcessor()

Get the rendering effects processing user interface that applies to this frame. If there is non, returns null. In a multipass environment this is called at prior to any pass being made, and only after all the passes have been complete.

Returns:

The effects processor to apply to this frame

getCullablePass

RenderPassCullable getCullablePass(int passIndex)

Get the cullable layer child that for the given layer index. For a single pass scene this represents everything about the scene to be rendered. The view environment of this scene is the same as that of the first render pass.

Parameters:

passIndex - The index of the pass to fetch

Returns:

The layer cullable at the given index or null

numCullableChildren

int numCullableChildren()

Returns the number of valid cullable rendering passes to process. In a single pass scene return 1.

Returns:

A number greater than or equal to zero