/////////////////////////////////////////////////////////////////////////////// 
// 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 __DBGSMANAGER_H_INCLUDED_
#define __DBGSMANAGER_H_INCLUDED_

class OdDbObjectId;
class OdDbViewport;
class OdDbDatabase;
class OdGiContextForDbDatabase;

#include "Gs/Gs.h"
#include "DbExport.h"

#include "TD_PackPush.h"

/** \details
    Corresponding C++ library: TD_Db
    <group OdGs_Classes> 
*/
class TOOLKIT_EXPORT OdGsLayoutHelper : public OdGsDevice
{
public:
  ODRX_DECLARE_MEMBERS(OdGsLayoutHelper);
  /** \details
    Returns the Layout object associated with this LayoutHelper object.
  */
  virtual OdDbObjectId layoutId() const = 0;
  /** \details
    Returns the active GsView object of the Layout object associated with this LayoutHelper object.
  */
  virtual OdGsViewPtr activeView() const = 0;
  /** \details
    Sets the active GsView object of the Layout object associated with this LayoutHelper object.
    \param pView [in]  Pointer to the GsView.
  */
  virtual void makeViewActive(OdGsView* pView) = 0;
  /** \details
    Return the OdGsModel object associated with this layout helper.
  */
  virtual OdGsModel* gsModel() = 0;

  /** \details
    Returns the underlying OdGsDevice object associated with this LayoutHelper object.
  */
  virtual OdGsDevicePtr underlyingDevice() const = 0;

  /** \details
    Sets the active viewport
    \param at [in]  Pick point in device coordinates.
  */
  virtual bool setActiveViewport(const OdGePoint2d& screenPt) = 0;

  /** \details
    \param id [in]  ObjectId of viewport which will be made active.
  */
  virtual bool setActiveViewport(const OdDbObjectId& id) = 0;

  /** \details
    Restores layout GsView database linkages state.
  */
  virtual void restoreGsViewDbLinkState() = 0;

  /** \details
    Checks does underlying device supports Gs state saving/loading.
  */
  virtual bool supportLayoutGsStateSaving() const = 0;
  /** \details
    Stores Gs state compatible with this LayoutHelper object.
    \param pStream [in]  Pointer onto OdStreamBuf object into which Gs state will be stored.
    \param nFlags [in]  Optional flags.
  */
  virtual bool storeLayoutGsState(OdStreamBuf* pStream, OdUInt32 nFlags = 0) const = 0;
  /** \details
    Extracts Layout object Id from Gs state stream.
    \param pStream [in]  Pointer onto OdStreamBuf object into which Gs state will be stored.
    \param pDb [in]  Opened database pointer.
    \param layoutObjId [out]  Layout object Id will be returned through this argument.
    \param nFlags [in]  Optional flags.
  */
  static bool extractLayoutIdForGsState(OdStreamBuf* pStream, OdDbDatabase *pDb, OdDbObjectId &layoutObjId, OdUInt32 nFlags = 0);
  /** \details
    Restores Gs state compatible with this LayoutHelper object.
    \param pStream [in]  Pointer onto OdStreamBuf object from which Gs state will be restored.
    \param nFlags [in]  Optional flags.
    \param pRetFiler [out]  Returns filer object invoked for state loading.
  */
  virtual bool restoreLayoutGsState(OdStreamBuf* pStream, OdUInt32 nFlags = 0) = 0;
};

typedef OdSmartPtr<OdGsLayoutHelper> OdGsLayoutHelperPtr;


/** \details
    Corresponding C++ library: TD_Db
    <group OdGs_Classes> 
*/
class TOOLKIT_EXPORT OdGsPaperLayoutHelper : public OdGsLayoutHelper
{
public:
  ODRX_DECLARE_MEMBERS(OdGsPaperLayoutHelper);

  virtual OdGsViewPtr overallView() const = 0;
  virtual void makeViewOverall(OdGsView* pView) = 0;
  virtual void initGsView(OdGsView* pView, const OdDbViewport* pVp) = 0;

  virtual OdGsViewPtr addViewport(const OdDbViewport* pVp);
  virtual OdGsViewPtr insertViewport(int viewIndex, const OdDbViewport* pVp);

  // Viewport filters behavior

  /** \details
    Viewport filter type.
  */
  enum ViewportFilter
  {
    kVpScreenFilter = (1 << 0), // Check does viewport is visible on screen.
    kVpSizeFilter   = (1 << 1), // Check does viewport dimensions larger corresponding value.
    kVpMaxActFilter = (1 << 2)  // Check does viewport number does not exceeds MAXACTVP variable.
  };
  /** \details
    Viewport filter branch.
  */
  enum ViewportFilterBranch
  {
    kVpBrDefault = 1, // Default branch.
    kVpBrPlot    = 2, // Plot generation branch.
    kVpBrAll     = 3  // All viewport filter branches.
  };
  /** \details
    Viewport filter application mode.
  */
  enum ViewportFilterMode
  {
    kVpFilterVisible   = 3, // Apply filter with visible effect (default).
    kVpFilterInvisible = 1, // Apply filter without visible effect.
    kVpFilterDisable   = 0  // Avoid filter application.
  };
  /** \details
    Setup specified viewport filter parameters.
    \param vpFilter [in]  Specify filter type for parameters setup.
    \param filterBranch [in]  Specify filter branch(es) for parameters setup.
    \param filterMode [in]  Specify filter application mode.
    \param filterParam [in]  Specify filter parameter (actual for size filter only, where it is mean minimal viewport size in pixels).
  */
  virtual void setViewportFilter(ViewportFilter vpFilter, ViewportFilterBranch filterBranch = kVpBrAll,
                                 ViewportFilterMode filterMode = kVpFilterVisible, OdUInt32 filterParam = 0);
};

typedef OdSmartPtr<OdGsPaperLayoutHelper> OdGsPaperLayoutHelperPtr;

/** \details

    Corresponding C++ library: TD_Db
    <group OdGs_Classes> 
*/
class TOOLKIT_EXPORT OdGsModelLayoutHelper : public OdGsLayoutHelper
{
public:
  ODRX_DECLARE_MEMBERS(OdGsModelLayoutHelper);
};

typedef OdSmartPtr<OdGsModelLayoutHelper> OdGsModelLayoutHelperPtr;


/** \details

    <group TD_Namespaces>
*/
namespace OdDbGsManager
{
  /** \details
      Populates OdGsDevice-derived object with OdGsViews-derived objects.
      Returns OdGsDevice-derived wrapper that handles some OdGsDevice's calls.
  */
  TOOLKIT_EXPORT OdGsLayoutHelperPtr setupActiveLayoutViews(OdGsDevice* pDevice,
    OdGiContextForDbDatabase* pGiCtx);

  /** \details
      Populates OdGsDevice-derived object with OdGsViews-derived objects.
      Returns OdGsDevice-derived wrapper that handles some OdGsDevice's calls.
  */
  TOOLKIT_EXPORT OdGsLayoutHelperPtr setupLayoutViews(OdDbObjectId layoutId, OdGsDevice* pDevice, 
    OdGiContextForDbDatabase* pGiCtx);

  /** \details
      Setups OdGsDevice-derived object with the palette associated with specified layout.
  */
  TOOLKIT_EXPORT void setupPalette(OdGsDevice* device, OdGiContextForDbDatabase* giContext,
    OdDbStub* layoutId = 0, ODCOLORREF palBackground = ODRGBA(0,0,0,0));
}

#include "TD_PackPop.h"

#endif // __DBGSMANAGER_H_INCLUDED_