HInputHandlerOptions

Detailed Description

class HInputHandlerOptions

HInputHandlerOptions is used to pass data to the HInputHandler. All options are used based on the handler’s needs. Specific HInputHandler subclassed instances should document their own usage of options.

Public Types

enum [anonymous]

Specifies how cell header should be imported

Values:

enumerator SINGLE_ENTITY_CELLHEADER

indicates that cell header entity will be imported as single segment

enumerator BREAK_CELLHEADER

indicates that cell header will have as many segments as its children

enumerator OPT_CELLHEADER

same as BREAK_CELLHEADER, but segment structure will be optimized for color

enum [anonymous]

Specifies how data precision should be handled (not all implemented)

Values:

enumerator AUTOMATIC

handling choice is left to the importer

enumerator RETAIN_AS_IS

data is kept in the format from the file

enumerator FLOAT_IF_SAFE

data is converted to float if it appears safe, otherwise it is retained as double

enumerator FORCE_FLOAT

data is forced to single-precision

enumerator FORCE_DOUBLE

data is forced to double-precision

Public Functions

inline HInputHandlerOptions()

Construct an HInputHandlerOptions object.

inline HInputHandlerOptions(HInputHandlerOptions const *o)

Construct an HInputHandlerOptions object from another HInputHandlerOptions object.

Parameters:o – A pointer to an HInputHandlerOptions object that you want to copy.
inline HInputHandlerOptions(HInputHandlerOptions const &o)

Construct an HInputHandlerOptions object from another HInputHandlerOptions object.

Parameters:o – Pass by reference an HInputHandlerOptions object that you want to copy.
virtual ~HInputHandlerOptions()

Public Members

HBaseView *m_pHBaseView

A pointer to the HBaseView object for this input.

char const *m_pImageName

The HOOPS image name to use for a newly loaded image.

char const *m_pImageFormat

The HOOPS image format to use for loading an image if not using filename .ext for format.

bool m_bLocal

The value is true if the image will have the local attribute.

HStreamFileToolkit *m_tk

The streamfile toolkit to be used.

bool m_bLogging

If true, logging will be enabled in those plugins that support it.

HIOConnector *m_pConnector

A pointer to HIOConnector object. The connectivity between HOOPS and kernel will be stored in this.

void *m_pExtendedData

A pointer to extra data needed by a HInputHandler subclass.

bool m_bImportMetadata

DWG and SKP import option: Set to true if you want to import the metadata (xdata) along with the geometry.

char const *m_license

A pointer to a license key, intended to be used by 3rd party toolkits which require a license key to be passed in. Currently used by HIO_Exchange and HIO_Publish

bool m_bIgnoreOffEntities

DGN,DWG and SketchUp file import option: If true, ignores import of entities whose visibility is off.

double m_coneFactor

DGN file import option: This is for elements inserted as meshes in HOOPS. Increasing value of this factor increases the number of rows/columns in mesh elements.

double m_factorForSmartSolids

DGN file import option: This is for smarts/feature solids. This is angle in degree with range from 0 to 360 Increasing the value decreases the tessellation

int m_iDGNCellHeaderOption

DGN file import option: has three option about how cell header should be imported.

void *m_pPRCAsmModelFile

PRC import option: Returned to user. Contains Pointer to A3DAsmModelFile entity.

bool m_pPRCDeleteModelFile

PRC import option: If true model file is deleted after loading is complete.

HIOConnector *m_pPRCPMIConnector

PRC import option: Pointer to connector class. If not null prc PMI entities will be associated to HOOPS keys.

BREP_Topology *m_pPRCTopologyManager

PRC import option: Pointer to connector class. If not null prc topology entities will be associated to HOOPS keys.

bool m_bPRCMergeFaces

PRC import option: If true individual faces will be merged into one shell.

bool m_bPRCImportNonBrepFaces
bool m_bPRCCreatePRCFileOnly

PRC import option: If true temporary prc file will be created but no parsing and creation of HOOPS entities occurs.

