Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
SoByteStream(3IV)()					   SoByteStream(3IV)()

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

INHERITS FROM
       SoByteStream

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

	  Methods from class SoByteStream:

			  SoByteStream()
			  ~SoByteStream()
     void		  convert(SoNode *node,	SbBool binaryFormat = TRUE)
     void		  convert(SoPath *path,	SbBool binaryFormat = TRUE)
     void		  convert(SoPathList  *pathList, SbBool	binaryFormat =
			       TRUE)
     void *		  getData()
     uint32_t		  getNumBytes()
     static SoPathList *  unconvert(SoByteStream *byteStream)
     static SoPathList *  unconvert(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	opera-
       tions.  (The  SoXtClipboard  class passes SoByteStream data during copy
       and paste.)

METHODS
			  SoByteStream()
			  ~SoByteStream()
	  Constructor and destructor.

     void		  convert(SoNode *node,	SbBool binaryFormat = TRUE)
     void		  convert(SoPath *path,	SbBool binaryFormat = TRUE)
     void		  convert(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 *		  getData()
     uint32_t		  getNumBytes()
	  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.

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

SEE ALSO
       SoXtClipboard

							   SoByteStream(3IV)()

NAME | INHERITS FROM | SYNOPSIS | DESCRIPTION | METHODS | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=SoByteStream&sektion=3iv&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help