Depth buffer parameters node. More...

#include <Inventor/nodes/SoDepthBuffer.h>

Inheritance diagram for SoDepthBuffer:

Public Types
enum	DepthWriteFunction { NEVER = SoDepthBufferElement::NEVER , LESS = SoDepthBufferElement::LESS , EQUAL = SoDepthBufferElement::EQUAL , LEQUAL = SoDepthBufferElement::LEQUAL , GREATER = SoDepthBufferElement::GREATER , NOTEQUAL = SoDepthBufferElement::NOTEQUAL , GEQUAL = SoDepthBufferElement::GEQUAL , ALWAYS = SoDepthBufferElement::ALWAYS }
	Depth function mode as defined by OpenGL. More...

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.

	SoDepthBuffer ()
	Constructor.

virtual void	setOverride (const SbBool state)
	Turns the override flag on or off.

virtual SbBool	isOverride () const
	Returns the state of the override flag.

Public Member Functions inherited from SoNode
virtual SoNode *	copy (SbBool copyConnections=FALSE) const
	Creates and returns an exact copy of the node.

virtual SbBool	affectsState () const
	Returns TRUE if a node has an effect on the state during traversal.

virtual void	touch ()
	Marks an instance as modified, simulating a change to it.

Public Member Functions inherited from SoFieldContainer
void	setToDefaults ()
	Sets all fields in this object to their default values.

SbBool	hasDefaultValues () const
	Returns TRUE if all of the object's fields have their default values.

SbBool	fieldsAreEqual (const SoFieldContainer *fc) const
	Returns TRUE if this object's fields are exactly equal to fc's fields.

void	copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE)
	Copies the contents of fc's fields into this object's fields.

