Open Inventor Reference
SoByteStream.h
Go to the documentation of this file.
1/*
2 *
3 * Copyright (C) 2000 Silicon Graphics, Inc. All Rights Reserved.
4 *
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2.1 of the License, or (at your option) any later version.
9 *
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
14 *
15 * Further, this software is distributed without any warranty that it is
16 * free of the rightful claim of any third person regarding infringement
17 * or the like. Any license provided herein, whether implied or
18 * otherwise, applies only to this software file. Patent licenses, if
19 * any, provided herein do not apply to combinations of this program with
20 * other software, or any other product whatsoever.
21 *
22 * You should have received a copy of the GNU Lesser General Public
23 * License along with this library; if not, write to the Free Software
24 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 *
26 * Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
27 * Mountain View, CA 94043, or:
28 *
29 * http://www.sgi.com
30 *
31 * For further information regarding this notice, see:
32 *
33 * http://oss.sgi.com/projects/GenInfo/NoticeExplan/
34 *
35 */
36
37
38/*
39 * Copyright (C) 1990,91 Silicon Graphics, Inc.
40 *
41 _______________________________________________________________________
42 ______________ S I L I C O N G R A P H I C S I N C . ____________
43 |
44 | $Revision: 1.1.1.1 $
45 |
46 | Description:
47 | This file defines the SoByteStream class.
48 |
49 | Author(s): David Mott
50 |
51 ______________ S I L I C O N G R A P H I C S I N C . ____________
52 _______________________________________________________________________
53 */
54
55#ifndef _SO_BYTE_STREAM_
56#define _SO_BYTE_STREAM_
57
58#include <Inventor/SbBasic.h>
59
60class SoNode;
61class SoPath;
62class SoPathList;
63
64
67
77
79 public:
84
89
91 void convert(SoNode *node, bool binaryFormat = TRUE);
92
94 void convert(SoPath *path, bool binaryFormat = TRUE);
95
100 void convert(SoPathList *pathList, bool binaryFormat = TRUE);
101
105 void * getData() { return data; }
108 uint32_t getNumBytes() { return numBytes; }
109
113
116 static SoPathList * unconvert(SoByteStream *byteStream);
117
120 static SoPathList * unconvert(void *data, uint32_t numBytes);
121
122 SoEXTENDER public:
126 void copy(void *d, size_t len);
127 bool isRawData() const { return isRaw; }
128
129 private:
130 void *data;
131 uint32_t numBytes;
132 bool isRaw;
133};
134
135#endif // _SO_BYTE_STREAM_
#define SoEXTENDER
Provide inline template functions for abs, swap, min, max, and clamp.
Definition SbBasic.h:154
#define TRUE
Definition SbBasic.h:76
#define INVENTOR_API
Disable some annoying warnings on MSVC 6.
Definition SbSystem.h:77
unsigned int uint32_t
Definition SbTypeDefs.h:44
Converts scene graph objects to character byte streams.
SoByteStream()
Constructor and destructor.
~SoByteStream()
Constructor and destructor.
static SoPathList * unconvert(void *data, uint32_t numBytes)
These take byte stream data and unconvert it back to scene graph objects.
void copy(void *d, size_t len)
This allows apps to store raw data here without converting an Inventor node, path,...
void convert(SoPathList *pathList, bool binaryFormat=TRUE)
These convert the passed scene graph object(s) into a byte stream.
static SoPathList * unconvert(SoByteStream *byteStream)
Unconvert a byte stream back to a path list.
uint32_t getNumBytes()
Returns the number of bytes from the last convert() operation.
void * getData()
Returns the data from the last convert() operation.
void convert(SoPath *path, bool binaryFormat=TRUE)
bool isRawData() const
void convert(SoNode *node, bool binaryFormat=TRUE)
Convert the passed node, path, or path list into a byte stream.
Abstract base class for all database nodes.
Definition SoNode.h:103
Maintains a list of pointers to paths.
Definition SoLists.h:212
Path that points to a list of hierarchical nodes.
Definition SoPath.h:109