OpenSceneGraph/doc/doc++/osg/EarthSky.html
2002-04-21 21:53:03 +00:00

161 lines
6.8 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<TITLE>class SG_EXPORT osg::EarthSky</TITLE>
<META NAME="GENERATOR" CONTENT="DOC++ 3.4.8">
</HEAD>
<BODY BGCOLOR="#ffffff">
<H2>class SG_EXPORT <A HREF="#DOC.DOCU">osg::EarthSky</A></H2></H2><BLOCKQUOTE>EarthSky 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,CEarthSky,MEarthSky.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.33.1">EarthSky</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif> <B><A HREF="#DOC.2.33.2">EarthSky</A></B>(const <!1><A HREF="EarthSky.html#DOC.2.33.2">EarthSky</A>&amp; es, const <!1><A HREF="CopyOp.html">CopyOp</A>&amp; copyop=CopyOp::SHALLOW_COPY)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif> <B><A HREF="#DOC.2.33.3">META_Node</A></B>(<!1><A HREF="EarthSky.html">EarthSky</A>)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline void <B><A HREF="#DOC.2.33.4">setRequiresClear</A></B>(const 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 const bool <B><A HREF="#DOC.2.33.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.33.6">setClearColor</A></B>(const <!1><A HREF="Vec4.html">Vec4</A>&amp; 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>&amp; <B><A HREF="#DOC.2.33.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.33.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.33.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.33.8">~EarthSky</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 void <B>traverse</B>(<!1><A HREF="NodeVisitor.html">NodeVisitor</A>&amp; 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 int <B>getNumChildren</B>() const
<DT>
<IMG ALT="o" SRC=icon2.gif>inline Node* <B>getChild</B>( const int i )
<DT>
<IMG ALT="o" SRC=icon2.gif>inline const Node* <B>getChild</B>( const 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>
<P><DL>
<DT><H3>Protected Methods</H3><DD><DT>
<IMG ALT="o" SRC=icon2.gif>virtual const bool <B>computeBound</B>() const
</DL></P>
</DL>
<A NAME="DOC.DOCU"></A>
<HR>
<H2>Documentation</H2>
<BLOCKQUOTE>EarthSky 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 EarthSky by default has StateSet attached
to it which sets the default EarthSky 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="EarthSky"></A>
<A NAME="DOC.2.33.1"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> EarthSky()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="EarthSky"></A>
<A NAME="DOC.2.33.2"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> EarthSky(const <!1><A HREF="EarthSky.html#DOC.2.33.2">EarthSky</A>&amp; es, const <!1><A HREF="CopyOp.html">CopyOp</A>&amp; copyop=CopyOp::SHALLOW_COPY)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="META_Node"></A>
<A NAME="DOC.2.33.3"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> META_Node(<!1><A HREF="EarthSky.html">EarthSky</A>)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="setRequiresClear"></A>
<A NAME="DOC.2.33.4"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline void setRequiresClear(const 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.33.5"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline const 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.33.6"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline void setClearColor(const <!1><A HREF="Vec4.html">Vec4</A>&amp; color)</B></TT>
<DD>Sets the clear color.
<DL><DT><DD></DL><P>
<A NAME="getClearColor"></A>
<A NAME="DOC.2.33.7"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline const <!1><A HREF="Vec4.html">Vec4</A>&amp; getClearColor() const </B></TT>
<DD>Returns the clear color.
<DL><DT><DD></DL><P>
<A NAME="~EarthSky"></A>
<A NAME="DOC.2.33.8"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual ~EarthSky()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="_requiresClear"></A>
<A NAME="DOC.2.33.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.33.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>