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

Interface of converter's properties. More...

#include <conv_exchange_settings.h>

+ Inheritance diagram for IConvertorProperty3D:

Public Member Functions

virtual const std::string GetDocumentName () const =0
 Get document's name.
 
virtual const c3d::path_string FullFilePath () const =0
 Get file name for converting.
 
virtual bool IsFileAscii () const =0
 Whether the file is a text file.
 
virtual long int GetFormatVersion () const
 Get the version of format for export.
 
virtual bool IsOutOnlySurfaces () const =0
 Whether to export only surfaces (introduced for work with converter IGES ).
 
virtual bool IsAssembling () const =0
 Whether the document for export is an assembly.
 
virtual bool GetIoPermission (MbeIOPermiss nPermission) const =0
 Get the value of permission for import-export of objects of a certain type.
 
virtual void GetIoPermissions (std::vector< bool > &ioPermissions) const =0
 Get values of permission for import-export of objects of certain types.
 
virtual void SetIoPermission (MbeIOPermiss nPermission, bool set)=0
 Set permission for import-export of objects of a certain type.
 
virtual bool GetPropertyString (MbeConverterStrings nString, std::string &propertyString) const =0
 Get the value of a certain string for the converter.
 
virtual void SetPropertyString (MbeConverterStrings nString, const std::string &propertyString)=0
 Set the value of a certain string for the converter.
 
virtual eTextForm GetAnnotationTextRepresentation () const
 Text representation in annotation objects.
 
virtual bool ExportComponentsSeparately () const
 Export components into separate files ( if provided in format). More...
 
virtual MbPlacement3D GetOriginLocation () const =0
 Get the location, the model is placed in.
 
virtual bool ReplaceLocationsToRight () const =0
 Replace components' placements to right-oriented.
 
virtual bool EnableAutoStitch (double &) const =0
 If surfaces should be stitched automatically. More...
 
virtual double LengthUnitsFactor () const
 Get the factor of the length units to millimeters. More...
 
virtual double AppLengthUnitsFactor () const
 Get addifional factor of the length units to millimeters in the application model. More...
 
virtual void LogReport (ptrdiff_t id, eMsgType msgType, eMsgDetail msgText)=0
 Make a record in the converter report. More...
 
virtual MbStepData TesselationParameters () const
 Get data for step calculation during triangulation (for JT, STL, VRML only).
 
virtual MbStepData LOD0TesselationParameters () const
 Get data for step calculation during triangulation of LOD0 (for JTonly).
 
virtual bool DualSeams () const
 Whether to keep coincident points of seams (for STL, VRML only).
 
virtual bool JoinSimilarFaces () const
 Whether to join similar faces.
 
virtual bool AddRemovedFacesAsShells () const
 Whether to add removed faces as shells.
 
virtual SPtr< IProductIdMakerProductIdentifierGenerator () const
 Get generator of one-line product identifier.
 
virtual C3DConverterDebugSettings GetDebugSettings () const
 Get the settings of debug info.
 
virtual SPtr< IC3DCharEncodingTransformerGetUserCharEncodingTransformer () const
 Get user string transformer.
 
virtual DEPRECATE_DECLARE bool ImportComponentsWithColoredReplica ()
 Create colored replicas of components on import.
 

Detailed Description

Interface of converter's properties.

Interface of converter's properties realizes getting the document's name and other information about it, such as the author, and management of modes of operations - stitching of surfaces with possibility of solids creation, objects filtration, generation of translation journal.

Member Function Documentation

◆ ExportComponentsSeparately()

virtual bool IConvertorProperty3D::ExportComponentsSeparately ( ) const
inlinevirtual

Export components into separate files ( if provided in format).

Note
EXPEREIMENTAL.

Reimplemented in ConvConvertorProperty3D.

◆ EnableAutoStitch()

virtual bool IConvertorProperty3D::EnableAutoStitch ( double &  ) const
pure virtual

If surfaces should be stitched automatically.

Returns
true - Stitch surfaces automatically, false - Ask user first time.
Parameters
[out]stitchPrecision- Stitch precision.

Implemented in ConvConvertorProperty3D.

◆ LengthUnitsFactor()

virtual double IConvertorProperty3D::LengthUnitsFactor ( ) const
inlinevirtual

Get the factor of the length units to millimeters.

During the import all spatial objects (coordinate values, radiuses) are multiplied by the returned value, unless the scale factor comes from the exchange file. During the export the exchange format facilities are used to specify the length units or all spatial objects (coordinate values, radiuses) are multiplied by the returned value.

Reimplemented in ConvConvertorProperty3D.

◆ AppLengthUnitsFactor()

virtual double IConvertorProperty3D::AppLengthUnitsFactor ( ) const
inlinevirtual

Get addifional factor of the length units to millimeters in the application model.

During the import from all formats except for JT all spatial objects (coordinate values, radiuses) are multiplied by the returned value, even if the scale factor comes from the exchange file. During the export the exchange format facilities are used to specify the length units or all spatial objects (coordinate values, radiuses) are multiplied by the returned value.

Reimplemented in ConvConvertorProperty3D.

◆ LogReport()

virtual void IConvertorProperty3D::LogReport ( ptrdiff_t  id,
eMsgType  msgType,
eMsgDetail  msgText 
)
pure virtual

Make a record in the converter report.

Parameters
[in]id- Identifier of an element inside the file of a foreign format.
[in]msgType- Message type.
[in]msgText- Message code.

Implemented in ConvConvertorProperty3D.


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