C3D Toolkit  Kernel - 118069, Vision - 2.16.7.1844
conv_model_exchange.h File Reference

Common API of the converter. More...

#include <map>
#include <tool_cstring.h>
#include <model_item.h>
#include <model_entity.h>
#include <solid.h>
#include "conv_res_type.h"
#include "conv_format_info.h"
#include <conv_plugin_version_info.h>

Classes

class  c3d::C3DExchangeBuffer
 Memory buffer for data exchange. More...
 
class  IConverter3D
 Converter's interface. More...
 

Namespaces

 c3d
 C3D namespace declaration.
 

Typedefs

typedef std::map< c3d::string_t, c3d::string_t > c3d::optionNameValuePairs_t
 The container of named values of options.
 

Enumerations

enum  MbeModelExchangeFormat {
  mxf_autodetect , mxf_ACIS , mxf_IGES , mxf_JT ,
  mxf_Parasolid , mxf_STEP , mxf_STL , mxf_VRML ,
  mxf_3MF , mxf_OBJ , mxf_GRDECL , mxf_ASCIIPoint ,
  mxf_C3D , mxf_ACISBinary , mxf_ParasolidBinary
}
 Model exchange format. More...
 

Functions

MbeConvResType c3d::ImportFromFile (MbModel &model, const path_string &fileName, IConvertorProperty3D *prop=nullptr, IProgressIndicator *indicator=nullptr)
 Read a file of an exchange format into model. More...
 
MbeConvResType c3d::ImportFromFile (c3d::ItemSPtr &item, const path_string &filePath, IConvertorProperty3D *prop=nullptr, IProgressIndicator *indicator=nullptr)
 Read a file of an exchange format into element. More...
 
MbeConvResType c3d::ImportFromFile (ItModelDocument &mDoc, const path_string &filePath, IConvertorProperty3D *prop=nullptr, IProgressIndicator *indicator=nullptr)
 Read a file of an exchange format into model. More...
 
MbeConvResType c3d::ExportIntoFile (MbModel &model, const path_string &filePath, IConvertorProperty3D *prop=nullptr, IProgressIndicator *indicator=nullptr)
 Write the model into an exchange format file. More...
 
MbeConvResType c3d::ExportIntoFile (MbItem &item, const path_string &filePath, IConvertorProperty3D *prop=nullptr, IProgressIndicator *indicator=nullptr)
 Write the model into an exchange format file. More...
 
MbeConvResType c3d::ExportIntoFile (ItModelDocument &mDoc, const path_string &filePath, IConvertorProperty3D *prop=nullptr, IProgressIndicator *indicator=nullptr)
 Write the model into an exchange format file. More...
 
MbeConvResType c3d::ImportFromBuffer (MbModel &model, const C3DExchangeBuffer &buffer, MbeModelExchangeFormat modelFormat, IConvertorProperty3D *prop=nullptr, IProgressIndicator *indicator=nullptr)
 Import data from buffer into model. More...
 
MbeConvResType c3d::ImportFromBuffer (c3d::ItemSPtr &item, const C3DExchangeBuffer &buffer, MbeModelExchangeFormat modelFormat, IConvertorProperty3D *prop=nullptr, IProgressIndicator *indicator=nullptr)
 Import data from buffer into model. More...
 
MbeConvResType c3d::ImportFromBuffer (ItModelDocument &mDoc, const C3DExchangeBuffer &buffer, MbeModelExchangeFormat modelFormat, IConvertorProperty3D *prop=nullptr, IProgressIndicator *indicator=nullptr)
 Import data from buffer into model. More...
 
MbeConvResType c3d::ExportIntoBuffer (MbModel &model, MbeModelExchangeFormat modelFormat, C3DExchangeBuffer &buffer, IConvertorProperty3D *prop=nullptr, IProgressIndicator *indicator=nullptr)
 Export model into buffer. More...
 
MbeConvResType c3d::ExportIntoBuffer (MbItem &item, MbeModelExchangeFormat modelFormat, C3DExchangeBuffer &buffer, IConvertorProperty3D *prop=nullptr, IProgressIndicator *indicator=nullptr)
 Export model into buffer. More...
 
MbeConvResType c3d::ExportIntoBuffer (ItModelDocument &item, MbeModelExchangeFormat modelFormat, C3DExchangeBuffer &buffer, IConvertorProperty3D *prop=nullptr, IProgressIndicator *indicator=nullptr)
 Export model document into buffer. More...
 
std::vector< FormatInfo > c3d::GetSupportedFormats ()
 Get list of supported formats. More...
 
std::vector< PluginVersionInfo > c3d::GetLoadedPluginsVersions ()
 Get versions of loaded plugins. More...
 
IConverter3D * GetConverter3D ()
 Get the converter interface.
 
void ReleaseConverter3D (IConverter3D *)
 Release the converter interface.
 
IConverter3D * GetConvertor3D ()
 Get the converter interface.
 
void ReleaseConvertor3D (IConverter3D *convInstance)
 Release the converter interface.
 

Detailed Description

Common API of the converter.

Functions for export and import from buffer and file using file's extension for format detection, class of converter for format-specific methods and API for plugin, format-specific import and export functions.