Open Inventor Release 2023.2.3
 
Loading...
Searching...
No Matches
SoByteStream.h
Go to the documentation of this file.
1/*=======================================================================
2 * Copyright 1991-1996, Silicon Graphics, Inc.
3 * ALL RIGHTS RESERVED
4 *
5 * UNPUBLISHED -- Rights reserved under the copyright laws of the United
6 * States. Use of a copyright notice is precautionary only and does not
7 * imply publication or disclosure.
8 *
9 * U.S. GOVERNMENT RESTRICTED RIGHTS LEGEND:
10 * Use, duplication or disclosure by the Government is subject to restrictions
11 * as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights
12 * in Technical Data and Computer Software clause at DFARS 252.227-7013 and/or
13 * in similar or successor clauses in the FAR, or the DOD or NASA FAR
14 * Supplement. Contractor/manufacturer is Silicon Graphics, Inc.,
15 * 2011 N. Shoreline Blvd. Mountain View, CA 94039-7311.
16 *
17 * THE CONTENT OF THIS WORK CONTAINS CONFIDENTIAL AND PROPRIETARY
18 * INFORMATION OF SILICON GRAPHICS, INC. ANY DUPLICATION, MODIFICATION,
19 * DISTRIBUTION, OR DISCLOSURE IN ANY FORM, IN WHOLE, OR IN PART, IS STRICTLY
20 * PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SILICON
21 * GRAPHICS, INC.
22**=======================================================================*/
23/*=======================================================================
24** Author : David Mott (MMM yyyy)
25**=======================================================================*/
26/*=======================================================================
27 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.), ***
28 *** AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT. ***
29 *** ***
30 *** REPRODUCTION, DISCLOSURE, OR USE, IN WHOLE OR IN PART, OTHER THAN AS ***
31 *** SPECIFIED IN THE LICENSE ARE NOT TO BE UNDERTAKEN EXCEPT WITH PRIOR ***
32 *** WRITTEN AUTHORIZATION OF FEI S.A.S. ***
33 *** ***
34 *** RESTRICTED RIGHTS LEGEND ***
35 *** USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS ***
36 *** WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN ***
37 *** SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT ***
38 *** CLAUSE AT FAR 52.227-19 OR SUBPARAGRAPH (C)(1)(II) OF THE RIGHTS IN ***
39 *** TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013. ***
40 *** ***
41 *** COPYRIGHT (C) 1996-2014 BY FEI S.A.S, ***
42 *** BORDEAUX, FRANCE ***
43 *** ALL RIGHTS RESERVED ***
44**=======================================================================*/
45/*=======================================================================
46** Modified by : VSG (MMM YYYY)
47**=======================================================================*/
48
49
50#ifndef _SO_BYTE_STREAM_
51#define _SO_BYTE_STREAM_
52
53#include <Inventor/SbBasic.h>
54
55class SoNode;
56class SoPath;
57class SoPathList;
58
60//
61// Class: SoByteStream
62//
63// This class creates a byte stream representation of a scene graph,
64// using the SoWriteAction to write to an in memory buffer. Byte streams
65// are commonly used to transfer data, for instance during copy and paste.
66//
68
86 public:
95
103 void convert(SoNode *node, SbBool binaryFormat = TRUE);
104
112 void convert(SoPath *path, SbBool binaryFormat = TRUE);
113
121 void convert(SoPathList *pathList, SbBool binaryFormat = TRUE);
122
129 void * getData() { return data; }
136 size_t/*uint32_t*/ getNumBytes() { return numBytes; }
137
138 // Unconvert a byte stream back to a path list.
139 // This static routine performs an SoDB::read on the data,
140 // and returns a path list of the paths read in.
141
146 static SoPathList *unconvert(SoByteStream *byteStream);
152 static SoPathList *unconvert(void *data, size_t numBytes);
153
154 private:
155 // This allows apps to store raw data here without converting
156 // an Inventor node, path, or path list. This sets isRaw to TRUE,
157 // and that data cannot be unconverted.
158 void copy(void *d, size_t len);
159 SbBool isRawData() const { return isRaw; }
160
161 private:
162 void *data;
163 size_t numBytes;
164 SbBool isRaw;
165
166};
167
168#endif // _SO_BYTE_STREAM_
169
#define TRUE
Possible value of SbBool.
Definition SbBase.h:77
Converts scene graph objects to character byte streams.
SoByteStream()
Constructor.
size_t getNumBytes()
Returns the number of bytes from the last convert() operation.
~SoByteStream()
Destructor.
void convert(SoNode *node, SbBool binaryFormat=TRUE)
Converts the passed scene graph object(s) into a byte stream.
void convert(SoPath *path, SbBool binaryFormat=TRUE)
Converts the passed scene graph object(s) into a byte stream.
static SoPathList * unconvert(SoByteStream *byteStream)
Takes byte stream data and unconverts it back to scene graph objects.
void convert(SoPathList *pathList, SbBool binaryFormat=TRUE)
Converts the passed scene graph object(s) into a byte stream.
void * getData()
Returns the data from the last convert() operation.
static SoPathList * unconvert(void *data, size_t numBytes)
Takes byte stream data and unconverts it back to scene graph objects.
Abstract base class for all database nodes.
Definition SoNode.h:145
Path that points to a list of hierarchical nodes.
Definition SoPath.h:187
Maintains a list of pointers to paths.
Definition SoPathList.h:81
int SbBool
Boolean type.
Definition SbBase.h:87