bool m_bPRCInstanceShells
bool m_bPRCCalculatePhysicalProperties
void (*m_pPRCMultiModelSelectionCallback)(char const *in_container, int in_num_configs, char const *in_configs[], int &out_config_selection)

PRC import option: Function pointer for interactive multi-model loading.

bool m_bPRCStoreUserAttributes

PRC import option: If true all prc user attributes will be converted as user option.

void (*m_pPRCDeleteModelCallback)(void *&pPRCAsmModelFile)

PRC import option: Function pointer to delete model.

bool m_bPRCImportHiddenObjects

PRC import option: If true, hidden objects will be imported though not visible. If false, hidden objects will be skipped over and not imported.

bool m_bPRCLoadAsDrawings

PRC import option: When loading a DWG or DXF file through HIOUtilityExchange, set this option to true to import it as a drawing, false to import it as a 3D model.

float m_PRCModelUnits

PRC import option: Used to specify the model units of an already loaded model, so that other models can be scaled appropriately when loaded in the same scene.

bool m_bPRCExtractLargeTranslations

PRC import option: If set to true, large translation matrices set at the top of the model will be stripped out to avoid visual artifacts due to precision loss. The extracted translation, if any, will be stored on the model segment as a user option with name “extracted translation = (x, y, z)”. By default, this option is set to false.

HC_KEY m_PRCReferenceSegmentKey

PRC import option: If this model is being loaded with the intent of it being merged with another, previously loaded model, and if m_bPRCExtractLargeTranslations is set to true, m_PRCReferenceSegment should contain the key of the segment of the previously loaded model. Doing so will guarantee that relative transformations between the two models are taken into account when large translations are extracted.

bool m_bDGNRebaselineModel

DGN file import option: if true then whole model is rebased with use of model extents to compensate for the floating point precision loss

bool m_bDGNImportAllModels

DGN file import option: if true then all the models are imported in the DGN file else only current model is imported.

bool m_bDisableDWFDrawOrder

DWF file import option: If true, Draw order will be ignored, depth range setting will not be added in entity segments. Segment optimization works better this way.

bool m_bImportThumbnail

DWF file import option: if true then Thumbnail are imported in the DWF file.

bool m_bDWFRebaselineModel

DWF file import option: if true then whole model is rebased with use of model extents to compensate for the floating point precision loss

bool m_bOptimizeSegmentTree

SKP file import option: if true then model is optimized using Optimize_Segment_Tree API. Can be set to true if scene graph structure is not important

bool m_bForceRenderedModeColors

Rhino file import option: if true then Exchange will force rendered mode colors instead of shading mode colors when importing Rhino files.

bool m_bLegacyOptimize

DGN file import option: If true, then user options for entities remain at the segment level. If false, then user options for entities will be moved onto geometry. A setting of false is recommended as it allows for a more optimal scene graph.

bool m_bDwgSkipUnreferencedBlocks

DWG file import option: If true, entities of type AcDbBlockTableRecord, which are not referenced by other AcDbBlockTableRecords will not be imported. AcDbBlockTableRecord entities which are Layouts will always be imported. A setting of false will provide the user with a complete representation of the file Block Table. A setting of true will improve the import time of DWG files containing unreferenced block table records. This setting defaults to false.

double m_z_separation
double m_depth_range

For 2D files (DWF only as of this time), the drawing can be layered either by using depth range or by offsetting the z values. To separate the layers by z value, make sure z > 0. To use depth range, make sure depth range > 0.

bool m_bOOCAutoUpdate

OOC import option: Determines whether or not the view for the OOC model should automatically update when new points are loaded into memory.

bool m_bOOCAutoCleanup

OOC import option: Determines whether or not the view for the OOC model should automatically cleanup the OOC data when the view is destroyed.

int m_attributePrecisionMode

The manner in which precision in attributes (such as matrices) is handled.

bool m_generatedDouble

The manner in which precision in geometry is handled.

returned to caller. true if the importer generated any double-precision data

bool m_bIsTestingSettings

Testing settings. true if you want to activate testings settings.