class SG_EXPORT osg::ClipNode

Leaf Node for defining the position of ClipPlanes in the scene

Inheritance:

Public Methods

typedef std::vector<ref_ptr<ClipPlane> > ClipPlaneList 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.

inline const unsigned int getNumClipPlanes() const

return the number of ClipPlanes

inline ClipPlane* getClipPlane(unsigned int pos)

Get ClipPlane at specificed index position

inline const ClipPlane* getClipPlane(unsigned int pos) const

Get const ClipPlane at specificed index position

inline ClipPlaneList& getClipPlaneList()

Get the ClipPlaneList

inline const ClipPlaneList& getClipPlaneList() 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 Fields

StateAttribute::GLModeValue _value

ClipPlaneList _planes

Protected Methods

virtual ~ClipNode()

virtual const bool computeBound() const

Inherited from Group:

Public Methods

virtual void traverse(NodeVisitor& nv)

virtual bool addChild( Node* child )

virtual bool removeChild( Node* child )

virtual bool replaceChild( Node* origChild, Node* newChild )

inline const unsigned int getNumChildren() const

inline Node* getChild( const unsigned int i )

inline const Node* getChild( const unsigned int i ) const

inline bool containsNode( const Node* node ) const

inline ChildList::iterator findNode( const Node* node )

inline ChildList::const_iterator findNode( const Node* node ) const

Protected Fields

ChildList _children

Documentation

Leaf Node for defining the position of ClipPlanes in the scene

typedef std::vector<ref_ptr<ClipPlane> > ClipPlaneList 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. Return true if plane is added, return false if plane already exists in ClipNode, or clipplane is false.

const bool removeClipPlane(ClipPlane* clipplane)

Remove ClipPlane from a ClipNode. Return true if plane is removed, return false if plane does not exists in ClipNode.

const bool 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.

inline const unsigned int getNumClipPlanes() const

return the number of ClipPlanes

inline ClipPlane* getClipPlane(unsigned int pos)

Get ClipPlane at specificed index position

inline const ClipPlane* getClipPlane(unsigned int pos) const

Get const ClipPlane at specificed index position

inline ClipPlaneList& getClipPlaneList()

Get the ClipPlaneList

inline const ClipPlaneList& getClipPlaneList() 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

virtual ~ClipNode()

virtual const bool computeBound() const

StateAttribute::GLModeValue _value

ClipPlaneList _planes

This class has no child classes.

Alphabetic index HTML hierarchy of classes or Java