#include <MvdXmlHostAppServices.h>
Additional Inherited Members | |
 Public Types inherited from OdDbBaseHostAppServices | |
| enum | RemapFileContext { kDrawingOpen = 0 , kXrefResolution = 1 , kRasterResolution = 2 } |
| enum | FindFileHint { kDefault = 0 , kFontFile = 1 , kCompiledShapeFile = 2 , kTrueTypeFontFile = 3 , kEmbeddedImageFile = 4 , kXRefDrawing = 5 , kPatternFile = 6 , kTXApplication = 7 , kFontMapFile = 8 , kUnderlayFile = 9 , kTextureMapFile = 10 , kPhotometricWebFile = 11 , kAssetLibXMLFile = 12 } |
| enum | GsBitmapDeviceFlags { kUseSoftwareHLR = (1 << 0) , kFor2dExportRender = (1 << 1) , kFor2dExportRenderHLR = (1 << 2) , kForThumbnail = (1 << 3) } |
| Static Public Member Functions inherited from OdRxObject | |
| static OdRxObjectPtr | cast (const OdRxObject *pointer) |
| static OdRxClass * | desc () |
Detailed Description
Definition at line 37 of file MvdXmlHostAppServices.h.
Constructor & Destructor Documentation
◆ OdMvdXmlHostAppServices()
| OdMvdXmlHostAppServices::OdMvdXmlHostAppServices | ( | ) |
Creates a platform-specific operation services object for mvdXML functionality.
◆ ~OdMvdXmlHostAppServices()
| OdMvdXmlHostAppServices::~OdMvdXmlHostAppServices | ( | ) |
Deletes a platform-specific operation services object for mvdXML functionality.
Member Function Documentation
◆ companyName()
|
virtual |
Retrieves the current name of the client company.
- Returns
- Returns a string object containing the current name of the client company.
- Remarks
- The default implementation of this method returns oddgGetLibraryInfo()->getCompanyName(). This method is typically used for populating information about the client's company.
Implements OdDbBaseHostAppServices.
◆ databaseClass()
|
virtual |
Retrieves the mvdXML database class description.
- Returns
- Returns the desc() method's result of the <link OdMvdXmlFile, OdMvdXmlFile> object.
◆ findFile()
|
virtual |
Searches for a specified file.
- Parameters
-
filename [in] A name of the file to find. pDb [in] A pointer to the database context. If the parameter value is equal to NULL, the file search is not related to a database. hint [in] A hint that indicates the type of file that is required.
- Returns
- Returns the full path to the found file; if the file was not found, the method returns an empty string.
- Remarks
- This method is called by IFC SDK when it needs to get access to a file, such as a font file, a template file, etc. If the pDb parameter value is not equal to NULL, it is possible to call the getFilename() method of the database instance to determine the full path to the IFC file associated with the database. The typical search order is the following:
The file name itself.
The current directory.
The drawing directory (for SHX font, image, and xref files).
The Windows fonts directory (only for TTF fonts on Windows platforms).
The hint parameter's value must be one of the following:
Value Description Extension kDefault 0 Any file. any kFontFile 1 Can be either SHX or TTF file. SHX or TTF kCompiledShapeFile 2 SHX file. SHX kTrueTypeFontFile 3 TTF file. TTF kEmbeddedImageFile 4 Image file. ISM kXRefDrawing 5 External reference file. kPatternFile 6 Pattern file (PAT). PAT kDRXApplication 7 DRX application file. DRX kFontMapFile 8 FontMap file. FMP
Implements OdDbBaseHostAppServices.
◆ formatMessage()
|
virtual |
details Formats an error message string corresponding to the specified error code(s).
- Parameters
-
errorCode [in] An error code.
- Returns
- Returns a string with a formatted error message.
Reimplemented from OdDbBaseHostAppServices.
◆ getAlternateFontName()
|
virtual |
Retrieves the current default font name.
- Returns
- Returns the path to the font file to be used when a given font file can not be found by IFC SDK.
- Remarks
- The default implementation of the method returns an empty string.
- See also
- <exref target="https://docs.opendesign.com/td/FontHandling.html">Font Handling</exref>
Implements OdDbBaseHostAppServices.
◆ getFontMapFileName()
|
virtual |
Retrieves the current font mapping file. This font mapping file is used by the <link OdIfcHostAppServices::getPreferableFont@OdString&@OdFontType, getPreferableFont()> method.
- Returns
- Returns the name of the font mapping file.
- Remarks
- The default implementation of this method returns an empty string.
- See also
- <exref target="https://docs.opendesign.com/td/FontHandling.html">Font Handling</exref>
Implements OdDbBaseHostAppServices.
◆ getPreferableFont()
|
virtual |
Retrieves the current preferable font name for a specified font name and type.
- Parameters
-
fontName [in] A font name. fontType [in] A font type.
- Returns
- Returns a string object containing the preferable font name.
- Remarks
- The default implementation of this method returns an empty string.
The fontType parameter value must be one of the following:
Value Description kFontTypeUnknown 0 Unknown. kFontTypeShx 1 SHX font. kFontTypeTrueType 2 TrueType font. kFontTypeShape 3 Shape file. kFontTypeBig 4 BigFont file.
- See also
- <exref target="https://docs.opendesign.com/td/FontHandling.html">Font Handling</exref>
Implements OdDbBaseHostAppServices.
◆ getProcessor()
| OdMvdXml::OdMvdXmlProcessorPtr OdMvdXmlHostAppServices::getProcessor | ( | OdMvdXml::ProccesorType | type | ) |
Retrieves the mvdXML processor.
- Returns
- Returns the smart pointer of the <link OdMvdXmlProcessor, OdMvdXmlProcessor> object.
◆ getSubstituteFont()
|
virtual |
Retrieves the current substitute font name. The substitute font is used in cases when a specified font is not found.
- Parameters
-
fontName [in] A font name. fontType [in] A font type.
- Returns
- Returns a string object that contains the substitute font name.
- Remarks
- The default implementation of this method returns an empty string. The fontType parameter value must be one of the following:
Value Description kFontTypeUnknown 0 Unknown. kFontTypeShx 1 SHX font. kFontTypeTrueType 2 TrueType font. kFontTypeShape 3 Shape file. kFontTypeBig 4 BigFont file.
- See also
- <exref target="https://docs.opendesign.com/td/FontHandling.html">Font Handling</exref>
Implements OdDbBaseHostAppServices.
◆ getSubstituteFontByChar()
|
virtual |
Retrieves the typeface name of the TTF font that has the specified character.
- Parameters
-
pFont [in] A TTF font object. unicodeChar [in] A symbol to find in the substitute font name. pDb [in] A raw pointer to the database context.
- Returns
- Returns a string object that contains the substitute font name.
- Remarks
- The default method implementation uses the Windows API for getting the font.
- See also
- <exref target="https://docs.opendesign.com/td/FontHandling.html">Font Handling</exref>
Reimplemented from OdDbBaseHostAppServices.
◆ ODRX_DECLARE_MEMBERS()
| OdMvdXmlHostAppServices::ODRX_DECLARE_MEMBERS | ( | OdMvdXmlHostAppServices | ) |
◆ product()
|
virtual |
Retrieves the current name of the client product based on ODA IFC SDK.
- Returns
- Returns a string object containing the current name of the client product.
- Remarks
- The default implementation of this method returns program(). This method is typically used for populating information about the product.
Implements OdDbBaseHostAppServices.
◆ program()
|
virtual |
Retrieves the current name of the client program based on ODA IFC SDK.
- Returns
- Returns a string object containing the custom application name.
- Remarks
- The default implementation of this method returns oddgGetLibraryInfo()->getLibName(). This method is typically used for populating information about the application.
Implements OdDbBaseHostAppServices.
◆ releaseMajorMinorString()
|
virtual |
Retrieves the major and minor numbers of the client application's version represented as a string.
- Returns
- Returns a string object that contains the application's major and minor version numbers.
- Remarks
- The default implementation of this method returns oddgGetLibraryInfo()->getLibVersion().
Reimplemented from OdDbBaseHostAppServices.
◆ versionString()
|
virtual |
Retrieves the release version of the client application represented as a string.
- Returns
- Returns the release version string of the client application.
- Remarks
- The default implementation of this method returns oddgGetLibraryInfo()->getLibVersion().
Reimplemented from OdDbBaseHostAppServices.
The documentation for this class was generated from the following file: