Public Types | Public Member Functions | Public Attributes | List of all members
HInputHandlerOptions Class Reference

#include <HIOManager.h>

Public Types

enum  { SINGLE_ENTITY_CELLHEADER, BREAK_CELLHEADER, OPT_CELLHEADER }
 
enum  {
  AUTOMATIC, RETAIN_AS_IS, FLOAT_IF_SAFE, FORCE_FLOAT,
  FORCE_DOUBLE
}
 

Public Member Functions

 HInputHandlerOptions ()
 
 HInputHandlerOptions (HInputHandlerOptions const *o)
 
 HInputHandlerOptions (const HInputHandlerOptions &o)
 

Public Attributes

int m_attributePrecisionMode
 The manner in which precision in attributes (such as matrices) is handled.
 
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_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_bDisableDWFDrawOrder
 
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_bDwgSkipUnreferencedBlocks
 
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_bIgnoreOffEntities
 
bool m_bImportMetadata
 DWG and SKP import option: Set to true if you want to import the metadata (xdata) along with the geometry.
 
bool m_bImportThumbnail
 DWF file import option: if true then Thumbnail are imported in the DWF file.
 
bool m_bIsTestingSettings
 Testing settings. true if you want to activate testings settings.
 
bool m_bLegacyOptimize
 
bool m_bLocal
 The value is true if the image will have the local attribute.
 
bool m_bLogging
 If true, logging will be enabled in those plugins that support it.
 
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.
 
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_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_bPRCCalculatePhysicalProperties
 
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_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. More...
 
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_bPRCImportNonBrepFaces
 
bool m_bPRCInstanceShells
 
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.
 
bool m_bPRCMergeFaces
 PRC import option: If true individual faces will be merged into one shell.
 
bool m_bPRCStoreUserAttributes
 PRC import option: If true all prc user attributes will be converted as user option.
 
double m_coneFactor
 
double m_depth_range
 
double m_factorForSmartSolids
 
bool m_generatedDouble
 The manner in which precision in geometry is handled. More...
 
int m_iDGNCellHeaderOption
 DGN file import option: has three option about how cell header should be imported.
 
const char * 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.
 
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.
 
HBaseView * m_pHBaseView
 A pointer to the HBaseView object for this input.
 
const char * m_pImageFormat
 The HOOPS image format to use for loading an image if not using filename .ext for format.
 
const char * m_pImageName
 The HOOPS image name to use for a newly loaded image.
 
void * m_pOOCNodeDeltas
 OOC import option: Pointer to node deltas. If not null, importer will use it to selectively reject points on file load.
 
void * m_pPRCAsmModelFile
 PRC import option: Returned to user. Contains Pointer to A3DAsmModelFile entity.
 
void(* m_pPRCDeleteModelCallback )(void *&pPRCAsmModelFile)
 PRC import option: Function pointer to delete model.
 
bool m_pPRCDeleteModelFile
 PRC import option: If true model file is deleted after loading is complete.
 
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.
 
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.
 
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.
 
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. More...
 
HStreamFileToolkit * m_tk
 The streamfile toolkit to be used.
 
double m_z_separation
 

Detailed Description

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.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Specifies how cell header should be imported

Enumerator
SINGLE_ENTITY_CELLHEADER 

indicates that cell header entity will be imported as single segment

BREAK_CELLHEADER 

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

OPT_CELLHEADER 

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

◆ anonymous enum

anonymous enum

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

Enumerator
AUTOMATIC 

handling choice is left to the importer

RETAIN_AS_IS 

data is kept in the format from the file

FLOAT_IF_SAFE 

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

FORCE_FLOAT 

data is forced to single-precision

FORCE_DOUBLE 

data is forced to double-precision

Constructor & Destructor Documentation

◆ HInputHandlerOptions() [1/3]

HInputHandlerOptions::HInputHandlerOptions ( )
inline

Construct an HInputHandlerOptions object.

◆ HInputHandlerOptions() [2/3]

HInputHandlerOptions::HInputHandlerOptions ( HInputHandlerOptions const *  o)
inline

Construct an HInputHandlerOptions object from another HInputHandlerOptions object.

Parameters
oA pointer to an HInputHandlerOptions object that you want to copy.

