This reference page is linked to from the following overview topics: Miscellaneous Utilities, Serializing Plug-in Data.

Detailed Description

Streams are used to read information from a file, or to write it to a file.

In a Mudbox plug-in, you would typically use the Stream class when you override the Serialize method of a custom node that you have derived from the Node class. When you save or load a scene, Mudbox will call that method and pass you a stream object, which you can then use.

Typically, a stream object is used like this:

        void myNode::Serialize( Stream& s )
        {
            myParentClass::Serialize(s);
            s == myVariable1 == myVariable2 == myVariable3;
        }

Here, the "==" operator will store the variables in the stream (if the stream is writing), or read them from the stream (if it is reading). So you can use the same code for both reading and writing. Since the "==" operator returns a stream reference, you can serialize multiple variables on the same line if you wish to do so, as shown above.

Examples:: CurveBrush/CurveCreator.h, ImmediateModeRenderer/ImmediateModeRenderer.h, MeshDisplace/displacer.h, PtexExtractor/PtexLayout.h, and PtexExtractor/PtexUtilizer.h.

Definition at line 39 of file stream.h.

#include <stream.h>

Inheritance diagram for Stream:

[legend]

List of all members.

Public Types
enum	{ chunk = 0x800000 }
Public Member Functions
virtual	~Stream (void)
	Destructor.
virtual QString	FileName (void) const
	Returns the name of the file.
virtual bool	IsValid (void)
	Returns true if the stream has a valid version number.
virtual bool	IsOlderThan (int iVersion) const
	(Deprecated) Checks if the file is older than a specified version.
virtual bool	IsNewerThan (int iVersion) const
	(Deprecated) Checks if the file is newer than a specified version.
virtual int	ClassVersion (const class ClassDesc *pClass) const
	Returns the version for a class inside the current stream.
template<typename Type >
bool	IsOlderThan (int iVersion, Type *) const
	Checks if the file is older than a specified version for the given class.
template<typename Type >
bool	IsNewerThan (int iVersion, Type *) const
	Checks if the file is newer than a specified version for the given class.
virtual bool	IsStoring (void) const
	Returns true if the stream is in storing mode (i.e.
virtual void	SetError (bool bError)
	Use this method to inform Mudbox that there is an error in the stream you are trying to read or write.
virtual int	Version (void) const
	Returns the version number of the stream.
virtual uint64	CurrentPosition (void) const
	Returns the current position in the file. See also SetCurrentPosition().
virtual void	SetCurrentPosition (uint64 iPosition)
	Sets the current position in the file.
virtual void	ReportCorruption (void)
	Call this function from your Serialize implementation, if you detect that the file content is corrupt.
virtual void	Open (const QString &sFileName, bool bStoring=false, int iProjectedFileSize=0, bool bProgressBar=true)
	Opens the file attached to this stream.
virtual void	Reopen (bool bStoring=false)
	Re-opens the file attached to this stream.
virtual bool	Close (void)
	Closes the file attached to this stream.
virtual bool	Eof (void)
	Returns true if you are reading the file, and you have reached the end of it.
virtual bool	ReadContents (void)
	This function reads the content of the stream into the memory, when the stream is opened for read.
virtual size_t	Read (void *pBuffer, size_t iSize)
	Reads data directly from the stream into a buffer you provide.
virtual size_t	Write (const void *pBuffer, size_t iSize)
	Writes data to the stream from a buffer you provide.
int	ReadInt (void)
	Reads a single integer from the stream, and returns it.
virtual void	ReadToFile (const QString &sFile)
	Takes the entire contents of the stream and writes it into the specified file.
virtual void	WriteFromFile (const QString &sFile)
	Fills the stream with the content of the specified file.
template<typename type >
Stream &	operator>> (type &v)
	Reads data from the stream to any data type.
template<typename type >
Stream &	operator<< (const type &v)
	Stores any data type into the stream.
virtual Node *	ReadPointer (void)
	Read/Writes node pointers.
virtual void	WritePointer (Node *pPointer)
template<typename type >
Stream &	operator>> (type *&p)
	Reads a pointer from the file.
template<typename type >
Stream &	operator<< (type *&p)
	Writes a pointer into the stream.
template<typename type >
Stream &	operator>> (Store< type > &s)
	Reads data from the stream to any Store (array) type.
template<typename type >
Stream &	operator<< (const Store< type > &s)
	Writes any store type (array) to the stream.
Stream &	operator>> (QString &s)
	Read/Writes QString.
Stream &	operator<< (const QString &s)
template<typename type >
Stream &	operator>> (QVector< type > &s)
	Reads data from the stream to a QVector object.
template<typename type >
Stream &	operator<< (const QVector< type > &s)
	Writes any store type (array) to the stream.
Protected Member Functions
	Stream (void)
	You cannot create a Stream object directly. Call CreateInstance<Stream>(), then use Stream::Open to specify parameters.

Member Enumeration Documentation

anonymous enum

virtual void Open	(	const QString &	sFileName,
		bool	bStoring = `false`,
		int	iProjectedFileSize = `0`,
		bool	bProgressBar = `true`
	)		`[virtual]`

[in]	sFileName	The name of the file to be opened
[in]	bStoring	Set this to true if you are storing data (i.e. writing the file), and false otherwise
[in]	iProjectedFileSize	If you know how big your file will be, you can optionally specify this argument to help display the status bar correctly
[in]	bProgressBar	If true, a progress bar will be displayed while reading and writing the file.

virtual size_t Read	(	void *	pBuffer,
		size_t	iSize
	)		`[virtual]`

[in]	pBuffer	A pointer to a block of memory to hold the data
[in]	iSize	The number of bytes to be read

virtual size_t Write	(	const void *	pBuffer,
		size_t	iSize
	)		`[virtual]`

[in]	pBuffer	A pointer to a buffer of data you want to write
[in]	iSize	The number of bytes you want to write

Stream Class Reference

Detailed Description

Public Types

Public Member Functions

Protected Member Functions

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation