Depth
Go to the documentation of this file.
/* -*-c++-*- OpenSceneGraph - Copyright (C) 1998-2006 Robert Osfield
*
* This library is open source and may be redistributed and/or modified under
* the terms of the OpenSceneGraph Public License (OSGPL) version 0.0 or
* (at your option) any later version. The full license is in LICENSE file
* included with this distribution, and on the openscenegraph.org website.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* OpenSceneGraph Public License for more details.
*/
#ifndef OSG_DEPTH
#define OSG_DEPTH 1
#include <osg/StateAttribute>
namespace osg {
class OSG_EXPORT Depth : public StateAttribute
{
public :
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
};
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):
StateAttribute(dp,copyop),
_func(dp._func),
_zNear(dp._zNear),
_zFar(dp._zFar),
_depthWriteMask(dp._depthWriteMask) {}
META_StateAttribute(osg, Depth, DEPTH);
virtual int compare(const StateAttribute& sa) const
{
// check the types are equal and then create the rhs variable
// used by the COMPARE_StateAttribute_Parameter macros below.
COMPARE_StateAttribute_Types(Depth,sa)
// compare each parameter in turn against the rhs.
COMPARE_StateAttribute_Parameter(_func)
COMPARE_StateAttribute_Parameter(_depthWriteMask)
COMPARE_StateAttribute_Parameter(_zNear)
COMPARE_StateAttribute_Parameter(_zFar)
return 0; // passed all the above comparison macros, must be equal.
}
virtual bool getModeUsage(StateAttribute::ModeUsage& usage) const
{
usage.usesMode(GL_DEPTH_TEST);
return true;
}
inline void setFunction(Function func) { _func = func; }
inline Function getFunction() const { return _func; }
inline void setRange(double zNear, double zFar)
{
_zNear = zNear;
_zFar = zFar;
}
inline void setZNear(double zNear) { _zNear=zNear; }
inline double getZNear() const { return _zNear; }
inline void setZFar(double zFar) { _zFar=zFar; }
inline double getZFar() const { return _zFar; }
inline void setWriteMask(bool mask) { _depthWriteMask = mask; }
inline bool getWriteMask() const { return _depthWriteMask; }
virtual void apply(State& state) const;
protected:
virtual ~Depth();
Function _func;
double _zNear;
double _zFar;
bool _depthWriteMask;
};
}
#endif
StateAttribute
COMPARE_StateAttribute_Parameter
#define COMPARE_StateAttribute_Parameter(parameter)
Definition StateAttribute:69
COMPARE_StateAttribute_Types
#define COMPARE_StateAttribute_Types(TYPE, rhs_attribute)
Definition StateAttribute:57
osg::CopyOp
Definition CopyOp:41
osg::CopyOp::SHALLOW_COPY
@ SHALLOW_COPY
Definition CopyOp:47
osg::Depth::compare
virtual int compare(const StateAttribute &sa) const
Definition Depth:55
osg::Depth::setRange
void setRange(double zNear, double zFar)
Definition Depth:80
osg::Depth::apply
virtual void apply(State &state) const
osg::Depth::_func
Function _func
Definition Depth:102
osg::Depth::setWriteMask
void setWriteMask(bool mask)
Definition Depth:92
osg::Depth::setFunction
void setFunction(Function func)
Definition Depth:76
osg::Depth::setZFar
void setZFar(double zFar)
Definition Depth:89
osg::Depth::getZFar
double getZFar() const
Definition Depth:90
osg::Depth::getZNear
double getZNear() const
Definition Depth:87
osg::Depth::_zFar
double _zFar
Definition Depth:105
osg::Depth::META_StateAttribute
META_StateAttribute(osg, Depth, DEPTH)
osg::Depth::getWriteMask
bool getWriteMask() const
Definition Depth:93
osg::Depth::setZNear
void setZNear(double zNear)
Definition Depth:86
osg::Depth::Depth
Depth(const Depth &dp, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
Definition Depth:44
osg::Depth::getModeUsage
virtual bool getModeUsage(StateAttribute::ModeUsage &usage) const
Definition Depth:70
osg::Depth::_zNear
double _zNear
Definition Depth:104
osg::Depth::_depthWriteMask
bool _depthWriteMask
Definition Depth:107
osg::Depth::~Depth
virtual ~Depth()
osg::Depth::getFunction
Function getFunction() const
Definition Depth:77
osg::Depth::Function
Function
Definition Depth:29
osg::Depth::GREATER
@ GREATER
Definition Depth:34
osg::Depth::EQUAL
@ EQUAL
Definition Depth:32
osg::Depth::LESS
@ LESS
Definition Depth:31
osg::Depth::GEQUAL
@ GEQUAL
Definition Depth:36
osg::Depth::LEQUAL
@ LEQUAL
Definition Depth:33
osg::Depth::NOTEQUAL
@ NOTEQUAL
Definition Depth:35
osg::Depth::NEVER
@ NEVER
Definition Depth:30
osg::Depth::ALWAYS
@ ALWAYS
Definition Depth:37
osg::Depth::Depth
Depth(Function func=LESS, double zNear=0.0, double zFar=1.0, bool writeMask=true)
osg::StateAttribute::StateAttribute
StateAttribute()
osg::StateAttribute::DEPTH
@ DEPTH
Definition StateAttribute:154
osg::State
Definition State:80
osg
Definition AlphaFunc:19
OSG_EXPORT
#define OSG_EXPORT
Definition osg/Export:39
osg::StateAttribute::ModeUsage
Definition StateAttribute:308
osg::StateAttribute::ModeUsage::usesMode
virtual void usesMode(GLMode mode)=0