CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
OdDbGeoMapFieldsPE Class Reference

#include <DbGeoMapFieldsPE.h>

Inheritance diagram for OdDbGeoMapFieldsPE:
OdRxObject

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdDbGeoMapFieldsPE)
 
virtual ~OdDbGeoMapFieldsPE ()
 
virtual OdInt8 getLOD (OdDbGeoMap *pGeoMap) const
 
virtual bool getIsOutOfDate (OdDbGeoMap *pGeoMap) const
 
virtual const OdBinaryData & getPixelData (OdDbGeoMap *pGeoMap) const
 
virtual const OdGePoint2dArray & getPtClipBnd (OdDbGeoMap *pGeoMap) const
 
virtual const OdStringArray & getStrings (OdDbGeoMap *pGeoMap) const
 
virtual const OdGeVector3d & getvU (OdDbGeoMap *pGeoMap) const
 
virtual const OdGeVector3d & getvV (OdDbGeoMap *pGeoMap) const
 
virtual double getTextHeight (OdDbGeoMap *pGeoMap) const
 
virtual OdCmColor getTextColor (OdDbGeoMap *pGeoMap) const
 
virtual OdInt32 getHeight (OdDbGeoMap *pGeoMap) const
 
virtual OdInt32 getWidth (OdDbGeoMap *pGeoMap) const
 
virtual double getImageWidth (OdDbGeoMap *pGeoMap) const
 
virtual double getImageHeight (OdDbGeoMap *pGeoMap) const
 
virtual const OdGePoint3d & getPtTextPosition (OdDbGeoMap *pGeoMap) const
 
virtual const OdGePoint3d & getPtImageBottomLeft (OdDbGeoMap *pGeoMap) const
 
virtual OdInt8 getResolution (OdDbGeoMap *pGeoMap) const
 
virtual OdResult setLOD (OdDbGeoMap *pGeoMap, OdInt8 LOD) const
 
virtual OdResult setIsOutOfDate (OdDbGeoMap *pGeoMap, bool bIsOutOfDate) const
 
virtual OdResult setPixelData (OdDbGeoMap *pGeoMap, const OdBinaryData &pixelData) const
 
virtual OdResult setPtClipBnd (OdDbGeoMap *pGeoMap, const OdGePoint2dArray &ptClipBnd) const
 
virtual OdResult setStrings (OdDbGeoMap *pGeoMap, const OdStringArray &strings) const
 
virtual OdResult setvU (OdDbGeoMap *pGeoMap, const OdGeVector3d &vU) const
 
virtual OdResult setvV (OdDbGeoMap *pGeoMap, const OdGeVector3d &vV) const
 
virtual OdResult setTextHeight (OdDbGeoMap *pGeoMap, double dTextHeight) const
 
virtual OdResult setTextColor (OdDbGeoMap *pGeoMap, const OdCmColor &cColor) const
 
virtual OdResult setHeight (OdDbGeoMap *pGeoMap, OdInt32 height) const
 
virtual OdResult setWidth (OdDbGeoMap *pGeoMap, OdInt32 width) const
 
virtual OdResult setImageWidth (OdDbGeoMap *pGeoMap, double dImageWidth) const
 
virtual OdResult setImageHeight (OdDbGeoMap *pGeoMap, double dImageHeight) const
 
virtual OdResult setPtTextPosition (OdDbGeoMap *pGeoMap, const OdGePoint3d &ptTextPosition) const
 
virtual OdResult setPtImageBottomLeft (OdDbGeoMap *pGeoMap, const OdGePoint3d &ptImageBottomLeft) const
 
virtual OdResult setResolution (OdDbGeoMap *pGeoMap, OdInt8 Resolution) const
 
- Public Member Functions inherited from OdRxObject
 ODRX_HEAP_OPERATORS ()
 
 OdRxObject ()
 
virtual ~OdRxObject ()
 
virtual OdRxObject * queryX (const OdRxClass *pClass) const
 
virtual OdRxObject * x (const OdRxClass *pClass) const
 
