Alphabetical Class Index  Class Hierarchy   File Members   Compound Members   File List  

HIOUtilityU3D Class Reference

#include <HIOUtilityU3D.h>

Inheritance diagram for HIOUtilityU3D:

HInputHandler HOutputHandler

List of all members.

Public Member Functions

HFileInputResult FileInputByKey (const unsigned short *FileName, HC_KEY key, HInputHandlerOptions *options)
HFileInputResult FileInputByKey (const char *FileName, HC_KEY key, HInputHandlerOptions *options)
HFileInputResult FileInputByKey (const __wchar_t *FileName, HC_KEY key, HInputHandlerOptions *options)
HFileOutputResult FileOutputByKey (const char *filename, HC_KEY key, HOutputHandlerOptions *options)
HFileOutputResult FileOutputByKey (const unsigned short *filename, HC_KEY key, HOutputHandlerOptions *options)
HFileOutputResult FileOutputByKey (const __wchar_t *filename, HC_KEY key, HOutputHandlerOptions *options)
const char * GetInputName ()
HInputHandlerStyle GetInputStyle ()
const char * GetInputTypesString ()
const char * GetOutputName ()
HOutputHandlerStyle GetOutputStyle ()
const char * GetOutputTypesString ()
 HIOUtilityU3D ()
void RegisterInputHandlerTypes ()
void RegisterOutputHandlerTypes ()


Detailed Description

DEPRECATED -> this class is no longer supported or maintained by TS3D and may be removed in the future. Developers who were using this class in order to export 3D-PDF content should migrate to the HOOPS Exchange/Publish support for the PRC format.

Developers interested in using this HIO module must build and support it on their own.

The HIOUtilityU3D is a class which facilitates export of HOOPS scene graph to U3D format. To use this integration class you will need to obtain a license for the U3D Toolkit. Please refer to http://u3d.sourceforge.net/ for more details on U3D (Universal 3D) format and the SDK to read and write U3D files.


Constructor & Destructor Documentation

HIOUtilityU3D::HIOUtilityU3D (  )  [inline]


Member Function Documentation

HFileInputResult HIOUtilityU3D::FileInputByKey ( const unsigned short *  filename,
HC_KEY  key,
HInputHandlerOptions options 
) [inline, virtual]

This method loads model data from a given file to a given HOOPS segment key. Note that this must be implemented in a subclassed HInputHandler instance handling models.

Parameters:
filename The UNICODE name of the file to load.
key The HOOPS segment key to load model data into.
options An options class containing any needed extra information for the operation.
Returns:
The HFileInputResult result of the input operation.

Reimplemented from HInputHandler.

References HInputHandler::FileInputByKey().

HFileInputResult HIOUtilityU3D::FileInputByKey ( const char *  filename,
HC_KEY  key,
HInputHandlerOptions options 
) [inline, virtual]

This method loads model data from a given file to a given HOOPS segment key. Note that this must be implemented in a subclassed HInputHandler instance handling models.

Parameters:
filename The name of the file to load.
key The HOOPS segment key to load model data into.
options An options class containing any needed extra information for the operation.
Returns:
The HFileInputResult result of the input operation.

Reimplemented from HInputHandler.

References HInputHandler::FileInputByKey().

HFileInputResult HIOUtilityU3D::FileInputByKey ( const __wchar_t *  FileName,
HC_KEY  key,
HInputHandlerOptions options 
) [virtual]

This method reads the U3D file into the segment tree underneath the given key.

Parameters:
filename The name of the file to load.
key The HOOPS segment key to load model data into.
options An options class containing any needed extra information for operation.
Returns:
The HFileInputResult result of the input operation.

Reimplemented from HInputHandler.

HFileOutputResult HIOUtilityU3D::FileOutputByKey ( const char *  filename,
HC_KEY  key,
HOutputHandlerOptions options 
) [inline, virtual]

This method writes model data from a given HOOPS key to a given output file. Note that this must be implimented in a subclassed HOutputHandler instance handling models.

Parameters:
filename The name of the file to output.
key The HOOPS segment key to output model data from.
options The options class containing any needed extra information for the operation.
Returns:
The HFileOutputResult result of the output operation.

Reimplemented from HOutputHandler.

References HOutputHandler::FileOutputByKey().

HFileOutputResult HIOUtilityU3D::FileOutputByKey ( const unsigned short *  filename,
HC_KEY  key,
HOutputHandlerOptions options 
) [inline, virtual]

This method writes model data from a given HOOPS key to a given output file. Note that this must be implimented in a subclassed HOutputHandler instance handling models.

Parameters:
filename The wide character name of the file to output.
key The HOOPS segment key to get output model data from.
options The options class containing any needed extra information for the operation.
Returns:
The HFileOutputResult result of the output operation.

Reimplemented from HOutputHandler.

References HOutputHandler::FileOutputByKey().

HFileOutputResult HIOUtilityU3D::FileOutputByKey ( const __wchar_t *  filename,
HC_KEY  key,
HOutputHandlerOptions options 
) [virtual]

This method exports the HOOPS segment tree under the given key to a U3D file.

Parameters:
filename The name of the file to output.
key The HOOPS segment key to output model data from.
options The options class containing any needed extra information for the operation.
Returns:
The HFileOutputResult result of the output operation.

Reimplemented from HOutputHandler.

const char* HIOUtilityU3D::GetInputName (  )  [inline, virtual]

Returns:
A character pointer denoting the name of the input handler.

Implements HInputHandler.

HInputHandlerStyle HIOUtilityU3D::GetInputStyle (  )  [inline, virtual]

Returns:
The type of input style which is HInputHandlerStyleModel.

Implements HInputHandler.

References HInputHandlerStyleModel.

const char* HIOUtilityU3D::GetInputTypesString (  )  [inline, virtual]

Returns:
The input extension type that is handled by HIOUtilityHMF which is "u3d".

Implements HInputHandler.

const char* HIOUtilityU3D::GetOutputName (  )  [inline, virtual]

Returns:
A character pointer denoting the name of the handler.

Implements HOutputHandler.

HOutputHandlerStyle HIOUtilityU3D::GetOutputStyle (  )  [inline, virtual]

Returns:
The type of output style which is HOutputHandlerStyleModel.

Implements HOutputHandler.

const char* HIOUtilityU3D::GetOutputTypesString (  )  [inline, virtual]

Returns:
The string of the type of output this handler creates which is "u3d".

Implements HOutputHandler.

void HIOUtilityU3D::RegisterInputHandlerTypes (  )  [inline, virtual]

This method registers the "u3d" extension to this handler for reading.

Implements HInputHandler.

References HIORegisterInputType.

void HIOUtilityU3D::RegisterOutputHandlerTypes (  )  [inline, virtual]

This method registers the "u3d" extension to this handler as an output handler.

Implements HOutputHandler.

References HIORegisterOutputType.


The documentation for this class was generated from the following file: