DbGsManager.h

Go to the documentation of this file.

 
// Copyright (C) 2002-2022, 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-2022 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"
 
class TOOLKIT_EXPORT OdGsLayoutHelper : public OdGsDevice
{
public:
  ODRX_DECLARE_MEMBERS(OdGsLayoutHelper);
  virtual OdDbObjectId layoutId() const = 0;
  virtual OdGsViewPtr activeView() const = 0;
  virtual void makeViewActive(OdGsView* pView) = 0;
  virtual OdGsModel* gsModel() = 0;
 
  virtual OdGsDevicePtr underlyingDevice() const = 0;
 
  virtual bool setActiveViewport(const OdGePoint2d& screenPt) = 0;
 
  virtual bool setActiveViewport(const OdDbObjectId& id) = 0;
 
  virtual void restoreGsViewDbLinkState() = 0;
 
  virtual bool supportLayoutGsStateSaving() const = 0;
  virtual bool storeLayoutGsState(OdStreamBuf* pStream, OdUInt32 nFlags = 0) const = 0;
  static bool extractLayoutIdForGsState(OdStreamBuf* pStream, OdDbDatabase *pDb, OdDbObjectId &layoutObjId, OdUInt32 nFlags = 0);
  virtual bool restoreLayoutGsState(OdStreamBuf* pStream, OdUInt32 nFlags = 0) = 0;
};
 
typedef OdSmartPtr<OdGsLayoutHelper> OdGsLayoutHelperPtr;
 
 
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
 
  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.
  };
  enum ViewportFilterBranch
  {
    kVpBrDefault = 1, // Default branch.
    kVpBrPlot    = 2, // Plot generation branch.
    kVpBrAll     = 3  // All viewport filter branches.
  };
  enum ViewportFilterMode
  {
    kVpFilterVisible   = 3, // Apply filter with visible effect (default).
    kVpFilterInvisible = 1, // Apply filter without visible effect.
    kVpFilterDisable   = 0  // Avoid filter application.
  };
  virtual void setViewportFilter(ViewportFilter vpFilter, ViewportFilterBranch filterBranch = kVpBrAll,
                                 ViewportFilterMode filterMode = kVpFilterVisible, OdUInt32 filterParam = 0);
};
 
typedef OdSmartPtr<OdGsPaperLayoutHelper> OdGsPaperLayoutHelperPtr;
 
class TOOLKIT_EXPORT OdGsModelLayoutHelper : public OdGsLayoutHelper
{
public:
  ODRX_DECLARE_MEMBERS(OdGsModelLayoutHelper);
};
 
typedef OdSmartPtr<OdGsModelLayoutHelper> OdGsModelLayoutHelperPtr;
 
 
namespace OdDbGsManager
{
  TOOLKIT_EXPORT OdGsLayoutHelperPtr setupActiveLayoutViews(OdGsDevice* pDevice,
    OdGiContextForDbDatabase* pGiCtx);
 
  TOOLKIT_EXPORT OdGsLayoutHelperPtr setupLayoutViews(OdDbObjectId layoutId, OdGsDevice* pDevice, 
    OdGiContextForDbDatabase* pGiCtx);
 
  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_