Alphabetical Class Index   Class Hierarchy   Compound Members   File Members   File List  

HTK_Read_Stream_File

Functions

TK_Status HBINFILETK_API HTK_Read_Stream_File (char const *filename, HStreamFileToolkit *tk)
 Reads a HOOPS Stream File and map it to the HOOPS/3dGS scene-graph.
TK_Status HBINFILETK_API HTK_Read_Stream_File (char const *filename, int flags=0)
 Reads a HOOPS Stream File and map it to the HOOPS/3dGS scene-graph.
TK_Status HBINFILETK_API HTK_Read_Stream_File (__wchar_t const *filename, HStreamFileToolkit *tk)
 Reads a HOOPS Stream File and map it to the HOOPS/3dGS scene-graph.
TK_Status HBINFILETK_API HTK_Read_Stream_File (__wchar_t const *filename, int flags=0)
 Reads a HOOPS Stream File and map it to the HOOPS/3dGS scene-graph.
TK_Status HBINFILETK_API HTK_Read_Stream_File (char const *filename, int flags, HStreamFileToolkit *tk)
 Deprecated; reads a HOOPS Stream File and map it to the HOOPS/3dGS scene-graph

Function Documentation

TK_Status HBINFILETK_API HTK_Read_Stream_File ( char const *  filename,
HStreamFileToolkit tk 
)

Reads a HOOPS Stream File and map it to the HOOPS/3dGS scene-graph.

The contents of the HOOPS Stream File are mapped to the corresponding HOOPS/3dGS scene-graph hierarchy underneath the currently open segment.

Parameters:
filenameA character pointer denoting the name of the file to read in.
tkA pointer to the HStreamFileToolkit to use as a basis for reading the file. This would be passed in to read in a customized file that contains user-specified data. Options to control how the file is read may be specified using the BStreamFileToolkit::SetReadFlags() method on the toolkit.
TK_Status HBINFILETK_API HTK_Read_Stream_File ( char const *  filename,
int  flags = 0 
)

Reads a HOOPS Stream File and map it to the HOOPS/3dGS scene-graph.

The contents of the HOOPS Stream File are mapped to the corresponding HOOPS/3dGS scene-graph hierarchy underneath the currently open segment.

Parameters:
filenameA character pointer denoting the name of the file to read in.
flagsBitwise encoding of options which control how the file is read. TK_File_Read_Options provides a list of supported options.
TK_Status HBINFILETK_API HTK_Read_Stream_File ( __wchar_t const *  filename,
HStreamFileToolkit tk 
)

Reads a HOOPS Stream File and map it to the HOOPS/3dGS scene-graph.

The contents of the HOOPS Stream File are mapped to the corresponding HOOPS/3dGS scene-graph hierarchy underneath the currently open segment.

Parameters:
filenameA pointer to a UNICODE wide character string denoting the name of the file to read in.
tkA pointer to the HStreamFileToolkit object to use as a basis for generating the file. This would be
TK_Status HBINFILETK_API HTK_Read_Stream_File ( __wchar_t const *  filename,
int  flags = 0 
)

Reads a HOOPS Stream File and map it to the HOOPS/3dGS scene-graph.

The contents of the HOOPS Stream File are mapped to the corresponding HOOPS/3dGS scene-graph hierarchy underneath the currently open segment.

Parameters:
filenameA pointer to a UNICODE wide character string denoting the name of the file to read in.
flagsBitwise encoding of options which control how the file is read. TK_File_Read_Options provides a list of supported options.
TK_Status HBINFILETK_API HTK_Read_Stream_File ( char const *  filename,
int  flags,
HStreamFileToolkit tk 
)

Deprecated; reads a HOOPS Stream File and map it to the HOOPS/3dGS scene-graph

The contents of the HOOPS Stream File are mapped to the corresponding HOOPS/3dGS scene-graph hierarchy underneath the currently open segment. This form of the function is provided for backward compatibility.