org.j3d.aviatrix3d.pipeline.graphics
Class ViewportLayerCollection

java.lang.Object
  org.j3d.aviatrix3d.pipeline.graphics.ViewportLayerCollection

public class ViewportLayerCollection
extends java.lang.Object

Data holder that passes the information about what is to be rendered from a single viewport that has one or more layers.

Version:

$Revision: 3.5 $

Author:

Justin Couch

Field Summary

static int	FLAT_SCENE Scene type is 2D scene
MultipassRenderBucket[]	multipass Listing of valid scenes to render from this latyer
static int	MULTIPASS_SCENE Scene type is multipass scene
int	numBuckets The total number of buckets to render
int	numMultipass The number of multipass scenes total, in all render buckets
int	numScenes The number of valid scenes to render in this layer
SceneRenderBucket[]	scenes Listing of valid scenes to render from this latyer
byte[]	sceneType Indication of what scene type this layer represents.
static int	SINGLE_SCENE Scene type is basic scene

Constructor Summary

ViewportLayerCollection()
Create a default bucket for handling a layer that defaults to having a single scene.

ViewportLayerCollection(int sceneCount)
Create a bucket for handling a layer that can hold the given number of scenes to be rendered.

Method Summary

void	ensureMultipassCapacity(int size) Ensure that there are enough items in the scenes array for the given number of scenes to be processed.
void	ensureSceneCapacity(int size) Ensure that there are enough items in the scenes array for the given number of scenes to be processed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SINGLE_SCENE

public static final int SINGLE_SCENE

Scene type is basic scene

See Also:

Constant Field Values

MULTIPASS_SCENE

public static final int MULTIPASS_SCENE

Scene type is multipass scene

See Also:

Constant Field Values

FLAT_SCENE

public static final int FLAT_SCENE

Scene type is 2D scene

See Also:

Constant Field Values

scenes

public SceneRenderBucket[] scenes

Listing of valid scenes to render from this latyer

numScenes

public int numScenes

The number of valid scenes to render in this layer

multipass

public MultipassRenderBucket[] multipass

Listing of valid scenes to render from this latyer

numMultipass

public int numMultipass

The number of multipass scenes total, in all render buckets

sceneType

public byte[] sceneType

Indication of what scene type this layer represents. May be one of normal, multipass or 2D.

numBuckets

public int numBuckets

The total number of buckets to render

Constructor Detail

ViewportLayerCollection

public ViewportLayerCollection()

Create a default bucket for handling a layer that defaults to having a single scene.

By default the multipass buckets are not allocated.

ViewportLayerCollection

public ViewportLayerCollection(int sceneCount)
                        throws java.lang.IllegalArgumentException

Create a bucket for handling a layer that can hold the given number of scenes to be rendered. If the value is <= 0 an exception is generated

By default the multipass buckets are not allocated.

Parameters:

sceneCount - The number of scenes to be handled

Throws:

java.lang.IllegalArgumentException - The size was non-positive

Method Detail

ensureSceneCapacity

public void ensureSceneCapacity(int size)

Ensure that there are enough items in the scenes array for the given number of scenes to be processed. This will resize the array and initialise more bucket instances as needed.

Parameters:

size - The minimum size needed

ensureMultipassCapacity

public void ensureMultipassCapacity(int size)

Ensure that there are enough items in the scenes array for the given number of scenes to be processed. This will resize the array and initialise more bucket instances as needed.

Parameters:

size - The minimum size needed