/////////////////////////////////////////////////////////////////////////////// 
// Copyright (C) 2002-2016, 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-2016 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_ABSTRACTVIEWPORTDATAFORDBVIEWPORT_
#define _OD_DB_ABSTRACTVIEWPORTDATAFORDBVIEWPORT_

#include "TD_PackPush.h"

#include "DbAbstractViewportData.h"

/** \details
    This class is the Protocol Extension class for OdDbViewport objects.
    Library: TD_Db
    <group OdDb_Classes>
*/
class TOOLKIT_EXPORT OdDbAbstractViewportDataForDbViewport : public OdDbAbstractViewportData
{
public:
  ODRX_DECLARE_MEMBERS(OdDbAbstractViewportDataForDbViewport);

  void setView(
      OdRxObject* pViewport,
      const OdGePoint3d& target,
      const OdGeVector3d& direction,
      const OdGeVector3d& upVector,
      double fieldWidth,
      double fieldHeight,
      bool perspective,
      const OdGeVector2d& viewOffset = OdGeVector2d::kIdentity) const;

  OdGePoint3d  target  (const OdRxObject* pViewport) const;
  OdGeVector3d direction(const OdRxObject* pViewport) const;
  OdGeVector3d upVector(const OdRxObject* pViewport) const;

  double fieldWidth(const OdRxObject* pViewport) const;
  double fieldHeight(const OdRxObject* pViewport) const;

  OdGeVector2d viewOffset(const OdRxObject* pViewport) const;

  double viewTwist(const OdRxObject* pViewport) const;

  bool isPerspective(const OdRxObject* pViewport) const;

  void setLensLength(OdRxObject* pViewport, double lensLength) const;
  double lensLength(const OdRxObject* pViewport) const;

  bool isFrontClipOn(const OdRxObject* pViewport) const;
  void setFrontClipOn(OdRxObject* pViewport, bool frontClip) const;

  bool isBackClipOn(const OdRxObject* pViewport) const;
  void setBackClipOn(OdRxObject* pViewport, bool backClip) const;

  bool isFrontClipAtEyeOn(const OdRxObject* pViewport) const;
  void setFrontClipAtEyeOn(OdRxObject* pViewport, bool frontClipAtEye) const;

  double frontClipDistance(const OdRxObject* pViewport) const;
  void setFrontClipDistance(OdRxObject* pViewport, double frontClipDistance) const;

  double backClipDistance(const OdRxObject* pViewport) const;
  void setBackClipDistance(OdRxObject* pViewport, double backClipDistance) const;

  void setRenderMode(OdRxObject* pViewport, OdDb::RenderMode mode) const;
  OdDb::RenderMode renderMode(const OdRxObject* pViewport) const;

  void setVisualStyle(OdRxObject* pViewport, OdDbStub* visualStyleId) const;
  OdDbStub* visualStyle(const OdRxObject* pViewport) const;

  void setBackground(OdRxObject* pViewport, OdDbStub* backgroundId) const;
  OdDbStub* background(const OdRxObject* pViewport) const;

  void frozenLayers(const OdRxObject* pViewport, OdDbStubPtrArray& frozenLayers) const;
  void setFrozenLayers(OdRxObject* pViewport, const OdDbStubPtrArray& frozenLayers) const;

  bool hasUcs(const OdRxObject* pViewport) const;
  void getUcs(const OdRxObject* pViewport, OdGePoint3d& origin, OdGeVector3d& xAxis, OdGeVector3d& yAxis) const;
  OdDb::OrthographicView orthoUcs(const OdRxObject* pViewport, const OdDbBaseDatabase* pDb = 0) const;
  OdDbStub* ucsName(const OdRxObject* pViewport) const;
  double elevation(const OdRxObject* pViewport) const;
  void setUcs(OdRxObject* pViewport, const OdGePoint3d& origin, const OdGeVector3d& xAxis, const OdGeVector3d& yAxis) const;
  bool setUcs(OdRxObject* pViewport, OdDb::OrthographicView orthoUcs, const OdDbBaseDatabase* pDb = 0) const;
  bool setUcs(OdRxObject* pViewport, OdDbStub* ucsId) const;
  void setUcsToWorld(OdRxObject* pViewport) const;
  void setElevation(OdRxObject* pViewport, double elevation) const;

  bool viewExtents(const OdRxObject* pViewport, OdGeBoundBlock3d& extents) const;
  bool plotExtents(const OdRxObject* pViewport, OdGeBoundBlock3d& extents, bool bExtendOnly = false,
                   bool bExtentsValid = true, const OdGeMatrix3d *pWorldToEye = NULL) const;

  OdRxObjectPtr plotDataObject(const OdRxObject* pViewport, bool bOpenForWrite = false) const;

