SoByteStream(3IV)

NAME
     SoByteStream (SoByteStream) - converts scene graph objects to character
     byte streams

INHERITS FROM
     SoByteStream

SYNOPSIS
     #include <Inventor_c/misc/SoByteStream.h>

          Functions from class SoByteStream:

     SoByteStream *      SoByteStreamCreate()
     void                SoByteStreamDelete(SoByteStream *this)
     void                SoByteStreamConvertNode(SoByteStream *this, SoNode
                              *node, SbBool binaryFormat = TRUE)
     void                SoByteStreamConvertPath(SoByteStream *this, SoPath
                              *path, SbBool binaryFormat = TRUE)
     void                SoByteStreamConvertPathList(SoByteStream *this,
                              SoPathList *pathList, SbBool binaryFormat =
                              TRUE)
     void *              SoByteStreamGetData(SoByteStream *this)
     uint32_t            SoByteStreamGetNumBytes(SoByteStream *this)
     SoPathList *        SoByteStreamUncomvertStream(SoByteStream *byteStream)
     SoPathList *        SoByteStreamUnconvertData(void *data, uint32_t
                              numBytes)


DESCRIPTION
     This class creates a byte stream representation of a scene graph, using
     an SoWriteAction to write path lists to an in-memory buffer. Byte streams
     are commonly used to transfer data in copy and paste operations. (The
     SoXtClipboard class passes SoByteStream data during copy and paste.)

FUNCTIONS
     SoByteStream *      SoByteStreamCreate()
     void                SoByteStreamDelete(SoByteStream *this)
          Constructor and destructor.

     void                SoByteStreamConvertNode(SoByteStream *this, SoNode
                              *node, SbBool binaryFormat = TRUE)
     void                SoByteStreamConvertPath(SoByteStream *this, SoPath
                              *path, SbBool binaryFormat = TRUE)
     void                SoByteStreamConvertPathList(SoByteStream *this,
                              SoPathList *pathList, SbBool binaryFormat =
                              TRUE)
          These convert the passed scene graph object(s) into a byte stream.
          The caller may specify whether the byte stream is written in binary
          (TRUE) or ASCII (FALSE) format, and can pass the object(s) by node,
          path, or pathList.
     void *              SoByteStreamGetData(SoByteStream *this)
     uint32_t            SoByteStreamGetNumBytes(SoByteStream *this)
          These return the data and number of bytes from the last convert()
          operation. This byte stream format is well suited to data transfers,
          like copy and paste.

     SoPathList *        SoByteStreamUncomvertStream(SoByteStream *byteStream)
     SoPathList *        SoByteStreamUnconvertData(void *data, uint32_t
                              numBytes)
          These take byte stream data and unconvert it back to scene graph
          objects. The objects are returned in a path list.


SEE ALSO
     SoXtClipboard