HIOUtilityDwfImport Class Reference

#include <HIOUtilityDwfImport.h>

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 ()
 
- Public Member Functions inherited from HInputHandler
virtual HFileInputResult FileInputByKey (const __wchar_t *filename, HC_KEY key, HInputHandlerOptions *options)
 
virtual HFileInputResult FileInputByKey (const unsigned short *filename, HC_KEY key, HInputHandlerOptions *options)
 
virtual HFileInputResult FileInputToImageKey (const char *filename, HC_KEY *image_key, HC_KEY segment_key, HInputHandlerOptions *options)
 
virtual HFileInputResult FileInputToImageKey (const __wchar_t *filename, HC_KEY *image_key, HC_KEY segment_key, HInputHandlerOptions *options)
 
virtual HFileInputResult FileInputToImageKey (const unsigned short *filename, HC_KEY *image_key, HC_KEY segment_key, HInputHandlerOptions *options)
 
const __wchar_t * GetInputInformation ()
 
unsigned long GetInputOps ()
 
float GetInputPercentProgress ()
 
const __wchar_t * GetInputProgress ()
 
 HInputHandler ()
 
void ReportInputInformation (const char *information)
 This posts information to the information queue.
 
void ReportInputInformation (const __wchar_t *information)
 
void ReportInputPercentProgress (float percent_progress)
 This posts the current percent progress should be between 0.0 and 1.0.
 
void ReportInputProgress (const char *progress)
 This posts the current progress message.
 
void ReportInputProgress (const __wchar_t *progress)
 
HIONoticeCallbackSetInputInformationNoticeCallback (HIONoticeCallback *notice_callback)
 
HIOPercentNoticeCallbackSetInputPercentProgressNoticeCallback (HIOPercentNoticeCallback *percent_notice_callback)
 
HIONoticeCallbackSetInputProgressNoticeCallback (HIONoticeCallback *notice_callback)
 
void SetModuleDirectory (const char *module_directory)
 
void SetModuleDirectory (const __wchar_t *module_directory)
 

Additional Inherited Members

- Protected Member Functions inherited from HInputHandler
void SetFinishedInput ()
 
void SetInputOps (unsigned long ops)
 This sets the HInputOp.
 
void SetStartingInput (const char *filename)
 
void SetStartingInput (const __wchar_t *filename=0)
 
- Protected Attributes inherited from HInputHandler
unsigned long m_InputOps
 This is the HInputOp set for a subclassed instance.
 
__wchar_t * m_module_directory
 

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

◆ FileInputByKey() [1/2]

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

◆ FileInputByKey() [2/2]

HFileInputResult HIOUtilityDwfImport::FileInputByKey ( const char *  filename,
HC_KEY  key,
HInputHandlerOptions options 
)
inlinevirtual

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.

◆ GetInputName()

const char* HIOUtilityDwfImport::GetInputName ( )
inlinevirtual
Returns
A character pointer denoting the name of the input handler.

Implements HInputHandler.

◆ GetInputStyle()

HInputHandlerStyle HIOUtilityDwfImport::GetInputStyle ( )
inlinevirtual

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.

◆ GetInputTypesString()

const char* HIOUtilityDwfImport::GetInputTypesString ( )
inlinevirtual

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.

◆ GetOutputName()

const char* HIOUtilityDwfImport::GetOutputName ( )
inline
Returns
A character pointer denoting the name of the handler.

◆ RegisterInputHandlerTypes()

void HIOUtilityDwfImport::RegisterInputHandlerTypes ( )
inlinevirtual

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: