com.openinventor.inventor.nodes

Class SoDepthBuffer

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.misc.SoBase

com.openinventor.inventor.fields.SoFieldContainer

com.openinventor.inventor.nodes.SoNode

com.openinventor.inventor.nodes.SoDepthBuffer

All Implemented Interfaces:

SafeDisposable

public class SoDepthBuffer
extends SoNode

Depth buffer parameters node. This class specifies the depth buffer parameters used for rendering, including:

• Depth buffer test enabled,
• Depth buffer writing enabled,
• Depth buffer range, and
• Depth comparison function.

It can also be used to clear the depth buffer by setting the clearBuffer field to true.

Limitations:

• Transparency:
  The "depth peeling" transparency types (SORTED_PIXELS_BLEND and DELAYED_SORTED_PIXELS_BLEND) do not work correctly if this node is used to change depth buffer settings.
• Test function
  By default SoDepthBuffer sets the OpenGL depth buffer test function to LESS. (Meaning that only fragments with a depth value strictly less than the current depth buffer value will be rendered.) This is NOT the same as the Open Inventor default.
  
  By default Open Inventor sets the depth buffer test function to LEQUAL and this value is recommended for most applications. Some Open Inventor features, for example SoGradientBackground, will not work correctly with the depth buffer test function set to LESS.

File format/default:

DepthBuffer {

test	true
write	true
function	LESS
range	(0.0,1.0)
clearBuffer	false

}

Action behavior:

SoGLRenderAction

See also:

SoPolygonOffset, SoDepthOffset, SoGLRenderAction

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SoDepthBuffer.DepthWriteFunctions Depth function mode as defined by OpenGL.

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALWAYS Deprecated. Use SoDepthBuffer.DepthWriteFunctions.ALWAYS instead.
SoSFBool	clearBuffer If true, the depth buffer is cleared when the node is traversed (glClear(GL_DEPTH_BUFFER_BIT)).
static int	EQUAL Deprecated. Use SoDepthBuffer.DepthWriteFunctions.EQUAL instead.
SoSFEnum<SoDepthBuffer.DepthWriteFunctions>	function Depth comparison function to use (glDepthFunc).
static int	GEQUAL Deprecated. Use SoDepthBuffer.DepthWriteFunctions.GEQUAL instead.
static int	GREATER Deprecated. Use SoDepthBuffer.DepthWriteFunctions.GREATER instead.
static int	LEQUAL Deprecated. Use SoDepthBuffer.DepthWriteFunctions.LEQUAL instead.
static int	LESS Deprecated. Use SoDepthBuffer.DepthWriteFunctions.LESS instead.
static int	NEVER Deprecated. Use SoDepthBuffer.DepthWriteFunctions.NEVER instead.
static int	NOTEQUAL Deprecated. Use SoDepthBuffer.DepthWriteFunctions.NOTEQUAL instead.
SoSFVec2f	range Value range for the depth buffer (glDepthRange).
SoSFBool	test Enable depth buffer testing (glEnable).
SoSFBool	write Enable depth buffer writing (glDepthMask).

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoDepthBuffer() Constructor.

Method Summary

Methods inherited from class com.openinventor.inventor.nodes.SoNode

affectsState, callback, copy, copy, distribute, doAction, getAlternateRep, getBoundingBox, getByName, getMatrix, getPrimitiveCount, getRenderUnitID, GLRender, GLRenderBelowPath, GLRenderInPath, GLRenderOffPath, grabEventsCleanup, grabEventsSetup, handleEvent, isBoundingBoxIgnoring, isOverride, pick, rayPick, search, setOverride, touch, write

Methods inherited from class com.openinventor.inventor.fields.SoFieldContainer

copyFieldValues, copyFieldValues, enableNotify, fieldsAreEqual, get, getAllFields, getEventIn, getEventOut, getField, getFieldName, hasDefaultValues, isNotifyEnabled, set, setToDefaults

Methods inherited from class com.openinventor.inventor.misc.SoBase

dispose, getEXTERNPROTO, getName, getPROTO, isDisposable, isSynchronizable, setName, setSynchronizable

Methods inherited from class com.openinventor.inventor.Inventor

getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

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

Field Detail

NEVER

@Deprecated
public static final int NEVER

Deprecated. Use SoDepthBuffer.DepthWriteFunctions.NEVER instead.

LESS

@Deprecated
public static final int LESS

Deprecated. Use SoDepthBuffer.DepthWriteFunctions.LESS instead.

EQUAL

@Deprecated
public static final int EQUAL

Deprecated. Use SoDepthBuffer.DepthWriteFunctions.EQUAL instead.

LEQUAL

@Deprecated
public static final int LEQUAL

Deprecated. Use SoDepthBuffer.DepthWriteFunctions.LEQUAL instead.

GREATER

@Deprecated
public static final int GREATER

Deprecated. Use SoDepthBuffer.DepthWriteFunctions.GREATER instead.

NOTEQUAL

@Deprecated
public static final int NOTEQUAL

Deprecated. Use SoDepthBuffer.DepthWriteFunctions.NOTEQUAL instead.

GEQUAL

@Deprecated
public static final int GEQUAL

Deprecated. Use SoDepthBuffer.DepthWriteFunctions.GEQUAL instead.

ALWAYS

@Deprecated
public static final int ALWAYS

Deprecated. Use SoDepthBuffer.DepthWriteFunctions.ALWAYS instead.

test

public final SoSFBool test

Enable depth buffer testing (glEnable). Default is true.

Note that disabling depth testing will prevent the depth buffer from being updated even if depth buffer writing is set to true.

write

public final SoSFBool write

Enable depth buffer writing (glDepthMask). Default is true.

function

public final SoSFEnum<SoDepthBuffer.DepthWriteFunctions> function

Depth comparison function to use (glDepthFunc). . Default is LESS.

range

public final SoSFVec2f range

Value range for the depth buffer (glDepthRange). Default is [0.0-1.0]. The range will be clamped to [0.0-1.0] by OpenGL.

clearBuffer

public final SoSFBool clearBuffer

If true, the depth buffer is cleared when the node is traversed (glClear(GL_DEPTH_BUFFER_BIT)). The extent of the buffer that is actually cleared may be limited using an SoViewportClipping node. Default is false.

Since:

Open Inventor 8.6

Constructor Detail

SoDepthBuffer

public SoDepthBuffer()

Constructor.