OpenSceneGraph 3.6.5
|
The osgDB library provides support for reading and writing scene graphs, providing a plugin framework and file utility classes. More...
Classes | |
class | Archive |
Base class for implementing database Archives. More... | |
class | AuthenticationDetails |
class | AuthenticationMap |
struct | base64_decodestate |
struct | base64_encodestate |
class | Base64decoder |
class | Base64encoder |
class | BaseCompressor |
class | BaseSerializer |
struct | basic_type_wrapper |
basic structure for custom runtime inheritance checking More... | |
class | BitFlagsSerializer |
class | ClassInterface |
ClassInterface provides a general means of checking for supported properties of classes, and getting/setting those properties. More... | |
class | DatabasePager |
Database paging class which manages the loading of files in a background thread, and synchronizing of loaded models with the main scene graph. More... | |
class | DatabaseRevision |
class | DatabaseRevisions |
class | DeprecatedDotOsgWrapperManager |
deprecated. More... | |
class | DotOsgWrapper |
deprecated. More... | |
class | DynamicLibrary |
DynamicLibrary - encapsulates the loading and unloading of dynamic libraries, typically used for loading ReaderWriter plug-ins. More... | |
class | EnumSerializer |
class | ExternalFileWriter |
Helper allowing 'intelligent' writing of external files (images, shaders, etc.), regarding to a main file (a scene), especially in plugins. More... | |
class | Field |
deprecated. More... | |
class | FieldReader |
deprecated. More... | |
class | FieldReaderIterator |
deprecated. More... | |
class | FileCache |
class | FileList |
class | FileLocationCallback |
struct | FileNameComparator |
Functor for helping sort filename in alphabetical and numerical order when using in conjunction with std::sort. More... | |
class | FindFileCallback |
struct | FinishedObjectReadCallback |
class | GLenumSerializer |
class | ifstream |
class | ImageOptions |
class | ImagePager |
class | ImageProcessor |
class | ImageSerializer |
class | Input |
deprecated. More... | |
class | InputException |
class | InputIterator |
class | InputStream |
class | IntLookup |
class | IsAVectorSerializer |
class | ListSerializer |
class | MapBaseSerializer |
class | MapIteratorObject |
class | MapSerializer |
class | MatrixSerializer |
struct | MethodObject |
class | ObjectCache |
struct | ObjectGLenum |
class | ObjectMark |
class | ObjectProperty |
class | ObjectSerializer |
class | ObjectWrapper |
struct | ObjectWrapperAssociate |
class | ObjectWrapperManager |
class | ofstream |
class | Options |
Options base class used for passing options into plugins to control their operation. More... | |
class | Output |
deprecated. More... | |
class | OutputException |
class | OutputIterator |
class | OutputStream |
class | ParameterOutput |
struct | PluginFunctionProxy |
class | PropByRefSerializer |
class | PropByValSerializer |
class | ReaderWriter |
Pure virtual base class for reading and writing of non native formats. More... | |
class | ReaderWriterInfo |
class | ReadFileCallback |
class | RegisterCompressorProxy |
class | RegisterCustomWrapperProxy |
class | RegisterDotOsgWrapperProxy |
deprecated. More... | |
class | RegisterImageProcessorProxy |
Proxy class for automatic registration of reader/writers with the Registry. More... | |
class | RegisterReaderWriterProxy |
Proxy class for automatic registration of reader/writers with the Registry. More... | |
class | RegisterWrapperProxy |
class | Registry |
Registry is a singleton factory which stores the reader/writers which are linked in at runtime for reading non-native file formats. More... | |
class | SharedStateManager |
class | StringSerializer |
class | TemplateRegisterDotOsgWrapperProxy |
deprecated. More... | |
class | TemplateSerializer |
struct | type_wrapper |
a class template that checks inheritance between a given Object's class and a class defined at compile time through the template parameter T. More... | |
struct | UpdateWrapperVersionProxy |
class | UserLookupTableProxy |
class | UserSerializer |
class | VectorBaseSerializer |
class | VectorSerializer |
class | WriteFileCallback |
class | XmlNode |
XmlNode class for very basic reading and writing of xml files. More... |
Typedefs | |
typedef std::deque< std::string > | FilePathList |
list of directories to search through which searching for files. | |
typedef osg::Object * | ObjectPtr |
typedef std::vector< std::string > | DirectoryContents |
simple list of names to represent a directory's contents. | |
typedef std::list< std::string > | FileNameList |
typedef std::list< osg::ref_ptr< ReaderWriterInfo > > | ReaderWriterInfoList |
typedef std::vector< std::string > | StringList |
Enumerations | |
enum | CaseSensitivity { CASE_SENSITIVE , CASE_INSENSITIVE } |
enum | base64_decodestep { step_a , step_b , step_c , step_d } |
enum | base64_encodestep { step_A , step_B , step_C } |
enum | FileType { FILE_NOT_FOUND , REGULAR_FILE , DIRECTORY } |
enum | CopyFileResult { COPY_FILE_OK , COPY_FILE_SOURCE_EQUALS_DESTINATION , COPY_FILE_BAD_ARGUMENT , COPY_FILE_SOURCE_MISSING , COPY_FILE_SOURCE_NOT_OPENED , COPY_FILE_DESTINATION_NOT_OPENED , COPY_FILE_READ_ERROR , COPY_FILE_WRITE_ERROR } |
Functions | |
OSGDB_EXPORT Archive * | openArchive (const std::string &filename, ReaderWriter::ArchiveStatus status, unsigned int indexBlockSizeHint=4096) |
Open an archive for reading or writing. | |
OSGDB_EXPORT Archive * | openArchive (const std::string &filename, ReaderWriter::ArchiveStatus status, unsigned int indexBlockSizeHint, Options *options) |
Open an archive for reading or writing. | |
OSGDB_EXPORT osgDB::BaseSerializer::Type | getTypeEnumFromPtr (const osg::Object *) |
OSGDB_EXPORT const char * | getTypeStringFromPtr (const osg::Object *) |
OSGDB_EXPORT osgDB::BaseSerializer::Type | getTypeEnumFromPtr (const osg::Image *) |
OSGDB_EXPORT const char * | getTypeStringFromPtr (const osg::Image *) |
void | base64_init_encodestate (base64_encodestate *state_in) |
void | base64_init_decodestate (base64_decodestate *state_in) |
OSGDB_EXPORT std::string | convertUTF16toUTF8 (const wchar_t *source, unsigned sourceLength) |
OSGDB_EXPORT std::wstring | convertUTF8toUTF16 (const char *source, unsigned sourceLength) |
OSGDB_EXPORT std::string | convertUTF16toUTF8 (const std::wstring &s) |
OSGDB_EXPORT std::string | convertUTF16toUTF8 (const wchar_t *s) |
OSGDB_EXPORT std::wstring | convertUTF8toUTF16 (const std::string &s) |
OSGDB_EXPORT std::wstring | convertUTF8toUTF16 (const char *s) |
OSGDB_EXPORT std::string | convertStringFromCurrentCodePageToUTF8 (const char *source, unsigned sourceLength) |
OSGDB_EXPORT std::string | convertStringFromUTF8toCurrentCodePage (const char *source, unsigned sourceLength) |
OSGDB_EXPORT std::string | convertStringFromCurrentCodePageToUTF8 (const std::string &s) |
OSGDB_EXPORT std::string | convertStringFromCurrentCodePageToUTF8 (const char *s) |
OSGDB_EXPORT std::string | convertStringFromUTF8toCurrentCodePage (const std::string &s) |
OSGDB_EXPORT std::string | convertStringFromUTF8toCurrentCodePage (const char *s) |
OSGDB_EXPORT std::string | getFilePath (const std::string &filename) |
Gets the parent path from full name (Ex: /a/b/c.Ext => /a/b). | |
OSGDB_EXPORT std::string | getFileExtension (const std::string &filename) |
Gets the extension without dot (Ex: /a/b/c.Ext => Ext). | |
OSGDB_EXPORT std::string | getFileExtensionIncludingDot (const std::string &filename) |
Gets the extension including dot (Ex: /a/b/c.Ext => .Ext). | |
OSGDB_EXPORT std::string | getLowerCaseFileExtension (const std::string &filename) |
Gets the lowercase extension without dot (Ex: /a/b/c.Ext => ext). | |
OSGDB_EXPORT std::string | getSimpleFileName (const std::string &fileName) |
Gets file name with extension (Ex: /a/b/c.Ext => c.Ext). | |
OSGDB_EXPORT std::string | getNameLessExtension (const std::string &fileName) |
Gets file path without last extension (Ex: /a/b/c.Ext => /a/b/c ; file.ext1.ext2 => file.ext1). | |
OSGDB_EXPORT std::string | getNameLessAllExtensions (const std::string &fileName) |
Gets file path without all extensions (Ex: /a/b/c.Ext => /a/b/c ; file.ext1.ext2 => file). | |
OSGDB_EXPORT std::string | getStrippedName (const std::string &fileName) |
Gets file name without last extension (Ex: /a/b/c.Ext => c ; file.ext1.ext2 => file.ext1). | |
OSGDB_EXPORT std::string | getPathRelative (const std::string &from, const std::string &to) |
If 'to' is in a subdirectory of 'from' then this function returns the subpath, otherwise it just returns the file name. | |
OSGDB_EXPORT std::string | getPathRoot (const std::string &path) |
Gets root part of a path ("/" or "C:"), or an empty string if none found. | |
OSGDB_EXPORT bool | isAbsolutePath (const std::string &path) |
Tests if path is absolute, as !getPathRoot(path).empty(). | |
OSGDB_EXPORT std::string | convertFileNameToWindowsStyle (const std::string &fileName) |
Converts forward slashes (/) to back slashes (). | |
OSGDB_EXPORT std::string | convertFileNameToUnixStyle (const std::string &fileName) |
Converts back slashes () to forward slashes (/). | |
OSGDB_EXPORT std::string | convertToLowerCase (const std::string &fileName) |
OSGDB_EXPORT char | getNativePathSeparator () |
Get the path separator for the current platform. | |
OSGDB_EXPORT bool | isFileNameNativeStyle (const std::string &fileName) |
Check if the path contains only the current platform's path separators. | |
OSGDB_EXPORT std::string | convertFileNameToNativeStyle (const std::string &fileName) |
Convert the path to contain only the current platform's path separators. | |
OSGDB_EXPORT bool | equalCaseInsensitive (const std::string &lhs, const std::string &rhs) |
OSGDB_EXPORT bool | equalCaseInsensitive (const std::string &lhs, const char *rhs) |
OSGDB_EXPORT bool | containsServerAddress (const std::string &filename) |
OSGDB_EXPORT std::string | getServerProtocol (const std::string &filename) |
OSGDB_EXPORT std::string | getServerAddress (const std::string &filename) |
OSGDB_EXPORT std::string | getServerFileName (const std::string &filename) |
OSGDB_EXPORT std::string | concatPaths (const std::string &left, const std::string &right) |
Concatenates two paths. | |
OSGDB_EXPORT std::string | getRealPath (const std::string &path) |
Removes . | |
OSGDB_EXPORT void | getPathElements (const std::string &path, std::vector< std::string > &out_elements) |
Splits a path into elements between separators (including Windows' root, if any). | |
OSGDB_EXPORT void | stringcopy (char *dest, const char *src, size_t length) |
OSGDB_EXPORT FILE * | fopen (const char *filename, const char *mode) |
Overload of the standard fopen function. | |
OSGDB_EXPORT bool | makeDirectory (const std::string &directoryPath) |
Make a new directory. | |
OSGDB_EXPORT bool | makeDirectoryForFile (const std::string &filePath) |
Make a new directory for a given file. | |
OSGDB_EXPORT std::string | getCurrentWorkingDirectory (void) |
Get current working directory. | |
OSGDB_EXPORT bool | setCurrentWorkingDirectory (const std::string &newCurrentWorkingDirectory) |
Set current working directory. | |
OSGDB_EXPORT bool | fileExists (const std::string &filename) |
return true if a file exists. | |
OSGDB_EXPORT FileType | fileType (const std::string &filename) |
return type of file. | |
OSGDB_EXPORT std::string | findFileInPath (const std::string &filename, const FilePathList &filePath, CaseSensitivity caseSensitivity=CASE_SENSITIVE) |
find specified file in specified file path. | |
OSGDB_EXPORT std::string | findFileInDirectory (const std::string &fileName, const std::string &dirName, CaseSensitivity caseSensitivity=CASE_SENSITIVE) |
return the directory/filename of a file if its is contained within specified directory. | |
OSGDB_EXPORT DirectoryContents | getDirectoryContents (const std::string &dirName) |
Return the contents of a directory. | |
OSGDB_EXPORT DirectoryContents | getSortedDirectoryContents (const std::string &dirName) |
Return the contents of a directory, sorting the names into alphabetic and numberical order. | |
OSGDB_EXPORT DirectoryContents | expandWildcardsInFilename (const std::string &filename) |
Return the list of filenames that match the given filename with wildcards. | |
OSGDB_EXPORT CopyFileResult | copyFile (const std::string &source, const std::string &destination) |
Copy a file to another location, overwriting if necessary. | |
void | setDataFilePathList (const FilePathList &filepath) |
void | setDataFilePathList (const std::string &paths) |
FilePathList & | getDataFilePathList () |
OSGDB_EXPORT std::string | findDataFile (const std::string &filename, CaseSensitivity caseSensitivity=CASE_SENSITIVE) |
Search for specified file in file system, checking the DataFilePathList for possible paths, returning the full path of the first valid file found, return an empty string if no string is found. | |
OSGDB_EXPORT std::string | findDataFile (const std::string &filename, const Options *options, CaseSensitivity caseSensitivity=CASE_SENSITIVE) |
Search for specified file in file system, checking first the database path set in the Options structure, then the DataFilePathList for possible paths, returning the full path of the first valid file found, return an empty string if no string is found. | |
void | setLibraryFilePathList (const FilePathList &filepaths) |
void | setLibraryFilePathList (const std::string &paths) |
FilePathList & | getLibraryFilePathList () |
OSGDB_EXPORT std::string | findLibraryFile (const std::string &filename, CaseSensitivity caseSensitivity=CASE_SENSITIVE) |
OSGDB_EXPORT void | convertStringPathIntoFilePathList (const std::string &paths, FilePathList &filepath) |
convert a string containing a list of paths delimited either with ';' (Windows) or ':' (All other platforms) into FilePath representation. | |
OSGDB_EXPORT bool | containsCurrentWorkingDirectoryReference (const FilePathList &paths) |
Return true if FilePathList contains a filepath that is significies checking of the current working directory. | |
OSGDB_EXPORT void | appendPlatformSpecificLibraryFilePaths (FilePathList &filepath) |
OSGDB_EXPORT void | appendPlatformSpecificResourceFilePaths (FilePathList &filepath) |
void OSGDB_EXPORT | open (std::fstream &fs, const char *filename, std::ios_base::openmode mode) |
Convenience function for fstream open , std::ifstream, and std::ofstream to automatically handle UTF-8 to UTF-16 filename conversion. | |
template<class Iterator> | |
void | writeArray (Output &fw, Iterator first, Iterator last, int noItemsPerLine=0) |
template<class Iterator> | |
void | writeArrayAsInts (Output &fw, Iterator first, Iterator last, int noItemsPerLine=0) |
FileNameList OSGDB_EXPORT | listAllAvailablePlugins () |
bool OSGDB_EXPORT | queryPlugin (const std::string &fileName, ReaderWriterInfoList &infoList) |
bool OSGDB_EXPORT | outputPluginDetails (std::ostream &out, const std::string &fileName) |
OSGDB_EXPORT osg::ref_ptr< osg::Object > | readRefObjectFile (const std::string &filename, const Options *options) |
Read an osg::Object from file. | |
osg::ref_ptr< osg::Object > | readRefObjectFile (const std::string &filename) |
Read an osg::Object from file. | |
template<class T> | |
osg::ref_ptr< T > | readRefFile (const std::string &filename, const Options *options) |
template<class T> | |
osg::ref_ptr< T > | readRefFile (const std::string &filename) |
OSGDB_EXPORT osg::ref_ptr< osg::Image > | readRefImageFile (const std::string &filename, const Options *options) |
Read an osg::Image from file. | |
osg::ref_ptr< osg::Image > | readRefImageFile (const std::string &filename) |
Read an osg::Image from file. | |
OSGDB_EXPORT osg::ref_ptr< osg::HeightField > | readRefHeightFieldFile (const std::string &filename, const Options *options) |
Read an osg::HeightField from file. | |
osg::ref_ptr< osg::HeightField > | readRefHeightFieldFile (const std::string &filename) |
Read an osg::HeightField from file. | |
OSGDB_EXPORT osg::ref_ptr< osg::Node > | readRefNodeFile (const std::string &filename, const Options *options) |
Read an osg::Node from file. | |
osg::ref_ptr< osg::Node > | readRefNodeFile (const std::string &filename) |
Read an osg::Node from file. | |
OSGDB_EXPORT osg::ref_ptr< osg::Node > | readRefNodeFiles (std::vector< std::string > &fileList, const Options *options) |
Read an osg::Node subgraph from files, creating a osg::Group to contain the nodes if more than one subgraph has been loaded. | |
osg::ref_ptr< osg::Node > | readRefNodeFiles (std::vector< std::string > &fileList) |
Read an osg::Node subgraph from files, creating a osg::Group to contain the nodes if more than one subgraph has been loaded. | |
OSGDB_EXPORT osg::ref_ptr< osg::Node > | readRefNodeFiles (osg::ArgumentParser &parser, const Options *options) |
Read an osg::Node subgraph from files, creating a osg::Group to contain the nodes if more than one subgraph has been loaded. | |
osg::ref_ptr< osg::Node > | readRefNodeFiles (osg::ArgumentParser &parser) |
Read an osg::Node subgraph from files, creating a osg::Group to contain the nodes if more than one subgraph has been loaded. | |
OSGDB_EXPORT osg::ref_ptr< osg::Shader > | readRefShaderFile (const std::string &filename, const Options *options) |
Read an osg::Shader from file. | |
osg::ref_ptr< osg::Shader > | readRefShaderFile (const std::string &filename) |
Read an osg::Shader from file. | |
osg::ref_ptr< osg::Shader > | readRefShaderFile (osg::Shader::Type type, const std::string &filename, const Options *options) |
Read an osg::Shader from file and set to specified shader type. | |
osg::ref_ptr< osg::Shader > | readRefShaderFile (osg::Shader::Type type, const std::string &filename) |
Read an osg::Shader from file and set to specified shader type Return valid osg::Shader on success, return NULL on failure. | |
OSGDB_EXPORT osg::ref_ptr< osg::Shader > | readRefShaderFileWithFallback (osg::Shader::Type type, const std::string &filename, const Options *options, const char *fallback) |
Read an osg::Shader from file and set to specified shader type, if a shader isn't loaded fallback to specific shader source. | |
osg::ref_ptr< osg::Shader > | readRefShaderFileWithFallback (osg::Shader::Type type, const std::string &filename, const char *fallback) |
Read an osg::Shader from file and set to specified shader type, if a shader isn't loaded fallback to specific shader source. | |
OSGDB_EXPORT osg::ref_ptr< osg::Script > | readRefScriptFile (const std::string &filename, const Options *options) |
Read an osg::Script from file. | |
osg::ref_ptr< osg::Script > | readRefScriptFile (const std::string &filename) |
Read an osg::Script from file. | |
void | readCommandLine (osg::ArgumentParser &parser) |
read the command line arguments. | |
OSGDB_EXPORT void | split (const std::string &src, StringList &list, char separator=' ') |
OSGDB_EXPORT bool | writeObjectFile (const osg::Object &object, const std::string &filename, const Options *options) |
Write an osg::Object to file. | |
bool | writeObjectFile (const osg::Object &object, const std::string &filename) |
Write an osg::Object to file. | |
OSGDB_EXPORT bool | writeImageFile (const osg::Image &image, const std::string &filename, const Options *options) |
Write an osg::Image to file. | |
bool | writeImageFile (const osg::Image &image, const std::string &filename) |
Write an osg::Image to file. | |
OSGDB_EXPORT bool | writeHeightFieldFile (const osg::HeightField &hf, const std::string &filename, const Options *options) |
Write an osg::HeightField to file. | |
bool | writeHeightFieldFile (const osg::HeightField &hf, const std::string &filename) |
Write an osg::HeightField to file. | |
OSGDB_EXPORT bool | writeNodeFile (const osg::Node &node, const std::string &filename, const Options *options) |
Write an osg::Node to file. | |
bool | writeNodeFile (const osg::Node &node, const std::string &filename) |
Write an osg::Node to file. | |
OSGDB_EXPORT bool | writeShaderFile (const osg::Shader &shader, const std::string &filename, const Options *options) |
Write an osg::Shader to file. | |
bool | writeShaderFile (const osg::Shader &shader, const std::string &filename) |
Write an osg::Shader to file. | |
OSGDB_EXPORT bool | writeScriptFile (const osg::Script &image, const std::string &filename, const Options *options) |
Write an osg::Script to file. | |
bool | writeScriptFile (const osg::Script &image, const std::string &filename) |
Write an osg::Script to file. | |
OSGDB_EXPORT XmlNode * | readXmlFile (const std::string &filename, const Options *options) |
read an Xml file, find the file in Options DataFilePathList. | |
XmlNode * | readXmlFile (const std::string &filename) |
read an Xml file, find the file in osgDB::Registry's eaderWriter::Options DataFilePathList. | |
OSGDB_EXPORT XmlNode * | readXmlStream (std::istream &fin) |
read an Xml from from an istream. | |
OSGDB_EXPORT std::string | trimEnclosingSpaces (const std::string &str) |
Variables | |
const int | BUFFERSIZE = 8192 |
const unsigned int | PLUGIN_VERSION = 2 |
const int | BOOL_SIZE = 1 |
const int | CHAR_SIZE = 1 |
const int | SHORT_SIZE = 2 |
const int | INT_SIZE = 4 |
const int | LONG_SIZE = 4 |
const int | INT64_SIZE = 8 |
const int | FLOAT_SIZE = 4 |
const int | DOUBLE_SIZE = 8 |
const int | GLENUM_SIZE = 4 |
const int | ID_BYTE_ARRAY = 0 |
const int | ID_UBYTE_ARRAY = 1 |
const int | ID_SHORT_ARRAY = 2 |
const int | ID_USHORT_ARRAY = 3 |
const int | ID_INT_ARRAY = 4 |
const int | ID_UINT_ARRAY = 5 |
const int | ID_FLOAT_ARRAY = 6 |
const int | ID_DOUBLE_ARRAY = 7 |
const int | ID_VEC2B_ARRAY = 8 |
const int | ID_VEC3B_ARRAY = 9 |
const int | ID_VEC4B_ARRAY = 10 |
const int | ID_VEC4UB_ARRAY = 11 |
const int | ID_VEC2S_ARRAY = 12 |
const int | ID_VEC3S_ARRAY = 13 |
const int | ID_VEC4S_ARRAY = 14 |
const int | ID_VEC2_ARRAY = 15 |
const int | ID_VEC3_ARRAY = 16 |
const int | ID_VEC4_ARRAY = 17 |
const int | ID_VEC2D_ARRAY = 18 |
const int | ID_VEC3D_ARRAY = 19 |
const int | ID_VEC4D_ARRAY = 20 |
const int | ID_VEC2UB_ARRAY = 21 |
const int | ID_VEC3UB_ARRAY = 22 |
const int | ID_VEC2US_ARRAY = 23 |
const int | ID_VEC3US_ARRAY = 24 |
const int | ID_VEC4US_ARRAY = 25 |
const int | ID_VEC2I_ARRAY = 26 |
const int | ID_VEC3I_ARRAY = 27 |
const int | ID_VEC4I_ARRAY = 28 |
const int | ID_VEC2UI_ARRAY = 29 |
const int | ID_VEC3UI_ARRAY = 30 |
const int | ID_VEC4UI_ARRAY = 31 |
const int | ID_UINT64_ARRAY = 32 |
const int | ID_INT64_ARRAY = 33 |
const int | ID_DRAWARRAYS = 50 |
const int | ID_DRAWARRAY_LENGTH = 51 |
const int | ID_DRAWELEMENTS_UBYTE = 52 |
const int | ID_DRAWELEMENTS_USHORT = 53 |
const int | ID_DRAWELEMENTS_UINT = 54 |
const int | INDENT_VALUE = 2 |
const int | IMAGE_INLINE_DATA = 0 |
const int | IMAGE_INLINE_FILE = 1 |
const int | IMAGE_EXTERNAL = 2 |
const int | IMAGE_WRITE_OUT = 3 |
const char | UNIX_PATH_SEPARATOR = '/' |
const char | WINDOWS_PATH_SEPARATOR = '\\' |
The osgDB library provides support for reading and writing scene graphs, providing a plugin framework and file utility classes.
The plugin framework in centered around the osgDB::Registry, and allows plugins which provide specific file format support to be dynamically loaded on demand.
typedef std::vector<std::string> osgDB::DirectoryContents |
simple list of names to represent a directory's contents.
typedef std::list<std::string> osgDB::FileNameList |
typedef std::deque< std::string > osgDB::FilePathList |
list of directories to search through which searching for files.
List of directories to search through which searching for files.
typedef osg::Object* osgDB::ObjectPtr |
typedef std::list< osg::ref_ptr<ReaderWriterInfo> > osgDB::ReaderWriterInfoList |
typedef std::vector<std::string> osgDB::StringList |
enum osgDB::FileType |
|
extern |
References OSGDB_EXPORT.
|
extern |
References OSGDB_EXPORT.
|
inline |
References osgDB::base64_decodestate::plainchar, osgDB::base64_decodestate::step, and step_a.
Referenced by osgDB::Base64decoder::Base64decoder().
|
inline |
References osgDB::base64_encodestate::result, osgDB::base64_encodestate::step, step_A, and osgDB::base64_encodestate::stepcount.
Referenced by osgDB::Base64encoder::Base64encoder().
|
extern |
Concatenates two paths.
References OSGDB_EXPORT.
|
extern |
Return true if FilePathList contains a filepath that is significies checking of the current working directory.
References OSGDB_EXPORT.
|
extern |
References OSGDB_EXPORT.
|
extern |
Convert the path to contain only the current platform's path separators.
References OSGDB_EXPORT.
|
extern |
Converts back slashes () to forward slashes (/).
References OSGDB_EXPORT.
|
extern |
Converts forward slashes (/) to back slashes ().
References OSGDB_EXPORT.
|
extern |
References OSGDB_EXPORT.
|
extern |
References OSGDB_EXPORT.
|
extern |
References OSGDB_EXPORT.
|
extern |
References OSGDB_EXPORT.
|
extern |
References OSGDB_EXPORT.
|
extern |
References OSGDB_EXPORT.
|
extern |
convert a string containing a list of paths delimited either with ';' (Windows) or ':' (All other platforms) into FilePath representation.
References OSGDB_EXPORT.
|
extern |
References OSGDB_EXPORT.
|
extern |
References OSGDB_EXPORT.
|
extern |
References OSGDB_EXPORT.
|
extern |
References OSGDB_EXPORT.
|
extern |
References OSGDB_EXPORT.
|
extern |
References OSGDB_EXPORT.
|
extern |
References OSGDB_EXPORT.
|
extern |
Copy a file to another location, overwriting if necessary.
You must provide full path for both source and destination.
References OSGDB_EXPORT.
|
extern |
References OSGDB_EXPORT.
|
extern |
References OSGDB_EXPORT.
|
extern |
Return the list of filenames that match the given filename with wildcards.
Will only expand '*', and will not expand wildcards in directory, only in filename part of the given filename. Return value will contain path+filename so that if ever the above limitation (expanding wildcards in directory) is fixed, client code will still work unchanged.
References OSGDB_EXPORT.
|
extern |
return true if a file exists.
References OSGDB_EXPORT.
|
extern |
return type of file.
References OSGDB_EXPORT.
|
extern |
Search for specified file in file system, checking the DataFilePathList for possible paths, returning the full path of the first valid file found, return an empty string if no string is found.
References CASE_SENSITIVE, and OSGDB_EXPORT.
|
extern |
Search for specified file in file system, checking first the database path set in the Options structure, then the DataFilePathList for possible paths, returning the full path of the first valid file found, return an empty string if no string is found.
References CASE_SENSITIVE, and OSGDB_EXPORT.
|
extern |
return the directory/filename of a file if its is contained within specified directory.
return "" if directory does not contain file. If caseInsensitive is set to true then a case insensitive comparison is used to compare fileName to directory contents. This is useful when unix programs attempt read case insensitive windows filenames.
References CASE_SENSITIVE, and OSGDB_EXPORT.
|
extern |
find specified file in specified file path.
References CASE_SENSITIVE, and OSGDB_EXPORT.
|
extern |
References CASE_SENSITIVE, and OSGDB_EXPORT.
|
extern |
Overload of the standard fopen function.
If OSG_USE_UTF8_FILENAME is defined, filename will be expanded from UTF8 to UTF16 and _wfopen will be called.
References OSGDB_EXPORT.
|
extern |
Get current working directory.
References OSGDB_EXPORT.
|
inline |
References osgDB::Registry::getDataFilePathList(), and osgDB::Registry::instance().
|
extern |
Return the contents of a directory.
Return value will contain filenames only, not absolute paths. Returns an empty array on any error.
References OSGDB_EXPORT.
|
extern |
Gets the extension without dot (Ex: /a/b/c.Ext => Ext).
References OSGDB_EXPORT.
|
extern |
Gets the extension including dot (Ex: /a/b/c.Ext => .Ext).
References OSGDB_EXPORT.
|
extern |
Gets the parent path from full name (Ex: /a/b/c.Ext => /a/b).
References OSGDB_EXPORT.
|
inline |
References osgDB::Registry::getLibraryFilePathList(), and osgDB::Registry::instance().
|
extern |
Gets the lowercase extension without dot (Ex: /a/b/c.Ext => ext).
References OSGDB_EXPORT.
|
extern |
Gets file path without all extensions (Ex: /a/b/c.Ext => /a/b/c ; file.ext1.ext2 => file).
References OSGDB_EXPORT.
|
extern |
Gets file path without last extension (Ex: /a/b/c.Ext => /a/b/c ; file.ext1.ext2 => file.ext1).
References OSGDB_EXPORT.
|
extern |
Get the path separator for the current platform.
References OSGDB_EXPORT.
|
extern |
Splits a path into elements between separators (including Windows' root, if any).
References OSGDB_EXPORT.
|
extern |
If 'to' is in a subdirectory of 'from' then this function returns the subpath, otherwise it just returns the file name.
The function does not automagically resolve paths as the system does, so be careful to give canonical paths. However, the function interprets slashes ('/') and backslashes ('\') as they were equal.
References OSGDB_EXPORT.
|
extern |
Gets root part of a path ("/" or "C:"), or an empty string if none found.
References OSGDB_EXPORT.
|
extern |
|
extern |
References OSGDB_EXPORT.
|
extern |
References OSGDB_EXPORT.
|
extern |
References OSGDB_EXPORT.
|
extern |
Gets file name with extension (Ex: /a/b/c.Ext => c.Ext).
References OSGDB_EXPORT.
|
extern |
Return the contents of a directory, sorting the names into alphabetic and numberical order.
Return value will contain filenames only, not absolute paths. Returns an empty array on any error.
References OSGDB_EXPORT.
|
extern |
Gets file name without last extension (Ex: /a/b/c.Ext => c ; file.ext1.ext2 => file.ext1).
References OSGDB_EXPORT.
|
extern |
References OSGDB_EXPORT.
|
extern |
References OSGDB_EXPORT.
|
extern |
References OSGDB_EXPORT.
|
extern |
References OSGDB_EXPORT.
|
extern |
Tests if path is absolute, as !getPathRoot(path).empty().
References OSGDB_EXPORT.
|
extern |
Check if the path contains only the current platform's path separators.
References OSGDB_EXPORT.
FileNameList OSGDB_EXPORT osgDB::listAllAvailablePlugins | ( | ) |
References OSGDB_EXPORT.
|
extern |
|
extern |
Make a new directory for a given file.
References OSGDB_EXPORT.
void OSGDB_EXPORT osgDB::open | ( | std::fstream & | fs, |
const char * | filename, | ||
std::ios_base::openmode | mode ) |
Convenience function for fstream open , std::ifstream, and std::ofstream to automatically handle UTF-8 to UTF-16 filename conversion.
Always use one of these classes in any OpenSceneGraph code instead of the STL equivalent.
References OSGDB_EXPORT.
OSGDB_EXPORT Archive * osgDB::openArchive | ( | const std::string & | filename, |
ReaderWriter::ArchiveStatus | status, | ||
unsigned int | indexBlockSizeHint, | ||
Options * | options ) |
Open an archive for reading or writing.
References OSGDB_EXPORT.
OSGDB_EXPORT Archive * osgDB::openArchive | ( | const std::string & | filename, |
ReaderWriter::ArchiveStatus | status, | ||
unsigned int | indexBlockSizeHint = 4096 ) |
Open an archive for reading or writing.
References OSGDB_EXPORT.
bool OSGDB_EXPORT osgDB::outputPluginDetails | ( | std::ostream & | out, |
const std::string & | fileName ) |
References OSGDB_EXPORT.
bool OSGDB_EXPORT osgDB::queryPlugin | ( | const std::string & | fileName, |
ReaderWriterInfoList & | infoList ) |
References OSGDB_EXPORT.
|
inline |
read the command line arguments.
References osgDB::Registry::instance(), and osgDB::Registry::readCommandLine().
|
inline |
References osgDB::Registry::instance(), and readRefFile().
|
inline |
References readRefObjectFile().
Referenced by readRefFile().
|
inline |
Read an osg::HeightField from file.
Return an assigned osg::ref_ptr on success, return an osg::ref_ptr with a NULL pointer assigned to it on failure. The osgDB::Registry is used to load the appropriate ReaderWriter plugin for the filename extension, and this plugin then handles the request to read the specified file.
References osgDB::Registry::instance(), and readRefHeightFieldFile().
|
extern |
Read an osg::HeightField from file.
Return an assigned osg::ref_ptr on success, return an osg::ref_ptr with a NULL pointer assigned to it on failure. Use the Options object to control cache operations and file search paths in osgDB::Registry. The osgDB::Registry is used to load the appropriate ReaderWriter plugin for the filename extension, and this plugin then handles the request to read the specified file.
References OSGDB_EXPORT.
Referenced by readRefHeightFieldFile().
|
inline |
Read an osg::Image from file.
Return an assigned osg::ref_ptr on success, return an osg::ref_ptr with a NULL pointer assigned to it on failure. The osgDB::Registry is used to load the appropriate ReaderWriter plugin for the filename extension, and this plugin then handles the request to read the specified file.
References osgDB::Registry::instance(), and readRefImageFile().
|
extern |
Read an osg::Image from file.
Return an assigned osg::ref_ptr on success, return an osg::ref_ptr with a NULL pointer assigned to it on failure. Use the Options object to control cache operations and file search paths in osgDB::Registry. The osgDB::Registry is used to load the appropriate ReaderWriter plugin for the filename extension, and this plugin then handles the request to read the specified file.
References OSGDB_EXPORT.
Referenced by readRefImageFile().
|
inline |
Read an osg::Node from file.
Return an assigned osg::ref_ptr on success, return an osg::ref_ptr with a NULL pointer assigned to it on failure. The osgDB::Registry is used to load the appropriate ReaderWriter plugin for the filename extension, and this plugin then handles the request to read the specified file.
References osgDB::Registry::instance(), and readRefNodeFile().
|
extern |
Read an osg::Node from file.
Return an assigned osg::ref_ptr on success, return an osg::ref_ptr with a NULL pointer assigned to it on failure. Use the Options object to control cache operations and file search paths in osgDB::Registry. The osgDB::Registry is used to load the appropriate ReaderWriter plugin for the filename extension, and this plugin then handles the request to read the specified file.
References OSGDB_EXPORT.
Referenced by readRefNodeFile().
|
inline |
Read an osg::Node subgraph from files, creating a osg::Group to contain the nodes if more than one subgraph has been loaded.
References osgDB::Registry::instance(), and readRefNodeFiles().
|
extern |
Read an osg::Node subgraph from files, creating a osg::Group to contain the nodes if more than one subgraph has been loaded.
Use the Options object to control cache operations and file search paths in osgDB::Registry.
References OSGDB_EXPORT.
|
inline |
Read an osg::Node subgraph from files, creating a osg::Group to contain the nodes if more than one subgraph has been loaded.
References osgDB::Registry::instance(), and readRefNodeFiles().
|
extern |
Read an osg::Node subgraph from files, creating a osg::Group to contain the nodes if more than one subgraph has been loaded.
Use the Options object to control cache operations and file search paths in osgDB::Registry. Does NOT ignore strings beginning with a dash '-' character.
References OSGDB_EXPORT.
Referenced by readRefNodeFiles(), and readRefNodeFiles().
|
inline |
Read an osg::Object from file.
Return an assigned osg::ref_ptr on success, return an osg::ref_ptr with a NULL pointer assigned to it on failure. The osgDB::Registry is used to load the appropriate ReaderWriter plugin for the filename extension, and this plugin then handles the request to read the specified file.
References osgDB::Registry::instance(), and readRefObjectFile().
|
extern |
Read an osg::Object from file.
Return an assigned osg::ref_ptr on success, return an osg::ref_ptr with a NULL pointer assigned to it on failure. Use the Options object to control cache operations and file search paths in osgDB::Registry. The osgDB::Registry is used to load the appropriate ReaderWriter plugin for the filename extension, and this plugin then handles the request to read the specified file.
References OSGDB_EXPORT.
Referenced by readRefFile(), and readRefObjectFile().
|
inline |
Read an osg::Script from file.
Return an assigned osg::ref_ptr on success, return an osg::ref_ptr with a NULL pointer assigned to it on failure. The osgDB::Registry is used to load the appropriate ReaderWriter plugin for the filename extension, and this plugin then handles the request to read the specified file.
References osgDB::Registry::instance(), and readRefScriptFile().
|
extern |
Read an osg::Script from file.
Return an assigned osg::ref_ptr on success, return an osg::ref_ptr with a NULL pointer assigned to it on failure. Use the Options object to control cache operations and file search paths in osgDB::Registry. The osgDB::Registry is used to load the appropriate ReaderWriter plugin for the filename extension, and this plugin then handles the request to read the specified file.
References OSGDB_EXPORT.
Referenced by readRefScriptFile().
|
inline |
Read an osg::Shader from file.
Return an assigned osg::ref_ptr on success, return an osg::ref_ptr with a NULL pointer assigned to it on failure. The osgDB::Registry is used to load the appropriate ReaderWriter plugin for the filename extension, and this plugin then handles the request to read the specified file.
References osgDB::Registry::instance(), and readRefShaderFile().
|
extern |
Read an osg::Shader from file.
Return an assigned osg::ref_ptr on success, return an osg::ref_ptr with a NULL pointer assigned to it on failure. Use the Options object to control cache operations and file search paths in osgDB::Registry. The osgDB::Registry is used to load the appropriate ReaderWriter plugin for the filename extension, and this plugin then handles the request to read the specified file.
References OSGDB_EXPORT.
Referenced by readRefShaderFile(), readRefShaderFile(), and readRefShaderFile().
|
inline |
Read an osg::Shader from file and set to specified shader type Return valid osg::Shader on success, return NULL on failure.
The osgDB::Registry is used to load the appropriate ReaderWriter plugin for the filename extension, and this plugin then handles the request to read the specified file.
References osgDB::Registry::instance(), and readRefShaderFile().
|
inline |
Read an osg::Shader from file and set to specified shader type.
Return valid osg::Shader on success, return NULL on failure. Use the Options object to control cache operations and file search paths in osgDB::Registry. The osgDB::Registry is used to load the appropriate ReaderWriter plugin for the filename extension, and this plugin then handles the request to read the specified file.
References readRefShaderFile(), osg::Shader::UNDEFINED, and osg::ref_ptr< T >::valid().
|
inline |
Read an osg::Shader from file and set to specified shader type, if a shader isn't loaded fallback to specific shader source.
The osgDB::Registry is used to load the appropriate ReaderWriter plugin for the filename extension, and this plugin then handles the request to read the specified file.
References osgDB::Registry::instance(), and readRefShaderFileWithFallback().
|
extern |
Read an osg::Shader from file and set to specified shader type, if a shader isn't loaded fallback to specific shader source.
Use the Options object to control cache operations and file search paths in osgDB::Registry. The osgDB::Registry is used to load the appropriate ReaderWriter plugin for the filename extension, and this plugin then handles the request to read the specified file.
References OSGDB_EXPORT.
Referenced by readRefShaderFileWithFallback().
|
inline |
read an Xml file, find the file in osgDB::Registry's eaderWriter::Options DataFilePathList.
References osgDB::Registry::instance(), and readXmlFile().
|
extern |
read an Xml file, find the file in Options DataFilePathList.
References OSGDB_EXPORT.
Referenced by readXmlFile().
|
extern |
read an Xml from from an istream.
References OSGDB_EXPORT.
|
extern |
Set current working directory.
References OSGDB_EXPORT.
|
inline |
References osgDB::Registry::instance(), and osgDB::Registry::setDataFilePathList().
|
inline |
References osgDB::Registry::instance(), and osgDB::Registry::setDataFilePathList().
|
inline |
References osgDB::Registry::instance(), and osgDB::Registry::setLibraryFilePathList().
|
inline |
References osgDB::Registry::instance(), and osgDB::Registry::setLibraryFilePathList().
|
extern |
References OSGDB_EXPORT.
Referenced by osgDB::BitFlagsSerializer< C, P >::read().
|
extern |
References OSGDB_EXPORT.
|
extern |
References OSGDB_EXPORT.
Referenced by osgDB::XmlNode::getTrimmedContents().
void osgDB::writeArray | ( | Output & | fw, |
Iterator | first, | ||
Iterator | last, | ||
int | noItemsPerLine = 0 ) |
void osgDB::writeArrayAsInts | ( | Output & | fw, |
Iterator | first, | ||
Iterator | last, | ||
int | noItemsPerLine = 0 ) |
|
inline |
Write an osg::HeightField to file.
Return true on success, return false on failure. The osgDB::Registry is used to load the appropriate ReaderWriter plugin for the filename extension, and this plugin then handles the request to write the specified file.
References osgDB::Registry::instance(), and writeHeightFieldFile().
|
extern |
Write an osg::HeightField to file.
Return true on success, return false on failure. Use the Options object to control cache operations and file search paths in osgDB::Registry. The osgDB::Registry is used to load the appropriate ReaderWriter plugin for the filename extension, and this plugin then handles the request to write the specified file.
References OSGDB_EXPORT.
Referenced by writeHeightFieldFile().
|
inline |
Write an osg::Image to file.
Return true on success, return false on failure. The osgDB::Registry is used to load the appropriate ReaderWriter plugin for the filename extension, and this plugin then handles the request to write the specified file.
References osgDB::Registry::instance(), and writeImageFile().
|
extern |
Write an osg::Image to file.
Return true on success, return false on failure. Use the Options object to control cache operations and file search paths in osgDB::Registry. The osgDB::Registry is used to load the appropriate ReaderWriter plugin for the filename extension, and this plugin then handles the request to write the specified file.
References OSGDB_EXPORT.
Referenced by writeImageFile().
|
inline |
Write an osg::Node to file.
Return true on success, return false on failure. The osgDB::Registry is used to load the appropriate ReaderWriter plugin for the filename extension, and this plugin then handles the request to write the specified file.
References osgDB::Registry::instance(), and writeNodeFile().
|
extern |
Write an osg::Node to file.
Return true on success, return false on failure. Use the Options object to control cache operations and file search paths in osgDB::Registry. The osgDB::Registry is used to load the appropriate ReaderWriter plugin for the filename extension, and this plugin then handles the request to write the specified file.
References OSGDB_EXPORT.
Referenced by writeNodeFile().
|
inline |
Write an osg::Object to file.
Return true on success, return false on failure. The osgDB::Registry is used to load the appropriate ReaderWriter plugin for the filename extension, and this plugin then handles the request to write the specified file.
References osgDB::Registry::instance(), and writeObjectFile().
|
extern |
Write an osg::Object to file.
Return true on success, return false on failure. Use the Options object to control cache operations and file search paths in osgDB::Registry. The osgDB::Registry is used to load the appropriate ReaderWriter plugin for the filename extension, and this plugin then handles the request to write the specified file.
References OSGDB_EXPORT.
Referenced by writeObjectFile().
|
inline |
Write an osg::Script to file.
Return true on success, return false on failure. The osgDB::Registry is used to load the appropriate ReaderWriter plugin for the filename extension, and this plugin then handles the request to write the specified file.
References osgDB::Registry::instance(), and writeScriptFile().
|
extern |
Write an osg::Script to file.
Return true on success, return false on failure. Use the Options object to control cache operations and file search paths in osgDB::Registry. The osgDB::Registry is used to load the appropriate ReaderWriter plugin for the filename extension, and this plugin then handles the request to write the specified file.
References OSGDB_EXPORT.
Referenced by writeScriptFile().
|
inline |
Write an osg::Shader to file.
Return true on success, return false on failure. The osgDB::Registry is used to load the appropriate ReaderWriter plugin for the filename extension, and this plugin then handles the request to write the specified file.
References osgDB::Registry::instance(), and writeShaderFile().
|
extern |
Write an osg::Shader to file.
Return true on success, return false on failure. Use the Options object to control cache operations and file search paths in osgDB::Registry. The osgDB::Registry is used to load the appropriate ReaderWriter plugin for the filename extension, and this plugin then handles the request to write the specified file.
References OSGDB_EXPORT.
Referenced by writeShaderFile().
const int osgDB::BOOL_SIZE = 1 |
const int osgDB::BUFFERSIZE = 8192 |
Referenced by osgDB::Base64decoder::Base64decoder(), and osgDB::Base64encoder::Base64encoder().
const int osgDB::CHAR_SIZE = 1 |
const int osgDB::DOUBLE_SIZE = 8 |
const int osgDB::FLOAT_SIZE = 4 |
const int osgDB::GLENUM_SIZE = 4 |
const int osgDB::ID_BYTE_ARRAY = 0 |
const int osgDB::ID_DOUBLE_ARRAY = 7 |
const int osgDB::ID_DRAWARRAY_LENGTH = 51 |
const int osgDB::ID_DRAWARRAYS = 50 |
const int osgDB::ID_DRAWELEMENTS_UBYTE = 52 |
const int osgDB::ID_DRAWELEMENTS_UINT = 54 |
const int osgDB::ID_DRAWELEMENTS_USHORT = 53 |
const int osgDB::ID_FLOAT_ARRAY = 6 |
const int osgDB::ID_INT64_ARRAY = 33 |
const int osgDB::ID_INT_ARRAY = 4 |
const int osgDB::ID_SHORT_ARRAY = 2 |
const int osgDB::ID_UBYTE_ARRAY = 1 |
const int osgDB::ID_UINT64_ARRAY = 32 |
const int osgDB::ID_UINT_ARRAY = 5 |
const int osgDB::ID_USHORT_ARRAY = 3 |
const int osgDB::ID_VEC2_ARRAY = 15 |
const int osgDB::ID_VEC2B_ARRAY = 8 |
const int osgDB::ID_VEC2D_ARRAY = 18 |
const int osgDB::ID_VEC2I_ARRAY = 26 |
const int osgDB::ID_VEC2S_ARRAY = 12 |
const int osgDB::ID_VEC2UB_ARRAY = 21 |
const int osgDB::ID_VEC2UI_ARRAY = 29 |
const int osgDB::ID_VEC2US_ARRAY = 23 |
const int osgDB::ID_VEC3_ARRAY = 16 |
const int osgDB::ID_VEC3B_ARRAY = 9 |
const int osgDB::ID_VEC3D_ARRAY = 19 |
const int osgDB::ID_VEC3I_ARRAY = 27 |
const int osgDB::ID_VEC3S_ARRAY = 13 |
const int osgDB::ID_VEC3UB_ARRAY = 22 |
const int osgDB::ID_VEC3UI_ARRAY = 30 |
const int osgDB::ID_VEC3US_ARRAY = 24 |
const int osgDB::ID_VEC4_ARRAY = 17 |
const int osgDB::ID_VEC4B_ARRAY = 10 |
const int osgDB::ID_VEC4D_ARRAY = 20 |
const int osgDB::ID_VEC4I_ARRAY = 28 |
const int osgDB::ID_VEC4S_ARRAY = 14 |
const int osgDB::ID_VEC4UB_ARRAY = 11 |
const int osgDB::ID_VEC4UI_ARRAY = 31 |
const int osgDB::ID_VEC4US_ARRAY = 25 |
const int osgDB::IMAGE_EXTERNAL = 2 |
const int osgDB::IMAGE_INLINE_DATA = 0 |
const int osgDB::IMAGE_INLINE_FILE = 1 |
const int osgDB::IMAGE_WRITE_OUT = 3 |
const int osgDB::INDENT_VALUE = 2 |
const int osgDB::INT64_SIZE = 8 |
const int osgDB::INT_SIZE = 4 |
const int osgDB::LONG_SIZE = 4 |
const unsigned int osgDB::PLUGIN_VERSION = 2 |
const int osgDB::SHORT_SIZE = 2 |
const char osgDB::UNIX_PATH_SEPARATOR = '/' |
const char osgDB::WINDOWS_PATH_SEPARATOR = '\\' |
![]() | Generated at Sun Jul 20 2025 00:00:00 for the OpenSceneGraph by doxygen 1.14.0. |