Introduction

Getting Started

Programming Guides

API Reference

Additional Resources

BStream.h
Go to the documentation of this file.
1 // Copyright (c) Tech Soft 3D, Inc.
2 //
3 // The information contained herein is confidential and proprietary to Tech Soft 3D, Inc.,
4 // and considered a trade secret as defined under civil and criminal statutes.
5 // Tech Soft 3D, Inc. shall pursue its civil and criminal remedies in the event of
6 // unauthorized use or misappropriation of its trade secrets. Use of this information
7 // by anyone other than authorized employees of Tech Soft 3D, Inc. is granted only under
8 // a written non-disclosure agreement, expressly prescribing the scope and manner of such use.
9 
11 
16 #ifndef BBINFILETKHEADER
17 #define BBINFILETKHEADER
18 
19 #ifndef _MSC_VER
20 #define __wchar_t wchar_t
21 #endif
22 
23 #ifdef __ia64
24  #ifndef __HP_aCC
25  #error C++ compiler required
26  #endif
27 #else
28  #ifndef __cplusplus
29  #error C++ compiler required
30  #endif
31 #endif
32 
37 #if defined(_MSC_VER) && !defined(BSTREAM_STATIC_LIB)
38  #ifdef BBINFILETK_EXPORTS
39  #define BBINFILETK_API2 __declspec (dllexport)
40  #else
41  #define BBINFILETK_API2 __declspec (dllimport)
42  #endif
43 #endif
44 
45 #if defined(LINUX_SYSTEM) && !defined(BSTREAM_STATIC_LIB)
46  #ifdef BBINFILETK_EXPORTS
47  #define BBINFILETK_API2 __attribute__ ((visibility ("default")))
48  #else
49  #define BBINFILETK_API2
50  #endif
51 #endif
52 
53 #ifndef BBINFILETK_API2
54  #define BBINFILETK_API2
55 #endif
56 
60 #define BBINFILETK_API BBINFILETK_API2
61 
62 
66 #define TK_File_Format_Version 2070 // 20.70
67 
69 // but are mentioned in the spec as test points for format changes)
70 #ifdef CREATE_FILE_FORMAT_HISTORY_TABLE
71  BBINFILETK_API int TK_File_Format_History[] = {
72  // Format Release Notes
73  //------------------------------------------------------------------------------------------
74  // 2070 // TK_UTF8_Strings general flag
75  // 2065 // hidden line sorting
76  // 2060 // selection sorting heuristic
77  // 2055 // geometry options: coordinate systems
78  // 2050 // eye dome lighting back color
79  // 2045 // individual frame buffer effects toggles
80  // 2040 // Support NURBS Surface Trim Start and End parameters
81  // 2035 // window and screen_range offsets
82  // 2030 // cut geometry edge weight/pattern
83  // 2025 // text background, shapes, & leaders
84  // 2020 // separate texture channel locking
85  // 2015 // selection bias
86  // 2010 // complex clip region
87  2005, // selection culling, handling for max distance and view volume culling
88  2000, // depth peeling algorithm
89  1980, // 1980 initial 20 release
90  // 1975 // double precision
91  // 1950 // text font layout
92  1910, // mask transform "offset"
93  1905, // object space clip region
94  1900, // 1900
95  // 1840 // text region fitting
96  // 1835 // png and texture source dimensions
97  // 1830 // texture camera
98  // 1825 // conditional actions
99  // 1820 // separate edge join cutoff
100  // 1815 // named styles
101  // 1810 // material shaders
102  // 1805 // compressed images directly supported in graphics system (jpeg, targa, dxt, luminance8)
103  1800, // 1800
104  // 1790 // hlr transparency cutoff
105  // 1785 // contour and isoline options, diffuse texture tint, diffuse color tint
106  // 1780 // new indexed user data
107  // 1775 // new text alignment format, explicit patterns
108  // 1770 // text character color & horizontal offset, vertex displacement, hlr render text, max extent level
109  // 1765 // force defer, vertex decimation, model type
110  // 1760 // transparency depth writing
111  // 1755 // rgba vertex colors
112  // 1750 // hard extent culling
113  1715, // 17.1 vertex displacement backport
114  1710, // ignore subsegment locks
115  1700, // 1700
116  // 1660 // camera relative lights
117  // 1655 // reflection visibility
118  // 1650 // ambient up vector, separate ambient colors, gooch options, marker index interpolation
119  1615, // anti-alias
120  1610, // 1610
121  // 1605 // infinite ray, zsort options, geometry options
122  1600, // 1600
123  // 1555 // fix to some color types
124  // 1550 // colors can now have Geo_Extended2, shadow map/simple reflection rendering options
125  // 1520 // geometry reference
126  // 1515 // shadow map options, selection level, display list levels, simple reflection, infinite line opcode
127  // 1510 // maximum extent mode
128  // 1505 // screen range, depth images
129  1500, // 1500
130  // 1415 // obscuration use octree
131  // 1410 // simple shadow opacity, anisotropic texture filter
132  // 1405 // join cutoff angle, ordered drawing heuristics
133  1401, // 1410 internal polyline selection limit
134  1400, // 1400
135  // 1345 // string format color maps
136  // 1340 // rgba image compression
137  // 1335 // general displacement
138  // 1330 // priority
139  // 1325 // text greeking mode, extended text renderer & text preference
140  // 1320 // Heuristic_Detail_Selection, nonculled edge visibility
141  // 1315 // distance threshold LOD option, new fallback type "bounding none"
142  // 1310 // depth peeling
143  // 1305 // cutting section, adjacent edge visibility, force grayscale
144  1300, // 1300
145  // 1220 // font bold/italic/renderer, cut geometry color locks
146  // 1215 // circular center
147  // 1210 // geometry-level attributes, text character attributes, unicode32, image tint
148  // 1205 // obscuration pixel threshold, subpixel culling, hard edge angle
149  1200, // 1200
150  // 1175 // explicit parameter width, uncompressed parameters
151  // 1170 // camera relative lights, simple shadow mode
152  // 1165 // extended texture definitions
153  // 1160 // glyph definitions & line styles
154  // 1155 // spheres, texture downsamping, compressed dictionary, image reference
155  // 1150 // conditions, new hlr options (color, weight)
156  1105, // additional polyhedron attributes
157  1100, // 1100
158  // 1002 // simple shadow options, text region
159  // 1001 // camera near_limit, mask transform, image size/scale, new texture options
160  1000, // 1000
161  // 908 // threshold type in LOD options
162  // 907 // polar normals
163  // 906 // edgebreaker changes
164  // 905 // hlr silhouette cleanup, unicode_options
165  900, // 900
166  // 806 // bounding box inheritance, cut geometry options, fast hidden line,
167  // hidden line render faces, depth range, gradient window patterns,
168  // additional NURBS surface controls
169  // 805 // polycylinder attributes, ExRef, URL
170  800, // 800
171  710, // 760 new transparency controls, dictionary format 2
172  // 705, // PolyCylinder, Extended Heuristics, XML, LoD collections, Shell Regions
173  // 702, // PolyPolypoint
174  700, // 700
175  // 652, // null shell
176  651, // 661
177  // 650, // NURBS Surface, Cylinder, Extended Rendering_Options, Defined Fonts, Selectability
178  // extensive polyhedron data & compression changes
179  // 610, // View
180  // 600, // Stream version generally synched to Hoops version
181  // 601, // support longer text string
182  105, // 600 Generate_Dictionary changed to Suppress_Dictionary
183  100, // 500 Initial release
184  0 // [list termination]
185  };
186 #else
187  extern BBINFILETK_API int TK_File_Format_History[];
188 #endif
189 
190 
191 #define TK_DEFAULT_BUFFER_SIZE 32768
192 
193 
194 
195 #ifdef HSTREAM_READONLY
196  #ifndef BSTREAM_READONLY
197  #define BSTREAM_READONLY
198  #endif
199 #endif
200 #ifdef BSTREAM_READONLY
201  extern char const stream_readonly[];
202 #endif
203 #ifdef BSTREAM_DISABLE_QUANTIZATION
204  extern char const stream_disable_quantization[];
205 #endif
206 #ifdef BSTREAM_DISABLE_EDGEBREAKER
207  extern char const stream_disable_edgebreaker[];
208 #endif
209 #ifdef BSTREAM_DISABLE_REPULSE_COMPRESSION
210  extern char const stream_disable_repulse_compression[];
211 #endif
212 #ifdef BSTREAM_DISABLE_ASCII
213  extern char const stream_disable_ascii[];
214 #endif
215 
216 
217 #ifdef _MSC_VER
218 # pragma warning ( push )
219 # pragma warning (disable: 4577) // 'noexcept' used with no exception handling mode specified;
220 #endif
221 
222 #include <cmath>
223 
224 #ifdef _MSC_VER
225 # pragma warning ( pop )
226 #endif
227 
228 #include <cstring>
229 #include <cstdio>
230 
231 #ifdef NEED_BOOL_TYPE
232  #undef NEED_BOOL_TYPE
233  typedef int bool;
234 
235  const bool true = !0;
236  const bool false = 0;
237 #endif
238 
239 
244 #ifndef SWIG
245 #if defined(WIN64) || defined(_WIN64)
246 # define ID_Key __int64
247 #else
248 # define ID_Key long
249 #endif
250 #endif
251 
252 
253 #ifndef alter
254 # define alter
255 #endif
256 
257 
258 #ifndef HPS_CORE_BUILD
259 template <typename T> void Swap (T & a, T & b) { T tmp = a; a = b; b = tmp; }
260 #endif
261 
262 
267 
272 enum TK_Status {
273  TK_Normal = 0,
274  TK_Error = 1,
275  TK_Pause = 2,
276  TK_Single = 3,
282  TK_Abort = 9,
284 };
288 
296  TK_Suppress_LOD = 0x00000002,
300  TK_Force_Tags = 0x00000020,
303  TK_Disable_Instancing = 0x00000200,
304  TK_Generate_Dictionary = 0x00000400,
306  TK_Disable_Tristrips = 0x00001000,
308  TK_Global_Quantization = 0x00004000,
312  TK_Communicator_Mode = 0x00040000,
314 };
315 
316 
322 };
323 
324 
330  TK_Ignore_Version = 0x00000002,
332  TK_Ignore_Bounding_LODs = 0x00000008,
333  TK_Disable_Deferal = 0x00000010
334 };
335 
340  TK_Logging_Sequence = 0x00000001,
341  TK_Logging_Tagging = 0x00000002,
343 };
344 
345 
350  // for Geometries and some attributes
352 
353  // for includes and styles
355  TK_Has_Filter = 0x02,
356  TK_Has_Custody = 0x04,
358 };
359 
360 
361 #include "BOpcodeHandler.h"
362 #include "BStreamFileToolkit.h"
363 
369 
380 #ifndef SWIG
381 TK_Status BBINFILETK_API TK_Read_Stream_File (char const * filename, BStreamFileToolkit * tk);
382 #endif
383 
385 
394 #ifndef SWIG
395 TK_Status BBINFILETK_API TK_Read_Stream_File (char const * filename, int flags = 0);
396 #endif
397 
398 
399 
400 
402 TK_Status BBINFILETK_API TK_Read_Stream_File (__wchar_t const * filename, BStreamFileToolkit * tk);
403 #ifdef _MSC_VER
404 TK_Status BBINFILETK_API TK_Read_Stream_File (unsigned short const * filename, BStreamFileToolkit * tk);
405 #endif
406 
408 TK_Status BBINFILETK_API TK_Read_Stream_File (__wchar_t const * filename, int flags = 0);
409 #ifdef _MSC_VER
410 TK_Status BBINFILETK_API TK_Read_Stream_File (unsigned short const * filename, int flags = 0);
411 #endif
412 
413 
415 
422 #ifndef SWIG
423 TK_Status BBINFILETK_API TK_Read_Stream_File (char const * filename, int flags, BStreamFileToolkit * tk);
424 #endif
425 
427 #endif
428 
Definition: BStream.h:280
entity has an owning interest in its referee
Definition: BStream.h:356
Definition: BStream.h:303
TK_File_Read_Options
Definition: BStream.h:328
Definition: BStream.h:307
Contains data types which are used by BBaseOpcodeHandler.
Definition: BStream.h:306
TK_Debug_Logging_Options
Definition: BStream.h:339
Definition: BStream.h:340
entity string(s) are UTF8 rather than (presumably) ISO Latin-1
Definition: BStream.h:357
Definition: BStream.h:277
The BStreamFileToolkit class provides support for importing/exporting HOOPS Stream File information...
Definition: BStreamFileToolkit.h:367
Definition: BStream.h:329
TK_Dictionary_Options
Definition: BStream.h:320
Definition: BStream.h:308
Definition: BStream.h:300
Definition: BStream.h:274
Definition: BStream.h:333
TK_Status BBINFILETK_API TK_Read_Stream_File(char const *filename, BStreamFileToolkit *tk)
Reads a HOOPS Stream File.
Definition: BStream.h:298
Definition: BStream.h:313
BBINFILETK_API int TK_File_Format_History[]
Table of format changes, commented values are informational (were never included in a release...
Definition: BStream.h:331
Definition: BStream.h:278
Definition: BStream.h:297
Definition: BStream.h:273
Definition: BStream.h:296
Definition: BStream.h:275
entity has an associated condition
Definition: BStream.h:354
TK_File_Write_Options
Options which control how the HOOPS Stream File is generated.
Definition: BStream.h:295
Definition: BStream.h:341
TK_General_Flags
Definition: BStream.h:349
Definition: BStream.h:309
Definition: BStream.h:302
entity has an associated filter
Definition: BStream.h:355
TK_Status
Codes which can be either passed to various toolkit functions, or indicate the result of a toolkit fu...
Definition: BStream.h:272
Definition: BStream.h:310
dictionary entries include bounding volume info
Definition: BStream.h:321
Definition: BStream.h:342
Definition: BStream.h:305
Definition: BStream.h:282
Definition: BStream.h:301
Definition: BStream.h:283
Definition: BStream.h:281
Definition: BStream.h:276
Definition: BStream.h:332
Definition: BStream.h:330
Definition: BStream.h:312
Definition: BStream.h:311
Definition: BStream.h:304
Definition: BStream.h:279
Definition: BStream.h:299
entity is double precision
Definition: BStream.h:351