Alphabetical Class Index  Class Hierarchy   File Members   Compound Members   File List  

HInputHandlerOptions Class Reference

#include <HIOManager.h>

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
 Applies to HIO_DGN. if true then all the models are imported in the DGN file else only current model is imported.
 
bool m_bDGNRebaselineModel
 Applies to HIO_DGN. 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
 Applies to HIO_DWF. 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
 Applies to HIO_DWG module. 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
 HIO_DWG and HIO_SKP import option: Set to true if you want to import the metadata (xdata) along with the geometry.
 
bool m_bImportThumbnail
 Applies to HIO_DWF. if true then Thumbnail are imported in the DWF file.
 
bool m_bImportWireframeForBrep
 Applies to HIO_DWG module. 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
 Applies to HIO_DWG module. 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_bOptimizeSegmentTree
 Applies to HIO_SKP. 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_bPMIDetected
 
bool m_bPRCCreatePRCFileOnly
 Applies to HIO_Exchange and HIO_Publish. 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_bPRCMergeFaces
 Applies to HIO_Exchange and HIO_Publish. 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.
 
bool m_bSuppressEarlyOptimization
 
double m_coneFactor
 
double m_depth_range
 
double m_Deviation
 Applies to HIO_DWG module. The allowable maximum difference in world space between a true mathematical surface and the tessellated surface.
 
double m_dPRCMinimumTransparency
 PRC import option: define the minimum of transparency that can be applied.
 
HDwgViewVector m_eDwgViewVector
 
double m_factorForSmartSolids
 
int m_iDGNCellHeaderOption
 Applies to HIO_DWG module. Contains options 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
 Applies to HIO_DWG module. 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 scene-graph entities and 3rd party toolkit/format objects is managed by this class.
 
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_pPRCAsmModelFile
 PRC import option: Returned to user. Contains Pointer to A3DAsmModelFile entity.
 
bool m_pPRCDeleteModelFile
 Applies to HIO_Exchange and HIO_Publish. 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)
 Applies to HIO_Exchange and HIO_Publish. Function pointer for interactive multi-model loading.
 
HIOConnectorm_pPRCPMIConnector
 Applies to HIO_Exchange and HIO_Publish. Pointer to connector class. If not null, PRC PMI entities will be associated to HOOPS keys.
 
BREP_Topologym_pPRCTopologyManager
 Applies to HIO_Exchange and HIO_Publish. 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

Applies to HIO_DWG module. 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

bool HInputHandlerOptions::m_bAttachDWGHandles

Applies to HIO_DWG module. If true, DWG entity handles will be imported and put it as UserOptions. Default value is false.

Referenced by HInputHandlerOptions().

bool HInputHandlerOptions::m_bDisableDWFDrawOrder

Applies to HIO_DWF. If true, draw order will be ignored, and depth range setting will not be added in entity segments. Segment-tree optimization will be more effective if this is set.

Referenced by HInputHandlerOptions().

bool HInputHandlerOptions::m_bDisableDWGDrawOrder

Applies to HIO_DWG module. 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().

bool HInputHandlerOptions::m_bDwgDepthRangeDrawOrder

Applies to HIO_DWG. 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().

bool HInputHandlerOptions::m_bDWGInsertMeshesAsShells

Applies to HIO_DWG. If true, All meshes will be converted as shells.

Referenced by HInputHandlerOptions().

bool HInputHandlerOptions::m_bIgnoreOffEntities

HIO_DGN, HIO_DWG and HIO_SketchUp file import option. If true, ignores import of entities whose visibilty is off.

Referenced by HInputHandlerOptions().

bool HInputHandlerOptions::m_bImportAllLayouts

Applies to HIO_DWG. 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().

bool HInputHandlerOptions::m_bLegacyOptimize

Applies to HIO_DWG/HIO_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().

double HInputHandlerOptions::m_coneFactor

Applies to HIO_DGN module. 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().

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

HDwgViewVector HInputHandlerOptions::m_eDwgViewVector

Applies to HIO_DWG. 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().

double HInputHandlerOptions::m_factorForSmartSolids

Applies to HIO_DGN module. This is for smarts/feature solids. This is an angle, in degrees, from 0 to 360 Increasing the value decreases the tessellation.

Referenced by HInputHandlerOptions().

struct vlist_s* HInputHandlerOptions::m_listDWGLayouts

Applies to HIO_DWG module. List of DWG Layouts to be imported. If list is not provided, default Model_Space is imported

Referenced by HInputHandlerOptions().

struct vlist_s* HInputHandlerOptions::m_listEntityType

Applies to HIO_DWG module. 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().

struct vlist_s* HInputHandlerOptions::m_listRegAppNames

Applies to HIO_DWG module. 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().

HPoint HInputHandlerOptions::m_sDwgContrastColorRgb

Applies to HIO_DWG. 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().

double HInputHandlerOptions::m_z_separation

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: