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