/////////////////////////////////////////////////////////////////////////////// 
// Copyright (C) 2002-2025, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Open Design Alliance software pursuant to a license 
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2025 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
///////////////////////////////////////////////////////////////////////////////
#ifndef _OD_DB_GEOMAP_PE_
#define _OD_DB_GEOMAP_PE_

#include "DbGeoMap.h"

#include "TD_PackPush.h"

/** \details
  An abstract class that represents a protocol extension for the OdDbGeoMap class,
  which provides the ability to override the OdDbGeoMap::updateMapImage() function implementation.

  <group OdDb_Classes>
*/
class DBGEOLOCATIONOBJ_EXPORT OdDbGeoMapPE : public OdRxObject
{
public:
  ODRX_DECLARE_MEMBERS(OdDbGeoMapPE);

  /** \details
    Default destructor.
  */
  virtual ~OdDbGeoMapPE() {};

  /** \details
    Updates the embedded image by recapturing an area from the live map.
    
    \param pGeoMap [in] Pointer to the OdDbGeoMap object.
    \param 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.
  */
  virtual OdResult updateMapImage(OdDbGeoMap * pGeoMap, bool bReset) = 0;
};

typedef OdSmartPtr<OdDbGeoMapPE> OdDbGeoMapPEPtr;

#include "TD_PackPop.h"

#endif //_OD_DB_GEOMAP_PE_