Alphabetical Class Index  Class Hierarchy   File Members   Compound Members   File List  

HIOUtilityDwfImport Class Reference

#include <HIOUtilityDwfImport.h>

List of all members.

Public Member Functions

HFileInputResult FileInputByKey (const wchar_t *FileName, HC_KEY key, HInputHandlerOptions *options)
HFileInputResult FileInputByKey (const char *FileName, HC_KEY key, HInputHandlerOptions *options)
const char * GetInputName ()
HInputHandlerStyle GetInputStyle ()
const char * GetInputTypesString ()
const char * GetOutputName ()
void RegisterInputHandlerTypes ()

Detailed Description

The HIOUtilityDwfImport is the integration class for the DWF toolkit. Using this integration class allows you to import Autodesk's DWF (Design Web Format). This integration is based on DWF Toolkit version 7+. To use this integration class you will need to obtain a license of DWF Toolkit.


Member Function Documentation

HFileInputResult HIOUtilityDwfImport::FileInputByKey ( const wchar_t *  FileName,
HC_KEY  key,
HInputHandlerOptions options 
)

This method reads the DWF file into the segment tree underneath given key

Parameters:
FileNameA character pointer denoting the name of the file to be read in
keyHOOPS key to segment for data to load in
Importoptions
Returns:
InputOK if the import succeeds
HFileInputResult HIOUtilityDwfImport::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:
filenameThe name of the file to load.
keyThe HOOPS segment key to load model data into.
optionsAn options class containing any needed extra information for the operation.
Returns:
The #HFileInputResult result of the input operation.

Reimplemented from HInputHandler.

References HInputHandler::FileInputByKey().

const char* HIOUtilityDwfImport::GetInputName ( ) [inline, virtual]
Returns:
A character pointer denoting the name of the input handler.

Implements HInputHandler.

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

This abstract method returns the HInputHandlerStyle the HInputHandler.

For example, the following line of code can be used for an HInputHandler that handles models:

 

Implements HInputHandler.

References HInputHandlerStyleModel.

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

This method must be implemented in a subclassed HInputHandler.

Returns:
The extension type or types that are handled by this HInputHandler.

Examples:

The following line of code can be used to specify the stl extension:

 
 {return "stl";};

The following line of code can be used to specify that the jpg, bmp and gif extension are handled:

 
 {return "jpg;bmp;gif";};

Implements HInputHandler.

const char* HIOUtilityDwfImport::GetOutputName ( ) [inline]
Returns:
A character pointer denoting the name of the handler.
void HIOUtilityDwfImport::RegisterInputHandlerTypes ( ) [inline, virtual]

This abstract function must register extension types to be handled by subclassed HInputHandler instance.

For example, the following line of code can be used to specify a class that will handle files with "stl" extensions:

 
 {HIORegisterInputType("stl",this);};

Implements HInputHandler.

References HIORegisterInputType.


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