DbAbstractViewportData.h

Go to the documentation of this file.

// Copyright (C) 2002-2017, 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 Teigha(R) software pursuant to a license 
//   agreement with Open Design Alliance.
//   Teigha(R) Copyright (C) 2002-2017 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_DBABSTRACTVIEWPORTDATA_H
#define OD_DBABSTRACTVIEWPORTDATA_H
 
#include "AbstractViewPE.h"
 
class OdGsView;
 
class TOOLKIT_EXPORT OdDbAbstractViewportData : public OdAbstractViewPE
{
public:
  ODRX_DECLARE_MEMBERS(OdDbAbstractViewportData);
 
  virtual void setProps(OdRxObject* pViewport, const OdRxObject* pSourceView) const;
 
  // OdAbstractViewPE-inherited methods
 
  TD_USING(OdAbstractViewPE::setUcs);
  virtual void setUcs(OdRxObject* pDestinationView, const OdRxObject* pSourceView) const;
  virtual bool hasViewOffset(const OdRxObject* pViewport) const;
  virtual bool applyPlotSettings(OdRxObject* pDestinationView, const OdRxObject* pSourceView) const;
 
  virtual OdDbStub* compatibleCopyObject(const OdRxObject* pViewport, OdDbStub* pCopyObject) const;
 
  //
 
  virtual bool isUcsSavedWithViewport(const OdRxObject* pViewport) const = 0;
 
  virtual void setUcsPerViewport( OdRxObject* pViewport, bool ucsPerViewport) const = 0;
 
  virtual bool isUcsFollowModeOn(const OdRxObject* pViewport) const = 0;
 
  virtual void setUcsFollowModeOn(OdRxObject* pViewport, bool ucsFollowMode) const = 0;
 
  virtual OdUInt16 circleSides(const OdRxObject* pViewport) const = 0;
  virtual void setCircleSides(OdRxObject* pViewport, OdUInt16 circleSides) const = 0;
 
  virtual bool isGridOn(const OdRxObject* pViewport) const = 0;
  virtual void setGridOn(OdRxObject* pViewport, bool gridOn) const = 0;
 
  virtual OdGeVector2d gridIncrement(const OdRxObject* pViewport) const = 0;
  virtual void setGridIncrement(OdRxObject* pViewport, const OdGeVector2d& gridIncrement) const = 0;
 
  virtual bool isGridBoundToLimits(const OdRxObject* pViewport) const = 0;
  virtual void setGridBoundToLimits(OdRxObject* pViewport, bool gridDispFlag) const = 0;
 
  virtual bool isGridAdaptive(const OdRxObject* pViewport) const = 0;
  virtual void setGridAdaptive(OdRxObject* pViewport, bool gridDispFlag) const = 0;
 
  virtual bool isGridSubdivisionRestricted(const OdRxObject* pViewport) const = 0;
  virtual void setGridSubdivisionRestricted(OdRxObject* pViewport, bool gridDispFlag) const = 0;
 
  virtual bool isGridFollow(const OdRxObject* pViewport) const = 0;
  virtual void setGridFollow(OdRxObject* pViewport, bool gridDispFlag) const = 0;
 
  virtual OdInt16 gridMajor(const OdRxObject* pViewport) const = 0;
  virtual void setGridMajor(OdRxObject* pViewport, OdInt16 nMajor) const = 0;
 
  virtual bool isUcsIconVisible(const OdRxObject* pViewport) const = 0;
  virtual void setUcsIconVisible(OdRxObject* pViewport, bool iconVisible) const = 0;
 
  virtual bool isUcsIconAtOrigin(const OdRxObject* pViewport) const = 0;
  virtual void setUcsIconAtOrigin(OdRxObject* pViewport, bool atOrigin) const = 0;
 
  virtual bool isSnapOn(const OdRxObject* pViewport) const = 0;
  virtual void setSnapOn(OdRxObject* pViewport, bool snapOn) const = 0;
 
  virtual bool isSnapIsometric(const OdRxObject* pViewport) const = 0;
  virtual void setSnapIsometric(OdRxObject* pViewport, bool snapIsometric) const = 0;
 
  virtual double snapAngle(const OdRxObject* pViewport) const = 0;
  virtual void setSnapAngle(OdRxObject* pViewport, double snapAngle) const = 0;
 
  virtual OdGePoint2d snapBase(const OdRxObject* pViewport) const = 0;
  virtual void setSnapBase(OdRxObject* pViewport, const OdGePoint2d& snapBase) const = 0; 
 
  virtual OdGeVector2d snapIncrement(const OdRxObject* pViewport) const = 0;
  virtual void setSnapIncrement(OdRxObject* pViewport, const OdGeVector2d& snapIncrement) const = 0;
 
  virtual OdUInt16 snapIsoPair(const OdRxObject* pViewport) const = 0;
  virtual void setSnapIsoPair(OdRxObject* pViewport, OdUInt16 snapIsoPair) const = 0;
 
  virtual double brightness(const OdRxObject* pViewport) const = 0;
  virtual void setBrightness(OdRxObject* pViewport, double brightness) const = 0;
 
  virtual double contrast(const OdRxObject* pViewport) const = 0;
  virtual void setContrast(OdRxObject* pViewport, double contrast) const = 0;
 
  virtual OdCmColor ambientLightColor(const OdRxObject* pViewport) const = 0;
  virtual void setAmbientLightColor(OdRxObject* pViewport, const OdCmColor& color) const = 0;
 
  virtual OdDbStub *sunId(const OdRxObject* pViewport) const = 0;
  virtual OdDbStub *setSun(OdRxObject* pViewport, OdRxObject* pSun) const = 0;
 
  virtual void toneOperatorParameters(const OdRxObject* pViewport, OdGiToneOperatorParameters &params) const = 0;
  virtual void setToneOperatorParameters(OdRxObject* pViewport, const OdGiToneOperatorParameters &params) const = 0;
 
  virtual OdGsView* gsView(const OdRxObject* pViewport) const = 0;
  
  virtual void setGsView(OdRxObject* pViewport, OdGsView* pGsView) const = 0;
 
  virtual int navvcubedisplay(const OdRxObject* pViewport) const;
  virtual OdResult setNavvcubedisplay(OdRxObject* pViewport, int nVal) const;
 
  TD_USING(OdAbstractViewPE::setView);
  virtual void setView(OdRxObject* pDestinationView, const OdRxObject* pSourceView) const;
};
 
typedef OdSmartPtr<OdDbAbstractViewportData> OdDbAbstractViewportDataPtr;
 
 
/* { Secret } */
class SavePeWriteEnabler
{
  OdDbObjectPtr m_pObj;
public:
  SavePeWriteEnabler(OdRxObject* pRxObj)
  {
    if ((m_pObj = OdDbObject::cast(pRxObj)).isNull())
      return;
    if (m_pObj->isWriteEnabled())
      m_pObj = NULL;
    else
      m_pObj->upgradeOpen(); // standard way for set method impl of PE
  }
  ~SavePeWriteEnabler()
  {
    if (m_pObj.get())
      m_pObj->downgradeOpen();
  }
};
 
#endif //#ifndef OD_DBABSTRACTVIEWPORTDATA_H