OpenSceneGraph  3.0.1
Public Member Functions | Protected Member Functions | Protected Attributes
osg::ClipPlane Class Reference

Encapsulates OpenGL glClipPlane(). More...

Inheritance diagram for osg::ClipPlane:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 ClipPlane ()
 ClipPlane (unsigned int no)
 ClipPlane (unsigned int no, const Vec4d &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)
 Copy constructor using CopyOp to manage deep vs shallow copy.
virtual osg::ObjectcloneType () const
 Clone the type of an attribute, with Object* return type.
virtual osg::Objectclone (const osg::CopyOp &copyop) const
 Clone an attribute, with Object* return type.
virtual bool isSameKindAs (const osg::Object *obj) const
 Return true if this and obj are of the same kind of object.
virtual const char * libraryName () const
 Return the name of the attribute's library.
virtual const char * className () const
 Return the name of the attribute's class type.
virtual Type getType () const
 Return the Type identifier of the attribute's class type.
virtual int compare (const StateAttribute &sa) const
 Return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs.
virtual unsigned int getMember () const
 Return the member identifier within the attribute's class type.
virtual bool getModeUsage (StateAttribute::ModeUsage &usage) const
 Return the modes associated with this StateAttribute.
void setClipPlane (const Plane &plane)
 Set the clip plane with the given Plane.
void setClipPlane (double a, double b, double c, double d)
 Defines the plane as [ a b c d ].
void setClipPlane (const Vec4d &plane)
 Set the clip plane with the given Vec4.
const Vec4dgetClipPlane () const
 Gets the clip plane as a Vec4d.
void setClipPlaneNum (unsigned int num)
 Sets the clip plane number.
unsigned int getClipPlaneNum () const
 Gets the clip plane number.
virtual void apply (State &state) const
 Applies the clip plane's state to the OpenGL state machine.

Protected Member Functions

virtual ~ClipPlane ()

Protected Attributes

Vec4d _clipPlane
unsigned int _clipPlaneNum

Detailed Description

Encapsulates OpenGL glClipPlane().


Constructor & Destructor Documentation

osg::ClipPlane::ClipPlane ( )
osg::ClipPlane::ClipPlane ( unsigned int  no) [inline]
osg::ClipPlane::ClipPlane ( unsigned int  no,
const Vec4d 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.

References _clipPlane, and _clipPlaneNum.

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.

Reimplemented from osg::StateAttribute.

virtual const char* osg::ClipPlane::className ( ) const [inline, virtual]

Return the name of the attribute's class type.

Reimplemented from osg::StateAttribute.

virtual osg::Object* osg::ClipPlane::clone ( const osg::CopyOp ) const [inline, virtual]

Clone an attribute, with Object* return type.

Must be defined by derived classes.

Implements osg::StateAttribute.

virtual osg::Object* osg::ClipPlane::cloneType ( ) const [inline, virtual]

Clone the type of an attribute, with Object* return type.

Must be defined by derived classes.

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.

References COMPARE_StateAttribute_Types, and COMPARE_StateAttribute_Parameter.

const Vec4d& osg::ClipPlane::getClipPlane ( ) const [inline]

Gets the clip plane as a Vec4d.

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

Gets the clip plane number.

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

Return the member identifier within the attribute's class type.

Used for light number/clip plane number etc.

Reimplemented from osg::StateAttribute.

virtual bool osg::ClipPlane::getModeUsage ( StateAttribute::ModeUsage ) const [inline, virtual]

Return the modes associated with this StateAttribute.

Reimplemented from osg::StateAttribute.

References osg::StateAttribute::ModeUsage::usesMode(), and GL_CLIP_PLANE0.

virtual Type osg::ClipPlane::getType ( ) const [inline, virtual]

Return the Type identifier of the attribute's class type.

Implements osg::StateAttribute.

virtual bool osg::ClipPlane::isSameKindAs ( const osg::Object obj) const [inline, virtual]

Return true if this and obj are of the same kind of object.

Reimplemented from osg::StateAttribute.

References NULL.

virtual const char* osg::ClipPlane::libraryName ( ) const [inline, virtual]

Return the name of the attribute's library.

Reimplemented from osg::StateAttribute.

void osg::ClipPlane::setClipPlane ( const Plane plane) [inline]

Set the clip plane with the given Plane.

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 Vec4d plane) [inline]

Set the clip plane with the given Vec4.

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

Sets the clip plane number.


Member Data Documentation

Referenced by ClipPlane().

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

Referenced by ClipPlane().


The documentation for this class was generated from the following file:

osg logo
Generated at Mon Oct 3 2011 12:39:41 for the OpenSceneGraph by doxygen 1.7.5.