C3D Toolkit  Kernel - 117982, Vision - 2.9.2.2
IConverter3D Class Referenceabstract

Converter's interface. More...

#include <conv_model_exchange.h>

Public Member Functions

virtual void SetConfgiurationSelector (SPtr< IConfigurationSelector > configuration_selector)=0
 Set handler for selecting configurations. More...
 
virtual void SetDeveloperEventLogger (SPtr< IConverterEventLogger > importEventLogger)=0
 Set logging handler. More...
 
virtual MbeConvResType SATRead (IConvertorProperty3D &prop, ItModelDocument &idoc, std::iostream *stream, IProgressIndicator *indicator, MbRefItem *qeuryStitch)=0
 Read a file of SAT format. More...
 
virtual MbeConvResType SATWrite (IConvertorProperty3D &prop, ItModelDocument &idoc, std::iostream *stream, IProgressIndicator *indicator)=0
 Write file of SAT format. More...
 
virtual MbeConvResType SATRead (IConvertorProperty3D &prop, ItModelDocument &idoc, IProgressIndicator *indicator=0, MbRefItem *qeuryStitch=0)=0
 Read a file of SAT format. More...
 
virtual MbeConvResType SATWrite (IConvertorProperty3D &prop, ItModelDocument &idoc, IProgressIndicator *indicator=0, MbRefItem *qeuryStitch=0)=0
 Write file of SAT format. More...
 
virtual MbeConvResType IGSRead (IConvertorProperty3D &prop, ItModelDocument &idoc, IProgressIndicator *indicator=0, MbRefItem *qeuryStitch=0)=0
 Read a file of IGES format. More...
 
virtual MbeConvResType IGSWrite (IConvertorProperty3D &prop, ItModelDocument &idoc, IProgressIndicator *indicator=0, MbRefItem *qeuryStitch=0)=0
 Write a file of IGES format. More...
 
virtual MbeConvResType JTRead (IConvertorProperty3D &prop, ItModelDocument &idoc, IProgressIndicator *indicator=0, MbRefItem *qeuryStitch=0)=0
 Read a file of JT format. More...
 
virtual MbeConvResType JTWrite (IConvertorProperty3D &prop, ItModelDocument &idoc, IProgressIndicator *indicator=0, MbRefItem *qeuryStitch=0)=0
 Write a file of JT format. More...
 
virtual MbeConvResType XTRead (IConvertorProperty3D &prop, ItModelDocument &idoc, IProgressIndicator *indicator=0, MbRefItem *qeuryStitch=0)=0
 Read a file of Parasolid format. More...
 
virtual MbeConvResType XTWrite (IConvertorProperty3D &prop, ItModelDocument &idoc, IProgressIndicator *indicator=0, MbRefItem *qeuryStitch=0)=0
 Write a file of Parasolid format. More...
 
virtual MbeConvResType STEPRead (IConvertorProperty3D &prop, ItModelDocument &idoc, IProgressIndicator *indicator=0, MbRefItem *qeuryStitch=0)=0
 Read a file of STEP format. More...
 
virtual MbeConvResType STEPWrite (IConvertorProperty3D &prop, ItModelDocument &idoc, IProgressIndicator *indicator=0, MbRefItem *qeuryStitch=0)=0
 Write a file of STEP format. More...
 
virtual MbeConvResType STLRead (IConvertorProperty3D &prop, ItModelDocument &idoc, IProgressIndicator *indicator=0, MbRefItem *qeuryStitch=0)=0
 Read a file of STL format. More...
 
virtual MbeConvResType STLWrite (IConvertorProperty3D &prop, ItModelDocument &idoc, IProgressIndicator *indicator=0, MbRefItem *qeuryStitch=0)=0
 Write a file of STL format. More...
 
virtual MbeConvResType OBJRead (IConvertorProperty3D &prop, ItModelDocument &idoc, IProgressIndicator *indicator=0)=0
 Read a file of OBJ format. More...
 
virtual MbeConvResType VRMLRead (IConvertorProperty3D &prop, ItModelDocument &idoc, IProgressIndicator *indicator=0, MbRefItem *qeuryStitch=0)=0
 Read a file of VRML format. More...
 
virtual MbeConvResType VRMLWrite (IConvertorProperty3D &prop, ItModelDocument &idoc, IProgressIndicator *indicator=0, MbRefItem *qeuryStitch=0)=0
 Write a file of VRML format. More...
 
virtual MbeConvResType ThreeMFWrite (IConvertorProperty3D &prop, ItModelDocument &idoc, IProgressIndicator *indicator=0, MbRefItem *qeuryStitch=0)=0
 Write a file of 3MF format. More...
 
virtual MbeConvResType GRDECLRead (IConvertorProperty3D &prop, ItModelDocument &idoc, IProgressIndicator *indicator=0, MbRefItem *qeuryStitch=0)=0
 Read a file of GRDECL format. More...
 
virtual MbeConvResType GRDECLWrite (IConvertorProperty3D &prop, ItModelDocument &idoc, IProgressIndicator *indicator=0, MbRefItem *qeuryStitch=0)=0
 Write a file of GRDECL format. More...
 