References m_attributePrecisionMode, m_bDGNImportAllModels, m_bDGNRebaselineModel, m_bDisableDWFDrawOrder, m_bDWFRebaselineModel, m_bDwgSkipUnreferencedBlocks, m_bForceRenderedModeColors, m_bIgnoreOffEntities, m_bImportMetadata, m_bImportThumbnail, m_bIsTestingSettings, m_bLegacyOptimize, m_bLocal, m_bOOCAutoCleanup, m_bOOCAutoUpdate, m_bOptimizeSegmentTree, m_bPRCCreatePRCFileOnly, m_bPRCExtractLargeTranslations, m_bPRCImportHiddenObjects, m_bPRCLoadAsDrawings, m_bPRCMergeFaces, m_coneFactor, m_depth_range, m_factorForSmartSolids, m_generatedDouble, m_iDGNCellHeaderOption, m_license, m_pConnector, m_pExtendedData, m_pHBaseView, m_pImageFormat, m_pImageName, m_pOOCNodeDeltas, m_pPRCAsmModelFile, m_pPRCDeleteModelCallback, m_pPRCDeleteModelFile, m_pPRCMultiModelSelectionCallback, m_pPRCPMIConnector, m_pPRCTopologyManager, m_PRCModelUnits, and m_PRCReferenceSegmentKey.

◆ HInputHandlerOptions() [3/3]

HInputHandlerOptions::HInputHandlerOptions ( const HInputHandlerOptions &  o)
inline

Construct an HInputHandlerOptions object from another HInputHandlerOptions object.

Parameters
oPass by reference an HInputHandlerOptions object that you want to copy.

References m_attributePrecisionMode, m_bDGNImportAllModels, m_bDGNRebaselineModel, m_bDisableDWFDrawOrder, m_bDWFRebaselineModel, m_bDwgSkipUnreferencedBlocks, m_bForceRenderedModeColors, m_bIgnoreOffEntities, m_bImportMetadata, m_bImportThumbnail, m_bIsTestingSettings, m_bLegacyOptimize, m_bLocal, m_bOOCAutoCleanup, m_bOOCAutoUpdate, m_bOptimizeSegmentTree, m_bPRCCreatePRCFileOnly, m_bPRCExtractLargeTranslations, m_bPRCImportHiddenObjects, m_bPRCLoadAsDrawings, m_bPRCMergeFaces, m_coneFactor, m_depth_range, m_factorForSmartSolids, m_generatedDouble, m_iDGNCellHeaderOption, m_pConnector, m_pExtendedData, m_pHBaseView, m_pImageFormat, m_pImageName, m_pOOCNodeDeltas, m_pPRCAsmModelFile, m_pPRCDeleteModelFile, m_pPRCMultiModelSelectionCallback, m_pPRCPMIConnector, m_pPRCTopologyManager, m_PRCModelUnits, and m_PRCReferenceSegmentKey.

Member Data Documentation

◆ m_bDisableDWFDrawOrder

bool HInputHandlerOptions::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.

Referenced by HInputHandlerOptions().

◆ m_bDwgSkipUnreferencedBlocks

bool HInputHandlerOptions::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.

Referenced by HInputHandlerOptions().

◆ m_bIgnoreOffEntities

bool HInputHandlerOptions::m_bIgnoreOffEntities

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

Referenced by HInputHandlerOptions().

◆ m_bLegacyOptimize

bool HInputHandlerOptions::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.

Referenced by HInputHandlerOptions().

◆ m_bPRCExtractLargeTranslations

bool HInputHandlerOptions::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.

Referenced by HInputHandlerOptions().

◆ m_coneFactor

double HInputHandlerOptions::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.

Referenced by HInputHandlerOptions().

◆ m_depth_range

double HInputHandlerOptions::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.

Referenced by HInputHandlerOptions().

◆ m_factorForSmartSolids

double HInputHandlerOptions::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

Referenced by HInputHandlerOptions().

◆ m_generatedDouble

bool HInputHandlerOptions::m_generatedDouble

The manner in which precision in geometry is handled.

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

Referenced by HInputHandlerOptions().

◆ m_PRCReferenceSegmentKey

HC_KEY HInputHandlerOptions::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.

Referenced by HInputHandlerOptions().

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