HIOManager.h
Go to the documentation of this file.
85 #define HIORegisterInputType(type,input_object) HIOManager::GetCurrentHIOManager()->RegisterInputHandler(type, input_object);
90 #define HIORegisterOutputType(type,output_object) HIOManager::GetCurrentHIOManager()->RegisterOutputHandler(type, output_object);
183 virtual bool GetHoopsEntities(void * pKernelEntity, vlist_s *ret_HoopsKeysList, HC_KEY modelKey);
521 OPT_CELLHEADER
544 void (*m_pPRCMultiModelSelectionCallback) (char const * in_container, int in_num_configs, char const * in_configs[],
560 // The extracted translation, if any, will be stored on the model segment as a user option with name "extracted translation = (x, y, z)".
608 For 2D files (DWF only as of this time), the drawing can be layered either by using depth range or by offsetting
609 the z values. To separate the layers by z value, make sure z > 0. To use depth range, make sure depth range > 0.
638 FORCE_DOUBLE
712 virtual HFileInputResult FileInputByKey(const char * filename, HC_KEY key, HInputHandlerOptions * options);
713 virtual HFileInputResult FileInputByKey(const __wchar_t * filename, HC_KEY key, HInputHandlerOptions * options);
724 virtual HFileInputResult FileInputByKey(const unsigned short * filename, HC_KEY key, HInputHandlerOptions * options);
736 virtual HFileInputResult FileInputToImageKey(const char * filename, HC_KEY * image_key, HC_KEY segment_key, HInputHandlerOptions * options);
737 virtual HFileInputResult FileInputToImageKey(const __wchar_t * filename, HC_KEY * image_key, HC_KEY segment_key, HInputHandlerOptions * options);
749 virtual HFileInputResult FileInputToImageKey(const unsigned short * filename, HC_KEY * image_key, HC_KEY segment_key, HInputHandlerOptions * options);
795 HIOPercentNoticeCallback * SetInputPercentProgressNoticeCallback(HIOPercentNoticeCallback *percent_notice_callback);
1300 virtual HFileOutputResult FileOutputByKey(const char * filename, HC_KEY key, HOutputHandlerOptions * options);
1301 virtual HFileOutputResult FileOutputByKey(const __wchar_t * filename, HC_KEY key, HOutputHandlerOptions * options);
1310 virtual HFileOutputResult FileOutputByKey(const unsigned short * filename, HC_KEY key, HOutputHandlerOptions * options);
1321 virtual HFileOutputResult FileOutputFromImageKey(const char * filename, HC_KEY image_key, HOutputHandlerOptions * options);
1322 virtual HFileOutputResult FileOutputFromImageKey(const __wchar_t * filename, HC_KEY image_key, HOutputHandlerOptions * options);
1384 HIOPercentNoticeCallback * SetOutputPercentProgressNoticeCallback(HIOPercentNoticeCallback *percent_notice_callback);
1469 virtual HOutputHandler * RegisterOutputHandler(const char * file_type, HOutputHandler * handler);
1481 virtual HIOConnector * RegisterConnector(const char * file_type, HIO_CREATE_FREE_FUNCTION Create, HIO_FREE_CONNECTOR_FUNCTION Free);
int PaperDpi() const
Indicates the DPI used for paper. This is set from the options dialog.
Definition: HIOManager.h:1073
Definition: HIOManager.h:1442
size_t LineFuseThreshold() const
Definition: HIOManager.h:1024
HBaseView * m_pHBaseView
A pointer to the HBaseView object for this output.
Definition: HIOManager.h:935
float PaperWidth() const
Width for output sizing in inches.
Definition: HIOManager.h:1000
bool m_bDGNRebaselineModel
DGN file import option: if true then whole model is rebased with use of model extents to compensate f...
Definition: HIOManager.h:565
Definition: HIOManager.h:869
bool m_bPRCExtractLargeTranslations
PRC import option: If set to true, large translation matrices set at the top of the model will be str...
Definition: HIOManager.h:562
Definition: HIOManager.h:99
void WindowFrame(bool const tf)
Determines if a window frame is drawn or not.
Definition: HIOManager.h:1054
void HSRAOptions(char const *const tf)
HOOPS HSRAOption string .
Definition: HIOManager.h:967
bool m_pPRCDeleteModelFile
PRC import option: If true model file is deleted after loading is complete.
Definition: HIOManager.h:528
void(* m_pPRCDeleteModelCallback)(void *&pPRCAsmModelFile)
PRC import option: Function pointer to delete model.
Definition: HIOManager.h:549
bool m_bPRCImportHiddenObjects
PRC import option: If true, hidden objects will be imported though not visible. If false...
Definition: HIOManager.h:551
char const * m_pPDFResourceDirectory
Definition: HIOManager.h:1181
struct vlist_s * owned_output_handlers
A list of default HOutputHandlers created by the manager.
Definition: HIOManager.h:1610
bool m_bLogging
If true, logging will be enabled in those plugins that support it.
Definition: HIOManager.h:483
The HBhvBehaviorManager class stores and manages all animation related data.
Definition: HBhvBehaviorManager.h:237
HCamera * Camera() const
A pointer to the HCamera object for this output.
Definition: HIOManager.h:951
void StlNormals(bool const tf)
Determines if we generate and output face normals when writing to STL file format.
Definition: HIOManager.h:1137
bool m_bDWFRebaselineModel
DWF file import option: if true then whole model is rebased with use of model extents to compensate f...
Definition: HIOManager.h:581
Definition: HUtility.h:2357
MVO_POINTER_SIZED_INT m_iPrcNameUserDataIndex
Definition: HIOManager.h:1217
const char * m_license
A pointer to a license key, intended to be used by 3rd party toolkits which require a license key to ...
Definition: HIOManager.h:495
struct vhash_s * mhash_Hoops2Kernel
A hash map between HOOPS Keys and kernel entities.
Definition: HIOManager.h:214
const char * m_pImageName
The HOOPS image name to use for a newly loaded image.
Definition: HIOManager.h:471
Definition: HIOManager.h:148
HInputHandler an abstract base class for model and image input.
Definition: HIOManager.h:663
bool m_bAVIShowCompressionDialog
Definition: HIOManager.h:1224
bool m_bDGNImportAllModels
DGN file import option: if true then all the models are imported in the DGN file else only current mo...
Definition: HIOManager.h:568
BREP_Topology * m_pPRCTopologyManager
PRC import option: Pointer to connector class. If not null prc topology entities will be associated t...
Definition: HIOManager.h:533
void * m_pOOCNodeDeltas
OOC import option: Pointer to node deltas. If not null, importer will use it to selectively reject po...
Definition: HIOManager.h:620
Specifies an HOutputHandler for a hardcopy output type.
Definition: HIOManager.h:859
HIOConnector * m_pConnector
A pointer to HIOConnector object. The connectivity between HOOPS and kernel will be stored in this...
Definition: HIOManager.h:486
HBhvBehaviorManager * m_pBehaviorManager
A pointer to the behavior manager.
Definition: HIOManager.h:1173
float m_PRCModelUnits
PRC import option: Used to specify the model units of an already loaded model, so that other models c...
Definition: HIOManager.h:557
Definition: HIOManager.h:122
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.
Definition: HIOManager.h:544
void PaperWidth(float const f)
Width for output sizing in inches.
Definition: HIOManager.h:1002
bool m_bOOCAutoCleanup
OOC import option: Determines whether or not the view for the OOC model should automatically cleanup ...
Definition: HIOManager.h:626
void ConserveMemory(bool const tf)
This option has been deprecated and has no effect.
Definition: HIOManager.h:1043
data is converted to float if it appears safe, otherwise it is retained as double ...
Definition: HIOManager.h:636
struct vhash_s * input_handlers
A hash of HInputHandlers.
Definition: HIOManager.h:1598
HOutputHandler an abstract base class for model and image output.
Definition: HIOManager.h:1255
H_OUTPUT_TYPE OutputType() const
The output type.
Definition: HIOManager.h:1114
Specifies using an iso view (looking at the origin from (1, 1, 1))
Definition: HIOManager.h:236
Specifies an HOutputHandler for a MVO style html file.
Definition: HIOManager.h:860
void OutputType(H_OUTPUT_TYPE ot)
The output type.
Definition: HIOManager.h:1116
bool WindowFrame() const
Determines if a window frame is drawn or not.
Definition: HIOManager.h:1052
int ImageDpi() const
Indicates the DPI used for images. This is calculated with info from HC_Show_Device_Info.
Definition: HIOManager.h:1066
bool m_bPRCLoadAsDrawings
PRC import option: When loading a DWG or DXF file through HIOUtilityExchange, set this option to true...
Definition: HIOManager.h:554
indicates that cell header entity will be imported as single segment
Definition: HIOManager.h:519
const char * m_pImageFormat
The HOOPS image format to use for loading an image if not using filename .ext for format...
Definition: HIOManager.h:474
int m_attributePrecisionMode
The manner in which precision in attributes (such as matrices) is handled.
Definition: HIOManager.h:642
void PaperHeight(float const f)
Height for output sizing in inches.
Definition: HIOManager.h:1009
indicates that cell header will have as many segments as its children
Definition: HIOManager.h:520
struct vhash_s * connector_procs
A hash of HIOConnector Create/Free functions.
Definition: HIOManager.h:1604
void * m_pExtendedData
A pointer to extra data needed by a HInputHandler subclass.
Definition: HIOManager.h:489
float WindowHeight() const
Height for output sizing in inches.
Definition: HIOManager.h:993
HOutputHandlerOptions(const HOutputHandlerOptions &o)
Definition: HIOManager.h:922
double m_factorForSmartSolids
Definition: HIOManager.h:508
bool m_bPRCStoreUserAttributes
PRC import option: If true all prc user attributes will be converted as user option.
Definition: HIOManager.h:547
void UseSubscreen(bool const tf)
Determines if HOOPS is calculating a subscreen to match the output to the size of the view window...
Definition: HIOManager.h:1061
float WindowWidth() const
Width for output sizing in inches.
Definition: HIOManager.h:986
char const * m_pHTMLTemplateFile
Definition: HIOManager.h:1241
HBaseView * View() const
A pointer to the HBaseView object for this output.
Definition: HIOManager.h:937
HPoint const * WindowColor() const
Set the color of the window. The RGB color stored in xyz of HPoint.
Definition: HIOManager.h:972
bool m_bPRCCreatePRCFileOnly
PRC import option: If true temporary prc file will be created but no parsing and creation of HOOPS en...
Definition: HIOManager.h:539
HInputHandlerOptions(HInputHandlerOptions const *o)
Definition: HIOManager.h:325
struct vlist_s * loaded_input_handlers
A list of dynamically loaded HInputHandlers libraries.
Definition: HIOManager.h:1613
void Model(HBaseModel *const m)
A pointer to the HBaseModel object for this output.
Definition: HIOManager.h:946
bool UseSubscreen() const
Determines if HOOPS is calculating a subscreen to match the output to the size of the view window...
Definition: HIOManager.h:1059
HInputHandlerOptions(const HInputHandlerOptions &o)
Definition: HIOManager.h:399
The HBaseModel class is used to store and manage model information.
Definition: HBaseModel.h:47
Definition: HIOManager.h:900
The HBaseView class defines and manages a view of model information.
Definition: HBaseView.h:332
Specifies using a top view (looking down the positive Z-axis at the XY-plane)
Definition: HIOManager.h:235
bool m_bForceRenderedModeColors
Rhino file import option: if true then Exchange will force rendered mode colors instead of shading mo...
Definition: HIOManager.h:587
void WindowColor(HPoint const *const tf)
Set the color of the window. The RGB color stored in xyz of HPoint.
Definition: HIOManager.h:974
bool m_bPrcRemoveAttributes
Definition: HIOManager.h:1211
struct vhash_s * output_handlers
A hash of HOutputHandlers.
Definition: HIOManager.h:1601
HC_KEY Key() const
The HC_Key for this output.
Definition: HIOManager.h:958
int m_Version
The file format version desired for writing.
Definition: HIOManager.h:1107
bool StlNormals() const
Determines if we generate and output face normals when writing to STL file format.
Definition: HIOManager.h:1135
bool m_bOOCAutoUpdate
OOC import option: Determines whether or not the view for the OOC model should automatically update w...
Definition: HIOManager.h:623
bool m_bDwgSkipUnreferencedBlocks
Definition: HIOManager.h:605
void WindowWidth(float const f)
Width for output sizing in inches.
Definition: HIOManager.h:988
bool Ascii() const
Some file formats, support binary and ascii such as STL. Set this to true for ascii output...
Definition: HIOManager.h:1128
float PaperHeight() const
Height for output sizing in inches.
Definition: HIOManager.h:1007
void UseWindowColor(bool const tf)
If set to true, the background color of the view is used.
Definition: HIOManager.h:981
void * m_pPRCAsmModelFile
PRC import option: Returned to user. Contains Pointer to A3DAsmModelFile entity.
Definition: HIOManager.h:525
bool ConserveMemory() const
This option has been deprecated and has no effect.
Definition: HIOManager.h:1041
HPrcBrepCompression m_ePrcBrepCompression
Definition: HIOManager.h:1205
bool ForceGrayscale() const
Specifies black and white output.
Definition: HIOManager.h:1014
HBaseModel * Model() const
A pointer to the HBaseModel object for this output.
Definition: HIOManager.h:944
void Output3d(bool const tf)
Some file formats, such as PDF and DWF, support 2d and/or 3d output. Set this to TRUE for 3d output...
Definition: HIOManager.h:1123
bool m_bPrcCompressTessellation
Definition: HIOManager.h:1221
data is kept in the format from the file
Definition: HIOManager.h:635
Definition: HIOManager.h:246
bool m_bOptimizeSegmentTree
SKP file import option: if true then model is optimized using Optimize_Segment_Tree API...
Definition: HIOManager.h:584
bool m_generatedDouble
The manner in which precision in geometry is handled.
Definition: HIOManager.h:648
void SetInputOps(unsigned long ops)
This sets the HInputOp.
Definition: HIOManager.h:833
struct vlist_s * loaded_output_handlers
A list of dynamically loaded HOutputHandlers libraries.
Definition: HIOManager.h:1616
void PaperDpi(int const dpi)
Indicates the DPI used for paper. This is set from the options dialog.
Definition: HIOManager.h:1075
HStreamFileToolkit * m_tk
The streamfile toolkit to be used.
Definition: HIOManager.h:480
struct vlist_s * owned_input_handlers
A list of default HInputHandlers created by the manager.
Definition: HIOManager.h:1607
bool m_bImportMetadata
DWG and SKP import option: Set to true if you want to import the metadata (xdata) along with the geom...
Definition: HIOManager.h:492
void SetOutputOps(unsigned long ops)
This sets the HOutputOp.
Definition: HIOManager.h:1420
bool UseWindowColor() const
If set to true, the background color of the view is used.
Definition: HIOManager.h:979
struct vhash_s * mhash_Kernel2Hoops
A hash map between kernel entities and HOOPS Keys.
Definition: HIOManager.h:217
bool Output3d() const
Some file formats, such as PDF and DWF, support 2d and/or 3d output. Set this to TRUE for 3d output...
Definition: HIOManager.h:1121
int m_iDGNCellHeaderOption
DGN file import option: has three option about how cell header should be imported.
Definition: HIOManager.h:511
bool m_bIsTestingSettings
Testing settings. true if you want to activate testings settings.
Definition: HIOManager.h:651
Specifies using the active viewport in the DWG file if present (if no active viewport is present...
Definition: HIOManager.h:237
struct vhash_s * created_connectors
A list of created HIOConnectors.
Definition: HIOManager.h:1619
HIOConnector * m_pPRCPMIConnector
PRC import option: Pointer to connector class. If not null prc PMI entities will be associated to HOO...
Definition: HIOManager.h:531
void WindowHeight(float const f)
Height for output sizing in inches.
Definition: HIOManager.h:995
HOutputHandlerOptions(HOutputHandlerOptions const *o)
Definition: HIOManager.h:915
bool m_bPRCMergeFaces
PRC import option: If true individual faces will be merged into one shell.
Definition: HIOManager.h:535
bool FastPrint() const
This option has been deprecated. Specifies printing method.
Definition: HIOManager.h:1034
HBaseView * m_pHBaseView
A pointer to the HBaseView object for this input.
Definition: HIOManager.h:468
char const * HSRAOptions() const
HOOPS HSRAOption string .
Definition: HIOManager.h:965
bool m_bHTMLIncludeMeasurementInformation
Definition: HIOManager.h:1244
bool m_bImportThumbnail
DWF file import option: if true then Thumbnail are imported in the DWF file.
Definition: HIOManager.h:578
void View(HBaseView *const v)
A pointer to the HBaseView object for this output.
Definition: HIOManager.h:939
Specifies using the view determined by the camera in the scene segment.
Definition: HIOManager.h:238
bool m_bLocal
The value is true if the image will have the local attribute.
Definition: HIOManager.h:477