OpenSceneGraph/doc/doc++/osgDB/osgDB.html
2002-07-16 20:07:32 +00:00

197 lines
11 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<TITLE>namespace osgDB</TITLE>
<META NAME="GENERATOR" CONTENT="DOC++ 3.4.8">
</HEAD>
<BODY BGCOLOR="#ffffff">
<H2>namespace <A HREF="#DOC.DOCU">osgDB</A></H2></H2>
<HR>
<P><DL>
<DT>
class OSGDB_EXPORT <B><A HREF="DotOsgWrapper.html">DotOsgWrapper</A></B>: public osg::Referenced
<DD><I>Wrapper class for specifying read and write functions for extending the osg file format.</I>
<DT>
class OSGDB_EXPORT <B><A HREF="DynamicLibrary.html">DynamicLibrary</A></B>: public osg::Referenced
<DD><I>DynamicLibrary - encapsulates the loading and unloading of dynamic libraries, typically used for loading ReaderWriter plug-ins</I>
<DT>
class OSGDB_EXPORT <B><A HREF="Field.html">Field</A></B>
<DT>
class OSGDB_EXPORT <B><A HREF="FieldReader.html">FieldReader</A></B>
<DT>
class OSGDB_EXPORT <B><A HREF="FieldReaderIterator.html">FieldReaderIterator</A></B>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>OSGDB_EXPORT extern std::string <B><A HREF="#DOC.2.6">getFilePath</A></B>(const std::string&amp; filename)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>OSGDB_EXPORT extern std::string <B><A HREF="#DOC.2.7">getFileExtension</A></B>(const std::string&amp; filename)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>OSGDB_EXPORT extern std::string <B><A HREF="#DOC.2.8">getLowerCaseFileExtension</A></B>(const std::string&amp; filename)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>OSGDB_EXPORT extern std::string <B><A HREF="#DOC.2.9">getSimpleFileName</A></B>(const std::string&amp; fileName)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>OSGDB_EXPORT extern std::string <B><A HREF="#DOC.2.10">getStrippedName</A></B>(const std::string&amp; fileName)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>OSGDB_EXPORT extern bool <B><A HREF="#DOC.2.11">equalCaseInsensitive</A></B>(const std::string&amp; lhs, const std::string&amp; rhs)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>OSGDB_EXPORT extern bool <B><A HREF="#DOC.2.12">equalCaseInsensitive</A></B>(const std::string&amp; lhs, const char* rhs)
<DT>
OSGDB_EXPORT extern bool <B><A HREF="fileExists.html">fileExists</A></B>(const std::string&amp; filename)
<DD><I>return true if a file exisits.</I>
<DT>
OSGDB_EXPORT extern std::string <B><A HREF="findFileInPath.html">findFileInPath</A></B>(const std::string&amp; filename, const <!1><A HREF="FilePathList.html">FilePathList</A>&amp; filePath)
<DD><I>find specified file in specified file path</I>
<DT>
OSGDB_EXPORT extern std::string <B><A HREF="findFileInDirectory.html">findFileInDirectory</A></B>(const std::string&amp; fileName, const std::string&amp; dirName, bool caseInsensitive=false)
<DD><I>return the directory/filename of a file if its is contained within specified directory.</I>
<DT>
typedef std::vector&lt;std::string&gt; <B><A HREF="DirectoryContents.html">DirectoryContents</A></B>
<DD><I>simple list of names to represent a directory's contents.</I>
<DT>
OSGDB_EXPORT extern <!1><A HREF="DirectoryContents.html">DirectoryContents</A> <B><A HREF="getDirectoryContents.html">getDirectoryContents</A></B>(const std::string&amp; dirName)
<DD><I>return the contents of a directory.</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline void <B><A HREF="#DOC.2.18">setDataFilePathList</A></B>(const <!1><A HREF="FilePathList.html">FilePathList</A>&amp; filepath)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline void <B><A HREF="#DOC.2.19">setDataFilePathList</A></B>(const std::string&amp; paths)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline <!1><A HREF="FilePathList.html">FilePathList</A>&amp; <B><A HREF="#DOC.2.20">getDataFilePathList</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>OSGDB_EXPORT extern std::string <B><A HREF="#DOC.2.21">findDataFile</A></B>(const std::string&amp; filename)
<DT>
class <B><A HREF="PushAndPopDataPath.html">PushAndPopDataPath</A></B>
<DD><I>Convinience class for pushing a path on construction, and popping the path and destruction.</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline void <B><A HREF="#DOC.2.23">setLibraryFilePathList</A></B>(const <!1><A HREF="FilePathList.html">FilePathList</A>&amp; filepaths)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline void <B><A HREF="#DOC.2.24">setLibraryFilePathList</A></B>(const std::string&amp; paths)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline <!1><A HREF="FilePathList.html">FilePathList</A>&amp; <B><A HREF="#DOC.2.25">getLibraryFilePathList</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>OSGDB_EXPORT extern std::string <B><A HREF="#DOC.2.26">findLibraryFile</A></B>(const std::string&amp; filename)
<DT>
class OSGDB_EXPORT <B><A HREF="Input.html">Input</A></B>: public <!1><A HREF="FieldReaderIterator.html">FieldReaderIterator</A>
<DD><I>Class for managing the reading of ASCII osg files</I>
<DT>
class OSGDB_EXPORT <B><A HREF="Output.html">Output</A></B>: public std::ofstream
<DD><I>ofstream wrapper class for adding support for indenting.</I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>template&lt;class T&gt; bool <B><A HREF="#DOC.2.29">writeArrayBlock</A></B>(<!1><A HREF="Output.html">Output</A>&amp; fw, T* start, T* finish)
<DT>
class OSGDB_EXPORT <B><A HREF="ReaderWriter.html">ReaderWriter</A></B>: public osg::Referenced
<DD><I>pure virtual base class for reading and writing of non native formats.</I>
<DT>
OSGDB_EXPORT extern osg::Object* <B><A HREF="readObjectFile.html">readObjectFile</A></B>(const std::string&amp; filename)
<DD><I>Read an osg::Object from file.</I>
<DT>
OSGDB_EXPORT extern osg::Image* <B><A HREF="readImageFile.html">readImageFile</A></B>(const std::string&amp; filename)
<DD><I>Read an osg::Image from file.</I>
<DT>
OSGDB_EXPORT extern osg::Node* <B><A HREF="readNodeFile.html">readNodeFile</A></B>(const std::string&amp; filename)
<DD><I>Read an osg::Node from file.</I>
<DT>
OSGDB_EXPORT extern osg::Node* <B><A HREF="readNodeFiles.html">readNodeFiles</A></B>(std::vector&lt;std::string&gt;&amp; commandLine)
<DD><I>Read an osg::Node subgraph from files, creating a osg::Group to contain the nodes if more than one subgraph has been loaded</I>
<DT>
typedef std::deque&lt;std::string&gt; <B><A HREF="FilePathList.html">FilePathList</A></B>
<DD><I>list of directories to search through which searching for files.</I>
<DT>
class OSGDB_EXPORT <B><A HREF="Registry.html">Registry</A></B>
<DD><I> Registry is a singleton factory which stores the reader/writers which are linked in at runtime for reading non-native file formats.</I>
<DT>
inline void <B><A HREF="readCommandLine.html">readCommandLine</A></B>(std::vector&lt;std::string&gt;&amp; commandLine)
<DD><I>read the command line string list into the osgDB::Registry(), removing any matched control sequences</I>
<DT>
class <B><A HREF="RegisterDotOsgWrapperProxy.html">RegisterDotOsgWrapperProxy</A></B>
<DD><I>Proxy class for automatic registration of DotOsgWrappers with the Registry</I>
<DT>
template&lt;class T&gt; class <B><A HREF="RegisterReaderWriterProxy.html">RegisterReaderWriterProxy</A></B>
<DD><I>Proxy class for automatic registration of reader/writers with the Registry</I>
<DT>
OSGDB_EXPORT extern bool <B><A HREF="writeObjectFile.html">writeObjectFile</A></B>(const osg::Object&amp; object, const std::string&amp; filename)
<DD><I>Write an osg::Object to file.</I>
<DT>
OSGDB_EXPORT extern bool <B><A HREF="writeImageFile.html">writeImageFile</A></B>(const osg::Image&amp; image, const std::string&amp; filename)
<DD><I>Write an osg::Image to file.</I>
<DT>
OSGDB_EXPORT extern bool <B><A HREF="writeNodeFile.html">writeNodeFile</A></B>(const osg::Node&amp; node, const std::string&amp; filename)
<DD><I>Write an osg::Node to file.</I>
</DL></P>
<A NAME="DOC.DOCU"></A>
<HR>
<H2>Documentation</H2>
<DL>
<A NAME="getFilePath"></A>
<A NAME="DOC.2.6"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>OSGDB_EXPORT extern std::string getFilePath(const std::string&amp; filename)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="getFileExtension"></A>
<A NAME="DOC.2.7"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>OSGDB_EXPORT extern std::string getFileExtension(const std::string&amp; filename)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="getLowerCaseFileExtension"></A>
<A NAME="DOC.2.8"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>OSGDB_EXPORT extern std::string getLowerCaseFileExtension(const std::string&amp; filename)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="getSimpleFileName"></A>
<A NAME="DOC.2.9"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>OSGDB_EXPORT extern std::string getSimpleFileName(const std::string&amp; fileName)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="getStrippedName"></A>
<A NAME="DOC.2.10"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>OSGDB_EXPORT extern std::string getStrippedName(const std::string&amp; fileName)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="equalCaseInsensitive"></A>
<A NAME="DOC.2.11"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>OSGDB_EXPORT extern bool equalCaseInsensitive(const std::string&amp; lhs, const std::string&amp; rhs)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="equalCaseInsensitive"></A>
<A NAME="DOC.2.12"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>OSGDB_EXPORT extern bool equalCaseInsensitive(const std::string&amp; lhs, const char* rhs)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="setDataFilePathList"></A>
<A NAME="DOC.2.18"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline void setDataFilePathList(const <!1><A HREF="FilePathList.html">FilePathList</A>&amp; filepath)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="setDataFilePathList"></A>
<A NAME="DOC.2.19"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline void setDataFilePathList(const std::string&amp; paths)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="getDataFilePathList"></A>
<A NAME="DOC.2.20"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline <!1><A HREF="FilePathList.html">FilePathList</A>&amp; getDataFilePathList()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="findDataFile"></A>
<A NAME="DOC.2.21"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>OSGDB_EXPORT extern std::string findDataFile(const std::string&amp; filename)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="setLibraryFilePathList"></A>
<A NAME="DOC.2.23"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline void setLibraryFilePathList(const <!1><A HREF="FilePathList.html">FilePathList</A>&amp; filepaths)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="setLibraryFilePathList"></A>
<A NAME="DOC.2.24"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline void setLibraryFilePathList(const std::string&amp; paths)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="getLibraryFilePathList"></A>
<A NAME="DOC.2.25"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline <!1><A HREF="FilePathList.html">FilePathList</A>&amp; getLibraryFilePathList()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="findLibraryFile"></A>
<A NAME="DOC.2.26"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>OSGDB_EXPORT extern std::string findLibraryFile(const std::string&amp; filename)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="writeArrayBlock"></A>
<A NAME="DOC.2.29"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>template&lt;class T&gt; bool writeArrayBlock(<!1><A HREF="Output.html">Output</A>&amp; fw, T* start, T* finish)</B></TT>
<DL><DT><DD></DL><P></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>