virtual OdRxClass * isA () const
 
virtual void addRef ()=0
 
virtual void release ()=0
 
virtual long numRefs () const
 
bool isKindOf (const OdRxClass *pClass) const
 
virtual OdRxObjectPtr clone () const
 
virtual void copyFrom (const OdRxObject *pSource)
 
virtual OdRx::Ordering comparedTo (const OdRxObject *pOther) const
 
virtual bool isEqualTo (const OdRxObject *pOther) const
 

Additional Inherited Members

- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClass * desc ()
 
static void rxInit ()
 
static void rxUninit ()
 

Detailed Description

An abstract class that represents a protocol extension for the OdDbGeoMap class, which provides direct access to OdDbGeoMap class fields.

<group OdDb_Classes>

Definition at line 36 of file DbGeoMapFieldsPE.h.

Constructor & Destructor Documentation

◆ ~OdDbGeoMapFieldsPE()

virtual OdDbGeoMapFieldsPE::~OdDbGeoMapFieldsPE ( )
inlinevirtual

Default destructor.

Definition at line 44 of file DbGeoMapFieldsPE.h.

Member Function Documentation

◆ getHeight()

virtual OdInt32 OdDbGeoMapFieldsPE::getHeight ( OdDbGeoMap * pGeoMap) const
virtual

Returns the height of the map image.

Parameters
pGeoMap[in] Pointer to the map image object.

◆ getImageHeight()

virtual double OdDbGeoMapFieldsPE::getImageHeight ( OdDbGeoMap * pGeoMap) const
virtual

Returns the image height of the map image.

Parameters
pGeoMap[in] Pointer to the map image object.

◆ getImageWidth()

virtual double OdDbGeoMapFieldsPE::getImageWidth ( OdDbGeoMap * pGeoMap) const
virtual

Returns the image width of the map image.

Parameters
pGeoMap[in] Pointer to the map image object.

◆ getIsOutOfDate()

virtual bool OdDbGeoMapFieldsPE::getIsOutOfDate ( OdDbGeoMap * pGeoMap) const
virtual

Returns the IsOutOfDate flag of the map image.

Parameters
pGeoMap[in] Pointer to the map image object.

◆ getLOD()

virtual OdInt8 OdDbGeoMapFieldsPE::getLOD ( OdDbGeoMap * pGeoMap) const
virtual

Returns the LOD of the map image.

Parameters
pGeoMap[in] Pointer to the map image object.

◆ getPixelData()

virtual const OdBinaryData & OdDbGeoMapFieldsPE::getPixelData ( OdDbGeoMap * pGeoMap) const
virtual

Returns the pixel data of the map image.

Parameters
pGeoMap[in] Pointer to the map image object.

◆ getPtClipBnd()

virtual const OdGePoint2dArray & OdDbGeoMapFieldsPE::getPtClipBnd ( OdDbGeoMap * pGeoMap) const
virtual

Returns the clip boundary array of the map image.

Parameters
pGeoMap[in] Pointer to the map image object.

◆ getPtImageBottomLeft()

virtual const OdGePoint3d & OdDbGeoMapFieldsPE::getPtImageBottomLeft ( OdDbGeoMap * pGeoMap) const
virtual

Returns the bottom left position of the map image.

Parameters
pGeoMap[in] Pointer to the map image object.

◆ getPtTextPosition()

virtual const OdGePoint3d & OdDbGeoMapFieldsPE::getPtTextPosition ( OdDbGeoMap * pGeoMap) const
virtual

Returns the text position of the map image.

Parameters
pGeoMap[in] Pointer to the map image object.

◆ getResolution()

virtual OdInt8 OdDbGeoMapFieldsPE::getResolution ( OdDbGeoMap * pGeoMap) const
virtual

Returns the resolution of the map image.

Parameters
pGeoMap[in] Pointer to the map image object.

◆ getStrings()

virtual const OdStringArray & OdDbGeoMapFieldsPE::getStrings ( OdDbGeoMap * pGeoMap) const
virtual

Returns the string array of the map image.

Parameters
pGeoMap[in] Pointer to the map image object.

◆ getTextColor()

virtual OdCmColor OdDbGeoMapFieldsPE::getTextColor ( OdDbGeoMap * pGeoMap) const
virtual

Returns the text color of the map image.

Parameters
pGeoMap[in] Pointer to the map image object.

◆ getTextHeight()

virtual double OdDbGeoMapFieldsPE::getTextHeight ( OdDbGeoMap * pGeoMap) const
virtual

Returns the text height of the map image.

Parameters
pGeoMap[in] Pointer to the map image object.

◆ getvU()

virtual const OdGeVector3d & OdDbGeoMapFieldsPE::getvU ( OdDbGeoMap * pGeoMap) const
virtual

Returns the width vector of the map image.

Parameters
pGeoMap[in] Pointer to the map image object.

◆ getvV()

virtual const OdGeVector3d & OdDbGeoMapFieldsPE::getvV ( OdDbGeoMap * pGeoMap) const
virtual

Returns the height vector of the map image.

Parameters
pGeoMap[in] Pointer to the map image object.

◆ getWidth()

virtual OdInt32 OdDbGeoMapFieldsPE::getWidth ( OdDbGeoMap * pGeoMap) const
virtual

Returns the width of the map image.

Parameters
pGeoMap[in] Pointer to the map image object.

◆ ODRX_DECLARE_MEMBERS()

OdDbGeoMapFieldsPE::ODRX_DECLARE_MEMBERS ( OdDbGeoMapFieldsPE )

◆ setHeight()

virtual OdResult OdDbGeoMapFieldsPE::setHeight ( OdDbGeoMap * pGeoMap,
OdInt32 height ) const
virtual

Sets the height for the map image.

Parameters
pGeoMap[in] Pointer to the map image object.
height[in] The height for the map image.
Returns
eOk if successful, or an appropriate error code otherwise.

◆ setImageHeight()

virtual OdResult OdDbGeoMapFieldsPE::setImageHeight ( OdDbGeoMap * pGeoMap,
double dImageHeight ) const
virtual

Sets the image height for the map image.

Parameters
pGeoMap[in] Pointer to the map image object.
dImageHeight[in] The image height for the map image.
Returns
eOk if successful, or an appropriate error code otherwise.

◆ setImageWidth()

virtual OdResult OdDbGeoMapFieldsPE::setImageWidth ( OdDbGeoMap * pGeoMap,
double dImageWidth ) const
virtual

Sets the image width for the map image.

Parameters
pGeoMap[in] Pointer to the map image object.
dImageWidth[in] The image width for the map image.
Returns
eOk if successful, or an appropriate error code otherwise.

◆ setIsOutOfDate()

virtual OdResult OdDbGeoMapFieldsPE::setIsOutOfDate ( OdDbGeoMap * pGeoMap,
bool bIsOutOfDate ) const
virtual

Sets the IsOutOfDate flag for the map image.

Parameters
pGeoMap[in] Pointer to the map image object.
bIsOutOfDate[in] Boolean value for the IsOutOfDate flag.
Returns
eOk if successful, or an appropriate error code otherwise.

◆ setLOD()

virtual OdResult OdDbGeoMapFieldsPE::setLOD ( OdDbGeoMap * pGeoMap,
OdInt8 LOD ) const
virtual

Sets the LOD (Level of Detail) for the map image.

Parameters
pGeoMap[in] Pointer to the map image object.
LOD[in] Level of detail.
Returns
eOk if successful, or an appropriate error code otherwise.

◆ setPixelData()

virtual OdResult OdDbGeoMapFieldsPE::setPixelData ( OdDbGeoMap * pGeoMap,
const OdBinaryData & pixelData ) const
virtual

Sets the pixel data for the map image.

Parameters
pGeoMap[in] Pointer to the map image object.
pixelData[in] Image pixel data represented as binary data.
Returns
eOk if successful, or an appropriate error code otherwise.

◆ setPtClipBnd()

