SoDepthBufferElement Class Reference

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

#include <Inventor/elements/SoDepthBufferElement.h>

Inheritance diagram for SoDepthBufferElement:

Public Types
enum	DepthWriteFunction {   NEVER , ALWAYS , LESS , LEQUAL ,   EQUAL , GEQUAL , GREATER , NOTEQUAL }

Public Member Functions
virtual SoElement *	copyMatchInfo (void) const
virtual void	init (SoState *state)
virtual SbBool	matches (const SoElement *element) const
virtual void	pop (SoState *state, const SoElement *prevTopElement)
virtual void	push (SoState *state)
Public Member Functions inherited from SoElement
virtual	~SoElement ()
int	getDepth (void) const
int	getStackIndex (void) const
const SoType	getTypeId (void) const
virtual void	print (FILE *file=stdout) const
void	setDepth (const int depth)

Static Public Member Functions
static void *	createInstance (void)
static void	get (SoState *state, SbBool &test_out, SbBool &write_out, DepthWriteFunction &function_out, SbVec2f &range_out)
static int	getClassStackIndex (void)
static SoType	getClassTypeId (void)
static DepthWriteFunction	getFunction (SoState *state)
static SbVec2f	getRange (SoState *state)
static SbBool	getTestEnable (SoState *state)
static SbBool	getWriteEnable (SoState *state)
static void	initClass (void)
static void	set (SoState *state, SbBool test, SbBool write, DepthWriteFunction function, SbVec2f range)
Static Public Member Functions inherited from SoElement
static int	getClassStackIndex (void)
static SoType	getClassTypeId (void)
static SoType	getIdFromStackIndex (const int stackIndex)
static int	getNumStackIndices (void)
static void	initClass (void)
static void	initElements (void)

Protected Member Functions
virtual	~SoDepthBufferElement ()
virtual void	setElt (SbBool test, SbBool write, DepthWriteFunction function, SbVec2f range)
Protected Member Functions inherited from SoElement
	SoElement (void)
void	capture (SoState *const state) const
virtual void	captureThis (SoState *state) const
SoElement *	getNextFree (void) const
SoElement *	getNextInStack (void) const
void	setStackIndex (const int index)
void	setTypeId (const SoType typeId)

Protected Attributes
DepthWriteFunction	function
SbVec2f	range
SbBool	test
SbBool	write
Protected Attributes inherited from SoElement
int	depth
int	stackIndex
SoType	typeId

Additional Inherited Members
Static Protected Member Functions inherited from SoElement
static int	createStackIndex (const SoType id)
static const SoElement *	getConstElement (SoState *const state, const int stackIndex)
static SoElement *	getElement (SoState *const state, const int stackIndex)
Static Protected Attributes inherited from SoElement
static int	classStackIndex
static SoTypeList *	stackToType

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::~SoDepthBufferElement ( void )

protectedvirtual

Destructor.

Member Function Documentation

copyMatchInfo()

SoElement * SoDepthBufferElement::copyMatchInfo ( void ) const

virtual

Internal Coin method.

Implements SoElement.

createInstance()

void * SoDepthBufferElement::createInstance ( void )

static

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Creates a new instance of the class type corresponding to the SoType object.

get()

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

static

Fetches this element's values.

getClassStackIndex()

static int SoDepthBufferElement::getClassStackIndex ( void )

static

This static method returns the state stack index for the class.

This static method returns the state stack index for the class.

getClassTypeId()

static SoType SoDepthBufferElement::getClassTypeId ( void )

static

This static method returns the SoType object associated with objects of this class.

This static method returns the class type.

getFunction()

SoDepthBufferElement::DepthWriteFunction SoDepthBufferElement::getFunction ( SoState * state )

static

Returns the set depth buffer write function.

getRange()

SbVec2f SoDepthBufferElement::getRange ( SoState * state )

static

Returns the depth buffer value range used.

getTestEnable()

SbBool SoDepthBufferElement::getTestEnable ( SoState * state )

static

Returns the depth test enabled state.

getWriteEnable()

SbBool SoDepthBufferElement::getWriteEnable ( SoState * state )

static

Returns the depth buffer write enabled state.

init()

void SoDepthBufferElement::init ( SoState * state )

virtual

Internal Coin method.

Reimplemented from SoElement.

Reimplemented in SoGLDepthBufferElement.

initClass()

void SoDepthBufferElement::initClass ( void )

static

Initialize relevant common data for all instances, like the type system.

matches()

SbBool SoDepthBufferElement::matches ( const SoElement * element ) const

virtual

Internal Coin method.

Implements SoElement.

pop()

void SoDepthBufferElement::pop ( SoState * state, const SoElement * prevTopElement )

virtual

Internal Coin method.

Reimplemented from SoElement.

Reimplemented in SoGLDepthBufferElement.

push()

void SoDepthBufferElement::push ( SoState * state )

virtual

Internal Coin method.

Reimplemented from SoElement.

Reimplemented in SoGLDepthBufferElement.

set()

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

static

Set this element's values.

setElt()

void SoDepthBufferElement::setElt ( SbBool test, SbBool write, DepthWriteFunction function, SbVec2f range )

protectedvirtual

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