  OdDbStub *annotationScale(const OdRxObject* pViewport) const;

  // OdDbAbstractViewportData

  bool isUcsSavedWithViewport(const OdRxObject* pViewport) const;
  void setUcsPerViewport( OdRxObject* pViewport, bool ucsPerViewport) const;

  bool isUcsFollowModeOn(const OdRxObject* pViewport) const;
  void setUcsFollowModeOn(OdRxObject* pViewport, bool ucsFollowMode) const;

  OdUInt16 circleSides(const OdRxObject* pViewport) const;
  void setCircleSides(OdRxObject* pViewport, OdUInt16 circleSides) const;

  bool isGridOn(const OdRxObject* pViewport) const;
  void setGridOn(OdRxObject* pViewport, bool gridOn) const;

  OdGeVector2d gridIncrement(const OdRxObject* pViewport) const;
  void setGridIncrement(OdRxObject* pViewport, const OdGeVector2d& gridIncrement) const;

  bool isGridBoundToLimits(const OdRxObject* pViewport) const;
  void setGridBoundToLimits(OdRxObject* pViewport, bool gridDispFlag) const;

  bool isGridAdaptive(const OdRxObject* pViewport) const;
  void setGridAdaptive(OdRxObject* pViewport, bool gridDispFlag) const;

  bool isGridSubdivisionRestricted(const OdRxObject* pViewport) const;
  void setGridSubdivisionRestricted(OdRxObject* pViewport, bool gridDispFlag) const;

  bool isGridFollow(const OdRxObject* pViewport) const;
  void setGridFollow(OdRxObject* pViewport, bool gridDispFlag) const;

  OdInt16 gridMajor(const OdRxObject* pViewport) const;
  void setGridMajor(OdRxObject* pViewport, OdInt16 nMajor) const;

  bool isUcsIconVisible(const OdRxObject* pViewport) const;
  void setUcsIconVisible(OdRxObject* pViewport, bool bVisible) const;

  bool isUcsIconAtOrigin(const OdRxObject* pViewport) const;
  void setUcsIconAtOrigin(OdRxObject* pViewport, bool bAtOrigin) const;

  bool isSnapOn(const OdRxObject* pViewport) const;
  void setSnapOn(OdRxObject* pViewport, bool iconVisible) const;

  bool isSnapIsometric(const OdRxObject* pViewport) const;
  void setSnapIsometric(OdRxObject* pViewport, bool snapIsometric) const;

  double snapAngle(const OdRxObject* pViewport) const;
  void setSnapAngle(OdRxObject* pViewport, double snapAngle) const;

  OdGePoint2d snapBase(const OdRxObject* pViewport) const;
  void setSnapBase(OdRxObject* pViewport, const OdGePoint2d& snapBase) const; 

  OdGeVector2d snapIncrement(const OdRxObject* pViewport) const;
  void setSnapIncrement(OdRxObject* pViewport, const OdGeVector2d&) const;

  OdUInt16 snapIsoPair(const OdRxObject* pViewport) const;
  void setSnapIsoPair(OdRxObject* pViewport, OdUInt16 snapIsoPair) const;

  bool isDefaultLightingOn(const OdRxObject* pViewport) const;
  void setDefaultLightingOn(OdRxObject* pViewport, bool isOn) const;

  OdGiViewportTraits::DefaultLightingType defaultLightingType(const OdRxObject* pViewport) const;
  void setDefaultLightingType(OdRxObject* pViewport, OdGiViewportTraits::DefaultLightingType lightingType) const;

  double brightness(const OdRxObject* pViewport) const;
  void setBrightness(OdRxObject* pViewport, double brightness) const;

  double contrast(const OdRxObject* pViewport) const;
  void setContrast(OdRxObject* pViewport, double contrast) const;

  OdCmColor ambientLightColor(const OdRxObject* pViewport) const;
  void setAmbientLightColor(OdRxObject* pViewport, const OdCmColor& color) const;

  OdDbStub *sunId(const OdRxObject* pViewport) const;
  OdDbStub *setSun(OdRxObject* pViewport, OdRxObject* pSun) const;

  void toneOperatorParameters(const OdRxObject* pViewport, OdGiToneOperatorParameters &params) const;
  void setToneOperatorParameters(OdRxObject* pViewport, const OdGiToneOperatorParameters &params) const;

  OdGsView* gsView(const OdRxObject* pViewport) const;
  void setGsView(OdRxObject* pViewport, OdGsView* pGsView) const;

  TD_USING(OdDbAbstractViewportData::setView);
  TD_USING(OdDbAbstractViewportData::setUcs);
};

#include "TD_PackPop.h"

#endif