org.j3d.aviatrix3d
Class GeneralBufferState

java.lang.Object
  org.j3d.aviatrix3d.SceneGraphObject
      org.j3d.aviatrix3d.BufferState
          org.j3d.aviatrix3d.GeneralBufferState

All Implemented Interfaces:

java.lang.Comparable, BufferStateRenderable, Renderable

public class GeneralBufferState
extends BufferState
implements BufferStateRenderable

Collection of state management options for a render pass for elements that don't directly influence the backing buffer.

The items configurable in this pass do not have any interaction with clearing state in the render buffer (ie no glClear() bit to toggle). The default setup for this class is:

• Blending: false
• Blend Equation: EQ_FUNC_ADD
• RGB Source Mode: BLEND_SRC_COLOR
• RGB Dest Mode: BLEND_ONE_MINUS_SRC_COLOR
• Alpha Source Mode: BLEND_SRC_ALPHA
• Alpha Dest Mode: BLEND_ONE_MINUS_SRC_ALPHA
• Separated Blend: false

Internationalisation Resource Names

• invalidAlphaDestMsg: Error message when the given function type does not match one of the available types.
• invalidBlendMsg: Error message when the given blend source type does not match one of the available types.
• invalidModeMsg: Error message when the given blend mode type does not match one of the available types.

Version:

$Revision: 2.7 $

Author:

Justin Couch

Field Summary

static int	BLEND_CONSTANT_ALPHA Set the blend factor to use the provided constant alpha value.The constant colour value is provide through the setBlendColour() method.
static int	BLEND_CONSTANT_COLOR Set the blend factor to use the provided constant colour.
static int	BLEND_DEST_ALPHA Set the blend factor to use the destination object's alpha value
static int	BLEND_DEST_COLOR Set the blend factor to use the destination object colour
static int	BLEND_ONE Set the blend factor to ones.
static int	BLEND_ONE_MINUS_CONSTANT_ALPHA Set the blend factor to use one minus the constant colour alpha value (1-c).
static int	BLEND_ONE_MINUS_CONSTANT_COLOR Set the blend factor to use one minus the constant colour (1-c).
static int	BLEND_ONE_MINUS_DEST_ALPHA Set the blend factor to use one minus the destination object alpha value (1-dest).
static int	BLEND_ONE_MINUS_DEST_COLOR Set the blend factor to use one minus the destination object colour (1-dest).
static int	BLEND_ONE_MINUS_SRC_ALPHA Set the blend factor to use one minus source object alpha value (1-src).
static int	BLEND_ONE_MINUS_SRC_COLOR Set the blend factor to use one minus source object colour (1-src).
static int	BLEND_SRC_ALPHA Set the blend factor to use the source object's alpha value
static int	BLEND_SRC_ALPHA_SATURATE Set the blend function to saturage the colour value using the alpha state.
static int	BLEND_SRC_COLOR Set the blend factor to use the source object colour
static int	BLEND_ZERO Set the blend factor to zeros.
static int	EQ_FUNC_ADD Set the blending equation to be CsS + CdD
static int	EQ_FUNC_MAX Set the blending equation to be max(CdD, CsS)
static int	EQ_FUNC_MIN Set the blending equation to be min(CdD, CsS)
static int	EQ_FUNC_SUBTRACT Set the blending equation to be CsS - CdD
static int	EQ_FUNC_SUBTRACT_REVERSE Set the blending equation to be CdD - CsS

Fields inherited from class org.j3d.aviatrix3d.BufferState

lastParent, liveCount, parentList

Fields inherited from class org.j3d.aviatrix3d.SceneGraphObject

alive, LISTENER_SET_TIMING_ERR_PROP, updateHandler

Fields inherited from interface org.j3d.aviatrix3d.rendering.BufferStateRenderable

ACCUMULATION_BUFFER, COLOR_BUFFER, DEPTH_BUFFER, GENERAL_BUFFER, STENCIL_BUFFER

Constructor Summary

GeneralBufferState()
Constructs a state set with default values.

Method Summary

