OSG  3.4.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
osgDB::Output Class Reference

#include <Output.h>

Inheritance diagram for osgDB::Output:
Inheritance graph
[legend]
Collaboration diagram for osgDB::Output:
Collaboration graph
[legend]

Public Types

enum  PathNameHint { AS_IS, FULL_PATH, RELATIVE_PATH, FILENAME_ONLY }
 

Public Member Functions

 Output ()
 
 Output (const char *name)
 
virtual ~Output ()
 
void setOptions (const Options *options)
 
const OptionsgetOptions () const
 
void setWriteOutDefaultValues (bool flag)
 
bool getWriteOutDefaultValues () const
 
void open (const char *name)
 
Outputindent ()
 
std::string wrapString (const char *str)
 
std::string wrapString (const std::string &str)
 
void setIndentStep (int step)
 
int getIndentStep () const
 
void setIndent (int indent)
 
int getIndent () const
 
void setNumIndicesPerLine (int num)
 
int getNumIndicesPerLine () const
 
void moveIn ()
 
void moveOut ()
 
virtual bool writeObject (const osg::Object &obj)
 
virtual void writeBeginObject (const std::string &name)
 
virtual void writeEndObject ()
 
virtual void writeUseID (const std::string &id)
 
virtual void writeUniqueID (const std::string &id)
 
bool getUniqueIDForObject (const osg::Object *obj, std::string &uniqueID)
 
bool createUniqueIDForObject (const osg::Object *obj, std::string &uniqueID)
 
bool registerUniqueIDForObject (const osg::Object *obj, std::string &uniqueID)
 
void setPathNameHint (const PathNameHint pnh)
 
PathNameHint getPathNameHint () const
 
virtual std::string getFileNameForOutput (const std::string &filename) const
 
const std::string & getFileName () const
 
void setOutputTextureFiles (bool flag)
 
bool getOutputTextureFiles () const
 
virtual std::string getTextureFileNameForOutput ()
 
void setOutputShaderFiles (bool flag)
 
bool getOutputShaderFiles () const
 
virtual std::string getShaderFileNameForOutput ()
 
void setExternalFileWritten (const std::string &filename, bool hasBeenWritten=true)
 
bool getExternalFileWritten (const std::string &filename) const
 
- Public Member Functions inherited from osgDB::ofstream
 ofstream ()
 
 ofstream (const char *filename, std::ios_base::openmode mode=std::ios_base::out)
 
 ~ofstream ()
 
void open (const char *filename, std::ios_base::openmode mode=std::ios_base::out)
 

Protected Types

typedef std::map< const
osg::Object *, std::string > 
UniqueIDToLabelMapping
 
typedef std::map< std::string,
bool > 
ExternalFileWrittenMap
 

Protected Member Functions

virtual void init ()
 

Protected Attributes

osg::ref_ptr< const Options_options
 
int _indent
 
int _indentStep
 
int _numIndicesPerLine
 
UniqueIDToLabelMapping _objectToUniqueIDMap
 
std::string _filename
 
PathNameHint _pathNameHint
 
bool _outputTextureFiles
 
unsigned int _textureFileNameNumber
 
bool _outputShaderFiles
 
unsigned int _shaderFileNameNumber
 
bool _writeOutDefaultValues
 
ExternalFileWrittenMap _externalFileWritten
 

Detailed Description

deprecated.

Definition at line 28 of file Output.h.

Member Typedef Documentation

typedef std::map<std::string, bool> osgDB::Output::ExternalFileWrittenMap
protected

Definition at line 135 of file Output.h.

typedef std::map<const osg::Object*,std::string> osgDB::Output::UniqueIDToLabelMapping
protected

Definition at line 120 of file Output.h.

Member Enumeration Documentation

Enumerator
AS_IS 
FULL_PATH 
RELATIVE_PATH 
FILENAME_ONLY 

Definition at line 79 of file Output.h.

Constructor & Destructor Documentation

osgDB::Output::Output ( )
osgDB::Output::Output ( const char *  name)
virtual osgDB::Output::~Output ( )
virtual

Member Function Documentation

bool osgDB::Output::createUniqueIDForObject ( const osg::Object obj,
std::string &  uniqueID 
)
bool osgDB::Output::getExternalFileWritten ( const std::string &  filename) const
const std::string& osgDB::Output::getFileName ( ) const
inline

Definition at line 91 of file Output.h.

virtual std::string osgDB::Output::getFileNameForOutput ( const std::string &  filename) const
virtual
int osgDB::Output::getIndent ( ) const
inline

Definition at line 61 of file Output.h.

