Alphabetical Class Index  Class Hierarchy   File Members   Compound Members   File List  

HInputHandlerOptions Class Reference

#include <HIOManager.h>

List of all members.

Public Types

enum  { SINGLE_ENTITY_CELLHEADER, BREAK_CELLHEADER, OPT_CELLHEADER }

Public Member Functions

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

Public Attributes

bool m_bAttachDWGHandles
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 precison loss.
bool m_bDisableDWFDrawOrder
bool m_bDisableDWGDrawOrder
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_bDwgDepthRangeDrawOrder
bool m_bDWGInsertMeshesAsShells
bool m_bForceReimport
 DWG file import option: If true, re-imports DWG files (master and all xrefs) even if their corresponding HSF files are found with a later date-timestamp. Valid only when m_bInputViaHSF is true.
bool m_bIgnoreOffEntities
bool m_bImportAllLayouts
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_bImportWireframeForBrep
 DWG file import option: Set to true if you want to import the wireframe representation for BRep solids. For e.g. wireframe edges of a cube.
bool m_bInputViaHSF
 DWG file import option: Set to true if you want to import the DWG file using BStream Toolkit. Use this option for very large DWG models.
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_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_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_Deviation
 DWG file import option: The allowable maximum difference in world space between a true mathematical surface and the tessellated surface. Valid values range from 0.01 to 10 (the default), with 0.01 representing the best tessellation and 10 the worst. To match the tessellation of AutoCAD, a value of 0.5 is usually sufficient.
HDwgViewVector m_eDwgViewVector
double m_factorForSmartSolids
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.
struct vlist_s * m_listDWGLayouts
struct vlist_s * m_listEntityType
struct vlist_s * m_listRegAppNames
double m_numIsolines
 DWG file import option: Set the number of isolines you want for surfaces (cylindrical/spherical/toroidal). Set to 0 for suppressing isolines .
HIOConnectorm_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.
HBaseViewm_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.
HIOConnectorm_pPRCPMIConnector
 PRC import option: Pointer to connector class. If not null prc PMI entities will be associated to HOOPS keys.
BREP_Topologym_pPRCTopologyManager
 PRC import option: Pointer to connector class. If not null prc topology entities will be associated to HOOPS keys.
HPoint m_sDwgContrastColorRgb
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

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 childs

OPT_CELLHEADER 

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


Constructor & Destructor Documentation

HInputHandlerOptions::HInputHandlerOptions ( ) [inline]

Construct an HInputHandlerOptions object.

References DwgViewportInherit.


Member Data Documentation

DWG file import option: If true, DWG entity handles will be imported and put it as UserOptions. Default value is false.

Referenced by HInputHandlerOptions().

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().

DWG 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().

DWG file import option: If true, then depth range will be used for determining the draw order of 2D entities which require it. If false, then geometry will be offset along the z-axis to determine the draw order of 2D entities which require it. A setting of false is recommended as it allows for a more optimal scene graph.

Referenced by HInputHandlerOptions().

DWG file import option: If true, All meshes will be converted as shells.

Referenced by HInputHandlerOptions().

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

Referenced by HInputHandlerOptions().

DWG file import option: If true, All Paper_Space Layouts will get imported. Model Space will have Visiblity=ON, while all others Layouts with visiblity=OFF.

Referenced by HInputHandlerOptions().

DWG/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().

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().

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().

DWG file import option: Controls the view vector passed to RealDWG which will determine the type of geometry drawn for certain view dependent entities. It is primarily intended for files coming from certain vertical AutoCAD products, e.g., AutoCAD MEP or AutoCAD ACA. The default it DwgViewportInherit.

Referenced by HInputHandlerOptions().

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().

DWG file import option: List of DWG Layouts to be imported. If list is not provided, default Model_Space is imported

Referenced by HInputHandlerOptions().

DWG file import option: List of AcDb entities which user want to import(e.g. AcDb3dSolid, AcDbBlockReference). Pass NULL if you want to import all supported AcDb entities.

Referenced by HInputHandlerOptions().

DWG file import option: List of strings (char*) which is name of registered application names. The DWG importer will import metadata (xdata) for these applications only. Pass NULL if you want import of all xData. This option will only be used if m_bImportMetadata is true.

Referenced by HInputHandlerOptions().

DWG file import option: Controls the color used if geometry within the DWG file is using the "contrast color" index from AutoCAD. In AutoCAD if geometry uses this "contrast color" index, the color of the geometry will vary with the window background color (if the window background is dark, the geometry will be white, if the window background is light, the geometry will be black). Setting this value allows the user to choose the color to set for geometry with this index. The default is black.

Referenced by HInputHandlerOptions().

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().


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