#include <DbGeoData.h>
Additional Inherited Members | |
 Static Public Member Functions inherited from OdRxObject | |
| static OdRxObjectPtr | cast (const OdRxObject *pointer) |
| static OdRxClass * | desc () |
| Protected Member Functions inherited from OdDbObject | |
| OdDbObject () | |
| virtual OdResult | subGetClassID (void *pClsid) const |
| virtual OdDbObjectPtr | subDeepClone (OdDbIdMapping &ownerIdMap, OdDbObject *pOwner, bool bPrimary) const |
| virtual OdDbObjectPtr | subWblockClone (OdDbIdMapping &ownerIdMap, OdDbObject *pOwner, bool bPrimary) const |
| Protected Member Functions inherited from OdGiDrawable | |
| OdGiDrawable () | |
| virtual OdUInt32 | subViewportDrawLogicalFlags (OdGiViewportDraw *vd) const |
| virtual OdUInt32 | subRegenSupportFlags () const |
| Protected Attributes inherited from OdDbObject | |
| OdDbObjectImpl * | m_pImpl |
Detailed Description
This class represents GeoData objects in an OdDbDatabase instance.
<group OdDb_Classes>
Definition at line 50 of file DbGeoData.h.
Member Enumeration Documentation
◆ ScaleEstimationMethod
This enumeration represents the scale estimation method.
| Enumerator | |
|---|---|
| kScaleEstMethodUnity | |
| kScaleEstMethodUserDefined | |
| kScaleEstMethodReferencePoint | |
| kScaleEstMethodPrismoidal | |
Definition at line 73 of file DbGeoData.h.
◆ TypeOfCoordinates
This enumeration represents the type of design coordinates.
| Enumerator | |
|---|---|
| kCoordTypUnknown | |
| kCoordTypLocal | |
| kCoordTypGrid | |
| kCoordTypGeographic | |
Definition at line 62 of file DbGeoData.h.
Constructor & Destructor Documentation
◆ OdDbGeoData()
| OdDbGeoData::OdDbGeoData | ( | ) |
Default constructor.
Member Function Documentation
◆ addMeshFace()
| void OdDbGeoData::addMeshFace | ( | int | faceIndex, |
| int | p0, | ||
| int | p1, | ||
| int | p2 | ||
| ) |
Sets the three vertex indexes for the specified triangle face.
- Parameters
-
faceIndex [in] Face index. p0 [in] The first vertex index. p1 [in] The second vertex index. p2 [in] The third vertex index.
◆ addMeshPointMap()
| void OdDbGeoData::addMeshPointMap | ( | int | index, |
| const OdGePoint2d & | srcPt, | ||
| const OdGePoint2d & | dstPt | ||
| ) |
Inserts a new design/reference point association into the mesh.
- Parameters
-
index [in] Array index. srcPt [in] Source point. dstPt [in] Destination point.
- Remarks
- The new point association is inserted before the array index parameter. If the index specification is invalid, the new point association is appended to the end of the mesh array.
◆ blockTableRecordId()
| OdDbObjectId OdDbGeoData::blockTableRecordId | ( | ) | const |
Returns the Object ID of the block table record.
◆ coordinateProjectionRadius()
| double OdDbGeoData::coordinateProjectionRadius | ( | ) | const |
Returns the radius of curvature of the ellipsoid model that is used in the sea-level correction algorithm.
- Remarks
- The radius is measured in meters.
◆ coordinateSystem()
| OdString OdDbGeoData::coordinateSystem | ( | ) | const |
Returns the current coordinate system definition.
◆ coordinateType()
| TypeOfCoordinates OdDbGeoData::coordinateType | ( | ) | const |
Returns the type of design coordinates.
- Remarks
- The type of design coordinates can be one of the following: kCoordTypUnknown kCoordTypLocal kCoordTypGrid kCoordTypGeographic
◆ designPoint()
| OdGePoint3d OdDbGeoData::designPoint | ( | ) | const |
Returns the design coordinates of the point associated with the point position specified by the setReferencePoint() method.
- Remarks
- There is no a default value for the point's design coordinates. They must be specified clearly by the application that creates an OdDbGeoData object.
◆ doSeaLevelCorrection()
| bool OdDbGeoData::doSeaLevelCorrection | ( | ) | const |
Returns the boolean value that controls the application of the sea-level correction to horizontal coordinates during a local-to-grid transformation process.
- Remarks
- The default value is false.
◆ 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 OdDbObject.
◆ 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 OdDbObject.
◆ 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 OdDbObject.
◆ 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 OdDbObject.
◆ eraseFromDb()
| OdResult OdDbGeoData::eraseFromDb | ( | ) |
Erases this OdDbGeoData object from the database.
- Returns
- Returns eOK if the object was successfully erased, or an appropriate error code if not.
◆ geoRSSTag()
| OdString OdDbGeoData::geoRSSTag | ( | ) | const |
Returns the geoRSS tag.
◆ getMeshFace()
| void OdDbGeoData::getMeshFace | ( | int | faceIndex, |
| int & | p0, | ||
| int & | p1, | ||
| int & | p2 | ||
| ) | const |
Returns the three vertex indexes for the specified face.
- Parameters
-
faceIndex [in] Face index. p0 [out] The first vertex index. p1 [out] The second vertex index. p2 [out] The third vertex index.
◆ getMeshPointMap()
| void OdDbGeoData::getMeshPointMap | ( | int | index, |
| OdGePoint2d & | srcPt, | ||
| OdGePoint2d & | dstPt | ||
| ) | const |
Returns the design points and the associated reference points in the object's transformation mesh.
- Parameters
-
index [in] Number of the points to be fetched. srcPt [out] Source point. dstPt [out] Destination point.
◆ getMeshPointMaps()
| void OdDbGeoData::getMeshPointMaps | ( | OdGePoint2dArray & | srcPts, |
| OdGePoint2dArray & | dstPts | ||
| ) | const |
Returns the object's transformation mesh points.
- Parameters
-
srcPts [out] Array of all design points. dstPts [out] Array of all reference points.
- Remarks
- The returned arrays are valid if they contain the same number of points and are not empty.
◆ horizontalUnits()
| OdDb::UnitsValue OdDbGeoData::horizontalUnits | ( | ) | const |
Returns the horizontal unit type.
- Returns
- If the current value of the horizontal unit scale was set by the setHorizontalUnit() method, this method returns the OdDb::UnitsValue used at that time.
◆ horizontalUnitScale()
| double OdDbGeoData::horizontalUnitScale | ( | ) | const |
Returns the current value of the horizontal unit scale.
- Returns
- Returns the factor that is used to multiply the X or Y coordinate in the design database to produce the equivalent value in meters.
- Remarks
- Default value is 1.0.
◆ northDirection()
| double OdDbGeoData::northDirection | ( | ) | const |
Returns the azimuth of the Y axis relative to true north in radians east of north.
◆ northDirectionVector()
| OdGeVector2d OdDbGeoData::northDirectionVector | ( | ) | const |
Returns the copy of the 2D vector that defines the direction of true north in terms of design coordinates.
◆ numMeshFaces()
| int OdDbGeoData::numMeshFaces | ( | ) | const |
Returns the number of faces in the mesh triangulation.
◆ numMeshPoints()
| int OdDbGeoData::numMeshPoints | ( | ) | const |
Returns the number of points in the transformation mesh.
◆ observationCoverage()
| OdString OdDbGeoData::observationCoverage | ( | ) | const |
Returns the current value of the ObservationCoverage property.
◆ observationFrom()
| OdString OdDbGeoData::observationFrom | ( | ) | const |
Returns the current value of the ObservationFrom property.
◆ observationTo()
| OdString OdDbGeoData::observationTo | ( | ) | const |
Returns the current value of the ObservationTo property.
◆ ODDB_DECLARE_MEMBERS()
| OdDbGeoData::ODDB_DECLARE_MEMBERS | ( | OdDbGeoData | ) |
◆ postToDb()
| OdResult OdDbGeoData::postToDb | ( | OdDbObjectId & | objId | ) |
Posts this OdDbGeoData object to the database.
- Parameters
-
objId [out] Object ID of the posted OdDbGeoData object.
- Returns
- Returns eOK if successful, or an appropriate error code if not.
- Remarks
- Call the setBlockTableRecordId() method to set the block table record before calling the postToDb() method.
◆ referencePoint()
| OdGePoint3d OdDbGeoData::referencePoint | ( | ) | const |
Returns the reference point associated with the design coordinates that is set by the setDesignPoint() method.
◆ resetMeshPointMaps()
| void OdDbGeoData::resetMeshPointMaps | ( | ) |
Resets both object's transformation mesh point arrays.
◆ scaleEstimationMethod()
| ScaleEstimationMethod OdDbGeoData::scaleEstimationMethod | ( | ) | const |
Returns the current value of the scale estimation method of this object.
◆ scaleFactor()
| double OdDbGeoData::scaleFactor | ( | ) | const |
Returns the current value of the scale factor of this object.
- Remarks
- The default value is 1.0.
◆ seaLevelElevation()
| double OdDbGeoData::seaLevelElevation | ( | ) | const |
Returns the current value of the object's sea level elevation.
◆ setBlockTableRecordId()
| void OdDbGeoData::setBlockTableRecordId | ( | const OdDbObjectId & | blockId | ) |
Sets the Object ID of the block table record.
- Parameters
-
blockId [in] Object ID of the block table record.
◆ setCoordinateProjectionRadius()
| void OdDbGeoData::setCoordinateProjectionRadius | ( | double | value | ) |
Sets the radius of curvature of the ellipsoid model that is used in the sea-level correction algorithm.
- Parameters
-
value [in] Radius value, in meters.
◆ setCoordinateSystem()
Sets the current coordinate system definition.
- Parameters
-
coordSystem [in] String that represents a coordinate system. \remarks When the coordinate system is changed, mesh point arrays are not changed. To get access to these arrays, use set/getMeshPointMaps(), getMeshPointMap() and addMeshPointMap() methods.
◆ setCoordinateType()
| void OdDbGeoData::setCoordinateType | ( | TypeOfCoordinates | designCoordinateType | ) |
Sets the type of design coordinates.
- Parameters
-
designCoordinateType [in] Type of coordinates for setting.
- Remarks
- The designCoordinateType can be one of the following: kCoordTypUnknown kCoordTypLocal kCoordTypGrid kCoordTypGeographic The current implementation supports only kCoordTypGrid and kCoordTypGeographic types and recalculates coordinates correctly only if the Unit of the drawing is set to meter.
◆ setDesignPoint()
| void OdDbGeoData::setDesignPoint | ( | const OdGePoint3d & | point | ) |
Sets the design coordinates of the point associated with the point position specified by the setReferencePoint() method.
- Parameters
-
point [in] Point design coordinates.
- Remarks
- There is no default value for the point's design coordinates. They must be specified clearly by the application that creates an OdDbGeoData object.
◆ setDoSeaLevelCorrection()
| void OdDbGeoData::setDoSeaLevelCorrection | ( | bool | seaLevelCorrectionOn | ) |
Sets the boolean value that controls the application of the sea-level correction to horizontal coordinates during a local-to-grid transformation process.
- Parameters
-
seaLevelCorrectionOn [in] Boolean value to enable (true) or disable (false) sea-level correction.
- Remarks
- The default value is false.
◆ setGeoRSSTag()
Sets the user generated geoRSS tag.
- Parameters
-
rssTag [in] GeoRSS tag value.
◆ setHorizontalUnits()
| void OdDbGeoData::setHorizontalUnits | ( | OdDb::UnitsValue | horizUnits | ) |
Sets the linear unit in which X and Y cooordinates are expressed.
- Parameters
-
horizUnits [in] Unit system in which horizontal X and Y coordinates are expressed.
◆ setHorizontalUnitScale()
| void OdDbGeoData::setHorizontalUnitScale | ( | double | horzUnitScale | ) |
Sets the current value of the horizontal unit scale.
- Parameters
-
horzUnitScale [in] Double value that is used to multiply the X or Y coordinate to produce the equivalent value in meters.
◆ setMeshPointMaps()
| void OdDbGeoData::setMeshPointMaps | ( | const OdGePoint2dArray & | srcPts, |
| const OdGePoint2dArray & | dstPts | ||
| ) |
Replaces the object's transformation mesh point arrays.
- Parameters
-
srcPts [in] Array of design points. dstPts [in] Array of associated reference points.
◆ setNorthDirectionVector()
| void OdDbGeoData::setNorthDirectionVector | ( | const OdGeVector2d & | north | ) |
Sets the current value of the 2D vector that defines the direction of true north in terms of design coordinates.
- Parameters
-
north [in] 2D vector.
- Remarks
- The default value is (0,1).
◆ setObservationCoverage()
Sets the current value of the ObservationCoverage property.
- Parameters
-
coverage [in] New value of the ObservationCoverage property.
◆ setObservationFrom()
Sets the current value of the ObservationFrom property.
- Parameters
-
from [in] New value of the ObservationFrom property.
◆ setObservationTo()
Sets the current value of the ObservationTo property.
- Parameters
-
to [in] New value of the ObservationTo property.
◆ setReferencePoint()
| void OdDbGeoData::setReferencePoint | ( | const OdGePoint3d & | point | ) |
Sets the reference point associated with the design coordinates that is set by the setDesignPoint() method.
- Parameters
-
point [in] Reference point.
- Remarks
- If the type of coordinate is kCoordTypLocal, the point argument is defined by the setCoordinateSystem() method of this object.
◆ setScaleEstimationMethod()
| void OdDbGeoData::setScaleEstimationMethod | ( | ScaleEstimationMethod | value | ) |
Sets the current value of the scale estimation method of this object.
- Parameters
-
value [in] ScaleEstimationMethod enum value.
◆ setScaleFactor()
| void OdDbGeoData::setScaleFactor | ( | double | value | ) |
Sets the user-defined scale factor of this object.
- Parameters
-
value [in] Scale value.
- Remarks
- The default value is 1.0.
◆ setSeaLevelElevation()
| void OdDbGeoData::setSeaLevelElevation | ( | double | value | ) |
Sets the object's sea level elevation.
- Parameters
-
value [in] Sea level evaluation value.
◆ setUpDirection()
| void OdDbGeoData::setUpDirection | ( | const OdGeVector3d & | vec | ) |
Sets the current value of the vector that defines the direction of the vertical axis of a local coordinate system.
- Parameters
-
vec [in] Reference to the OdGeVector3d object.
- Remarks
- The vector default value is (0, 0, 1).
◆ setVerticalUnits()
| void OdDbGeoData::setVerticalUnits | ( | OdDb::UnitsValue | vertUnits | ) |
Sets the vertical unit.
- Parameters
-
vertUnits [in] Vertical unit.
◆ setVerticalUnitScale()
| void OdDbGeoData::setVerticalUnitScale | ( | double | vertUnitScale | ) |
Sets the current value of the vertical unit scale.
- Parameters
-
horzUnitScale [in] Double value that is used to multiply the X or Y coordinate to produce the equivalent value in meters.
◆ transformFromLonLatAlt() [1/2]
| OdResult OdDbGeoData::transformFromLonLatAlt | ( | const OdGePoint3d & | geoPt, |
| OdGePoint3d & | dwgPt | ||
| ) | const |
Transforms the geographic point into an equivalent design point.
- Parameters
-
geoPt [in] Geographic point to be transformed. dwgPt [out] Transformed equivalent in design coordinates.
- Returns
- Returns eOK if successful, or an appropriate error code if not.
- Remarks
- Longitude ordinate is transformed in the X member of the OdGePoint3d object, latitude ordinate is transformed in the Y member of the OdGePoint3d object and the elevation (altitude) is transformed in the Z member of the OdGePoint3d object.
◆ transformFromLonLatAlt() [2/2]
| OdResult OdDbGeoData::transformFromLonLatAlt | ( | double | lon, |
| double | lat, | ||
| double | alt, | ||
| double & | x, | ||
| double & | y, | ||
| double & | z | ||
| ) | const |
Transforms the geographic point into an equivalent design point.
- Parameters
-
lon [in] Longitude ordinate of the point to be transformed. lat [in] Latitude ordinate of the point to be transformed. alt [in] Altitude ordinate of the point to be transformed. x [out] X ordinate of the transformed point. y [out] Y ordinate of the transformed point. z [out] Z ordinate of the transformed point.
- Returns
- Returns eOK if successful, or an appropriate error code if not.
◆ transformToLonLatAlt() [1/2]
| OdResult OdDbGeoData::transformToLonLatAlt | ( | const OdGePoint3d & | dwgPt, |
| OdGePoint3d & | geoPt | ||
| ) | const |
Transforms the design point into an equivalent geographic point.
- Parameters
-
dwgPt [in] Point, in design coordinates, to be transformed. geoPt [out] Geographic equivalent of the dwgPt.
- Returns
- Returns eOK if successful, or an appropriate error code if not.
- Remarks
- Longitude ordinate is transformed in the X member of the OdGePoint3d object, latitude ordinate is transformed in the Y member of the OdGePoint3d object and the elevation (altitude) is transformed in the Z member of the OdGePoint3d object.
◆ transformToLonLatAlt() [2/2]
| OdResult OdDbGeoData::transformToLonLatAlt | ( | double | x, |
| double | y, | ||
| double | z, | ||
| double & | lon, | ||
| double & | lat, | ||
| double & | alt | ||
| ) | const |
Transforms the design point into an equivalent geographic point.
- Parameters
-
x [in] X ordinate of the design point. y [in] Y ordinate of the design point. z [in] Z ordinate of the design point. lon [out] Longitude ordinate of the transformed point. lat [out] Latitude ordinate of the transformed point. alt [out] Altitude (elevation) ordinate of the transformed point.
- Returns
- Returns eOK if successful, or an appropriate error code if not.
◆ upDirection()
| OdGeVector3d OdDbGeoData::upDirection | ( | ) | const |
Returns the copy of the vector that defines the direction of the vertical axis of a local coordinate system.
- Remarks
- The default value of the vector is (0, 0, 1).
◆ verticalUnits()
| OdDb::UnitsValue OdDbGeoData::verticalUnits | ( | ) | const |
Returns the vertical unit type.
- Returns
- If the current value of the vertical unit scale was set by setVerticalUnits() method, this method returns the OdDb::UnitsValue used at that time.
◆ verticalUnitScale()
| double OdDbGeoData::verticalUnitScale | ( | ) | const |
Returns the current value of the vertical unit scale.
- Returns
- Returns the factor that is used to multiply the X or Y coordinate in the design database to produce the equivalent value in meters.
The documentation for this class was generated from the following file: