osgDB::OutputStream Class Reference

List of all members.

Public Types
enum	WriteType { WRITE_UNKNOWN = 0, WRITE_SCENE, WRITE_IMAGE, WRITE_OBJECT }
enum	WriteImageHint {   WRITE_USE_IMAGE_HINT = 0, WRITE_USE_EXTERNAL, WRITE_INLINE_DATA, WRITE_INLINE_FILE,   WRITE_EXTERNAL_FILE }
typedef std::map< const osg::Array *, unsigned int >	ArrayMap
typedef std::map< const osg::Object *, unsigned int >	ObjectMap
Public Member Functions
	OutputStream (const osgDB::Options *options)
virtual	~OutputStream ()
bool	isBinary () const
const std::string &	getSchemaName () const
const osgDB::Options *	getOptions () const
void	setWriteImageHint (WriteImageHint hint)
WriteImageHint	getWriteImageHint () const
OutputStream &	operator<< (bool b)
OutputStream &	operator<< (char c)
OutputStream &	operator<< (unsigned char c)
OutputStream &	operator<< (short s)
OutputStream &	operator<< (unsigned short s)
OutputStream &	operator<< (int i)
OutputStream &	operator<< (unsigned int i)
OutputStream &	operator<< (long l)
OutputStream &	operator<< (unsigned long l)
OutputStream &	operator<< (float f)
OutputStream &	operator<< (double d)
OutputStream &	operator<< (const std::string &s)
OutputStream &	operator<< (const char *s)
OutputStream &	operator<< (std::ostream &(*fn)(std::ostream &))
OutputStream &	operator<< (std::ios_base &(*fn)(std::ios_base &))
OutputStream &	operator<< (const ObjectGLenum &value)
OutputStream &	operator<< (const ObjectProperty &prop)
OutputStream &	operator<< (const ObjectMark &mark)
OutputStream &	operator<< (const osg::Vec2b &v)
OutputStream &	operator<< (const osg::Vec3b &v)
OutputStream &	operator<< (const osg::Vec4b &v)
OutputStream &	operator<< (const osg::Vec4ub &v)
OutputStream &	operator<< (const osg::Vec2s &v)
OutputStream &	operator<< (const osg::Vec3s &v)
OutputStream &	operator<< (const osg::Vec4s &v)
OutputStream &	operator<< (const osg::Vec2f &v)
OutputStream &	operator<< (const osg::Vec3f &v)
OutputStream &	operator<< (const osg::Vec4f &v)
OutputStream &	operator<< (const osg::Vec2d &v)
OutputStream &	operator<< (const osg::Vec3d &v)
OutputStream &	operator<< (const osg::Vec4d &v)
OutputStream &	operator<< (const osg::Quat &q)
OutputStream &	operator<< (const osg::Plane &p)
OutputStream &	operator<< (const osg::Matrixf &mat)
OutputStream &	operator<< (const osg::Matrixd &mat)
OutputStream &	operator<< (const osg::Array *a)
OutputStream &	operator<< (const osg::Image *img)
OutputStream &	operator<< (const osg::PrimitiveSet *p)
OutputStream &	operator<< (const osg::Object *obj)
OutputStream &	operator<< (const osg::ref_ptr< osg::Array > &ptr)
OutputStream &	operator<< (const osg::ref_ptr< osg::Image > &ptr)
OutputStream &	operator<< (const osg::ref_ptr< osg::PrimitiveSet > &ptr)
template<typename T >
OutputStream &	operator<< (const osg::ref_ptr< T > &ptr)
void	writeWrappedString (const std::string &str)
void	writeCharArray (const char *s, unsigned int size)
template<typename T >
void	writeSize (T size)
void	writeArray (const osg::Array *a)
void	writePrimitiveSet (const osg::PrimitiveSet *p)
void	writeImage (const osg::Image *img)
void	writeObject (const osg::Object *obj)
void	writeObjectFields (const osg::Object *obj)
void	setOutputIterator (OutputIterator *oi)
	set an output iterator, used directly when not using OutputStream with a traditional file releated stream.
void	start (OutputIterator *outIterator, WriteType type)
	start writing to OutputStream treating it as a traditional file releated stream, handles headers and versioning
void	compress (std::ostream *ostream)
void	writeSchema (std::ostream &fout)
void	throwException (const std::string &msg)
const OutputException *	getException () const
Protected Member Functions
template<typename T >
void	writeArrayImplementation (const T *, int write_size, unsigned int numInRow=1)
unsigned int	findOrCreateArrayID (const osg::Array *array, bool &newID)
unsigned int	findOrCreateObjectID (const osg::Object *obj, bool &newID)
Protected Attributes
ArrayMap	_arrayMap
ObjectMap	_objectMap
WriteImageHint	_writeImageHint
bool	_useSchemaData
std::map< std::string, std::string >	_inbuiltSchemaMap
std::vector< std::string >	_fields
std::string	_schemaName
std::string	_compressorName
std::stringstream	_compressSource
osg::ref_ptr< OutputIterator >	_out
osg::ref_ptr< OutputException >	_exception
osg::ref_ptr< const osgDB::Options >	_options

---

Member Typedef Documentation

typedef std::map<const osg::Array*, unsigned int> osgDB::OutputStream::ArrayMap

typedef std::map<const osg::Object*, unsigned int> osgDB::OutputStream::ObjectMap

---

Member Enumeration Documentation

enum osgDB::OutputStream::WriteImageHint

Enumerator:

WRITE_USE_IMAGE_HINT	Use image hint, write inline data or use external
WRITE_USE_EXTERNAL	Use external file on disk and write only the filename
WRITE_INLINE_DATA	Write Image::data() to stream
WRITE_INLINE_FILE	Write the image file itself to stream
WRITE_EXTERNAL_FILE	Write Image::data() to disk and use it as external file

enum osgDB::OutputStream::WriteType

Enumerator:

WRITE_UNKNOWN
WRITE_SCENE
WRITE_IMAGE
WRITE_OBJECT

---

Constructor & Destructor Documentation

osgDB::OutputStream::OutputStream

(

const osgDB::Options *

options

)

virtual osgDB::OutputStream::~OutputStream

(

)

[virtual]

---

Member Function Documentation

void osgDB::OutputStream::compress

(

std::ostream *

ostream

)

unsigned int osgDB::OutputStream::findOrCreateArrayID	(	const osg::Array *	array,
		bool &	newID
	)		[protected]

unsigned int osgDB::OutputStream::findOrCreateObjectID	(	const osg::Object *	obj,
		bool &	newID
	)		[protected]

const OutputException* osgDB::OutputStream::getException

(

)

const [inline]

const osgDB::Options* osgDB::OutputStream::getOptions

(

)

const [inline]

const std::string& osgDB::OutputStream::getSchemaName

(

)

const [inline]

WriteImageHint osgDB::OutputStream::getWriteImageHint

(

)

const [inline]

bool osgDB::OutputStream::isBinary

(

)

const [inline]

Referenced by osgDB::UserSerializer< C >::write(), osgDB::PropByValSerializer< C, P >::write(), osgDB::PropByRefSerializer< C, P >::write(), osgDB::MatrixSerializer< C >::write(), osgDB::GLenumSerializer< C, P >::write(), osgDB::StringSerializer< C >::write(), osgDB::ObjectSerializer< C, P >::write(), osgDB::ImageSerializer< C, P >::write(), osgDB::EnumSerializer< C, P, B >::write(), and osgDB::ListSerializer< C, P >::write().

OutputStream& osgDB::OutputStream::operator<<

(

bool

b

)

[inline]

OutputStream& osgDB::OutputStream::operator<<

(

char

c

)

[inline]

OutputStream& osgDB::OutputStream::operator<<

(

unsigned char

c

)

[inline]

OutputStream& osgDB::OutputStream::operator<<

(

short

s

)

[inline]

OutputStream& osgDB::OutputStream::operator<<

(

unsigned short

s

)

[inline]

OutputStream& osgDB::OutputStream::operator<<

(

int

i

)

[inline]

OutputStream& osgDB::OutputStream::operator<<

(

unsigned int

i

)

[inline]

OutputStream& osgDB::OutputStream::operator<<

(

long

l

)

[inline]

OutputStream& osgDB::OutputStream::operator<<

(

unsigned long

l

)

[inline]

OutputStream& osgDB::OutputStream::operator<<

(

float

f

)

[inline]

OutputStream& osgDB::OutputStream::operator<<

(

double

d

)

[inline]

OutputStream& osgDB::OutputStream::operator<<

(

const std::string &

s

)

[inline]

OutputStream& osgDB::OutputStream::operator<<

(

const char *

s

)

[inline]

OutputStream& osgDB::OutputStream::operator<<

(

std::ostream &(*)(std::ostream &)

fn

)

[inline]

OutputStream& osgDB::OutputStream::operator<<

(

std::ios_base &(*)(std::ios_base &)

fn

)

[inline]

OutputStream& osgDB::OutputStream::operator<<

(

const ObjectGLenum &

value

)

[inline]

OutputStream& osgDB::OutputStream::operator<<

(

const ObjectProperty &

prop

)

[inline]

OutputStream& osgDB::OutputStream::operator<<

(

const ObjectMark &

mark

)

[inline]

OutputStream& osgDB::OutputStream::operator<<

(

const osg::Vec2b &

v

)

OutputStream& osgDB::OutputStream::operator<<

(

const osg::Vec3b &

v

)

OutputStream& osgDB::OutputStream::operator<<

(

const osg::Vec4b &

v

)

OutputStream& osgDB::OutputStream::operator<<

(

const osg::Vec4ub &

v

)

OutputStream& osgDB::OutputStream::operator<<

(

const osg::Vec2s &

v

)

OutputStream& osgDB::OutputStream::operator<<

(

const osg::Vec3s &

v

)

OutputStream& osgDB::OutputStream::operator<<

(

const osg::Vec4s &

v

)

OutputStream& osgDB::OutputStream::operator<<

(

const osg::Vec2f &

v

)

OutputStream& osgDB::OutputStream::operator<<

(

const osg::Vec3f &

v

)

OutputStream& osgDB::OutputStream::operator<<

(

const osg::Vec4f &

v

)

OutputStream& osgDB::OutputStream::operator<<

(

const osg::Vec2d &

v

)

OutputStream& osgDB::OutputStream::operator<<

(

const osg::Vec3d &

v

)

OutputStream& osgDB::OutputStream::operator<<

(

const osg::Vec4d &

v

)

OutputStream& osgDB::OutputStream::operator<<

(

const osg::Quat &

q

)

OutputStream& osgDB::OutputStream::operator<<

(

const osg::Plane &

p

)

OutputStream& osgDB::OutputStream::operator<<

(

const osg::Matrixf &

mat

)

OutputStream& osgDB::OutputStream::operator<<

(

const osg::Matrixd &

mat

)

OutputStream& osgDB::OutputStream::operator<<

(

const osg::Array *

a

)

[inline]

References osgDB::writeArray().

OutputStream& osgDB::OutputStream::operator<<

(

const osg::Image *

img

)

[inline]

OutputStream& osgDB::OutputStream::operator<<

(

const osg::PrimitiveSet *

p

)

[inline]

OutputStream& osgDB::OutputStream::operator<<

(

const osg::Object *

obj

)

[inline]

OutputStream& osgDB::OutputStream::operator<<

(

const osg::ref_ptr< osg::Array > &

ptr

)

[inline]

References osgDB::writeArray().

OutputStream& osgDB::OutputStream::operator<<

(

const osg::ref_ptr< osg::Image > &

ptr

)

[inline]

OutputStream& osgDB::OutputStream::operator<<

(

const osg::ref_ptr< osg::PrimitiveSet > &

ptr

)

[inline]

template<typename T >

OutputStream& osgDB::OutputStream::operator<<

(

const osg::ref_ptr< T > &

ptr

)

[inline]

void osgDB::OutputStream::setOutputIterator

(

OutputIterator *

oi

)

[inline]

set an output iterator, used directly when not using OutputStream with a traditional file releated stream.

void osgDB::OutputStream::setWriteImageHint

(

WriteImageHint

hint

)

[inline]

void osgDB::OutputStream::start	(	OutputIterator *	outIterator,
		WriteType	type
	)

start writing to OutputStream treating it as a traditional file releated stream, handles headers and versioning

void osgDB::OutputStream::throwException

(

const std::string &

msg

)

[inline]

References _exception, and _fields.

void osgDB::OutputStream::writeArray

(

const osg::Array *

a

)

template<typename T >

void osgDB::OutputStream::writeArrayImplementation	(	const T *	,
		int	write_size,
		unsigned int	numInRow = 1
	)		[protected]

void osgDB::OutputStream::writeCharArray	(	const char *	s,
		unsigned int	size
	)		[inline]

void osgDB::OutputStream::writeImage

(

const osg::Image *

img

)

Referenced by osgDB::ImageSerializer< C, P >::write().

void osgDB::OutputStream::writeObject

(

const osg::Object *

obj

)

Referenced by osgDB::ObjectSerializer< C, P >::write().

void osgDB::OutputStream::writeObjectFields

(

const osg::Object *

obj

)

void osgDB::OutputStream::writePrimitiveSet

(

const osg::PrimitiveSet *

p

)

void osgDB::OutputStream::writeSchema

(

std::ostream &

fout

)

template<typename T >

void osgDB::OutputStream::writeSize

(

T

size

)

[inline]

void osgDB::OutputStream::writeWrappedString

(

const std::string &

str

)

[inline]

Referenced by osgDB::StringSerializer< C >::write().

---

Member Data Documentation

ArrayMap osgDB::OutputStream::_arrayMap [protected]

std::string osgDB::OutputStream::_compressorName [protected]

std::stringstream osgDB::OutputStream::_compressSource [protected]

osg::ref_ptr<OutputException> osgDB::OutputStream::_exception [protected]

Referenced by throwException().

std::vector<std::string> osgDB::OutputStream::_fields [protected]

Referenced by throwException().

std::map<std::string, std::string> osgDB::OutputStream::_inbuiltSchemaMap [protected]

ObjectMap osgDB::OutputStream::_objectMap [protected]

osg::ref_ptr<const osgDB::Options> osgDB::OutputStream::_options [protected]

osg::ref_ptr<OutputIterator> osgDB::OutputStream::_out [protected]

std::string osgDB::OutputStream::_schemaName [protected]

bool osgDB::OutputStream::_useSchemaData [protected]

WriteImageHint osgDB::OutputStream::_writeImageHint [protected]

---

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

• osgDB/OutputStream