conv_model_exchange.h File Reference

Common API of the converter. More...

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

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 }
	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...
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.
MbeConvResType	SATRead (IConvertorProperty3D &prop, ItModelDocument &idoc, IProgressIndicator *indicator)
	Read a file of SAT format. More...
MbeConvResType	SATWrite (IConvertorProperty3D &prop, ItModelDocument &idoc, IProgressIndicator *indicator)
	Write file of SAT format. More...
MbeConvResType	IGSRead (IConvertorProperty3D &prop, ItModelDocument &idoc, IProgressIndicator *indicator=0)
	Read a file of IGES format. More...
MbeConvResType	IGSWrite (IConvertorProperty3D &prop, ItModelDocument &idoc, IProgressIndicator *indicator=0)
	Write a file of IGES format. More...
MbeConvResType	JTRead (IConvertorProperty3D &prop, ItModelDocument &idoc, IProgressIndicator *indicator=0)
	Read a file of JT format. More...
MbeConvResType	JTWrite (IConvertorProperty3D &prop, ItModelDocument &idoc, IProgressIndicator *indicator=0)
	Write a file of JT format. More...
MbeConvResType	XTRead (IConvertorProperty3D &prop, ItModelDocument &idoc, IProgressIndicator *indicator=0)
	Read a file of Parasolid format. More...
MbeConvResType	XTWrite (IConvertorProperty3D &prop, ItModelDocument &idoc, IProgressIndicator *indicator=0)
	Write a file of Parasolid format. More...
MbeConvResType	STEPRead (IConvertorProperty3D &prop, ItModelDocument &idoc, IProgressIndicator *indicator=0)
	Read a file of STEP format. More...
MbeConvResType	STEPWrite (IConvertorProperty3D &prop, ItModelDocument &idoc, IProgressIndicator *indicator=0)
	Write a file of STEP format. More...
MbeConvResType	STLRead (IConvertorProperty3D &prop, ItModelDocument &idoc, IProgressIndicator *indicator=0)
	Read a file of STL format. More...
MbeConvResType	STLWrite (IConvertorProperty3D &prop, ItModelDocument &idoc, IProgressIndicator *indicator=0)
	Write a file of STL format. More...
MbeConvResType	OBJRead (IConvertorProperty3D &prop, ItModelDocument &idoc, IProgressIndicator *indicator=0)
	Read a file of OBJ format. More...
MbeConvResType	VRMLRead (IConvertorProperty3D &prop, ItModelDocument &idoc, IProgressIndicator *indicator=0)
	Read a file of VRML format. More...
MbeConvResType	GRDECLRead (IConvertorProperty3D &prop, ItModelDocument &idoc, IProgressIndicator *indicator=0)
	Read a file of GRDECL format. More...
MbeConvResType	GRDECLWrite (IConvertorProperty3D &prop, ItModelDocument &idoc, IProgressIndicator *indicator=0)
	Write a file of GRDECL format. More...
MbeConvResType	VRMLWrite (IConvertorProperty3D &prop, ItModelDocument &idoc, IProgressIndicator *indicator=0)
	Write a file of VRML format. More...
MbeConvResType	ThreeMFWrite (IConvertorProperty3D &prop, ItModelDocument &idoc, IProgressIndicator *indicator=0)
	Write a file of 3MF format. More...
MbeConvResType	ASCIIPointCloudRead (IConvertorProperty3D &prop, ItModelDocument &idoc, IProgressIndicator *indicator=0)
	Read a file of ASCII Point Cloud format. More...
MbeConvResType	ASCIIPointCloudWrite (IConvertorProperty3D &prop, ItModelDocument &idoc, IProgressIndicator *indicator=0)
	Write a point cloud file of ASCII format. More...

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.