/////////////////////////////////////////////////////////////////////////////// 
// 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_DBGEODATADRAWINGPE_H
#define OD_DBGEODATADRAWINGPE_H

#include "Gi/GiDrawable.h"
#include "Gi/GiDrawableImpl.h"
#include "DbExport.h"

/** \details
An abstract class that represents a protocol extension for an OdDbGeoData object to draw chunks images for OdDbGeoData.

<group OdDb_Classes>
*/
class TOOLKIT_EXPORT OdDbGeoDataChunksPE : public OdRxObject
{
public:
  ODRX_DECLARE_MEMBERS(OdDbGeoDataChunksPE);

  /** \details
    Virtual destructor.
  */
  virtual ~OdDbGeoDataChunksPE() {};
  /** \details
    Draws chunks images for OdDbGeoData.
    
    \param pVd [in] Pointer to the OdGiViewportDraw interface.
    
    \returns Returns eOK if successful, or an appropriate error code if not.
  */
  virtual OdResult drawGeoDataChunks(OdGiViewportDraw* pVd) const = 0;

  /** \details
    Draws providers string for currently drawn OdDbGeoData chuncks.
    
    \param pVd [in] Pointer to the OdGiViewportDraw interface.
    
    \returns Returns eOK if successful, or an appropriate error code if not.
  */
  virtual OdResult drawGeoDataProvidersString(OdGiViewportDraw* pVd) const = 0;

  /** \details
    Sets interface mode (enabled/disabled) to control images loading from the internet.

    \param bEnable [in] If true/false, interface is enabled/disabled.
  */
  virtual void setMode(bool bEnable) = 0;

  /** \details
    Gets interface mode (enabled/disabled) to control images loading from the internet.

    \returns Returns bool, that represents if interface is enabled/disabled.
  */
  virtual bool getMode() const = 0;
};

/** \details
  This template class is a specialization of the OdSmartPtr class for OdDbGeoDataChunksPE object pointers.
*/
typedef OdSmartPtr<OdDbGeoDataChunksPE> OdDbGeoDataChunksPEPtr;


/** \details
  This class represents implementation of OdGiDrawable, that is used to draw chunks of images of OdDbGeoData.

  <group OdDb_Classes>
*/
class TOOLKIT_EXPORT OdDbGeoDataChunks : public OdGiDrawableImpl<>
{
  ODRX_DECLARE_MEMBERS(OdDbGeoDataChunks);
protected:
  OdDbGeoDataChunks();
public:
  /** \details
    Virtual destructor.
  */
  virtual ~OdDbGeoDataChunks();

  virtual OdUInt32 subSetAttributes(OdGiDrawableTraits* pTraits) const ODRX_OVERRIDE;
  virtual bool subWorldDraw(OdGiWorldDraw* pWd) const ODRX_OVERRIDE;
  virtual void subViewportDraw(OdGiViewportDraw* pVd) const ODRX_OVERRIDE;
};

/** \details
  This template class is a specialization of the OdSmartPtr class for OdDbGeoDataChunks object pointers.
*/
typedef OdSmartPtr<OdDbGeoDataChunks> OdDbGeoDataChunksPtr;


/** \details
  This class represents implementation of OdGiDrawable, that is used to draw providers string for OdDbGeoData.

  <group OdDb_Classes>
*/
class TOOLKIT_EXPORT OdDbGeoDataProvidersString : public OdGiDrawableImpl<>
{
  ODRX_DECLARE_MEMBERS(OdDbGeoDataProvidersString);
protected:
  OdDbGeoDataProvidersString();
public:
  /** \details
    Virtual destructor.
  */
  virtual ~OdDbGeoDataProvidersString();

  OdUInt32 subSetAttributes(OdGiDrawableTraits* pTraits) const ODRX_OVERRIDE;
  bool subWorldDraw(OdGiWorldDraw* pWd) const ODRX_OVERRIDE;
  void subViewportDraw(OdGiViewportDraw* pVd) const ODRX_OVERRIDE;
};

/** \details
  This template class is a specialization of the OdSmartPtr class for OdDbGeoDataProvidersString object pointers.
*/
typedef OdSmartPtr<OdDbGeoDataProvidersString> OdDbGeoDataProvidersStringPtr;

#endif