HTK_Write_Stream_File

Functions

TK_Status HBINFILETK_API HTK_Write_Stream_File (char const *filename, HStreamFileToolkit *tk)
 Exports the HOOPS/3dGS scene-graph to a HOOPS Stream File. More...
 
TK_Status HBINFILETK_API HTK_Write_Stream_File (char const *filename, int flags=0)
 Exports the HOOPS/3dGS scene-graph to a HOOPS Stream File. More...
 
TK_Status HBINFILETK_API2 HTK_Write_Stream_File (__wchar_t const *filename, HStreamFileToolkit *tk)
 Exports the HOOPS/3dGS scene-graph to a HOOPS Stream File. More...
 
TK_Status HBINFILETK_API HTK_Write_Stream_File (__wchar_t const *filename, int flags=0)
 Exports the HOOPS/3dGS scene-graph to a HOOPS Stream File. More...
 
TK_Status HBINFILETK_API2 HTK_Write_Stream_File (char const *filename, int flags, HStreamFileToolkit *tk)
 Deprecated; exports the HOOPS/3dGS scene-graph to a HOOPS Stream File More...
 

Detailed Description

Function Documentation

◆ HTK_Write_Stream_File() [1/5]

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

Exports the HOOPS/3dGS scene-graph to a HOOPS Stream File.

The contents of the HOOPS/3dGS scene-graph, beginning with the currently open segment, are written out to a HOOPS Stream File

Parameters
filenameA character pointer denoting the name of the file to write.
tkA pointer to the HStreamFileToolkit object to use as a basis for generating the file. This would be passed in to write out a customized file that contains user-specified data. Options to control how the file is written may be specified using the BStreamFileToolkit::SetWriteFlags() method on the toolkit.

◆ HTK_Write_Stream_File() [2/5]

TK_Status HBINFILETK_API HTK_Write_Stream_File ( char const *  filename,
int  flags = 0 
)

Exports the HOOPS/3dGS scene-graph to a HOOPS Stream File.

The contents of the HOOPS/3dGS scene-graph, beginning with the currently open segment, are written out to a HOOPS Stream File

Parameters
filenameA character pointer denoting the name of the file to write.
flagsBitwise encoding of options to control how the file is written. TK_File_Write_Options provides a list of supported options.

◆ HTK_Write_Stream_File() [3/5]

TK_Status HBINFILETK_API2 HTK_Write_Stream_File ( __wchar_t const *  filename,
HStreamFileToolkit tk 
)

Exports the HOOPS/3dGS scene-graph to a HOOPS Stream File.

The contents of the HOOPS/3dGS scene-graph, beginning with the currently open segment, are written out to a HOOPS Stream File

Parameters
filenameA pointer to a UNICODE wide character string denoting the name of the file to write.
tkA pointer to the HStreamFileToolkit object to use as a basis for generating the file. This would be passed in to write out a customized file that contains user-specified data. Options to control how the file is written may be specified using the BStreamFileToolkit::SetWriteFlags() method on the toolkit.

◆ HTK_Write_Stream_File() [4/5]

TK_Status HBINFILETK_API HTK_Write_Stream_File ( __wchar_t const *  filename,
int  flags = 0 
)

Exports the HOOPS/3dGS scene-graph to a HOOPS Stream File.

The contents of the HOOPS/3dGS scene-graph, beginning with the currently open segment, are written out to a HOOPS Stream File

Parameters
filenameA pointer to a UNICODE wide character string denoting the name of the file to write.
flagsBitwise encoding of options to control how the file is written. TK_File_Write_Options provides a list of supported options.

◆ HTK_Write_Stream_File() [5/5]

TK_Status HBINFILETK_API2 HTK_Write_Stream_File ( char const *  filename,
int  flags,
HStreamFileToolkit tk 
)

Deprecated; exports the HOOPS/3dGS scene-graph to a HOOPS Stream File

The contents of the HOOPS/3dGS scene-graph, beginning with the currently open segment, are written out to a HOOPS Stream File. This form of the function is provided for backward compatibility.