---

osg::ClipPlane Class Reference

ClipPlane state class which encapsulates OpenGL glClipPlane() functionality. More...

Inheritance diagram for osg::ClipPlane:

[legend]List of all members.

Public Methods
	ClipPlane ()
	ClipPlane (unsigned int no, const Vec4 &plane)
	ClipPlane (unsigned int no, const Plane &plane)
	ClipPlane (unsigned int no, const double a, const double b, const double c, const double d)
	ClipPlane (const ClipPlane &cp, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
	Copy constructor using CopyOp to manage deep vs shallow copy.
	META_StateAttribute (osg, ClipPlane,(Type)(CLIPPLANE+_clipPlaneNum))
virtual int	compare (const StateAttribute &sa) const
	return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs.
virtual void	getAssociatedModes (std::vector< GLMode > &modes) const
	return the modes associated with this StateSet
void	setClipPlane (const Vec4 &plane)
	Set the clip plane, using a Vec4 to define plane.
void	setClipPlane (const Plane &plane)
	Set the clip plane, using a Plane to define plane.
void	setClipPlane (const double *plane)
	Set the clip plane, using a double[4] to define plane.
void	setClipPlane (const double a, const double b, const double c, const double d)
	Set the clip plane, using a a to define plane.
void	getClipPlane (Vec4 &plane) const
	Get the clip plane, values entered into a Vec4 passed to the getClipPlane.
void	getClipPlane (Plane &plane) const
	Get the clip plane, values entered into a Plane passed to the getClipPlane.
void	getClipPlane (double *plane) const
	Get the clip plane, values entered into a double[4] passed to the getClipPlane.
void	setClipPlaneNum (const unsigned int num)
	Set the clip plane number.
const unsigned int	getClipPlaneNum () const
	Get the clip plane number.
virtual void	apply (State &state) const
	Apply the clip plane's state to the OpenGL state machine.
Protected Methods
virtual	~ClipPlane ()
Protected Attributes
double	_clipPlane [4]
unsigned int	_clipPlaneNum

---

Detailed Description

ClipPlane state class which encapsulates OpenGL glClipPlane() functionality.

---

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, const double    a, const double    b, const double    c, const 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]

Apply 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.

virtual void osg::ClipPlane::getAssociatedModes (  std::vector< GLMode > &    modes )  const [inline, virtual]

return the modes associated with this StateSet Reimplemented from osg::StateAttribute.

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

Get the clip plane, values entered into a double[4] passed to the getClipPlane.

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

Get the clip plane, values entered into a Plane passed to the getClipPlane.

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

Get the clip plane, values entered into a Vec4 passed to the getClipPlane.

const unsigned int osg::ClipPlane::getClipPlaneNum (    )  const

Get the clip plane number.

osg::ClipPlane::META_StateAttribute (  osg   , ClipPlane   , (Type   )(CLIPPLANE+_clipPlaneNum) )

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

Set the clip plane, using a a to define plane.

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

Set the clip plane, using a double[4] to define plane.

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

Set the clip plane, using a Plane to define plane.

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

Set the clip plane, using a Vec4 to define plane.

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

Set 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:

• ClipPlane

---