TK_File_Write_Options

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

Enumerators

enumerator TK_File_Write_Options::TK_Suppress_LOD
TK_Suppress_LOD = 0x00000002

No LODS are exported, only the original shells are written out (single pass); implicitly disables dictionary

enumerator TK_File_Write_Options::TK_Full_Resolution_Vertices
TK_Full_Resolution_Vertices = 0x00000004

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

enumerator TK_File_Write_Options::TK_Full_Resolution_Normals
TK_Full_Resolution_Normals = 0x00000008

Data fidelity is required for normals; as in above description of TK_Full_Resolution_Points

enumerator TK_File_Write_Options::TK_First_LOD_Is_Bounding_Box
TK_First_LOD_Is_Bounding_Box = 0x00000010

Adds a new LOD to represent the lowest resolution of objects, which is a bounding box representation

enumerator TK_File_Write_Options::TK_Force_Tags
TK_Force_Tags = 0x00000020

All appropriate objects (geometries,segments,includes) will be tagged

enumerator TK_File_Write_Options::TK_Disable_Priority_Heuristic
TK_Disable_Priority_Heuristic = 0x00000040

Disables organization of multiresolution objects according to heuristic cost/benifit.

enumerator TK_File_Write_Options::TK_Disable_Global_Compression
TK_Disable_Global_Compression = 0x00000100

Inline lossless compression will not be used

enumerator TK_File_Write_Options::TK_Disable_Instancing
TK_Disable_Instancing = 0x00000200

Object instancing will not be used

enumerator TK_File_Write_Options::TK_Generate_Dictionary
TK_Generate_Dictionary = 0x00000400

Enables random-access by creation of the file dictionary

enumerator TK_File_Write_Options::TK_Connectivity_Compression
TK_Connectivity_Compression = 0x00000800

Enables connectivity compression

enumerator TK_File_Write_Options::TK_Disable_Tristrips
TK_Disable_Tristrips = 0x00001000

Disables triangle strips, and the triangulation it requires, in shells. Incurs a heavy read-time computational cost.

enumerator TK_File_Write_Options::TK_Disable_Compound_Primitives
TK_Disable_Compound_Primitives = 0x00002000

Disables the use of OpcodeHandlers that encode multiple primitives (since they cannot be properly tagged)

enumerator TK_File_Write_Options::TK_Global_Quantization
TK_Global_Quantization = 0x00004000

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.

enumerator TK_File_Write_Options::TK_Full_Resolution_Parameters
TK_Full_Resolution_Parameters = 0x00008000

Data fidelity is required for parameters (a.k.a texture coordinates); as in above description of TK_Full_Resolution_Points

enumerator TK_File_Write_Options::TK_Full_Resolution_Colors
TK_Full_Resolution_Colors = 0x00010000

Data fidelity is required for vertex/face colors; as in above description of TK_Full_Resolution_Points

enumerator TK_File_Write_Options::TK_Full_Resolution_Index_Colors
TK_Full_Resolution_Index_Colors = 0x00020000

Data fidelity is required for vertex/face colors-by-index; as in above description of TK_Full_Resolution_Points

enumerator TK_File_Write_Options::TK_Communicator_Mode
TK_Communicator_Mode = 0x00040000

Alters HSF Export for easier web viewer parsing

enumerator TK_File_Write_Options::TK_Disable_Custom_Shader
TK_Disable_Custom_Shader = 0x00080000

Disables custom shaders.

enumerator TK_File_Write_Options::TK_All_Global_Textures
TK_All_Global_Textures = 0x00100000

Include all global textures, new default is only those referenced.

enumerator TK_File_Write_Options::TK_No_Global_Textures
TK_No_Global_Textures = 0x00200000

Skip all global textures. Overrides “All” option if both set

enumerator TK_File_Write_Options::TK_Full_Resolution
TK_Full_Resolution = (TK_Full_Resolution_Vertices | TK_Full_Resolution_Normals | TK_Full_Resolution_Parameters | TK_Full_Resolution_Colors | TK_Full_Resolution_Index_Colors)

for convenience, a combination of 5 other options.