test.h File Reference

Contains definitions of global variables, functions and enumerated types. More...

Enumerations
enum	TK_Status {   TK_Normal = 0, TK_Error = 1, TK_Pause = 2, TK_Single = 3,   TK_Pending = 4, TK_Revisit = 5, TK_Complete = 6, TK_Version = 7,   TK_NotFound = 8, TK_Abort = 9 }
	Codes which can be either passed to various toolkit functions, or indicate the result of a toolkit function call. More...
enum	TK_File_Write_Options {   TK_Suppress_LOD = 0x00000002, TK_Full_Resolution_Vertices = 0x00000004, TK_Full_Resolution_Normals = 0x00000008, TK_Full_Resolution = (TK_Full_Resolution_Vertices|TK_Full_Resolution_Normals),   TK_First_LOD_Is_Bounding_Box = 0x00000010, TK_Force_Tags = 0x00000020, TK_Disable_Priority_Heuristic = 0x00000040, TK_Disable_Global_Compression = 0x00000100,   TK_Disable_Instancing = 0x00000200, TK_Generate_Dictionary = 0x00000400, TK_Connectivity_Compression = 0x00000800, TK_Disable_Tristrips = 0x00001000,   TK_Disable_Compound_Primitives = 0x00002000, TK_Global_Quantization = 0x00004000 }
	Options which control how the HOOPS Stream File is generated. More...

---

Detailed Description

Contains definitions of global variables, functions and enumerated types.

The HOOPS/Stream Toolkit utilizes several global enumerated types. The functions which black box support for writing and reading HOOPS Stream Files are also global, and are defined in BStream.h

---

Enumeration Type Documentation

enum TK_File_Write_Options

Options which control how the HOOPS Stream File is generated. An HSF file has a variety of properties, and the toolkit utilizes default logic when generating a file. This enumerated type gives the user high-level control over file compression, tagging and content. These options are set by calling BStreamFileToolkit::SetWriteFlags Enumeration values: TK_Suppress_LOD  No LODS are exported, only the original shells are written out (single pass); implicitly disables dictionary TK_Full_Resolution_Vertices  Data fidelity is required for geometry; this causes the full single-precision floating point information to be exported; does not affect LODs or lossless compression of connectivity information TK_Full_Resolution_Normals  Data fidelity is required for normals; as in above description of TK_Full_Resolution_Points TK_Full_Resolution  for convenience, a combination of 2 other options. TK_First_LOD_Is_Bounding_Box  Adds a new LOD to represent the lowest resolution of objects, which is a bounding box representation TK_Force_Tags  All appropriate objects (geometries,segments,includes) will be tagged TK_Disable_Priority_Heuristic  Disables organization of multiresolution objects according to heuristic cost/benifit. TK_Disable_Global_Compression  Inline lossless compression will not be used TK_Disable_Instancing  Object instancing will not be used TK_Generate_Dictionary  Enables random-access by creation of the file dictionary TK_Connectivity_Compression  Enables connectivity compression TK_Disable_Tristrips  Disables triangle strips, and the triangulation it requires, in shells. Incurs a heavy read-time computational cost. TK_Disable_Compound_Primitives  Disables the use of OpcodeHandlers that encode multiple primitives (since they cannot be properly tagged) TK_Global_Quantization  Causes any required quantization to be global (bbox of scene) instead of local (bbox of individual geometry) . Regardless of this flag, however, local quantization applies until the first TKE_Bounding_Info. HStreamFiletoolkit sends a TKE_Bounding_Info automatically, but BStreamFiletoolkit does not.

enum TK_Status

Codes which can be either passed to various toolkit functions, or indicate the result of a toolkit function call. Various toolkit functions can take arguments which control processing behavior. Most functions also provide a return value of type TK_Status to indicate success, failure or other information about processing status. Enumeration values: TK_Normal  When used as input: read through to a 'termination' code. When used as output: function call succeeded TK_Error  A return value; function call failed TK_Pause  An input value; instructs toolkit to stop reading at a 'pause' code TK_Single  An input value; instructs toolkit to stop reading after the first object is completed TK_Pending  A return value; the toolkit is waiting for (needs) more data TK_Revisit  A return value; interpret function succeeded, but we will run it through again later TK_Complete  A return value; processing is complete TK_Version  A return value; version mis-match detected, processing halted TK_NotFound  A return value; failed to find a match TK_Abort  A return value; non-fatal error. callback requested stop, or fall back to plan B (internal)

---