ClipPlane
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_CLIPPLANE
#define OSG_CLIPPLANE 1
#include <osg/Vec4d>
#include <osg/Plane>
#include <osg/StateAttribute>
#ifndef GL_CLIP_PLANE0
#define GL_CLIP_PLANE0 0x3000
#define GL_CLIP_PLANE1 0x3001
#define GL_CLIP_PLANE2 0x3002
#define GL_CLIP_PLANE3 0x3003
#define GL_CLIP_PLANE4 0x3004
#define GL_CLIP_PLANE5 0x3005
#endif
namespace osg {
class OSG_EXPORT ClipPlane : public StateAttribute
{
public :
ClipPlane();
inline ClipPlane(unsigned int no):_clipPlaneNum(no) {}
inline ClipPlane(unsigned int no,const Vec4d& plane):_clipPlaneNum(no) { setClipPlane(plane); }
inline ClipPlane(unsigned int no,const Plane& plane):_clipPlaneNum(no) { setClipPlane(plane); }
inline ClipPlane(unsigned int no,double a,double b,double c,double d): _clipPlaneNum(no) { setClipPlane(a,b,c,d); }
ClipPlane(const ClipPlane& cp,const CopyOp& copyop=CopyOp::SHALLOW_COPY):
StateAttribute(cp,copyop)
{
_clipPlane[0]=cp._clipPlane[0];
_clipPlane[1]=cp._clipPlane[1];
_clipPlane[2]=cp._clipPlane[2];
_clipPlane[3]=cp._clipPlane[3];
_clipPlaneNum=cp._clipPlaneNum;
}
virtual osg::Object* cloneType() const { return new ClipPlane( _clipPlaneNum ); }
virtual osg::Object* clone(const osg::CopyOp& copyop) const { return new ClipPlane(*this,copyop); }
virtual bool isSameKindAs(const osg::Object* obj) const { return dynamic_cast<const ClipPlane *>(obj)!=NULL; }
virtual const char* libraryName() const { return "osg"; }
virtual const char* className() const { return "ClipPlane"; }
virtual Type getType() const { return CLIPPLANE; }
virtual int compare(const StateAttribute& sa) const
{
// Check for equal types, then create the rhs variable
// used by the COMPARE_StateAttribute_Parameter macros below.
COMPARE_StateAttribute_Types(ClipPlane,sa)
// Compare each parameter in turn against the rhs.
COMPARE_StateAttribute_Parameter(_clipPlaneNum)
COMPARE_StateAttribute_Parameter(_clipPlane[0])
COMPARE_StateAttribute_Parameter(_clipPlane[1])
COMPARE_StateAttribute_Parameter(_clipPlane[2])
COMPARE_StateAttribute_Parameter(_clipPlane[3])
return 0; // Passed all the above comparison macros, so must be equal.
}
virtual unsigned int getMember() const { return _clipPlaneNum; }
virtual bool getModeUsage(StateAttribute::ModeUsage& usage) const
{
usage.usesMode((GLMode)(GL_CLIP_PLANE0+_clipPlaneNum));
return true;
}
void setClipPlane(const Plane& plane)
{
_clipPlane.set(plane[0],plane[1],plane[2],plane[3]);
}
void setClipPlane(double a,double b,double c,double d)
{
_clipPlane.set(a,b,c,d);
}
inline void setClipPlane(const Vec4d& plane) { _clipPlane = plane; }
const Vec4d& getClipPlane() const { return _clipPlane; }
void setClipPlaneNum(unsigned int num);
unsigned int getClipPlaneNum() const;
virtual void apply(State& state) const;
protected :
virtual ~ClipPlane();
Vec4d _clipPlane;
unsigned int _clipPlaneNum;
};
}
#endif
GL_CLIP_PLANE0
#define GL_CLIP_PLANE0
Definition ClipPlane:22
Plane
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
Vec4d
osg::ClipPlane::setClipPlane
void setClipPlane(const Plane &plane)
Definition ClipPlane:89
osg::ClipPlane::cloneType
virtual osg::Object * cloneType() const
Definition ClipPlane:55
osg::ClipPlane::setClipPlane
void setClipPlane(const Vec4d &plane)
Definition ClipPlane:101
osg::ClipPlane::getClipPlane
const Vec4d & getClipPlane() const
Definition ClipPlane:104
osg::ClipPlane::setClipPlaneNum
void setClipPlaneNum(unsigned int num)
osg::ClipPlane::getType
virtual Type getType() const
Definition ClipPlane:60
osg::ClipPlane::~ClipPlane
virtual ~ClipPlane()
osg::ClipPlane::apply
virtual void apply(State &state) const
osg::ClipPlane::libraryName
virtual const char * libraryName() const
Definition ClipPlane:58
osg::ClipPlane::_clipPlaneNum
unsigned int _clipPlaneNum
Definition ClipPlane:121
osg::ClipPlane::ClipPlane
ClipPlane(unsigned int no)
Definition ClipPlane:39
osg::ClipPlane::isSameKindAs
virtual bool isSameKindAs(const osg::Object *obj) const
Definition ClipPlane:57
osg::ClipPlane::ClipPlane
ClipPlane()
osg::ClipPlane::compare
virtual int compare(const StateAttribute &sa) const
Definition ClipPlane:63
osg::ClipPlane::setClipPlane
void setClipPlane(double a, double b, double c, double d)
Definition ClipPlane:95
osg::ClipPlane::_clipPlane
Vec4d _clipPlane
Definition ClipPlane:120
osg::ClipPlane::ClipPlane
ClipPlane(unsigned int no, const Plane &plane)
Definition ClipPlane:41
osg::ClipPlane::getMember
virtual unsigned int getMember() const
Definition ClipPlane:79
osg::ClipPlane::ClipPlane
ClipPlane(const ClipPlane &cp, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
Definition ClipPlane:45
osg::ClipPlane::getModeUsage
virtual bool getModeUsage(StateAttribute::ModeUsage &usage) const
Definition ClipPlane:81
osg::ClipPlane::ClipPlane
ClipPlane(unsigned int no, double a, double b, double c, double d)
Definition ClipPlane:42
osg::ClipPlane::ClipPlane
ClipPlane(unsigned int no, const Vec4d &plane)
Definition ClipPlane:40
osg::ClipPlane::clone
virtual osg::Object * clone(const osg::CopyOp &copyop) const
Definition ClipPlane:56
osg::ClipPlane::getClipPlaneNum
unsigned int getClipPlaneNum() const
osg::ClipPlane::className
virtual const char * className() const
Definition ClipPlane:59
osg::CopyOp
Definition CopyOp:41
osg::CopyOp::SHALLOW_COPY
@ SHALLOW_COPY
Definition CopyOp:47
osg::Object
Definition Object:61
osg::Plane
A plane class. It can be used to represent an infinite plane.
Definition Plane:34
osg::StateAttribute::GLMode
GLenum GLMode
Definition StateAttribute:81
osg::StateAttribute::StateAttribute
StateAttribute()
osg::StateAttribute::Type
Type
Definition StateAttribute:124
osg::StateAttribute::CLIPPLANE
@ CLIPPLANE
Definition StateAttribute:159
osg::State
Definition State:80
osg::Vec4d
Definition Vec4d:29
osg
Definition AlphaFunc:19
NULL
#define NULL
Definition osg/Export:55
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