'\"! tbl | mmdoc
'\"macro stdmacro
.ie n \{\
.   ds Cr \fB
.   ds Cb \fB
.\}
.el \{\
.   ds Cr \f7
.   ds Cb \f8
.\}
.TH SoByteStream(3IV)
.SH NAME
SoByteStream \(em converts scene graph objects to character byte streams 
.SH INHERITS FROM
SoByteStream
.SH SYNOPSIS
.ps -1
\*(Cr#include <Inventor/misc/SoByteStream.h>
.sp
.in 1i
\f1Methods from class SoByteStream:
.in 0.5i
.sp
.ta 21m
.in 1i+21n
.ti 0.5i
.ta 21m
.ds Pt \*(Cr
.ie \w'\*(Pt'>=21n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbSoByteStream\*(Cr()
.br
.in 1i+21n
.ti 0.5i
.ta 21m
.ds Pt \*(Cr
.ie \w'\*(Pt'>=21n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cb~SoByteStream\*(Cr()
.br
.in 1i+21n
.ti 0.5i
.ta 21m
.ds Pt \*(Crvoid
.ie \w'\*(Pt'>=21n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cbconvert\*(Cr(SoNode *node, SbBool binaryFormat = TRUE)
.br
.in 1i+21n
.ti 0.5i
.ta 21m
.ds Pt \*(Crvoid
.ie \w'\*(Pt'>=21n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cbconvert\*(Cr(SoPath *path, SbBool binaryFormat = TRUE)
.br
.in 1i+21n
.ti 0.5i
.ta 21m
.ds Pt \*(Crvoid
.ie \w'\*(Pt'>=21n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cbconvert\*(Cr(SoPathList *pathList, SbBool binaryFormat = TRUE)
.br
.in 1i+21n
.ti 0.5i
.ta 21m
.ds Pt \*(Crvoid *
.ie \w'\*(Pt'>=21n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbgetData\*(Cr()
.br
.in 1i+21n
.ti 0.5i
.ta 21m
.ds Pt \*(Cruint32_t
.ie \w'\*(Pt'>=21n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbgetNumBytes\*(Cr()
.br
.in 1i+21n
.ti 0.5i
.ta 21m
.ds Pt \*(Crstatic SoPathList *
.ie \w'\*(Pt'>=21n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cbunconvert\*(Cr(SoByteStream *byteStream)
.br
.in 1i+21n
.ti 0.5i
.ta 21m
.ds Pt \*(Crstatic SoPathList *
.ie \w'\*(Pt'>=21n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cbunconvert\*(Cr(void *data, uint32_t numBytes)
.sp
.SH DESCRIPTION
This class creates a byte stream representation of a scene graph, using an \*(CbSoWriteAction\f1 to write path lists to an in-memory buffer. Byte streams are commonly used to transfer data in copy and paste operations. (The \*(CbSoXtClipboard\f1
\&class passes \*(CbSoByteStream\f1 data during copy and paste.) 
.SH METHODS
.ta 21m
.in 1i+21n
.ti 0.5i
.ta 21m
.ds Pt \*(Cr
.ie \w'\*(Pt'>=21n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbSoByteStream\*(Cr()
.br
.in 1i+21n
.ti 0.5i
.ta 21m
.ds Pt \*(Cr
.ie \w'\*(Pt'>=21n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cb~SoByteStream\*(Cr()
.br
.in 1i
\f1Constructor and destructor. 
.sp
.in 0.5i
.in 1i+21n
.ti 0.5i
.ta 21m
.ds Pt \*(Crvoid
.ie \w'\*(Pt'>=21n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cbconvert\*(Cr(SoNode *node, SbBool binaryFormat = TRUE)
.br
.in 1i+21n
.ti 0.5i
.ta 21m
.ds Pt \*(Crvoid
.ie \w'\*(Pt'>=21n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cbconvert\*(Cr(SoPath *path, SbBool binaryFormat = TRUE)
.br
.in 1i+21n
.ti 0.5i
.ta 21m
.ds Pt \*(Crvoid
.ie \w'\*(Pt'>=21n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cbconvert\*(Cr(SoPathList *pathList, SbBool binaryFormat = TRUE)
.br
.in 1i
\f1These 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. 
.sp
.in 0.5i
.in 1i+21n
.ti 0.5i
.ta 21m
.ds Pt \*(Crvoid *
.ie \w'\*(Pt'>=21n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbgetData\*(Cr()
.br
.in 1i+21n
.ti 0.5i
.ta 21m
.ds Pt \*(Cruint32_t
.ie \w'\*(Pt'>=21n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbgetNumBytes\*(Cr()
.br
.in 1i
\f1These return the data and number of bytes from the last \*(Cbconvert()\f1 operation. This byte stream format is well suited to data transfers, like copy and paste. 
.sp
.in 0.5i
.in 1i+21n
.ti 0.5i
.ta 21m
.ds Pt \*(Crstatic SoPathList *
.ie \w'\*(Pt'>=21n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cbunconvert\*(Cr(SoByteStream *byteStream)
.br
.in 1i+21n
.ti 0.5i
.ta 21m
.ds Pt \*(Crstatic SoPathList *
.ie \w'\*(Pt'>=21n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cbunconvert\*(Cr(void *data, uint32_t numBytes)
.br
.in 1i
\f1These take byte stream data and unconvert it back to scene graph objects. The objects are returned in a path list. 
.sp
.in 0.5i
.SH SEE ALSO
\*(CbSoXtClipboard