1SoByteStream(3IV)()                                        SoByteStream(3IV)()
2
3
4

NAME

6       SoByteStream — converts scene graph objects to character byte streams
7

INHERITS FROM

9       SoByteStream
10

SYNOPSIS

12       #include <Inventor/misc/SoByteStream.h>
13
14          Methods from class SoByteStream:
15
16                          SoByteStream()
17                          ~SoByteStream()
18     void                 convert(SoNode *node, SbBool binaryFormat = TRUE)
19     void                 convert(SoPath *path, SbBool binaryFormat = TRUE)
20     void                 convert(SoPathList  *pathList, SbBool binaryFormat =
21                               TRUE)
22     void *               getData()
23     uint32_t             getNumBytes()
24     static SoPathList *  unconvert(SoByteStream *byteStream)
25     static SoPathList *  unconvert(void *data, uint32_t numBytes)
26
27

DESCRIPTION

29       This class creates a byte stream representation of a scene graph, using
30       an  SoWriteAction  to  write  path  lists  to an in-memory buffer. Byte
31       streams are commonly used to transfer data in  copy  and  paste  opera‐
32       tions.  (The  SoXtClipboard  class passes SoByteStream data during copy
33       and paste.)
34

METHODS

36                          SoByteStream()
37                          ~SoByteStream()
38          Constructor and destructor.
39
40     void                 convert(SoNode *node, SbBool binaryFormat = TRUE)
41     void                 convert(SoPath *path, SbBool binaryFormat = TRUE)
42     void                 convert(SoPathList *pathList, SbBool binaryFormat  =
43                               TRUE)
44          These  convert  the passed scene graph object(s) into a byte stream.
45          The caller may specify whether the byte stream is written in  binary
46          (TRUE)  or ASCII (FALSE) format, and can pass the object(s) by node,
47          path, or pathList.
48
49     void *               getData()
50     uint32_t             getNumBytes()
51          These return the data and number of bytes from  the  last  convert()
52          operation. This byte stream format is well suited to data transfers,
53          like copy and paste.
54
55     static SoPathList *  unconvert(SoByteStream *byteStream)
56     static SoPathList *  unconvert(void *data, uint32_t numBytes)
57          These take byte stream data and unconvert it  back  to  scene  graph
58          objects. The objects are returned in a path list.
59
60

SEE ALSO

62       SoXtClipboard
63
64
65
66
67                                                           SoByteStream(3IV)()