virtual OdResult OdDbGeoMapFieldsPE::setPtClipBnd ( OdDbGeoMap * pGeoMap,
const OdGePoint2dArray & ptClipBnd ) const
virtual

Sets the clip boundary array for the map image.

Parameters
pGeoMap[in] Pointer to the map image object.
ptClipBnd[in] The clip boundary array for the map image.
Returns
eOk if successful, or an appropriate error code otherwise.

◆ setPtImageBottomLeft()

virtual OdResult OdDbGeoMapFieldsPE::setPtImageBottomLeft ( OdDbGeoMap * pGeoMap,
const OdGePoint3d & ptImageBottomLeft ) const
virtual

Sets the bottom left position for the map image.

Parameters
pGeoMap[in] Pointer to the map image object.
ptImageBottomLeft[in] The bottom left position for the map image.
Returns
eOk if successful, or an appropriate error code otherwise.

◆ setPtTextPosition()

virtual OdResult OdDbGeoMapFieldsPE::setPtTextPosition ( OdDbGeoMap * pGeoMap,
const OdGePoint3d & ptTextPosition ) const
virtual

Sets the text position for the map image.

Parameters
pGeoMap[in] Pointer to the map image object.
ptTextPosition[in] The text position for the map image.
Returns
eOk if successful, or an appropriate error code otherwise.

◆ setResolution()

virtual OdResult OdDbGeoMapFieldsPE::setResolution ( OdDbGeoMap * pGeoMap,
OdInt8 Resolution ) const
virtual

Sets the resolution for the map image.

Parameters
pGeoMap[in] Pointer to the map image object.
Resolution[in] The resolution for the map image.
Returns
eOk if successful, or an appropriate error code otherwise.

◆ setStrings()

virtual OdResult OdDbGeoMapFieldsPE::setStrings ( OdDbGeoMap * pGeoMap,
const OdStringArray & strings ) const
virtual

Sets the string array for the map image.

Parameters
pGeoMap[in] Pointer to the map image object.
strings[in] The string array for the map image.
Returns
eOk if successful, or an appropriate error code otherwise.

◆ setTextColor()

virtual OdResult OdDbGeoMapFieldsPE::setTextColor ( OdDbGeoMap * pGeoMap,
const OdCmColor & cColor ) const
virtual

Sets the text color for the map image.

Parameters
pGeoMap[in] Pointer to the map image object.
cColor[in] The text color for the map image.
Returns
eOk if successful, or an appropriate error code otherwise.

◆ setTextHeight()

virtual OdResult OdDbGeoMapFieldsPE::setTextHeight ( OdDbGeoMap * pGeoMap,
double dTextHeight ) const
virtual

Sets the text height for the map image.

Parameters
pGeoMap[in] Pointer to the map image object.
dTextHeight[in] The text height for the map image.
Returns
eOk if successful, or an appropriate error code otherwise.

◆ setvU()

virtual OdResult OdDbGeoMapFieldsPE::setvU ( OdDbGeoMap * pGeoMap,
const OdGeVector3d & vU ) const
virtual

Sets the width vector for the map image.

Parameters
pGeoMap[in] Pointer to the map image object.
vU[in] The width vector for the map image.
Returns
eOk if successful, or an appropriate error code otherwise.

◆ setvV()

virtual OdResult OdDbGeoMapFieldsPE::setvV ( OdDbGeoMap * pGeoMap,
const OdGeVector3d & vV ) const
virtual

Sets the height vector for the map image.

Parameters
pGeoMap[in] Pointer to the map image object.
vV[in] The height vector for the map image.
Returns
eOk if successful, or an appropriate error code otherwise.

◆ setWidth()

virtual OdResult OdDbGeoMapFieldsPE::setWidth ( OdDbGeoMap * pGeoMap,
OdInt32 width ) const
virtual

Sets the width for the map image.

Parameters
pGeoMap[in] Pointer to the map image object.
width[in] The width for the map image.
Returns
eOk if successful, or an appropriate error code otherwise.
The documentation for this class was generated from the following file:
Generated on Tue Apr 15 2025 11:30:24