Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

osg::ClipNode Class Reference

Leaf Node for defining the position of ClipPlanes in the scene. More...

Inheritance diagram for osg::ClipNode:

Inheritance graph
[legend]
List of all members.

Public Types

typedef std::vector< ref_ptr<
ClipPlane > > 
ClipPlaneList

Public Methods

 ClipNode ()
 ClipNode (const ClipNode &es, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 META_Node (osg, ClipNode)
void createClipBox (const BoundingBox &bb, unsigned int clipPlaneNumberBase=0)
 Create a 6 clip planes to create a clip box.

const bool addClipPlane (ClipPlane *clipplane)
 Add a ClipPlane to a ClipNode.

const bool removeClipPlane (ClipPlane *clipplane)
 Remove ClipPlane from a ClipNode.

const bool removeClipPlane (unsigned int pos)
 Remove ClipPlane, at specified index, from a ClipNode.

const unsigned int getNumClipPlanes () const
 return the number of ClipPlanes.

ClipPlanegetClipPlane (unsigned int pos)
 Get ClipPlane at specificed index position.

const ClipPlanegetClipPlane (unsigned int pos) const
 Get const ClipPlane at specificed index position.

ClipPlaneListgetClipPlaneList ()
 Get the ClipPlaneList.

const ClipPlaneListgetClipPlaneList () const
 Get the const ClipPlaneList.

void setStateSetModes (StateSet &, const StateAttribute::GLModeValue) const
 Set the GLModes on StateSet associated with the ClipPlanes.

void setLocalStateSetModes (const StateAttribute::GLModeValue=StateAttribute::ON)
 Set up the local StateSet.


Protected Methods

virtual ~ClipNode ()
virtual const bool computeBound () const
 Compute the bounding sphere around Node's geometry or children.


Protected Attributes

StateAttribute::GLModeValue _value
ClipPlaneList _planes

Detailed Description

Leaf Node for defining the position of ClipPlanes in the scene.


Member Typedef Documentation

typedef std::vector<ref_ptr<ClipPlane> > osg::ClipNode::ClipPlaneList
 


Constructor & Destructor Documentation

osg::ClipNode::ClipNode  
 

osg::ClipNode::ClipNode const ClipNode &    es,
const CopyOp   copyop = CopyOp::SHALLOW_COPY
 

virtual osg::ClipNode::~ClipNode   [protected, virtual]
 


Member Function Documentation

const bool osg::ClipNode::addClipPlane ClipPlane   clipplane
 

Add a ClipPlane to a ClipNode.

Return true if plane is added, return false if plane already exists in ClipNode, or clipplane is false.

virtual const bool osg::ClipNode::computeBound   const [protected, virtual]
 

Compute the bounding sphere around Node's geometry or children.

This method is automatically called by getBound() when the bounding sphere has been marked dirty via dirtyBound().

Reimplemented from osg::Group.

void osg::ClipNode::createClipBox const BoundingBox   bb,
unsigned int    clipPlaneNumberBase = 0
 

Create a 6 clip planes to create a clip box.

const ClipPlane* osg::ClipNode::getClipPlane unsigned int    pos const [inline]
 

Get const ClipPlane at specificed index position.

ClipPlane* osg::ClipNode::getClipPlane unsigned int    pos [inline]
 

Get ClipPlane at specificed index position.

const ClipPlaneList& osg::ClipNode::getClipPlaneList   const [inline]
 

Get the const ClipPlaneList.

ClipPlaneList& osg::ClipNode::getClipPlaneList   [inline]
 

Get the ClipPlaneList.

const unsigned int osg::ClipNode::getNumClipPlanes   const [inline]
 

return the number of ClipPlanes.

osg::ClipNode::META_Node osg   ,
ClipNode   
 

const bool osg::ClipNode::removeClipPlane unsigned int    pos
 

Remove ClipPlane, at specified index, from a ClipNode.

Return true if plane is removed, return false if plane does not exists in ClipNode.

const bool osg::ClipNode::removeClipPlane ClipPlane   clipplane
 

Remove ClipPlane from a ClipNode.

Return true if plane is removed, return false if plane does not exists in ClipNode.

void osg::ClipNode::setLocalStateSetModes const StateAttribute::GLModeValue    = StateAttribute::ON
 

Set up the local StateSet.

void osg::ClipNode::setStateSetModes StateSet  ,
const StateAttribute::GLModeValue   
const
 

Set the GLModes on StateSet associated with the ClipPlanes.


Member Data Documentation

ClipPlaneList osg::ClipNode::_planes [protected]
 

StateAttribute::GLModeValue osg::ClipNode::_value [protected]
 


The documentation for this class was generated from the following file:
Generated at Wed Sep 18 13:55:26 2002 for the Open Scene Graph by doxygen 1.2.16.