Updated docs.

This commit is contained in:
Robert Osfield
2004-08-13 14:09:48 +00:00
parent 796e6bb50a
commit 3024fffbc4
5 changed files with 407 additions and 347 deletions

File diff suppressed because it is too large Load Diff

View File

@@ -24,6 +24,7 @@
<P><DL>
<DT><H3>Public Classes</H3><DD><DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>enum <B><A HREF="#DOC.2.55.1">CacheHintOptions</A></B>
<DD><I>bit mask for setting up which object types get cached by readObject/Image/HeightField/Node(filename) calls</I>
<DT>
class <B><A HREF="ReadFileCallback.html">ReadFileCallback</A></B>: public osg::Referenced
<DT>
@@ -326,31 +327,38 @@ register at runtime a reader/writer with the Registry.</BLOCKQUOTE>
<A NAME="CacheHintOptions"></A>
<A NAME="DOC.2.55.1"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>enum CacheHintOptions</B></TT>
<DD>bit mask for setting up which object types get cached by readObject/Image/HeightField/Node(filename) calls
<DL><DT><DD></DL><P><DL>
<A NAME="CACHE_NONE"></A>
<A NAME="DOC.2.55.1.1"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> CACHE_NONE</B></TT>
<DD>do not cache objects of any type
<DL><DT><DD></DL><P>
<A NAME="CACHE_NODES"></A>
<A NAME="DOC.2.55.1.2"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> CACHE_NODES</B></TT>
<DD>cache nodes loaded via readNode(filename)
<DL><DT><DD></DL><P>
<A NAME="CACHE_IMAGES"></A>
<A NAME="DOC.2.55.1.3"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> CACHE_IMAGES</B></TT>
<DD>cache images loaded via readImage(filename)
<DL><DT><DD></DL><P>
<A NAME="CACHE_HEIGHTFIELDS"></A>
<A NAME="DOC.2.55.1.4"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> CACHE_HEIGHTFIELDS</B></TT>
<DD>cache heightfield loaded via readHeightField(filename)
<DL><DT><DD></DL><P>
<A NAME="CACHE_OBJECTS"></A>
<A NAME="DOC.2.55.1.5"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> CACHE_OBJECTS</B></TT>
<DD>cache objects loaded via readObject(filename)
<DL><DT><DD></DL><P>
<A NAME="CACHE_ALL"></A>
<A NAME="DOC.2.55.1.6"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> CACHE_ALL</B></TT>
<DD>cache on all read*(filename) calls
<DL><DT><DD></DL><P></DL>
<A NAME="instance"></A>

View File

@@ -15,11 +15,11 @@
<param name=indent value="0,1,1,1,1,1,1">
<param name=arrowdir value="down">
</APPLET>
<APPLET CODE="ClassGraph.class" WIDTH=600 HEIGHT=35>
<param name=classes value="CRegistry,MRegistry.html">
<param name=before value="M">
<param name=after value="M">
<param name=indent value="0">
<APPLET CODE="ClassGraph.class" WIDTH=600 HEIGHT=65>
<param name=classes value="Mosg::Referenced,M,CRegistry,MRegistry.html">
<param name=before value="M,M">
<param name=after value="Md_,M">
<param name=indent value="0,1">
<param name=arrowdir value="down">
</APPLET>
<APPLET CODE="ClassGraph.class" WIDTH=600 HEIGHT=65>

View File

@@ -9,6 +9,16 @@
<H2>class OSGFX_EXPORT <A HREF="#DOC.DOCU">osgFX::Registry</A></H2></H2><HR>
<H2>Inheritance:</H2>
<APPLET CODE="ClassGraph.class" WIDTH=600 HEIGHT=65>
<param name=classes value="Mosg::Referenced,M,CRegistry,MRegistry.html">
<param name=before value="M,M">
<param name=after value="Md_,M">
<param name=indent value="0,1">
<param name=arrowdir value="down">
</APPLET>
<HR>
<DL>
<P><DL>
<DT><H3>Public Classes</H3><DD><DT>
@@ -17,15 +27,13 @@
<P><DL>
<DT><H3>Public Methods</H3><DD><DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline static <!1><A HREF="Registry.html">Registry</A>* <B><A HREF="#DOC.2.5.3">instance</A></B>()
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>static <!1><A HREF="Registry.html">Registry</A>* <B><A HREF="#DOC.2.5.3">instance</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline const <!1><A HREF="Registry.html#DOC.2.5.2">Effect_map</A>&amp; <B><A HREF="#DOC.2.5.4">getEffectMap</A></B>() const
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline <!1><A HREF="Registry.html">Registry</A>* <B><A HREF="#DOC.2.5.9">instance</A></B>()
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline const Registry::Effect_map&amp; <B><A HREF="#DOC.2.5.8">getEffectMap</A></B>() const
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline const Registry::Effect_map&amp; <B><A HREF="#DOC.2.5.10">getEffectMap</A></B>() const
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline void <B><A HREF="#DOC.2.5.11">registerEffect</A></B>(const <!1><A HREF="Effect.html">Effect</A>* effect)
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline void <B><A HREF="#DOC.2.5.9">registerEffect</A></B>(const <!1><A HREF="Effect.html">Effect</A>* effect)
</DL></P>
<P><DL>
@@ -63,7 +71,7 @@
<DL><DT><DD></DL><P>
<A NAME="instance"></A>
<A NAME="DOC.2.5.3"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline static <!1><A HREF="Registry.html">Registry</A>* instance()</B></TT>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>static <!1><A HREF="Registry.html">Registry</A>* instance()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="getEffectMap"></A>
<A NAME="DOC.2.5.4"></A>
@@ -77,16 +85,12 @@
<A NAME="DOC.2.5.6"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> ~Registry()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="instance"></A>
<A NAME="DOC.2.5.9"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline <!1><A HREF="Registry.html">Registry</A>* instance()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="getEffectMap"></A>
<A NAME="DOC.2.5.10"></A>
<A NAME="DOC.2.5.8"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline const Registry::Effect_map&amp; getEffectMap() const </B></TT>
<DL><DT><DD></DL><P>
<A NAME="registerEffect"></A>
<A NAME="DOC.2.5.11"></A>
<A NAME="DOC.2.5.9"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline void registerEffect(const <!1><A HREF="Effect.html">Effect</A>* effect)</B></TT>
<DL><DT><DD></DL><P></DL>

View File

@@ -23,7 +23,7 @@ class OSGFX_EXPORT <B><A HREF="Cartoon.html">Cartoon</A></B>: public <!1><A HRE
class OSGFX_EXPORT <B><A HREF="Effect.html">Effect</A></B>: public osg::Group
<DD><I> The base class for special effects.</I>
<DT>
class OSGFX_EXPORT <B><A HREF="Registry.html">Registry</A></B>
class OSGFX_EXPORT <B><A HREF="Registry.html">Registry</A></B>: public osg::Referenced
<DT>
class OSGFX_EXPORT <B><A HREF="Scribe.html">Scribe</A></B>: public <!1><A HREF="Effect.html">Effect</A>
<DD><I> This is a two-passes effect; the first pass renders the subgraph as usual while the second pass switches to wireframe mode, sets up lighting and material to obtain a fixed (user-defined) color and then renders the subgraph.</I>