OpenSceneGraph 3.6.5
ClipPlane
Go to the documentation of this file.
1/* -*-c++-*- OpenSceneGraph - Copyright (C) 1998-2006 Robert Osfield
2 *
3 * This library is open source and may be redistributed and/or modified under
4 * the terms of the OpenSceneGraph Public License (OSGPL) version 0.0 or
5 * (at your option) any later version. The full license is in LICENSE file
6 * included with this distribution, and on the openscenegraph.org website.
7 *
8 * This library is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * OpenSceneGraph Public License for more details.
12*/
13
14#ifndef OSG_CLIPPLANE
15#define OSG_CLIPPLANE 1
16
17#include <osg/Vec4d>
18#include <osg/Plane>
19#include <osg/StateAttribute>
20
21#ifndef GL_CLIP_PLANE0
22 #define GL_CLIP_PLANE0 0x3000
23 #define GL_CLIP_PLANE1 0x3001
24 #define GL_CLIP_PLANE2 0x3002
25 #define GL_CLIP_PLANE3 0x3003
26 #define GL_CLIP_PLANE4 0x3004
27 #define GL_CLIP_PLANE5 0x3005
28#endif
29
30namespace osg {
31
35{
36 public :
37
39 inline ClipPlane(unsigned int no):_clipPlaneNum(no) {}
40 inline ClipPlane(unsigned int no,const Vec4d& plane):_clipPlaneNum(no) { setClipPlane(plane); }
41 inline ClipPlane(unsigned int no,const Plane& plane):_clipPlaneNum(no) { setClipPlane(plane); }
42 inline ClipPlane(unsigned int no,double a,double b,double c,double d): _clipPlaneNum(no) { setClipPlane(a,b,c,d); }
43
46 StateAttribute(cp,copyop)
47 {
48 _clipPlane[0]=cp._clipPlane[0];
49 _clipPlane[1]=cp._clipPlane[1];
50 _clipPlane[2]=cp._clipPlane[2];
51 _clipPlane[3]=cp._clipPlane[3];
53 }
54
55 virtual osg::Object* cloneType() const { return new ClipPlane( _clipPlaneNum ); }
56 virtual osg::Object* clone(const osg::CopyOp& copyop) const { return new ClipPlane(*this,copyop); }
57 virtual bool isSameKindAs(const osg::Object* obj) const { return dynamic_cast<const ClipPlane *>(obj)!=NULL; }
58 virtual const char* libraryName() const { return "osg"; }
59 virtual const char* className() const { return "ClipPlane"; }
60 virtual Type getType() const { return CLIPPLANE; }
61
63 virtual int compare(const StateAttribute& sa) const
64 {
65 // Check for equal types, then create the rhs variable
66 // used by the COMPARE_StateAttribute_Parameter macros below.
68
69 // Compare each parameter in turn against the rhs.
75
76 return 0; // Passed all the above comparison macros, so must be equal.
77 }
78
79 virtual unsigned int getMember() const { return _clipPlaneNum; }
80
81 virtual bool getModeUsage(StateAttribute::ModeUsage& usage) const
82 {
84 return true;
85 }
86
87
89 void setClipPlane(const Plane& plane)
90 {
91 _clipPlane.set(plane[0],plane[1],plane[2],plane[3]);
92 }
93
95 void setClipPlane(double a,double b,double c,double d)
96 {
97 _clipPlane.set(a,b,c,d);
98 }
99
101 inline void setClipPlane(const Vec4d& plane) { _clipPlane = plane; }
102
104 const Vec4d& getClipPlane() const { return _clipPlane; }
105
106
108 void setClipPlaneNum(unsigned int num);
109
111 unsigned int getClipPlaneNum() const;
112
114 virtual void apply(State& state) const;
115
116 protected :
117
118 virtual ~ClipPlane();
119
121 unsigned int _clipPlaneNum;
122
123};
124
125}
126
127#endif
#define COMPARE_StateAttribute_Parameter(parameter)
COMPARE_StateAttribute_Parameter macro is a helper for implementing the StatateAtribute::compare(....
Definition StateAttribute:69
#define COMPARE_StateAttribute_Types(TYPE, rhs_attribute)
COMPARE_StateAttribute_Types macro is a helper for implementing the StateAtribute::compare(....
Definition StateAttribute:57
#define GL_CLIP_PLANE0
Definition ClipPlane:22
The core osg library provides the basic scene graph classes such as Nodes, State and Drawables,...
Definition AlphaFunc:19
void setClipPlane(const Plane &plane)
Set the clip plane with the given Plane.
Definition ClipPlane:89
virtual osg::Object * cloneType() const
Clone the type of an attribute, with Object* return type.
Definition ClipPlane:55
void setClipPlane(const Vec4d &plane)
Set the clip plane with the given Vec4.
Definition ClipPlane:101
const Vec4d & getClipPlane() const
Gets the clip plane as a Vec4d.
Definition ClipPlane:104
void setClipPlaneNum(unsigned int num)
Sets the clip plane number.
virtual Type getType() const
Return the Type identifier of the attribute's class type.
Definition ClipPlane:60
virtual ~ClipPlane()
virtual void apply(State &state) const
Applies the clip plane's state to the OpenGL state machine.
virtual const char * libraryName() const
Return the name of the attribute's library.
Definition ClipPlane:58
unsigned int _clipPlaneNum
Definition ClipPlane:121
ClipPlane(unsigned int no)
Definition ClipPlane:39
virtual bool isSameKindAs(const osg::Object *obj) const
Return true if this and obj are of the same kind of object.
Definition ClipPlane:57
virtual int compare(const StateAttribute &sa) const
Return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs.
Definition ClipPlane:63
void setClipPlane(double a, double b, double c, double d)
Defines the plane as [ a b c d ].
Definition ClipPlane:95
Vec4d _clipPlane
Definition ClipPlane:120
ClipPlane(unsigned int no, const Plane &plane)
Definition ClipPlane:41
virtual unsigned int getMember() const
Return the member identifier within the attribute's class type.
Definition ClipPlane:79
ClipPlane(const ClipPlane &cp, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
Copy constructor using CopyOp to manage deep vs shallow copy.
Definition ClipPlane:45
virtual bool getModeUsage(StateAttribute::ModeUsage &usage) const
Return the modes associated with this StateAttribute.
Definition ClipPlane:81
ClipPlane(unsigned int no, double a, double b, double c, double d)
Definition ClipPlane:42
ClipPlane(unsigned int no, const Vec4d &plane)
Definition ClipPlane:40
virtual osg::Object * clone(const osg::CopyOp &copyop) const
Clone an attribute, with Object* return type.
Definition ClipPlane:56
unsigned int getClipPlaneNum() const
Gets the clip plane number.
virtual const char * className() const
Return the name of the attribute's class type.
Definition ClipPlane:59
Copy Op(erator) used to control whether shallow or deep copy is used during copy construction and clo...
Definition CopyOp:41
@ SHALLOW_COPY
Definition CopyOp:47
Base class/standard interface for objects which require IO support, cloning and reference counting.
Definition Object:61
A plane class.
Definition Plane:34
Encapsulates the current applied OpenGL modes, attributes and vertex arrays settings,...
Definition State:80
GLenum GLMode
GLMode is the value used in glEnable/glDisable(mode)
Definition StateAttribute:81
Type
Type identifier to differentiate between different state types.
Definition StateAttribute:124
@ CLIPPLANE
Definition StateAttribute:159
Definition StateAttribute:308
virtual void usesMode(GLMode mode)=0
General purpose double quad.
Definition Vec4d:29
#define NULL
Definition Export:55
#define OSG_EXPORT
Definition Export:39

osg logo
Generated at Sun Jul 20 2025 00:00:00 for the OpenSceneGraph by doxygen 1.14.0.