virtual MbeConvResType ASCIIPointCloudRead (IConvertorProperty3D &prop, ItModelDocument &idoc, IProgressIndicator *indicator=0, MbRefItem *qeuryStitch=0)=0
 Read a file of ASCII Point Cloud format. More...
 
virtual MbeConvResType ASCIIPointCloudWrite (IConvertorProperty3D &prop, ItModelDocument &idoc, IProgressIndicator *indicator=0, MbRefItem *qeuryStitch=0)=0
 Write a point cloud file of ASCII format. More...
 
virtual MbeConvResType LoadForeignReader (const c3d::path_string &pluginName, const c3d::optionNameValuePairs_t &pluginSpecificSettings, IConfigurationSelector *configSelector=0)=0
 Load plugin for getting information necessary to build model. More...
 
virtual MbeConvResType ReleaseForeignReader ()=0
 Release the loaded plugin for getting information necessary to build model. More...
 
virtual MbeConvResType ImportForeign (const c3d::path_string &path, ItModelDocument &idoc, IConvertorProperty3D *prop=0, IProgressIndicator *indicator=0)=0
 Read a file using plugin. More...
 
virtual MbeConvResType PreliminaryImport (IConvertorProperty3D &prop, IProgressIndicator *indicator=0)=0
 Import preliminary model data: list of attributes and configurations . More...
 
virtual void SetPreliminaryCallbacks (IAttributeNamesCollector *attrCollector, IConfigurationSelector *configSelector)=0
 Set parameters to save data at the stage of preliminary import. More...
 
virtual MbeConvResType ImportFromFile (ItModelDocument &mDoc, const c3d::path_string &filePath, IConvertorProperty3D *prop=nullptr, IProgressIndicator *indicator=nullptr)=0
 Read a file of an exchange format into model. More...
 

Detailed Description

Converter's interface.

Converter's interface implements methods of export of the model to files of exchange formats and import from them.

Member Function Documentation

◆ SetConfgiurationSelector()

virtual void IConverter3D::SetConfgiurationSelector ( SPtr< IConfigurationSelector configuration_selector)
pure virtual

Set handler for selecting configurations.

If handler is set and imported file contains more than one configuration (embodiment), then the handler will be called for selection of needed configuration during reading.

Parameters
[in]configuration_selector- Pointer to handler to be set.

◆ SetDeveloperEventLogger()

virtual void IConverter3D::SetDeveloperEventLogger ( SPtr< IConverterEventLogger importEventLogger)
pure virtual

Set logging handler.

Parameters
[in]importEventLogger- Pointer to handler to be set.

◆ ASCIIPointCloudRead()

virtual MbeConvResType IConverter3D::ASCIIPointCloudRead ( IConvertorProperty3D prop,
ItModelDocument idoc,
IProgressIndicator indicator = 0,
MbRefItem qeuryStitch = 0 
)
pure virtual

Read a file of ASCII Point Cloud format.

Parameters
[in]prop- Implementation of converter's properties interface.
[in]idoc- Implementation of document interface.
[in]indicator- The process progress indicator.
[in]qeuryStitch- Dialog of request for stitching the surfaces (not used).
Returns
Code of the operation termination.

◆ ASCIIPointCloudWrite()

virtual MbeConvResType IConverter3D::ASCIIPointCloudWrite ( IConvertorProperty3D prop,
ItModelDocument idoc,
IProgressIndicator indicator = 0,
MbRefItem qeuryStitch = 0 
)
pure virtual

Write a point cloud file of ASCII format.

Parameters
[in]prop- Implementation of converter's properties interface.
[in]idoc- Implementation of document interface.
[in]indicator- The process progress indicator.
[in]qeuryStitch- Dialog of request for stitching the surfaces (not used).
Returns
Code of the operation termination.

◆ LoadForeignReader()

virtual MbeConvResType IConverter3D::LoadForeignReader ( const c3d::path_string &  pluginName,
const c3d::optionNameValuePairs_t pluginSpecificSettings,
IConfigurationSelector configSelector = 0 
)
pure virtual

Load plugin for getting information necessary to build model.

The description of plugin-specific settings shoud be taken from the plugin's vendor.

Note
Expereimental API.
Parameters
[in]pluginName- Name of the file to link.
[in]pluginSpecificSettings- Plugin-specific settings.
Returns
Code of the operation termination.
Note
EXPEREIMENTAL.

◆ ReleaseForeignReader()

virtual MbeConvResType IConverter3D::ReleaseForeignReader ( )
pure virtual

Release the loaded plugin for getting information necessary to build model.

Returns
Code of the operation termination.

◆ ImportForeign()

virtual MbeConvResType IConverter3D::ImportForeign ( const c3d::path_string &  path,
ItModelDocument idoc,
IConvertorProperty3D prop = 0,
IProgressIndicator indicator = 0 
)
pure virtual

Read a file using plugin.

Parameters
[in]path- Path of the file to read.
[in]idoc- Implementation of document interface.
[in]prop- Implementation of converter's properties interface.
[in]indicator- The process progress indicator.
Note
EXPEREIMENTAL.
Returns
Code of the operation termination.

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