boolean	checkClearBufferState() Check to see if this buffer should be cleared at the start of this run.
void	clearBufferState(javax.media.opengl.GL gl) Restore all state to the default values.
int	compareTo(GeneralBufferState gbs) Compares this object with the specified object for order.
int	compareTo(java.lang.Object o) Compares this object with the specified object for order.
void	enableBlending(boolean test) Set the flag for whether the blending should be enabled or disabled.
boolean	equals(GeneralBufferState gbs) Compares this object with the specified object to check for equivalence.
boolean	equals(java.lang.Object o) Compare this object for equality to the given object.
int	getAlphaDestinationBlendFactor() Request the currently set destination blend factor for the alpha component.
int	getAlphaSourceBlendFactor() Request the currently set source blend factor for the alpha component.
int	getBlendEquation() Request the currently set blend equation
int	getBufferBitMask() Get the GL buffer bit flag that this state class represents.
int	getBufferType() Get the type of buffer this state represents.
int	getDestinationBlendFactor() Request the currently set destination blend factor.
boolean	getSeparatedBlendFactors() Check to see the current state of whether separated blending is used or not.
int	getSourceBlendFactor() Request the currently set source blend factor.
boolean	isBlendingEnabled() Check to see if depth testing is currently enabled.
void	setAlphaDestinationBlendFactor(int factor) Set the destination blend factor to use.
void	setAlphaSourceBlendFactor(int factor) Set the source blend factor to use.
void	setBlendEquation(int mode) Set the blend equation to use.
void	setBufferState(javax.media.opengl.GL gl) Issue ogl commands needed for this buffer to set the initial state, including the initial enabling.
void	setDestinationBlendFactor(int factor) Set the destination blend factor to use.
void	setSeparatedBlendFactors(boolean state) Instruct the system whether to use separated RGB and Alpha blending functions.
void	setSourceBlendFactor(int factor) Set the source blend factor to use.
void	updateBufferState(javax.media.opengl.GL gl) Issue ogl commands needed for this component to change the state, assuming that it is already enabled.

Methods inherited from class org.j3d.aviatrix3d.BufferState

addParent, getParents, numParents, removeParent

Methods inherited from class org.j3d.aviatrix3d.SceneGraphObject

checkForCyclicChild, checkForCyclicParent, dataChanged, getAppUpdateWriteTimingMessage, getBoundsWriteTimingMessage, getDataWriteTimingMessage, getUserData, isLive, setLive, setUpdateHandler, setUserData

Methods inherited from class java.lang.Object

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

Field Detail

BLEND_ZERO

public static final int BLEND_ZERO

Set the blend factor to zeros.

See Also:

Constant Field Values

BLEND_ONE

public static final int BLEND_ONE

Set the blend factor to ones.

See Also:

Constant Field Values

BLEND_SRC_COLOR

public static final int BLEND_SRC_COLOR

Set the blend factor to use the source object colour

See Also:

Constant Field Values

BLEND_ONE_MINUS_SRC_COLOR

public static final int BLEND_ONE_MINUS_SRC_COLOR

Set the blend factor to use one minus source object colour (1-src).

See Also:

Constant Field Values

BLEND_DEST_COLOR

public static final int BLEND_DEST_COLOR

Set the blend factor to use the destination object colour

See Also:

Constant Field Values

BLEND_ONE_MINUS_DEST_COLOR

public static final int BLEND_ONE_MINUS_DEST_COLOR

Set the blend factor to use one minus the destination object colour (1-dest).

See Also:

Constant Field Values

BLEND_SRC_ALPHA

public static final int BLEND_SRC_ALPHA

Set the blend factor to use the source object's alpha value

See Also:

Constant Field Values

BLEND_ONE_MINUS_SRC_ALPHA

public static final int BLEND_ONE_MINUS_SRC_ALPHA

Set the blend factor to use one minus source object alpha value (1-src).

See Also:

Constant Field Values

BLEND_DEST_ALPHA

public static final int BLEND_DEST_ALPHA

Set the blend factor to use the destination object's alpha value

See Also:

Constant Field Values

BLEND_ONE_MINUS_DEST_ALPHA

public static final int BLEND_ONE_MINUS_DEST_ALPHA

Set the blend factor to use one minus the destination object alpha value (1-dest).

See Also:

Constant Field Values

BLEND_CONSTANT_COLOR

public static final int BLEND_CONSTANT_COLOR

Set the blend factor to use the provided constant colour. The constant colour value is provide through the setBlendColour() method.

See Also:

Constant Field Values

BLEND_ONE_MINUS_CONSTANT_COLOR

public static final int BLEND_ONE_MINUS_CONSTANT_COLOR

Set the blend factor to use one minus the constant colour (1-c). The constant colour value is provide through the setBlendColour() method.

See Also:

Constant Field Values

BLEND_CONSTANT_ALPHA

