2002-07-19 03:54:11 +08:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
< HTML >
< HEAD >
< TITLE > class SG_EXPORT osg::ClipNode< / TITLE >
< META NAME = "GENERATOR" CONTENT = "DOC++ 3.4.8" >
< / HEAD >
< BODY BGCOLOR = "#ffffff" >
< H2 > class SG_EXPORT < A HREF = "#DOC.DOCU" > osg::ClipNode< / A > < / H2 > < / H2 > < BLOCKQUOTE > Leaf Node for defining the position of ClipPlanes in the scene< / BLOCKQUOTE >
< HR >
< H2 > Inheritance:< / H2 >
< APPLET CODE = "ClassGraph.class" WIDTH = 600 HEIGHT = 95 >
< param name = classes value = "MNode,M,CGroup,MGroup.html,CClipNode,MClipNode.html" >
< param name = before value = "M,M,M" >
< param name = after value = "Md_SP,Md_,M" >
< param name = indent value = "0,1,2" >
< param name = arrowdir value = "down" >
< / APPLET >
< HR >
< DL >
< P > < DL >
< DT > < H3 > Public Methods< / H3 > < DD > < DT >
2002-08-29 22:29:49 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > typedef std::vector< <!1> < A HREF = "ref_ptr.html" > ref_ptr< / A > < <!1> < A HREF = "ClipPlane.html" > ClipPlane< / A > > > ClipPlaneList < B > < A HREF = "#DOC.2.27.1" > ClipNode< / A > < / B > ()
2002-07-19 03:54:11 +08:00
< DT >
2002-08-29 22:29:49 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > < B > < A HREF = "#DOC.2.27.2" > ClipNode< / A > < / B > (const <!1> < A HREF = "ClipNode.html#DOC.2.27.2" > ClipNode< / A > & es, const <!1> < A HREF = "CopyOp.html" > CopyOp< / A > & copyop=CopyOp::SHALLOW_COPY)
2002-07-19 03:54:11 +08:00
< DT >
2002-08-29 22:29:49 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > < B > < A HREF = "#DOC.2.27.3" > META_Node< / A > < / B > (<!1> < A HREF = "osg.html" > osg< / A > , <!1> < A HREF = "ClipNode.html" > ClipNode< / A > )
2002-07-19 03:54:11 +08:00
< DT >
2002-08-29 22:29:49 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > void < B > < A HREF = "#DOC.2.27.4" > createClipBox< / A > < / B > (const <!1> < A HREF = "BoundingBox.html" > BoundingBox< / A > & bb, unsigned int clipPlaneNumberBase=0)
2002-07-19 03:54:11 +08:00
< DD > < I > Create a 6 clip planes to create a clip box< / I >
< DT >
2002-08-29 22:29:49 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > const bool < B > < A HREF = "#DOC.2.27.5" > addClipPlane< / A > < / B > (<!1> < A HREF = "ClipPlane.html" > ClipPlane< / A > * clipplane)
2002-07-19 03:54:11 +08:00
< DD > < I > Add a ClipPlane to a ClipNode.< / I >
< DT >
2002-08-29 22:29:49 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > const bool < B > < A HREF = "#DOC.2.27.6" > removeClipPlane< / A > < / B > (<!1> < A HREF = "ClipPlane.html" > ClipPlane< / A > * clipplane)
2002-07-19 03:54:11 +08:00
< DD > < I > Remove ClipPlane from a ClipNode.< / I >
< DT >
2002-08-29 22:29:49 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > const bool < B > < A HREF = "#DOC.2.27.7" > removeClipPlane< / A > < / B > (unsigned int pos)
2002-07-19 03:54:11 +08:00
< DD > < I > Remove ClipPlane, at specified index, from a ClipNode.< / I >
< DT >
2002-08-29 22:29:49 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline const unsigned int < B > < A HREF = "#DOC.2.27.8" > getNumClipPlanes< / A > < / B > () const
2002-07-19 03:54:11 +08:00
< DD > < I > return the number of ClipPlanes< / I >
< DT >
2002-08-29 22:29:49 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline <!1> < A HREF = "ClipPlane.html" > ClipPlane< / A > * < B > < A HREF = "#DOC.2.27.9" > getClipPlane< / A > < / B > (unsigned int pos)
2002-07-19 03:54:11 +08:00
< DD > < I > Get ClipPlane at specificed index position< / I >
< DT >
2002-08-29 22:29:49 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline const <!1> < A HREF = "ClipPlane.html" > ClipPlane< / A > * < B > < A HREF = "#DOC.2.27.10" > getClipPlane< / A > < / B > (unsigned int pos) const
2002-07-19 03:54:11 +08:00
< DD > < I > Get const ClipPlane at specificed index position< / I >
< DT >
2002-08-29 22:29:49 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline ClipPlaneList& < B > < A HREF = "#DOC.2.27.11" > getClipPlaneList< / A > < / B > ()
2002-07-19 03:54:11 +08:00
< DD > < I > Get the ClipPlaneList< / I >
< DT >
2002-08-29 22:29:49 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline const ClipPlaneList& < B > < A HREF = "#DOC.2.27.12" > getClipPlaneList< / A > < / B > () const
2002-07-19 03:54:11 +08:00
< DD > < I > Get the const ClipPlaneList< / I >
< DT >
2002-08-29 22:29:49 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > void < B > < A HREF = "#DOC.2.27.13" > setStateSetModes< / A > < / B > (<!1> < A HREF = "StateSet.html" > StateSet< / A > & , const StateAttribute::GLModeValue) const
2002-07-19 03:54:11 +08:00
< DD > < I > Set the GLModes on StateSet associated with the ClipPlanes< / I >
< DT >
2002-08-29 22:29:49 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > void < B > < A HREF = "#DOC.2.27.14" > setLocalStateSetModes< / A > < / B > (const StateAttribute::GLModeValue=StateAttribute::ON)
2002-07-19 03:54:11 +08:00
< DD > < I > Set up the local StateSet < / I >
< / DL > < / P >
< P > < DL >
< DT > < H3 > Protected Fields< / H3 > < DD > < DT >
2002-08-29 22:29:49 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > StateAttribute::GLModeValue < B > < A HREF = "#DOC.2.27.17" > _value< / A > < / B >
2002-07-19 03:54:11 +08:00
< DT >
2002-08-29 22:29:49 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > ClipPlaneList < B > < A HREF = "#DOC.2.27.18" > _planes< / A > < / B >
2002-07-19 03:54:11 +08:00
< / DL > < / P >
< P > < DL >
< DT > < H3 > Protected Methods< / H3 > < DD > < DT >
2002-08-29 22:29:49 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > virtual < B > < A HREF = "#DOC.2.27.15" > ~ClipNode< / A > < / B > ()
2002-07-19 03:54:11 +08:00
< DT >
2002-08-29 22:29:49 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > virtual const bool < B > < A HREF = "#DOC.2.27.16" > computeBound< / A > < / B > () const
2002-07-19 03:54:11 +08:00
< / DL > < / P >
< / DL >
< HR > < H3 > Inherited from < A HREF = "Group.html" > Group< / A > :< / H3 >
< DL >
< P > < DL >
< DT > < H3 > Public Methods< / H3 > < DD > < DT >
< IMG ALT = "o" SRC = icon2.gif > virtual void < B > traverse< / B > (<!1> < A HREF = "NodeVisitor.html" > NodeVisitor< / A > & nv)
< DT >
< IMG ALT = "o" SRC = icon2.gif > virtual bool < B > addChild< / B > ( Node* child )
< DT >
< IMG ALT = "o" SRC = icon2.gif > virtual bool < B > removeChild< / B > ( Node* child )
< DT >
< IMG ALT = "o" SRC = icon2.gif > virtual bool < B > replaceChild< / B > ( Node* origChild, Node* newChild )
< DT >
< IMG ALT = "o" SRC = icon2.gif > inline const unsigned int < B > getNumChildren< / B > () const
< DT >
< IMG ALT = "o" SRC = icon2.gif > inline Node* < B > getChild< / B > ( const unsigned int i )
< DT >
< IMG ALT = "o" SRC = icon2.gif > inline const Node* < B > getChild< / B > ( const unsigned int i ) const
< DT >
< IMG ALT = "o" SRC = icon2.gif > inline bool < B > containsNode< / B > ( const Node* node ) const
< DT >
< IMG ALT = "o" SRC = icon2.gif > inline ChildList::iterator < B > findNode< / B > ( const Node* node )
< DT >
< IMG ALT = "o" SRC = icon2.gif > inline ChildList::const_iterator < B > findNode< / B > ( const Node* node ) const
< / DL > < / P >
< P > < DL >
< DT > < H3 > Protected Fields< / H3 > < DD > < DT >
< IMG ALT = "o" SRC = icon2.gif > ChildList < B > _children< / B >
< / DL > < / P >
< / DL >
< A NAME = "DOC.DOCU" > < / A >
< HR >
< H2 > Documentation< / H2 >
< BLOCKQUOTE > Leaf Node for defining the position of ClipPlanes in the scene< / BLOCKQUOTE >
< DL >
< A NAME = "ClipNode" > < / A >
2002-08-29 22:29:49 +08:00
< A NAME = "DOC.2.27.1" > < / A >
2002-07-19 03:54:11 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > typedef std::vector< <!1> < A HREF = "ref_ptr.html" > ref_ptr< / A > < <!1> < A HREF = "ClipPlane.html" > ClipPlane< / A > > > ClipPlaneList ClipNode()< / B > < / TT >
< DL > < DT > < DD > < / DL > < P >
< A NAME = "ClipNode" > < / A >
2002-08-29 22:29:49 +08:00
< A NAME = "DOC.2.27.2" > < / A >
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > ClipNode(const <!1> < A HREF = "ClipNode.html#DOC.2.27.2" > ClipNode< / A > & es, const <!1> < A HREF = "CopyOp.html" > CopyOp< / A > & copyop=CopyOp::SHALLOW_COPY)< / B > < / TT >
2002-07-19 03:54:11 +08:00
< DL > < DT > < DD > < / DL > < P >
< A NAME = "META_Node" > < / A >
2002-08-29 22:29:49 +08:00
< A NAME = "DOC.2.27.3" > < / A >
2002-07-19 03:54:11 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > META_Node(<!1> < A HREF = "osg.html" > osg< / A > , <!1> < A HREF = "ClipNode.html" > ClipNode< / A > )< / B > < / TT >
< DL > < DT > < DD > < / DL > < P >
< A NAME = "createClipBox" > < / A >
2002-08-29 22:29:49 +08:00
< A NAME = "DOC.2.27.4" > < / A >
2002-07-19 03:54:11 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > void createClipBox(const <!1> < A HREF = "BoundingBox.html" > BoundingBox< / A > & bb, unsigned int clipPlaneNumberBase=0)< / B > < / TT >
< DD > Create a 6 clip planes to create a clip box
< DL > < DT > < DD > < / DL > < P >
< A NAME = "addClipPlane" > < / A >
2002-08-29 22:29:49 +08:00
< A NAME = "DOC.2.27.5" > < / A >
2002-07-19 03:54:11 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > const bool addClipPlane(<!1> < A HREF = "ClipPlane.html" > ClipPlane< / A > * clipplane)< / B > < / TT >
< DD > Add a ClipPlane to a ClipNode. Return true if plane is added,
return false if plane already exists in ClipNode, or clipplane is false.
< DL > < DT > < DD > < / DL > < P >
< A NAME = "removeClipPlane" > < / A >
2002-08-29 22:29:49 +08:00
< A NAME = "DOC.2.27.6" > < / A >
2002-07-19 03:54:11 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > const bool removeClipPlane(<!1> < A HREF = "ClipPlane.html" > ClipPlane< / A > * clipplane)< / B > < / TT >
< DD > Remove ClipPlane from a ClipNode. Return true if plane is removed,
return false if plane does not exists in ClipNode.
< DL > < DT > < DD > < / DL > < P >
< A NAME = "removeClipPlane" > < / A >
2002-08-29 22:29:49 +08:00
< A NAME = "DOC.2.27.7" > < / A >
2002-07-19 03:54:11 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > const bool removeClipPlane(unsigned int pos)< / B > < / TT >
< DD > Remove ClipPlane, at specified index, from a ClipNode. Return true if plane is removed,
return false if plane does not exists in ClipNode.
< DL > < DT > < DD > < / DL > < P >
< A NAME = "getNumClipPlanes" > < / A >
2002-08-29 22:29:49 +08:00
< A NAME = "DOC.2.27.8" > < / A >
2002-07-19 03:54:11 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > inline const unsigned int getNumClipPlanes() const < / B > < / TT >
< DD > return the number of ClipPlanes
< DL > < DT > < DD > < / DL > < P >
< A NAME = "getClipPlane" > < / A >
2002-08-29 22:29:49 +08:00
< A NAME = "DOC.2.27.9" > < / A >
2002-07-19 03:54:11 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > inline <!1> < A HREF = "ClipPlane.html" > ClipPlane< / A > * getClipPlane(unsigned int pos)< / B > < / TT >
< DD > Get ClipPlane at specificed index position
< DL > < DT > < DD > < / DL > < P >
< A NAME = "getClipPlane" > < / A >
2002-08-29 22:29:49 +08:00
< A NAME = "DOC.2.27.10" > < / A >
2002-07-19 03:54:11 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > inline const <!1> < A HREF = "ClipPlane.html" > ClipPlane< / A > * getClipPlane(unsigned int pos) const < / B > < / TT >
< DD > Get const ClipPlane at specificed index position
< DL > < DT > < DD > < / DL > < P >
< A NAME = "getClipPlaneList" > < / A >
2002-08-29 22:29:49 +08:00
< A NAME = "DOC.2.27.11" > < / A >
2002-07-19 03:54:11 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > inline ClipPlaneList& getClipPlaneList()< / B > < / TT >
< DD > Get the ClipPlaneList
< DL > < DT > < DD > < / DL > < P >
< A NAME = "getClipPlaneList" > < / A >
2002-08-29 22:29:49 +08:00
< A NAME = "DOC.2.27.12" > < / A >
2002-07-19 03:54:11 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > inline const ClipPlaneList& getClipPlaneList() const < / B > < / TT >
< DD > Get the const ClipPlaneList
< DL > < DT > < DD > < / DL > < P >
< A NAME = "setStateSetModes" > < / A >
2002-08-29 22:29:49 +08:00
< A NAME = "DOC.2.27.13" > < / A >
2002-07-19 03:54:11 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > void setStateSetModes(<!1> < A HREF = "StateSet.html" > StateSet< / A > & , const StateAttribute::GLModeValue) const < / B > < / TT >
< DD > Set the GLModes on StateSet associated with the ClipPlanes
< DL > < DT > < DD > < / DL > < P >
< A NAME = "setLocalStateSetModes" > < / A >
2002-08-29 22:29:49 +08:00
< A NAME = "DOC.2.27.14" > < / A >
2002-07-19 03:54:11 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > void setLocalStateSetModes(const StateAttribute::GLModeValue=StateAttribute::ON)< / B > < / TT >
< DD > Set up the local StateSet
< DL > < DT > < DD > < / DL > < P >
< A NAME = "~ClipNode" > < / A >
2002-08-29 22:29:49 +08:00
< A NAME = "DOC.2.27.15" > < / A >
2002-07-19 03:54:11 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > virtual ~ClipNode()< / B > < / TT >
< DL > < DT > < DD > < / DL > < P >
< A NAME = "computeBound" > < / A >
2002-08-29 22:29:49 +08:00
< A NAME = "DOC.2.27.16" > < / A >
2002-07-19 03:54:11 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > virtual const bool computeBound() const < / B > < / TT >
< DL > < DT > < DD > < / DL > < P >
< A NAME = "_value" > < / A >
2002-08-29 22:29:49 +08:00
< A NAME = "DOC.2.27.17" > < / A >
2002-07-19 03:54:11 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > StateAttribute::GLModeValue _value< / B > < / TT >
< DL > < DT > < DD > < / DL > < P >
< A NAME = "_planes" > < / A >
2002-08-29 22:29:49 +08:00
< A NAME = "DOC.2.27.18" > < / A >
2002-07-19 03:54:11 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > ClipPlaneList _planes< / B > < / TT >
< DL > < DT > < DD > < / DL > < P > < / DL >
< HR > < DL > < DT > < B > This class has no child classes.< / B > < / DL >
< DL > < DT > < DD > < / DL > < P > < P > < I > < A HREF = "index.html" > Alphabetic index< / A > < / I > < I > < A HREF = "HIER.html" > HTML hierarchy of classes< / A > or < A HREF = "HIERjava.html" > Java< / A > < / I > < / P > < HR >
< BR >
This page was generated with the help of < A HREF = "http://docpp.sourceforge.net" > DOC++< / A > .
< / BODY >
< / HTML >
