AbstractViewPE.h

Go to the documentation of this file.

// Copyright (C) 2002-2024, 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-2024 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_ABSTRACTVIEWPE_H
#define OD_ABSTRACTVIEWPE_H
 
#include "DbRootExport.h"
#include "Ge/GePoint3d.h"
#include "Ge/GeVector2d.h"
#include "Ge/GeVector3d.h"
#include "ViewportDefs.h"
#include "DbStubPtrArray.h"
#include "Gi/GiViewportTraits.h"
 
class OdGeBoundBlock3d;
 
typedef OdRxObject OdDbBaseDatabase;
 
#include "TD_PackPush.h"

class DBROOT_EXPORT OdAbstractViewPE : public OdRxObject
{
public:
  ODRX_DECLARE_MEMBERS(OdAbstractViewPE);
 
  // Viewport methods:

  virtual OdGePoint2d lowerLeftCorner(const OdRxObject* pViewport) const;
  virtual OdGePoint2d upperRightCorner(const OdRxObject* pViewport) const;
  virtual void setViewport(OdRxObject* pViewport, const OdGePoint2d& lowerLeft, const OdGePoint2d& upperRight) const;
  virtual bool hasViewport(const OdRxObject* pViewport) const;
 
  // View methods:

  virtual OdGePoint3d target(const OdRxObject* pViewport) const = 0;
  
  virtual OdGeVector3d direction(const OdRxObject* pViewport) const = 0;

  virtual OdGeVector3d upVector (const OdRxObject* pViewport) const = 0;
  virtual double fieldWidth(const OdRxObject* pViewport) const = 0;
  virtual double fieldHeight(const OdRxObject* pViewport) const = 0;

  virtual bool isPerspective(const OdRxObject* pViewport) const = 0;
  
  virtual OdGeVector2d viewOffset(const OdRxObject* pViewport) const;
  virtual bool hasViewOffset(const OdRxObject* pViewport) const;

  virtual double viewTwist(const OdRxObject* pViewport) const = 0;

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

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

  virtual bool isFrontClipOn(const OdRxObject* pViewport) const = 0;

  virtual void setFrontClipOn(OdRxObject* pViewport, bool frontClip) const = 0;

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

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

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

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

  virtual void setRenderMode(OdRxObject* pViewport, OdDb::RenderMode renderMode) const = 0;

  virtual OdDb::RenderMode renderMode(const OdRxObject* pViewport) const = 0;

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

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

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

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

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

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

  virtual void setView(OdRxObject* pDestinationView, const OdRxObject* pSourceView) const;
 
  // UCS methods:

  virtual bool hasUcs(const OdRxObject* pViewport) const;

  virtual OdDb::OrthographicView orthoUcs(const OdRxObject* pViewport, const OdDbBaseDatabase* pDb = 0) const;

  virtual bool setUcs(OdRxObject* pViewport, OdDb::OrthographicView orthoUcs, const OdDbBaseDatabase* pDb = 0) const;
  
  virtual OdDbStub* ucsName(const OdRxObject* pViewport) const;

  virtual bool setUcs(OdRxObject* pViewport, OdDbStub* ucsId) const;

  virtual void getUcs(const OdRxObject* pViewport, OdGePoint3d& origin, OdGeVector3d& xAxis, OdGeVector3d& yAxis) const;

  virtual void setUcs(OdRxObject* pViewport, const OdGePoint3d& origin, const OdGeVector3d& xAxis, const OdGeVector3d& yAxis) const;

  virtual double elevation(const OdRxObject* pViewport) const;

  virtual void setElevation(OdRxObject* pViewport, double elevation) const;
  virtual void setUcs(OdRxObject* pDestinationView, const OdRxObject* pSourceView) const;
 
  // Util methods:

  virtual bool viewExtents(
    const OdRxObject* pViewport,
    OdGeBoundBlock3d& extents) const = 0;

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

  virtual bool zoomExtents(
    OdRxObject* pViewport,
    const OdGeBoundBlock3d* pExtents = 0,
    double extCoef = 1.02) const;

  virtual OdGeMatrix3d worldToEye(const OdRxObject* pViewport) const;
  virtual OdGeMatrix3d eyeToWorld(const OdRxObject* pViewport) const;

  virtual bool isPlotting(const OdRxObject* pViewport) const;
  virtual OdRxObjectPtr plotDataObject(const OdRxObject* pViewport, bool bOpenForWrite = false) const;
  virtual bool applyPlotSettings(OdRxObject* pDestinationView, const OdRxObject* pSourceView) const;

  virtual OdDbStub *annotationScale(const OdRxObject* pViewport) const;

  virtual OdDbStub* compatibleCopyObject(const OdRxObject* pViewport, OdDbStub* pCopyObject) const;
};

typedef OdSmartPtr<OdAbstractViewPE> OdAbstractViewPEPtr;
 
#include "TD_PackPop.h"
 
#endif // OD_ABSTRACTVIEWPE_H