172 lines
7.4 KiB
HTML
172 lines
7.4 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|
|
|
<HTML>
|
|
<HEAD>
|
|
<TITLE>class SG_EXPORT osg::ClearNode</TITLE>
|
|
<META NAME="GENERATOR" CONTENT="DOC++ 3.4.8">
|
|
</HEAD>
|
|
<BODY BGCOLOR="#ffffff">
|
|
|
|
<H2>class SG_EXPORT <A HREF="#DOC.DOCU">osg::ClearNode</A></H2></H2><BLOCKQUOTE>ClearNode is a Group node which controls the clearing of the color and depth buffers at the start of each frame.</BLOCKQUOTE>
|
|
<HR>
|
|
|
|
<H2>Inheritance:</H2>
|
|
<APPLET CODE="ClassGraph.class" WIDTH=600 HEIGHT=95>
|
|
<param name=classes value="MNode,M,CGroup,MGroup.html,CClearNode,MClearNode.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>
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif> <B><A HREF="#DOC.2.43.1">ClearNode</A></B>()
|
|
<DT>
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif> <B><A HREF="#DOC.2.43.2">ClearNode</A></B>(const <!1><A HREF="ClearNode.html#DOC.2.43.2">ClearNode</A>& es, const <!1><A HREF="CopyOp.html">CopyOp</A>& copyop=CopyOp::SHALLOW_COPY)
|
|
<DT>
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif> <B><A HREF="#DOC.2.43.3">META_Node</A></B>(<!1><A HREF="osg.html">osg</A>, <!1><A HREF="ClearNode.html">ClearNode</A>)
|
|
<DT>
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline void <B><A HREF="#DOC.2.43.4">setRequiresClear</A></B>(bool requiresClear)
|
|
<DD><I>Sets the flag which control whether a glClear is required at the beginning of each frame.</I>
|
|
<DT>
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline bool <B><A HREF="#DOC.2.43.5">getRequiresClear</A></B>() const
|
|
<DD><I>Gets the flag which control whether a glClear is required at the beginning of each frame.</I>
|
|
<DT>
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline void <B><A HREF="#DOC.2.43.6">setClearColor</A></B>(const <!1><A HREF="Vec4.html">Vec4</A>& color)
|
|
<DD><I>Sets the clear color.</I>
|
|
<DT>
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline const <!1><A HREF="Vec4.html">Vec4</A>& <B><A HREF="#DOC.2.43.7">getClearColor</A></B>() const
|
|
<DD><I>Returns the clear color.</I>
|
|
</DL></P>
|
|
|
|
<P><DL>
|
|
<DT><H3>Protected Fields</H3><DD><DT>
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>bool <B><A HREF="#DOC.2.43.9">_requiresClear</A></B>
|
|
<DT>
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif><!1><A HREF="Vec4.html">Vec4</A> <B><A HREF="#DOC.2.43.10">_clearColor</A></B>
|
|
</DL></P>
|
|
|
|
<P><DL>
|
|
<DT><H3>Protected Methods</H3><DD><DT>
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual <B><A HREF="#DOC.2.43.8">~ClearNode</A></B>()
|
|
</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 <!1><A HREF="Group.html">Group</A>* <B>asGroup</B>()
|
|
<DT>
|
|
<IMG ALT="o" SRC=icon2.gif>virtual const <!1><A HREF="Group.html">Group</A>* <B>asGroup</B>() const
|
|
<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 unsigned int <B>getNumChildren</B>() const
|
|
<DT>
|
|
<IMG ALT="o" SRC=icon2.gif>inline Node* <B>getChild</B>( unsigned int i )
|
|
<DT>
|
|
<IMG ALT="o" SRC=icon2.gif>inline const Node* <B>getChild</B>( 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
|
|
<DT>
|
|
<IMG ALT="o" SRC=icon2.gif>inline unsigned int <B>findChildNo</B>( const Node* node ) const
|
|
</DL></P>
|
|
|
|
<P><DL>
|
|
<DT><H3>Public Members</H3><DD><DT>
|
|
<IMG ALT="o" SRC=icon2.gif>typedef std::vector<<!1><A HREF="ref_ptr.html">ref_ptr</A><Node> > <B>ChildList</B>
|
|
</DL></P>
|
|
|
|
<P><DL>
|
|
<DT><H3>Protected Fields</H3><DD><DT>
|
|
<IMG ALT="o" SRC=icon2.gif><!1><A HREF="Group.html#DOC.2.74.1">ChildList</A> <B>_children</B>
|
|
</DL></P>
|
|
|
|
<P><DL>
|
|
<DT><H3>Protected Methods</H3><DD><DT>
|
|
<IMG ALT="o" SRC=icon2.gif>virtual bool <B>computeBound</B>() const
|
|
</DL></P>
|
|
|
|
</DL>
|
|
|
|
<A NAME="DOC.DOCU"></A>
|
|
<HR>
|
|
<H2>Documentation</H2>
|
|
<BLOCKQUOTE>ClearNode is a Group node which controls the clearing of the color and depth
|
|
buffers at the start of each frame.
|
|
The earth sky by default is empty and simply holds the clear color of
|
|
the background. However, if the uses wants to add their own clearing of
|
|
the color and depth buffers then the children can be added, and the
|
|
background clear turned off. The ClearNode by default has StateSet attached
|
|
to it which sets the default ClearNode bin number to -1, so that all drawables
|
|
below it are placed in a separate bin from the rest of the scene graph, and
|
|
are rendered prior to standard opaque and transparent drawables.</BLOCKQUOTE>
|
|
<DL>
|
|
|
|
<A NAME="ClearNode"></A>
|
|
<A NAME="DOC.2.43.1"></A>
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> ClearNode()</B></TT>
|
|
<DL><DT><DD></DL><P>
|
|
<A NAME="ClearNode"></A>
|
|
<A NAME="DOC.2.43.2"></A>
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> ClearNode(const <!1><A HREF="ClearNode.html#DOC.2.43.2">ClearNode</A>& es, const <!1><A HREF="CopyOp.html">CopyOp</A>& copyop=CopyOp::SHALLOW_COPY)</B></TT>
|
|
<DL><DT><DD></DL><P>
|
|
<A NAME="META_Node"></A>
|
|
<A NAME="DOC.2.43.3"></A>
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> META_Node(<!1><A HREF="osg.html">osg</A>, <!1><A HREF="ClearNode.html">ClearNode</A>)</B></TT>
|
|
<DL><DT><DD></DL><P>
|
|
<A NAME="setRequiresClear"></A>
|
|
<A NAME="DOC.2.43.4"></A>
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline void setRequiresClear(bool requiresClear)</B></TT>
|
|
<DD>Sets the flag which control whether a glClear is required at the beginning of each frame.
|
|
<DL><DT><DD></DL><P>
|
|
<A NAME="getRequiresClear"></A>
|
|
<A NAME="DOC.2.43.5"></A>
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline bool getRequiresClear() const </B></TT>
|
|
<DD>Gets the flag which control whether a glClear is required at the beginning of each frame.
|
|
<DL><DT><DD></DL><P>
|
|
<A NAME="setClearColor"></A>
|
|
<A NAME="DOC.2.43.6"></A>
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline void setClearColor(const <!1><A HREF="Vec4.html">Vec4</A>& color)</B></TT>
|
|
<DD>Sets the clear color.
|
|
<DL><DT><DD></DL><P>
|
|
<A NAME="getClearColor"></A>
|
|
<A NAME="DOC.2.43.7"></A>
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline const <!1><A HREF="Vec4.html">Vec4</A>& getClearColor() const </B></TT>
|
|
<DD>Returns the clear color.
|
|
<DL><DT><DD></DL><P>
|
|
<A NAME="~ClearNode"></A>
|
|
<A NAME="DOC.2.43.8"></A>
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual ~ClearNode()</B></TT>
|
|
<DL><DT><DD></DL><P>
|
|
<A NAME="_requiresClear"></A>
|
|
<A NAME="DOC.2.43.9"></A>
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>bool _requiresClear</B></TT>
|
|
<DL><DT><DD></DL><P>
|
|
<A NAME="_clearColor"></A>
|
|
<A NAME="DOC.2.43.10"></A>
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B><!1><A HREF="Vec4.html">Vec4</A> _clearColor</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>
|