public static final int BLEND_CONSTANT_ALPHA

Set the blend factor to use the provided constant alpha value.The constant colour value is provide through the setBlendColour() method.

See Also:

Constant Field Values

BLEND_ONE_MINUS_CONSTANT_ALPHA

public static final int BLEND_ONE_MINUS_CONSTANT_ALPHA

Set the blend factor to use one minus the constant colour alpha value (1-c). The constant colour value is provide through the setBlendColour() method.

See Also:

Constant Field Values

BLEND_SRC_ALPHA_SATURATE

public static final int BLEND_SRC_ALPHA_SATURATE

Set the blend function to saturage the colour value using the alpha state. The RGB value is calculated using the min(Asrc, 1 - Adest). The alpha value is treated as equivalent to GL_ONE. Can only be used as the source blend factor. An error will be generated if you try to use this for the destination factor.

See Also:

Constant Field Values

EQ_FUNC_ADD

public static final int EQ_FUNC_ADD

Set the blending equation to be C_sS + C_dD

See Also:

Constant Field Values

EQ_FUNC_SUBTRACT

public static final int EQ_FUNC_SUBTRACT

Set the blending equation to be C_sS - C_dD

See Also:

Constant Field Values

EQ_FUNC_SUBTRACT_REVERSE

public static final int EQ_FUNC_SUBTRACT_REVERSE

Set the blending equation to be C_dD - C_sS

See Also:

Constant Field Values

EQ_FUNC_MIN

public static final int EQ_FUNC_MIN

Set the blending equation to be min(C_dD, C_sS)

See Also:

Constant Field Values

EQ_FUNC_MAX

public static final int EQ_FUNC_MAX

Set the blending equation to be max(C_dD, C_sS)

See Also:

Constant Field Values

Constructor Detail

GeneralBufferState

public GeneralBufferState()

Constructs a state set with default values. Blending is disabled by default.

Method Detail

getBufferType

public int getBufferType()

Get the type of buffer this state represents.

Specified by:

getBufferType in interface BufferStateRenderable

Returns:

One of the _BUFFER constants

getBufferBitMask

public int getBufferBitMask()

Get the GL buffer bit flag that this state class represents. Used for bulk clearing all the states at once.

Specified by:

getBufferBitMask in interface BufferStateRenderable

Returns:

The bit state constant for Stencil Buffers

checkClearBufferState

public boolean checkClearBufferState()

Check to see if this buffer should be cleared at the start of this run. If it should be, add the bit mask from this state to the global list.

Specified by:

checkClearBufferState in interface BufferStateRenderable

Returns:

true if the state should be cleared

setBufferState

public void setBufferState(javax.media.opengl.GL gl)

Issue ogl commands needed for this buffer to set the initial state, including the initial enabling.

Specified by:

setBufferState in interface BufferStateRenderable

Parameters:

gl - The gl context to draw with

updateBufferState

public void updateBufferState(javax.media.opengl.GL gl)

Issue ogl commands needed for this component to change the state, assuming that it is already enabled.

Specified by:

updateBufferState in interface BufferStateRenderable

Parameters:

gl - The gl context to draw with

clearBufferState

public void clearBufferState(javax.media.opengl.GL gl)

Restore all state to the default values.

Specified by:

clearBufferState in interface BufferStateRenderable

Parameters:

gl - The gl context to draw with

compareTo

public int compareTo(java.lang.Object o)
              throws java.lang.ClassCastException

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

o - The objec to be compared

Returns:

-1, 0 or 1 depending on order

Throws:

java.lang.ClassCastException - The specified object's type prevents it from being compared to this Object

equals

public boolean equals(java.lang.Object o)

Compare this object for equality to the given object.

Specified by:

equals in interface Renderable

Overrides:

equals in class java.lang.Object

Parameters:

o - The object to be compared

Returns:

True if these represent the same values

enableBlending

public void enableBlending(boolean test)
                    throws InvalidWriteTimingException

Set the flag for whether the blending should be enabled or disabled.

Parameters:

test - True if testing should be enabled state to be used in the current operation

Throws:

InvalidWriteTimingException - An attempt was made to write outside of the NodeUpdateListener data changed callback method

isBlendingEnabled

public boolean isBlendingEnabled()

Check to see if depth testing is currently enabled.

Returns:

true when testing is enabled

setSourceBlendFactor

public void setSourceBlendFactor(int factor)
                          throws InvalidWriteTimingException

Set the source blend factor to use. Used for both non-separated blending and the RGB component when separated.

Parameters:

factor - The value to set for the factor

Throws:

java.lang.IllegalArgumentException - The blend factor is not one of the permitted types

InvalidWriteTimingException - An attempt was made to write outside of the NodeUpdateListener data changed callback method

getSourceBlendFactor

public int getSourceBlendFactor()

Request the currently set source blend factor.

Returns:

One of the BLEND_* constant values

setDestinationBlendFactor

public void setDestinationBlendFactor(int factor)
                               throws InvalidWriteTimingException

Set the destination blend factor to use. Used for both non-separated blending and the RGB component when separated.

Parameters:

factor - The value to set for the factor

Throws:

java.lang.IllegalArgumentException - The blend factor is not one of the permitted types or is SRC_ALPHA_SATURATED

InvalidWriteTimingException - An attempt was made to write outside of the NodeUpdateListener data changed callback method

getDestinationBlendFactor

public int getDestinationBlendFactor()

Request the currently set destination blend factor.

Returns:

One of the BLEND_* constant values

setAlphaSourceBlendFactor

public void setAlphaSourceBlendFactor(int factor)
                               throws InvalidWriteTimingException

Set the source blend factor to use. Only used for seperated blending mode's alpha component. If non-separated mode is used, this setting is ignored.

Parameters:

factor - The value to set for the factor

Throws:

java.lang.IllegalArgumentException - The blend factor is not one of the permitted types

InvalidWriteTimingException - An attempt was made to write outside of the NodeUpdateListener data changed callback method

getAlphaSourceBlendFactor

public int getAlphaSourceBlendFactor()

Request the currently set source blend factor for the alpha component.

Returns:

One of the BLEND_* constant values

setAlphaDestinationBlendFactor

public void setAlphaDestinationBlendFactor(int factor)
                                    throws InvalidWriteTimingException

Set the destination blend factor to use. Only used for seperated blending mode's alpha component. If non-separated mode is used, this setting is ignored.

Parameters:

factor - The value to set for the factor

Throws:

java.lang.IllegalArgumentException - The blend factor is not one of the permitted types or is SRC_ALPHA_SATURATED

InvalidWriteTimingException - An attempt was made to write outside of the NodeUpdateListener data changed callback method

getAlphaDestinationBlendFactor

public int getAlphaDestinationBlendFactor()

Request the currently set destination blend factor for the alpha component.

Returns:

One of the BLEND_* constant values

setSeparatedBlendFactors

public void setSeparatedBlendFactors(boolean state)
                              throws InvalidWriteTimingException

Instruct the system whether to use separated RGB and Alpha blending functions. By default this is not enabled, but may be turned on or off using this method.

Parameters:

state - True to enable the use of separate RGB and alpha blending

Throws:

InvalidWriteTimingException - An attempt was made to write outside of the NodeUpdateListener data changed callback method

setBlendEquation

public void setBlendEquation(int mode)

Set the blend equation to use. By default, after multiplying the source color by the source blend factor and the destination color by the destination blend factor, the two values are then added together to get the final color. If you want to use other operation besides addition, this function needs to be called. Available blending equations and their descriptions are listed below.

EQ_FUNC_ADD: Set the blending equation to be C_sS + C_dD EQ_FUNC_SUBTRACT: Set the blending equation to be C_sS - C_dD EQ_FUNC_SUBTRACT_REVERSE: Set the blending equation to be C_dD - C_sS EQ_FUNC_MIN: Set the blending equation to be min(C_dD, C_sS) EQ_FUNC_MAX: Set the blending equation to be max(C_dD, C_sS)

Parameters:

mode - Blending equation mode

Throws:

InvalidWriteTimingException - An attempt was made to write outside of the NodeUpdateListener data changed callback method

getBlendEquation

public int getBlendEquation()

Request the currently set blend equation

Returns:

Blend equation value

getSeparatedBlendFactors

public boolean getSeparatedBlendFactors()

Check to see the current state of whether separated blending is used or not.

Returns:

true if separated RGB and Alpha blending is used

compareTo

public int compareTo(GeneralBufferState gbs)

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Parameters:

gbs - The attributes instance to be comgbsred

Returns:

-1, 0 or 1 depending on order

equals

public boolean equals(GeneralBufferState gbs)

Compares this object with the specified object to check for equivalence.

Parameters:

gbs - The attributes instance to be compared

Returns:

true if the objects represent identical values