osg::Depth Class Reference

Encapsulate OpenGL glDepthFunc/Mask/Range functions. More...

Inheritance diagram for osg::Depth:

[legend]

List of all members.

Public Types
enum	Function {   NEVER = GL_NEVER, LESS = GL_LESS, EQUAL = GL_EQUAL, LEQUAL = GL_LEQUAL,   GREATER = GL_GREATER, NOTEQUAL = GL_NOTEQUAL, GEQUAL = GL_GEQUAL, ALWAYS = GL_ALWAYS }
Public Member Functions
	Depth (Function func=LESS, double zNear=0.0, double zFar=1.0, bool writeMask=true)
	Depth (const Depth &dp, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
	Copy constructor using CopyOp to manage deep vs shallow copy.
	META_StateAttribute (osg, Depth, DEPTH)
virtual int	compare (const StateAttribute &sa) const
	return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs.
virtual bool	getModeUsage (StateAttribute::ModeUsage &usage) const
	Return the modes associated with this StateAttribute.
void	setFunction (Function func)
Function	getFunction () const
void	setRange (double zNear, double zFar)
void	setZNear (double zNear)
double	getZNear () const
void	setZFar (double zFar)
double	getZFar () const
void	setWriteMask (bool mask)
bool	getWriteMask () const
virtual void	apply (State &state) const
	apply the OpenGL state attributes.
Protected Member Functions
virtual	~Depth ()
Protected Attributes
Function	_func
double	_zNear
double	_zFar
bool	_depthWriteMask

---

Detailed Description

Encapsulate OpenGL glDepthFunc/Mask/Range functions.

---

Member Enumeration Documentation

enum osg::Depth::Function

Enumerator:

NEVER
LESS
EQUAL
LEQUAL
GREATER
NOTEQUAL
GEQUAL
ALWAYS

---

Constructor & Destructor Documentation

osg::Depth::Depth	(	Function	func = LESS,
		double	zNear = 0.0,
		double	zFar = 1.0,
		bool	writeMask = true
	)

osg::Depth::Depth	(	const Depth &	dp,
		const CopyOp &	copyop = CopyOp::SHALLOW_COPY
	)			[inline]

Copy constructor using CopyOp to manage deep vs shallow copy.

virtual osg::Depth::~Depth

(

)

[protected, virtual]

---

Member Function Documentation

osg::Depth::META_StateAttribute	(	osg	,
		Depth	,
		DEPTH
	)

virtual int osg::Depth::compare

(

const StateAttribute &

sa

)

const [inline, virtual]

return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs.

Implements osg::StateAttribute.

virtual bool osg::Depth::getModeUsage

(

StateAttribute::ModeUsage &

)

const [inline, virtual]

Return the modes associated with this StateAttribute.

Reimplemented from osg::StateAttribute.

void osg::Depth::setFunction

(

Function

func

)

[inline]

Function osg::Depth::getFunction

(

)

const [inline]

void osg::Depth::setRange	(	double	zNear,
		double	zFar
	)			[inline]

void osg::Depth::setZNear

(

double

zNear

)

[inline]

double osg::Depth::getZNear

(

)

const [inline]

void osg::Depth::setZFar

(

double

zFar

)

[inline]

double osg::Depth::getZFar

(

)

const [inline]

void osg::Depth::setWriteMask

(

bool

mask

)

[inline]

bool osg::Depth::getWriteMask

(

)

const [inline]

virtual void osg::Depth::apply

(

State &

)

const [virtual]

apply the OpenGL state attributes.

The render info for the current OpenGL context is passed in to allow the StateAttribute to obtain details on the the current context and state.

Reimplemented from osg::StateAttribute.

---

Member Data Documentation

Function osg::Depth::_func [protected]

double osg::Depth::_zNear [protected]

double osg::Depth::_zFar [protected]

bool osg::Depth::_depthWriteMask [protected]

---

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

• Depth

---