SoDepthBufferElement Class Reference

The SoDepthBufferElement controls the depth buffer settings. More...

#include <Inventor/elements/SoDepthBufferElement.h>

Inheritance diagram for SoDepthBufferElement:

List of all members.

Public Types
enum	DepthWriteFunction {   NEVER, ALWAYS, LESS, LEQUAL,   EQUAL, GEQUAL, GREATER, NOTEQUAL }
Public Member Functions
virtual void	init (SoState *state)
virtual void	push (SoState *state)
virtual void	pop (SoState *state, const SoElement *prevTopElement)
virtual SbBool	matches (const SoElement *element) const
virtual SoElement *	copyMatchInfo (void) const
Static Public Member Functions
static void	initClass (void)
static void	set (SoState *state, SbBool test, SbBool write, DepthWriteFunction function, SbVec2f range)
static void	get (SoState *state, SbBool &test_out, SbBool &write_out, DepthWriteFunction &function_out, SbVec2f &range_out)
static SbBool	getTestEnable (SoState *state)
static SbBool	getWriteEnable (SoState *state)
static DepthWriteFunction	getFunction (SoState *state)
static SbVec2f	getRange (SoState *state)
Protected Member Functions
virtual	~SoDepthBufferElement ()
virtual void	setElt (SbBool test, SbBool write, DepthWriteFunction function, SbVec2f range)
Protected Attributes
SbBool	test
SbBool	write
DepthWriteFunction	function
SbVec2f	range

---

Detailed Description

The SoDepthBufferElement controls the depth buffer settings.

Be aware that this class is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

Since:

Coin 3.0

---

Constructor & Destructor Documentation

SoDepthBufferElement::~SoDepthBufferElement

(

void

)

[protected, virtual]

The destructor.

---

Member Function Documentation

void SoDepthBufferElement::initClass

(

void

)

[static]

This function initializes the SoDepthBufferElement class type for Coin.

Reimplemented from SoElement.

Reimplemented in SoGLDepthBufferElement.

void SoDepthBufferElement::set	(	SoState *	state,
		SbBool	test,
		SbBool	write,
		DepthWriteFunction	function,
		SbVec2f	range
	)		[static]

Set this element's values.

void SoDepthBufferElement::get	(	SoState *	state,
		SbBool &	test_out,
		SbBool &	write_out,
		DepthWriteFunction &	function_out,
		SbVec2f &	range_out
	)		[static]

Fetches this element's values.

SbBool SoDepthBufferElement::getTestEnable

(

SoState *

state

)

[static]

Returns the depth test enabled state.

SbBool SoDepthBufferElement::getWriteEnable

(

SoState *

state

)

[static]

Returns the depth buffer write enabled state.

SoDepthBufferElement::DepthWriteFunction SoDepthBufferElement::getFunction

(

SoState *

state

)

[static]

Returns the set depth buffer write function.

SbVec2f SoDepthBufferElement::getRange

(

SoState *

state

)

[static]

Returns the depth buffer value range used.

void SoDepthBufferElement::init

(

SoState *

state

)

[virtual]

Internal Coin method.

Reimplemented from SoElement.

Reimplemented in SoGLDepthBufferElement.

void SoDepthBufferElement::push

(

SoState *

state

)

[virtual]

Internal Coin method.

Reimplemented from SoElement.

Reimplemented in SoGLDepthBufferElement.

SbBool SoDepthBufferElement::matches

(

const SoElement *

element

)

const [virtual]

Internal Coin method.

Implements SoElement.

SoElement * SoDepthBufferElement::copyMatchInfo

(

void

)

const [virtual]

Internal Coin method.

Implements SoElement.

void SoDepthBufferElement::setElt	(	SbBool	test,
		SbBool	write,
		DepthWriteFunction	function,
		SbVec2f	range
	)		[protected, virtual]

Virtual method to set the state to get derived elements updated.

Reimplemented in SoGLDepthBufferElement.

---

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

• SoDepthBufferElement.h
• SoDepthBufferElement.cpp