SoNONUNICODE SbBool	set (const char *fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.

SbBool	set (const SbString &fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.

void	get (SbString &fieldDataString)
	Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.

virtual int	getFields (SoFieldList &list) const
	Appends references to all of this object's fields to resultList, and returns the number of fields appended.

virtual int	getAllFields (SoFieldList &list) const
	Returns a list of fields, including the eventIn's and eventOut's.

virtual SoField *	getField (const SbName &fieldName) const
	Returns a the field of this object whose name is fieldName.

virtual SoField *	getEventIn (const SbName &fieldName) const
	Returns a the eventIn with the given name.

virtual SoField *	getEventOut (const SbName &fieldName) const
	Returns the eventOut with the given name.

SbBool	getFieldName (const SoField *field, SbName &fieldName) const
	Returns the name of the given field in the fieldName argument.

SbBool	enableNotify (SbBool flag)
	Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).

SbBool	isNotifyEnabled () const
	Notification is the process of telling interested objects that this object has changed.

virtual void	setUserData (void *data)
	Sets application data.

void *	getUserData (void) const
	Gets user application data.

Public Member Functions inherited from SoBase
virtual SbName	getName () const
	Returns the name of an instance.

virtual void	setName (const SbName &name)
	Sets the name of an instance.

void	setSynchronizable (const bool b)
	Sets this to be a ScaleViz synchronizable object.

bool	isSynchronizable () const
	Gets the ScaleViz synchronizable state of this object.

Public Member Functions inherited from SoRefCounter
void	ref () const
	Adds a reference to an instance.

void	unref () const
	Removes a reference from an instance.

void	unrefNoDelete () const
	unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero.

int	getRefCount () const
	Returns current reference count.

void	lock () const
	lock this instance.

void	unlock () const
	unlock this instance.

Public Member Functions inherited from SoTypedObject
SbBool	isOfType (const SoType &type) const
	Returns TRUE if this object is of the type specified in type or is derived from that type.

template<typename TypedObjectClass >
SbBool	isOfType () const
	Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.

Static Public Member Functions
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Static Public Member Functions inherited from SoNode
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

static SoNode *	getByName (const SbName &name)
	A node's name can be set using SoBase::setName().

static int	getByName (const SbName &name, SoNodeList &list)
	A node's name can be set using SoBase::setName().

Static Public Member Functions inherited from SoFieldContainer
static SoType	getClassTypeId ()
	Returns the type of this class.

Static Public Member Functions inherited from SoBase
static SoType	getClassTypeId ()
	Returns type identifier for this class.

Static Public Member Functions inherited from SoTypedObject
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Public Attributes
SoSFBool	test
	Enable depth buffer testing (glEnable).

SoSFBool	write
	Enable depth buffer writing (glDepthMask).

SoSFEnum	function
	Depth comparison function to use (glDepthFunc).

SoSFVec2f	range
	Value range for the depth buffer (glDepthRange).

SoSFBool	clearBuffer
	If true, the depth buffer is cleared when the node is traversed.

Detailed Description

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.

To control whether frame buffer color components are written or not, see SoColorMask.

Limitations:

Transparency:
The "depth peeling" transparency types (SORTED_PIXEL) 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

test	TRUE
write	TRUE
function	LESS
range	(0.0,1.0)
clearBuffer	FALSE

ACTION BEHAVIOR

SoGLRenderAction

Member Enumeration Documentation

◆ DepthWriteFunction

enum SoDepthBuffer::DepthWriteFunction

Depth function mode as defined by OpenGL.

Enumerator
NEVER	Never passes.
LESS	Passes if the incoming depth value is less than the stored depth value.
EQUAL	Passes if the incoming depth value is equal to the stored depth value.
LEQUAL	Passes if the incoming depth value is less than or equal to the stored depth value.
GREATER	Passes if the incoming depth value is greater than the stored depth value.
NOTEQUAL	Passes if the incoming depth value is not equal to the stored depth value.
GEQUAL	Passes if the incoming depth value is greater than or equal to the stored depth value.
ALWAYS	Always passes.

Definition at line 100 of file SoDepthBuffer.h.

Constructor & Destructor Documentation

◆ SoDepthBuffer()

SoDepthBuffer::SoDepthBuffer ( )

Constructor.

Member Function Documentation

◆ getClassTypeId()

static SoType SoDepthBuffer::getClassTypeId ( )

static

Returns the type identifier for this class.

◆ getTypeId()

virtual SoType SoDepthBuffer::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from SoNode.

◆ isOverride()

virtual SbBool SoDepthBuffer::isOverride ( ) const

inlinevirtual

Returns the state of the override flag.

Reimplemented from SoNode.

Definition at line 170 of file SoDepthBuffer.h.

◆ setOverride()

virtual void SoDepthBuffer::setOverride ( const SbBool state )

inlinevirtual

Turns the override flag on or off.

The following property nodes are affected by the override flag: SoBaseColor, SoColorIndex, SoComplexity, SoDepthBuffer, SoDrawStyle, SoEnvironment, SoFont, SoFullSceneAntialiasing, SoLightModel, SoMaterial, SoMaterialBinding, SoPackedColor, SoPattern, SoPickStyle, SoPolygonOffset, SoShapeHints, SoVertexProperty, SoTextProperty.

Every node has an override flag associated with it. The override flag is a powerful mechanism typically used (sparingly) near the top of a scene graph. When this flag is set, any nodes of the same type encountered later in the graph are ignored even if they also have their own override flag set. For example, you might insert a line-style SoDrawStyle node at the top of a graph to ensure that the whole scene is drawn as wireframe objects, regardless of drawing styles specified lower in the scene graph. Use the setOverride() method to set and reset the override flag. The isOverride() method returns the state of the override flag.

Normally, the override flag is not used within a scene graph for modeling. Use it in applications where you need to specify a temporary change to the whole graph.

Note: The override flag is not written to a file.

Setting the override flag on a node whose field values are not inherited (for example on a sphere with a radius of 7) has no effect on other nodes in the graph of that type.

Reimplemented from SoNode.

Definition at line 164 of file SoDepthBuffer.h.

Member Data Documentation

◆ clearBuffer

SoSFBool SoDepthBuffer::clearBuffer

If true, the depth buffer is cleared when the node is traversed.

The extent of the buffer that is actually cleared may be limited using an SoViewportClipping node. Default is FALSE.

Note: Be careful when using this feature along with a transparency mode other than SoGLRenderAction::NO_SORT because the objects rendering order might be different from their ordering in the scene graph.

NOTE: field available since Open Inventor 8.6

Definition at line 156 of file SoDepthBuffer.h.

◆ function

SoSFEnum SoDepthBuffer::function

Depth comparison function to use (glDepthFunc).

Use enum DepthWriteFunction. Default is LESS.

Definition at line 137 of file SoDepthBuffer.h.

◆ range

SoSFVec2f SoDepthBuffer::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.

Definition at line 143 of file SoDepthBuffer.h.

◆ test

SoSFBool SoDepthBuffer::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.

Definition at line 126 of file SoDepthBuffer.h.

◆ write

SoSFBool SoDepthBuffer::write

Enable depth buffer writing (glDepthMask).

Default is TRUE.

Definition at line 131 of file SoDepthBuffer.h.

The documentation for this class was generated from the following file:

Inventor/nodes/SoDepthBuffer.h

Open Inventor Release 2023.2.3

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

FILE FORMAT/DEFAULT

ACTION BEHAVIOR

SEE ALSO

Member Enumeration Documentation

◆ DepthWriteFunction

Constructor & Destructor Documentation

◆ SoDepthBuffer()

Member Function Documentation

◆ getClassTypeId()

◆ getTypeId()

◆ isOverride()

◆ setOverride()

Member Data Documentation

◆ clearBuffer

◆ function

◆ range

◆ test

◆ write