int osgDB::Output::getIndentStep ( ) const
inline

Definition at line 58 of file Output.h.

int osgDB::Output::getNumIndicesPerLine ( ) const
inline

Definition at line 64 of file Output.h.

Here is the caller graph for this function:

const Options* osgDB::Output::getOptions ( ) const
inline

Definition at line 39 of file Output.h.

bool osgDB::Output::getOutputShaderFiles ( ) const
inline

Definition at line 101 of file Output.h.

bool osgDB::Output::getOutputTextureFiles ( ) const
inline

Definition at line 95 of file Output.h.

PathNameHint osgDB::Output::getPathNameHint ( ) const
inline

Definition at line 88 of file Output.h.

virtual std::string osgDB::Output::getShaderFileNameForOutput ( )
virtual
virtual std::string osgDB::Output::getTextureFileNameForOutput ( )
virtual
bool osgDB::Output::getUniqueIDForObject ( const osg::Object obj,
std::string &  uniqueID 
)
bool osgDB::Output::getWriteOutDefaultValues ( ) const
inline

Definition at line 42 of file Output.h.

Output& osgDB::Output::indent ( )

Here is the caller graph for this function:

virtual void osgDB::Output::init ( )
protectedvirtual
void osgDB::Output::moveIn ( )

Here is the caller graph for this function:

void osgDB::Output::moveOut ( )

Here is the caller graph for this function:

void osgDB::Output::open ( const char *  name)
bool osgDB::Output::registerUniqueIDForObject ( const osg::Object obj,
std::string &  uniqueID 
)
void osgDB::Output::setExternalFileWritten ( const std::string &  filename,
bool  hasBeenWritten = true 
)
void osgDB::Output::setIndent ( int  indent)
inline

Definition at line 60 of file Output.h.

void osgDB::Output::setIndentStep ( int  step)
inline

Definition at line 57 of file Output.h.

void osgDB::Output::setNumIndicesPerLine ( int  num)
inline

Definition at line 63 of file Output.h.

void osgDB::Output::setOptions ( const Options options)
void osgDB::Output::setOutputShaderFiles ( bool  flag)
inline

Definition at line 100 of file Output.h.

void osgDB::Output::setOutputTextureFiles ( bool  flag)
inline

Definition at line 94 of file Output.h.

void osgDB::Output::setPathNameHint ( const PathNameHint  pnh)
inline

Definition at line 87 of file Output.h.

void osgDB::Output::setWriteOutDefaultValues ( bool  flag)
inline

Definition at line 41 of file Output.h.

std::string osgDB::Output::wrapString ( const char *  str)

wrap a string with "" quotes and use " for any internal quotes.

std::string osgDB::Output::wrapString ( const std::string &  str)

wrap a string with "" quotes and use " for any internal quotes.

virtual void osgDB::Output::writeBeginObject ( const std::string &  name)
virtual
virtual void osgDB::Output::writeEndObject ( )
virtual
virtual bool osgDB::Output::writeObject ( const osg::Object obj)
virtual
virtual void osgDB::Output::writeUniqueID ( const std::string &  id)
virtual
virtual void osgDB::Output::writeUseID ( const std::string &  id)
virtual

Member Data Documentation

ExternalFileWrittenMap osgDB::Output::_externalFileWritten
protected

Definition at line 136 of file Output.h.

std::string osgDB::Output::_filename
protected

Definition at line 123 of file Output.h.

int osgDB::Output::_indent
protected

Definition at line 115 of file Output.h.

int osgDB::Output::_indentStep
protected

Definition at line 116 of file Output.h.

int osgDB::Output::_numIndicesPerLine
protected

Definition at line 118 of file Output.h.

UniqueIDToLabelMapping osgDB::Output::_objectToUniqueIDMap
protected

Definition at line 121 of file Output.h.

osg::ref_ptr<const Options> osgDB::Output::_options
protected

Definition at line 113 of file Output.h.

bool osgDB::Output::_outputShaderFiles
protected

Definition at line 130 of file Output.h.

bool osgDB::Output::_outputTextureFiles
protected

Definition at line 127 of file Output.h.

PathNameHint osgDB::Output::_pathNameHint
protected

Definition at line 125 of file Output.h.

unsigned int osgDB::Output::_shaderFileNameNumber
protected

Definition at line 131 of file Output.h.

unsigned int osgDB::Output::_textureFileNameNumber
protected

Definition at line 128 of file Output.h.

bool osgDB::Output::_writeOutDefaultValues
protected

Definition at line 133 of file Output.h.


The documentation for this class was generated from the following file: