#include <DbGeoMap.h>
Public Member Functions inherited from Friends | |
| class | OdDbGeoMapFieldsPE |
Detailed Description
This class represents an embedded raster image that is captured from a portion of a live map.
<group OdDb_Classes>
Definition at line 38 of file DbGeoMap.h.
Constructor & Destructor Documentation
◆ OdDbGeoMap()
| OdDbGeoMap::OdDbGeoMap | ( | ) |
Default constructor.
◆ ~OdDbGeoMap()
|
virtual |
Default destructor.
Member Function Documentation
◆ bottomLeftPt()
| OdGePoint3d OdDbGeoMap::bottomLeftPt | ( | ) | const |
Returns the bottom left corner point of the image frame.
◆ brightness()
|
virtual |
Returns the brightness value for this raster image entity (DXF 281).
- Returns
- Returns a value in the range [0.0 .. 100.0].
Reimplemented from OdDbRasterImage.
◆ clipBoundary()
|
virtual |
Returns the clip boundary for this raster image entity (DXF 14, 24).
- Remarks
- The clip boundary is specified in pixel coordinates.
Reimplemented from OdDbRasterImage.
◆ composeForLoad()
|
virtual |
After loading from file, performs necessary actions which require accessing other Database objects. For example, processing round-trip data.
- Parameters
-
format [in] File type. version [in] Drawing version of file loaded. pAuditInfo [in] Pointer to an OdDbAuditInfo object. Can be Null. Not Null if drawing is being loaded in Recover mode. If so, audit() will be called later.
- Remarks
- If an object in its dwgInFields() method accesses other database objects, it's non-thread-safe. Such objects can't be loaded in MT mode. To enable MT loading of custom objects, its dwgInFields() should not access other database objects. Such actions should be performed in composeForLoad(). composeForLoad() is called in single-thread mode after all thread-safe objects are loaded (their dwgInFields() were called in MT mode).
Being overridden in custom classes, the function first should call the parent class method. Parent class implementation takes care of parent class round-trip data and other actions which require access to other objects.
Reimplemented from OdDbObject.
◆ contrast()
|
virtual |
Returns the contrast value for this raster image entity (DXF 282).
- Returns
- Returns a value in the range [0.0 .. 100.0].
Reimplemented from OdDbRasterImage.
◆ decomposeForSave()
|
virtual |
Determines the behavior for custom objects when saving to .dwg or .dxf file.
- Parameters
-
ver [in] Drawing version to save as. replaceId [out] Object ID of the object replacing this object. exchangeXData [out] Set to true if and only if this function did not add XData to the replacement object.
- Remarks
- This function either
Returns an OdDbObjectPtr for a non- database -resident (NDBRO) replacement object, setting replaceId to OdDbObjectId::kNull. Returns NULL, setting replaceId for a database -resident (DBRO) replacement object.
Custom objects can decompose themselves into other objects, adding additional XData as required. The Drawings transfers XData from this object to the replacement object if and only if exchangeXData is true.
The default implementation returns NULL and sets replaceId to OdDbObjectId::kNull. This function can be overridden in custom classes.
The method is not intended to be called by client code. For processing owned objects use convertForSave() method.
Reimplemented from OdDbObject.
◆ dragStatus()
|
virtual |
Notification function called when this entity is involved in a drag operation.
- Parameters
-
status [in] Status of the drag operation.
Reimplemented from OdDbEntity.
◆ dwgInFields()
|
virtual |
Reads the .dwg file data of this object.
- Parameters
-
pFiler [in] Filer object from which data are read.
- Returns
- Returns the filer status.
This function is called by dwgIn() to allow the object to read its data.
When overriding this function:
1) Call assertWriteEnabled(). 2) Call the parent class's dwgInFields(pFiler). 3) If it returns eOK, continue; otherwise return whatever the parent's dwgInFields(pFiler) returned. 4) Call the OdDbDwgFiler(pFiler) methods to read each of the object's data items in the order they were written. 5) Return pFiler->filerStatus().
Reimplemented from OdDbRasterImage.
◆ dwgOutFields()
|
virtual |
Writes the .dwg file data of this object.
- Parameters
-
pFiler [in] Pointer to the filer to which data are written.
- Remarks
This function is called by dwgIn() to allow the object to write its data.
When overriding this function:
1) Call assertReadEnabled(). 2) Call the parent class's dwgOutFields(pFiler). 3) Call the OdDbDwgFiler(pFiler) methods to write each of the object's data items in the order they were written.
Reimplemented from OdDbRasterImage.
◆ dxfInFields()
|
virtual |
Reads the DXF data of this object.
- Parameters
-
pFiler [in] Pointer to the filer from which data are read.
- Returns
- Returns the filer status.
This function is called by dxfIn() to allow the object to read its data.
When overriding this function:
1) Call assertWriteEnabled(). 2) Call the parent class's dwgInFields(pFiler). 3) If it returns eOK, continue; otherwise return whatever the parent's dxfInFields(pFiler) returned. 4) Call the OdDbDxfFiler(pFiler) methods to read each of the object's data items in the order they were written. 5) Return pFiler->filerStatus().
Reimplemented from OdDbRasterImage.
◆ dxfOutFields()
|
virtual |
Writes the DXF data of this object.
- Parameters
-
pFiler [in] Pointer to the filer to which data are to be written.
- Remarks
This function is called by dxfOut() to allow the object to write its data.
When overriding this function:
1) Call assertReadEnabled(). 2) Call the parent class's dxfOutFields(pFiler). 4) Use pFiler to call the OdDbDxfFiler methods to write each of the object's data items in the order they were written.
Reimplemented from OdDbRasterImage.
◆ fade()
|
virtual |
Returns the fade value for this raster image entity (DXF 283).
- Returns
- Returns a value in the range [0.0 .. 100.0].
Reimplemented from OdDbRasterImage.
◆ getImageVertices()
| OdResult OdDbGeoMap::getImageVertices | ( | OdGePoint3dArray & | vertices | ) | const |
◆ getOrientation()
|
virtual |
Returns the orientation and origin of this raster image entity.
- Parameters
-
origin [out] Receives the lower-left corner. u [out] Receives the vector defining the image direction and width. v [out] Receives the vector defining the direction of the height of the image.
- Remarks
- These vectors define the outer edges of the raster image entity.
Reimplemented from OdDbRasterImage.
◆ getVertices()
|
virtual |
Adds the frame vertices of this raster image entity to the specified array.
- Parameters
-
vertices [in/out] Receives the vertices of the image frame.
- Remarks
- If isClipped(), these are the vertices of the clip boundary.
If !isClipped(), these are the corners of the image.
Reimplemented from OdDbRasterImage.
◆ height()
| double OdDbGeoMap::height | ( | ) | const |
Returns the height of the image frame.
◆ image()
|
virtual |
◆ imageBottomLeftPt()
| OdGePoint3d OdDbGeoMap::imageBottomLeftPt | ( | ) | const |
Returns the bottom left corner of the embedded image.
◆ imageDefId()
|
virtual |
Returns the Object ID of the OdDbRasterImageDef object associated with this raster image entity (DXF 340).
Reimplemented from OdDbRasterImage.
◆ imageHeight()
| double OdDbGeoMap::imageHeight | ( | ) | const |
Returns the height of the embedded image.
◆ imageSize()
|
virtual |
Returns the size in pixels of this raster image entity (DXF 13, 23).
- Parameters
-
getCachedValue [in] True to always return cached value. False to return the value from the OdDbRasterImageDef object of available.
Reimplemented from OdDbRasterImage.
◆ imageWidth()
| double OdDbGeoMap::imageWidth | ( | ) | const |
Returns the width of the embedded image.
◆ isOutOfDate()
| bool OdDbGeoMap::isOutOfDate | ( | ) | const |
Returns a flag that indicates whether the image is up to date.
◆ LOD()
| OdInt8 OdDbGeoMap::LOD | ( | ) | const |
Returns the LOD (Level Of Detail, zoom level) of the map image. Updating the image resets this value.
◆ mapType()
| OdGeoMapType OdDbGeoMap::mapType | ( | ) | const |
Returns the current map type of the map image.
◆ ODDB_DECLARE_MEMBERS()
| OdDbGeoMap::ODDB_DECLARE_MEMBERS | ( | OdDbGeoMap | ) |
◆ resolution()
| OdGeoMapResolution OdDbGeoMap::resolution | ( | ) | const |
Returns the resolution of the map image that is applied on top of the LOD.
◆ setBrightness()
Sets the brightness value for this raster image entity (DXF 281).
- Parameters
-
brightness [in] Image brightness [0.0 .. 100.0].
Reimplemented from OdDbRasterImage.
◆ setContrast()
Sets the contrast value for this raster image entity (DXF 282).
- Parameters
-
contrast [in] Image contrast. [0.0 .. 100.0]
Reimplemented from OdDbRasterImage.
◆ setFade()
Sets the fade value for this raster image entity (DXF 283).
- Parameters
-
fade [in] Image fade. [0.0 .. 100.0].
Reimplemented from OdDbRasterImage.
◆ setMapType()
| OdResult OdDbGeoMap::setMapType | ( | OdGeoMapType | mapType | ) |
Sets the current map type for the map image.
- Parameters
-
mapType [in] Map type enum value.
- Returns
- eOk if successful, or an appropriate error code otherwise.
◆ setOrientation()
|
virtual |
Sets the orientation and origin of this raster image entity.
- Parameters
-
origin [in] Lower-left corner. u [in] Image width vector. v [in] Image height vector.
- Returns
- Returns true if and only if successful.
- Remarks
- The actual height of the image is determined by the width and aspect ratio fo the original image.
These vectors define the outer edges of the raster image entity.
Reimplemented from OdDbRasterImage.
◆ setResolution()
| OdResult OdDbGeoMap::setResolution | ( | OdGeoMapResolution | resolution | ) |
Sets the resolution for the map image that is applied on top of the LOD.
- Parameters
-
resolution [in] Resolution enum value.
- Returns
- eOk if successful, or an appropriate error code otherwise.
◆ subClose()
|
virtual |
Called as the first operation as this object is being closed, for database -resident objects only.
- Remarks
- This function is notified just before the current open operation is to be closed, giving this function the ability to perform necessary operatons.
When overriding this function:
1) If the OdDbObject's state is incorrect, throw exception.
2) Call parent class's subClose().
3) If other actions are required before close, do them.
The default implementation of this function does nothing. This function can be overridden in custom classes.
Reimplemented from OdDbRasterImage.
◆ subErase()
|
virtual |
Called as the first operation as this object is being erased or unerased.
- Parameters
-
erasing [in] A copy of the erasing argument passed to erase().
- Remarks
- This function is notified just before the current object is to be erased, giving this function the ability to cancel the erase.
Returns eOk if and only if erase() is to continue.
When overriding this function:
1) If the OdDbObject's state is incorrect, return something other than eOk.
2) If the parent class's subErase() returns anything other than eOk, immediately return it.
3) If other actions are required before erase, do them.
4) Return eOk.
If you must make changes to this object's state, either make them after step 2, or roll them back if step 2 returns other than eOk.
The default implementation of this function does nothing but return eOk. This function can be overridden in custom classes.
Reimplemented from OdDbEntity.
◆ subGetGeomExtents()
|
protectedvirtual |
Reimplemented from OdDbRasterImage.
◆ subTransformBy()
|
virtual |
Reimplemented from OdDbRasterImage.
◆ subViewportDraw()
|
protectedvirtual |
Reimplemented from OdDbRasterImage.
◆ subWorldDraw()
|
protectedvirtual |
Reimplemented from OdDbRasterImage.
◆ updateMapImage()
Updates the embedded image by recapturing an area from the live map.
- Parameters
-
bReset [in] Indicates whether to capture the image in the optimal screen resolution. If true, the LOD and resolution are reset to optimal values.
- Returns
- eOk if successful, or an appropriate error code otherwise.
◆ updateMapImageIfNeeded()
◆ width()
| double OdDbGeoMap::width | ( | ) | const |
Returns the width of the image frame.
Friends And Related Symbol Documentation
◆ OdDbGeoMapFieldsPE
|
friend |
Definition at line 172 of file DbGeoMap.h.
The documentation for this class was generated from the following file:
Generated on Tue Apr 15 2025 11:30:24