Collaboration diagram for Converters Interface:

Classes
struct	C3DConverterDebugSettings
	Settings of the debug features of the C3D Converter. More...

struct	IProductIdMaker
	Interface of component's identifier generator. More...

class	IConvertorProperty3D
	Interface of converter's properties. More...

struct	NameProductIdMaker
	Implementation of component's identifier generator. More...

class	ConvConvertorProperty3D
	Pre-defined implementation of converter's properties. More...

class	ItModelDocument
	Interface of document of an assembly model or a part model. More...

class	C3DSymbolToItem
	Generator of text element's geometry shape. More...

class	C3DPmiToItem
	Generator of PMI's geometry shape. More...

class	C3dModelDocument
	Implementation of model document which has regular structure. More...

class	ItModelInstanceProperties
	Interface of properties of an instance, a subassembly or a part. More...

class	ItModelInstance
	Interface of the component instance. More...

class	ItModelAssembly
	Interface of the assembly. More...

class	ItModelPart
	Interface of a part. More...

class	c3d::C3DExchangeBuffer
	Memory buffer for data exchange. More...

class	IConverter3D
	Converter's interface. More...

Enumerations
enum	eLoggingMode { elm_LoggingOff , elm_LoggingAll , elm_LoggingForId }
	Logging mode. More...

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

enum	MbeConvResType { cnv_Success = 0 , cnv_Error , cnv_UserCanceled , cnv_NoBody , cnv_NoObjects , cnv_FileOpenError , cnv_FileWriteError , cnv_FileDeleteError , cnv_ImpossibleReadAssembly , cnv_LicenseNotFound , cnv_NotEnoughMemory , cnv_UnknownExtension }
	Result of converting operation. 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...

virtual MbeConvResType	IConverter3D::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...

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	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

Enumeration Type Documentation

◆ eLoggingMode

enum eLoggingMode

Logging mode.

Enumerator
elm_LoggingOff	Logging disabled.
elm_LoggingAll	Logging enabled for all objects.
elm_LoggingForId	Logging enabled for an object with the specified id.

◆ MbeModelExchangeFormat

enum MbeModelExchangeFormat

Model exchange format.

Enumerator
mxf_autodetect	File extension defines format.
mxf_ACIS	Read data from buffer as ACIS (.sat).
mxf_IGES	Read data from buffer as IGES (.igs or .iges).
mxf_JT	Read data from buffer as JT (.jt).
mxf_Parasolid	Read data from buffer as Parasolid (.x_t, .x_b, .xmt_txt, .xmp_txt, .xmt_bin or .xmp_bin ).
mxf_STEP	Read data from buffer as STEP (.stp or .step).
mxf_STL	Read data from buffer as STL (.stl).
mxf_VRML	Read data from buffer as VRML (.wrl).
mxf_3MF	Read data from buffer as 3MF (.3mf).
mxf_OBJ	Read data from buffer as OBJ (.obj).
mxf_GRDECL	Read data from buffer as GRDECL (.grdecl).
mxf_ASCIIPoint	Read data from buffer as ASCII point cloud (.txt, .asc or .xyz).
mxf_C3D	Read data from buffer as C3D (.c3d).

◆ MbeConvResType

enum MbeConvResType

Result of converting operation.

Enumerator
cnv_Success	Success.
cnv_Error	Error.
cnv_UserCanceled	Process interrupted by user.
cnv_NoBody	No solids found.
cnv_NoObjects	No objects found.
cnv_FileOpenError	File open error.
cnv_FileWriteError	File write error.
cnv_FileDeleteError	Could not delete file.
cnv_ImpossibleReadAssembly	Assemblies are not supported.
cnv_LicenseNotFound	License check failure.
cnv_NotEnoughMemory	Not enough memory.
cnv_UnknownExtension	Unknown file extenstion.

Function Documentation

◆ ImportFromFile() [1/4]

MbeConvResType c3d::ImportFromFile	(	MbModel &	model,
		const path_string &	fileName,
		IConvertorProperty3D *	prop = `nullptr`,
		IProgressIndicator *	indicator = `nullptr`
	)

Read a file of an exchange format into model.

The fileName argument is not used if converter properties are defined obviously, file path comes from the FullFilePath method. Otherwise default parameters corresponding ConvConvertorProperty3D implementation are used for import.

Parameters

[out]	model	- The model.
[in]	filePath	- File path.
[in]	prop	- Implementation of converter's properties interface.
[in]	indicator	- The process progress indicator.

Returns: Code of the operation termination.

◆ ImportFromFile() [2/4]

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.

