Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

osg::ClipPlane Class Reference

Inheritance diagram for osg::ClipPlane:

osg::StateAttribute osg::Object osg::Referenced List of all members.

Public Member Functions

 ClipPlane ()
 ClipPlane (unsigned int no, const Vec4 &plane)
 ClipPlane (unsigned int no, const Plane &plane)
 ClipPlane (unsigned int no, double a, double b, double c, double d)
 ClipPlane (const ClipPlane &cp, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 META_StateAttribute (osg, ClipPlane, CLIPPLANE)
virtual int compare (const StateAttribute &sa) const
virtual unsigned int getMember ()
virtual bool getModeUsage (ModeUsage &usage) const
void setClipPlane (const Vec4 &plane)
void setClipPlane (const Plane &plane)
void setClipPlane (const double *plane)
void setClipPlane (double a, double b, double c, double d)
void getClipPlane (Vec4 &plane) const
void getClipPlane (Plane &plane) const
void getClipPlane (double *plane) const
void setClipPlaneNum (unsigned int num)
unsigned int getClipPlaneNum () const
virtual void apply (State &state) const

Protected Member Functions

virtual ~ClipPlane ()

Protected Attributes

double _clipPlane [4]
unsigned int _clipPlaneNum

Detailed Description

Encapsulates OpenGL glClipPlane().


Constructor & Destructor Documentation

osg::ClipPlane::ClipPlane  ) 
 

osg::ClipPlane::ClipPlane unsigned int  no,
const Vec4 plane
[inline]
 

osg::ClipPlane::ClipPlane unsigned int  no,
const Plane plane
[inline]
 

osg::ClipPlane::ClipPlane unsigned int  no,
double  a,
double  b,
double  c,
double  d
[inline]
 

osg::ClipPlane::ClipPlane const ClipPlane cp,
const CopyOp copyop = CopyOp::SHALLOW_COPY
[inline]
 

Copy constructor using CopyOp to manage deep vs shallow copy.

virtual osg::ClipPlane::~ClipPlane  )  [protected, virtual]
 


Member Function Documentation

virtual void osg::ClipPlane::apply State state  )  const [virtual]
 

Applies the clip plane's state to the OpenGL state machine.

Implements osg::StateAttribute.

virtual int osg::ClipPlane::compare const StateAttribute sa  )  const [inline, virtual]
 

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

Implements osg::StateAttribute.

void osg::ClipPlane::getClipPlane double *  plane  )  const
 

Gets the clip plane as an array of doubles.

void osg::ClipPlane::getClipPlane Plane plane  )  const
 

Gets the clip plane as a Plane.

void osg::ClipPlane::getClipPlane Vec4 plane  )  const
 

Gets the clip plane as a Vec4.

unsigned int osg::ClipPlane::getClipPlaneNum  )  const
 

Gets the clip plane number.

virtual unsigned int osg::ClipPlane::getMember  )  [inline, virtual]
 

virtual bool osg::ClipPlane::getModeUsage ModeUsage &  usage  )  const [inline, virtual]
 

Return the modes associated with this StateAttribute.

Reimplemented from osg::StateAttribute.

osg::ClipPlane::META_StateAttribute osg  ,
ClipPlane  ,
CLIPPLANE 
 

void osg::ClipPlane::setClipPlane double  a,
double  b,
double  c,
double  d
[inline]
 

Defines the plane as [ a b c d ].

void osg::ClipPlane::setClipPlane const double *  plane  ) 
 

Defines the clip plane with the given double[4].

void osg::ClipPlane::setClipPlane const Plane plane  ) 
 

Defines this plane with the given Plane.

void osg::ClipPlane::setClipPlane const Vec4 plane  ) 
 

Defines the clip plane with the given Vec4.

void osg::ClipPlane::setClipPlaneNum unsigned int  num  ) 
 

Sets the clip plane number.


Member Data Documentation

double osg::ClipPlane::_clipPlane[4] [protected]
 

unsigned int osg::ClipPlane::_clipPlaneNum [protected]
 


The documentation for this class was generated from the following file:
Generated on Fri May 13 15:15:47 2005 for openscenegraph by  doxygen 1.4.2