The fileName argument is not used if converter properties are defined obviously, file path comes from the FullFilePath method. Otherwise default parameters corresponding ConvConvertorProperty3D implementation are used for import.

Parameters

[out]	item	- The element to replace.
[in]	filePath	- File path.
[in]	prop	- Implementation of converter's properties interface.
[in]	indicator	- The process progress indicator.

Returns: Code of the operation termination.

◆ ImportFromFile() [3/4]

MbeConvResType c3d::ImportFromFile	(	ItModelDocument &	mDoc,
		const path_string &	filePath,
		IConvertorProperty3D *	prop = `nullptr`,
		IProgressIndicator *	indicator = `nullptr`
	)

Read a file of an exchange format into model.

The fileName argument is not used if converter properties are defined obviously, file path comes from the FullFilePath method. Otherwise default parameters corresponding ConvConvertorProperty3D implementation are used for import.

Parameters

[out]	mDoc	- The model.
[in]	filePath	- File path.
[in]	prop	- Implementation of converter's properties interface.
[in]	indicator	- The process progress indicator.

Returns: Code of the operation termination.

◆ ExportIntoFile() [1/3]

MbeConvResType c3d::ExportIntoFile	(	MbModel &	model,
		const path_string &	filePath,
		IConvertorProperty3D *	prop = `nullptr`,
		IProgressIndicator *	indicator = `nullptr`
	)

Write the model into an exchange format file.

The fileName argument is not used if converter properties are defined obviously, file path comes from the FullFilePath method. Otherwise default parameters corresponding ConvConvertorProperty3D implementation are used for export.

Parameters

[out]	model	- The model.
[in]	filePath	- File path.
[in]	prop	- Implementation of converter's properties interface.
[in]	indicator	- The process progress indicator.

Returns: Code of the operation termination.

◆ ExportIntoFile() [2/3]

MbeConvResType c3d::ExportIntoFile	(	MbItem &	item,
		const path_string &	filePath,
		IConvertorProperty3D *	prop = `nullptr`,
		IProgressIndicator *	indicator = `nullptr`
	)

Write the model into an exchange format file.

The fileName argument is not used if converter properties are defined obviously, file path comes from the FullFilePath method. Otherwise default parameters corresponding ConvConvertorProperty3D implementation are used for export.

Parameters

[out]	model	- The exported element.
[in]	filePath	- File path.
[in]	prop	- Implementation of converter's properties interface.
[in]	indicator	- The process progress indicator.

Returns: Code of the operation termination.

◆ ExportIntoFile() [3/3]

MbeConvResType c3d::ExportIntoFile	(	ItModelDocument &	mDoc,
		const path_string &	filePath,
		IConvertorProperty3D *	prop = `nullptr`,
		IProgressIndicator *	indicator = `nullptr`
	)

Write the model into an exchange format file.

The fileName argument is not used if converter properties are defined obviously, file path comes from the FullFilePath method. Otherwise default parameters corresponding ConvConvertorProperty3D implementation are used for export.

Parameters

[in]	mDoc	- The exported model document.
[in]	filePath	- File path.
[in]	prop	- Implementation of converter's properties interface.
[in]	indicator	- The process progress indicator.

Returns: Code of the operation termination.

◆ ImportFromBuffer() [1/3]

MbeConvResType c3d::ImportFromBuffer	(	MbModel &	model,
		const C3DExchangeBuffer &	buffer,
		MbeModelExchangeFormat	modelFormat,
		IConvertorProperty3D *	prop = `nullptr`,
		IProgressIndicator *	indicator = `nullptr`
	)

Import data from buffer into model.

Parameters

[out]	model	- The model.
[in]	buffer	- Buffer.
[in]	modelFormat	- Model format.
[in]	prop	- Implementation of converter's properties interface.
[in]	indicator	- The process progress indicator.

Returns: Code of the operation termination.

◆ ImportFromBuffer() [2/3]

MbeConvResType c3d::ImportFromBuffer	(	c3d::ItemSPtr &	item,
		const C3DExchangeBuffer &	buffer,
		MbeModelExchangeFormat	modelFormat,
		IConvertorProperty3D *	prop = `nullptr`,
		IProgressIndicator *	indicator = `nullptr`
	)

Import data from buffer into model.

Parameters

[out]	item	- The item to replace.
[in]	buffer	- Buffer.
[in]	modelFormat	- Model format.
[in]	prop	- Implementation of converter's properties interface.
[in]	indicator	- The process progress indicator.

Returns: Code of the operation termination.

◆ ImportFromBuffer() [3/3]

MbeConvResType c3d::ImportFromBuffer	(	ItModelDocument &	mDoc,
		const C3DExchangeBuffer &	buffer,
		MbeModelExchangeFormat	modelFormat,
		IConvertorProperty3D *	prop = `nullptr`,
		IProgressIndicator *	indicator = `nullptr`
	)

Import data from buffer into model.

Parameters

[out]	mDoc	- Model document.
[in]	buffer	- Buffer.
[in]	modelFormat	- Model format.
[in]	prop	- Implementation of converter's properties interface.
[in]	indicator	- The process progress indicator.

Returns: Code of the operation termination.

◆ ExportIntoBuffer() [1/3]

MbeConvResType c3d::ExportIntoBuffer	(	MbModel &	model,
		MbeModelExchangeFormat	modelFormat,
		C3DExchangeBuffer &	buffer,
		IConvertorProperty3D *	prop = `nullptr`,
		IProgressIndicator *	indicator = `nullptr`
	)

Export model into buffer.

Parameters

[in]	model	- The model.
[in]	modelFormat	- Model format.
[out]	buffer	- Buffer.
[in]	prop	- Implementation of converter's properties interface.
[in]	indicator	- The process progress indicator.

Returns: Code of the operation termination.

◆ ExportIntoBuffer() [2/3]

MbeConvResType c3d::ExportIntoBuffer	(	MbItem &	item,
		MbeModelExchangeFormat	modelFormat,
		C3DExchangeBuffer &	buffer,
		IConvertorProperty3D *	prop = `nullptr`,
		IProgressIndicator *	indicator = `nullptr`
	)

Export model into buffer.

Parameters

[in]	item	- The item to export.
[in]	modelFormat	- Model format.
[out]	buffer	- Buffer.
[in]	prop	- Implementation of converter's properties interface.
[in]	indicator	- The process progress indicator.

Returns: Code of the operation termination.

◆ ExportIntoBuffer() [3/3]

MbeConvResType c3d::ExportIntoBuffer	(	ItModelDocument &	item,
		MbeModelExchangeFormat	modelFormat,
		C3DExchangeBuffer &	buffer,
		IConvertorProperty3D *	prop = `nullptr`,
		IProgressIndicator *	indicator = `nullptr`
	)

Export model document into buffer.

Parameters

[in]	mDoc	- The exported model document.
[in]	modelFormat	- Model format.
[out]	buffer	- Buffer.
[in]	prop	- Implementation of converter's properties interface.
[in]	indicator	- The process progress indicator.

Returns: Code of the operation termination.

◆ ImportFromFile() [4/4]

virtual MbeConvResType IConverter3D::ImportFromFile	(	ItModelDocument &	mDoc,
		const c3d::path_string &	filePath,
		IConvertorProperty3D *	prop = `nullptr`,
		IProgressIndicator *	indicator = `nullptr`
	)

pure virtual

Read a file of an exchange format into model.

The fileName argument is not used if converter properties are defined obviously, file path comes from the FullFilePath method. Otherwise default parameters corresponding ConvConvertorProperty3D implementation are used for import.

Parameters

[out]	mDoc	- The model.
[in]	filePath	- File path.
[in]	prop	- Implementation of converter's properties interface.
[in]	indicator	- The process progress indicator.

Returns: Code of the operation termination.

◆ ASCIIPointCloudRead()

MbeConvResType ASCIIPointCloudRead	(	IConvertorProperty3D &	prop,
		ItModelDocument &	idoc,
		IProgressIndicator *	indicator = `0`
	)

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.

Returns: Code of the operation termination.

◆ ASCIIPointCloudWrite()

MbeConvResType ASCIIPointCloudWrite	(	IConvertorProperty3D &	prop,
		ItModelDocument &	idoc,
		IProgressIndicator *	indicator = `0`
	)

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.

Returns: Code of the operation termination.

Classes

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ eLoggingMode

◆ MbeModelExchangeFormat

◆ MbeConvResType

Function Documentation

◆ ImportFromFile() [1/4]

◆ ImportFromFile() [2/4]

◆ ImportFromFile() [3/4]

◆ ExportIntoFile() [1/3]

◆ ExportIntoFile() [2/3]

◆ ExportIntoFile() [3/3]

◆ ImportFromBuffer() [1/3]

◆ ImportFromBuffer() [2/3]

◆ ImportFromBuffer() [3/3]

◆ ExportIntoBuffer() [1/3]

◆ ExportIntoBuffer() [2/3]

◆ ExportIntoBuffer() [3/3]

◆ ImportFromFile() [4/4]

◆ ASCIIPointCloudRead()

◆ ASCIIPointCloudWrite()