DbViewport.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_DB_VIEWPORT_
#define _OD_DB_VIEWPORT_
 
#include "TD_PackPush.h"
 
#include "DbEntity.h"
#include "DbSymbolTable.h"
#include "ViewportDefs.h"
#include "DbXrefObjectId.h"
 
#include "Gi/GiViewportTraits.h"
 
class OdGeExtents3d;
class OdGeMatrix3d;
class OdGsView;
class OdDbSun;
 
class TOOLKIT_EXPORT OdDbViewport : public OdDbEntity
{
protected:
  /* void dxfOutXData(OdDbDxfFiler* pFiler) const;
  */
public:
  ODDB_DECLARE_MEMBERS(OdDbViewport);
 
  OdDbViewport();
 
  double height() const;
 
  void setHeight(
    double height);
 
  double width() const;
 
  void setWidth(
    double width);
 
  OdGePoint3d centerPoint() const;
 
  void setCenterPoint(
    const OdGePoint3d& centerPoint);
 
  OdInt16 number() const;
 
  bool isOn() const;
 
  void setOn();
 
  void setOff();
 
  OdGePoint3d viewTarget() const;
 
  void setViewTarget(
    const OdGePoint3d& viewTarget);
 
  OdGeVector3d viewDirection() const;
 
  void setViewDirection(
    const OdGeVector3d& viewDirection);
 
  double viewHeight() const;
 
  void setViewHeight(
    double viewHeight);
 
  OdGePoint2d viewCenter() const;
 
  void setViewCenter(
    const OdGePoint2d& viewCenter);
 
  double twistAngle() const;
 
  void setTwistAngle(
    double twistAngle);
 
  double lensLength() const;
 
  void setLensLength(
    double lensLength);
 
  bool isFrontClipOn() const;
 
  void setFrontClipOn();
 
  void setFrontClipOff();
 
  bool isBackClipOn() const;
 
  void setBackClipOn();
 
  void setBackClipOff();
 
  bool isFrontClipAtEyeOn() const;
 
  void setFrontClipAtEyeOn();
 
  void setFrontClipAtEyeOff();
 
  double frontClipDistance() const;
 
  void setFrontClipDistance(
    double frontClipDistance);
 
  double backClipDistance() const;
 
  void setBackClipDistance(
    double backClipDistance);
 
  bool isPerspectiveOn() const;
 
  void setPerspectiveOn();
 
  void setPerspectiveOff();
 
  bool isUcsFollowModeOn() const;
 
  void setUcsFollowModeOn();
 
  void setUcsFollowModeOff();
 
  bool isUcsIconVisible() const;
 
  void setUcsIconVisible();
 
  void setUcsIconInvisible();
 
  bool isUcsIconAtOrigin() const;
 
  void setUcsIconAtOrigin();
 
  void setUcsIconAtCorner();
 
  bool isFastZoomOn() const;
 
  void setFastZoomOn();
 
  void setFastZoomOff();
 
  OdUInt16 circleSides() const;
 
  void setCircleSides(
    OdUInt16 circleSides);
 
  bool isSnapOn() const;
 
  void setSnapOn();
 
  void setSnapOff();
 
  bool isSnapIsometric() const;
 
  void setSnapIsometric();
 
  void setSnapStandard();
 
  double snapAngle() const;
 
  void setSnapAngle(
    double snapAngle);
 
  OdGePoint2d snapBasePoint() const;
 
  void setSnapBasePoint(
    const OdGePoint2d& snapBasePoint); 
  
  OdGeVector2d snapIncrement() const;
 
  void setSnapIncrement(
    const OdGeVector2d& snapIncrement);
  
  OdUInt16 snapIsoPair() const;
 
  void setSnapIsoPair(
    OdUInt16 snapIsoPair);
  
  bool isGridOn() const;
 
  void setGridOn();
 
  void setGridOff();
  
  OdGeVector2d gridIncrement() const;
 
  void setGridIncrement(
    const OdGeVector2d& gridIncrement);
  
  bool hiddenLinesRemoved() const;
 
  void showHiddenLines();
 
  void removeHiddenLines();
  
  void freezeLayersInViewport(
    const OdDbObjectIdArray& layerIds);
 
  void thawLayersInViewport(
    const OdDbObjectIdArray& layerIds);
 
  void thawAllLayersInViewport();
 
  bool isLayerFrozenInViewport(
    const OdDbObjectId& layerId) const;
 
  void getFrozenLayerList(
    OdDbObjectIdArray& layerIds) const;
  
  void updateDisplay() const;
  
  
  virtual OdUInt32 subSetAttributes(
    OdGiDrawableTraits* pTraits) const;
 
  virtual bool subWorldDraw(
    OdGiWorldDraw* pWd) const;
  
  bool isLocked() const;
 
  void setLocked();
 
  void setUnlocked();
  
  bool isTransparent() const;
 
  void setTransparent();
 
  void setOpaque();
  
  enum StandardScaleType
  {
    kScaleToFit,    // Scaled to Fit
    kCustomScale,   // Scale is not a standard scale
    k1_1,           // 1:1
    k1_2,           // 1:2
    k1_4,           // 1:4
    k1_5,           // 1:5
    k1_8,           // 1:8
    k1_10,          // 1:10
    k1_16,          // 1:16
    k1_20,          // 1:20
    k1_30,          // 1:30
    k1_40,          // 1:40
    k1_50,          // 1:50
    k1_100,         // 1:100
    k2_1,           // 2:1
    k4_1,           // 4:1
    k8_1,           // 8:1
    k10_1,          // 10:1
    k100_1,         // 100:1
    k1_128in_1ft,   // 1/128"= 1'
    k1_64in_1ft,    // 1/64"= 1'
    k1_32in_1ft,    // 1/32"= 1'
    k1_16in_1ft,    // 1/16"= 1'
    k3_32in_1ft,    // 3/32"= 1'
    k1_8in_1ft,     // 1/8" = 1'
    k3_16in_1ft,    // 3/16"= 1'
    k1_4in_1ft,     // 1/4" = 1'
    k3_8in_1ft,     // 3/8" = 1'
    k1_2in_1ft,     // 1/2" = 1'
    k3_4in_1ft,     // 3/4" = 1'
    k1in_1ft,       // 1" = 1'
    k1and1_2in_1ft, // 1 1/2"= 1'
    k3in_1ft,       // 3" = 1'
    k6in_1ft,       // 6" = 1'
    k1ft_1ft        // 1' = 1'
  };
  
  enum ShadePlotType
  {
      kAsDisplayed  = 0,     // As displayed
      kWireframe    = 1,     // Wireframe
      kHidden       = 2,     // Hidden
      kRendered     = 3,     // Rendered
      kVisualStyle  = 4,     // Visual style
      kRenderPreset = 5      // Render preset
  };
 
  double customScale() const;
 
  void setCustomScale(
    double customScale);
  
  StandardScaleType standardScale() const;
 
  void setStandardScale(
    const StandardScaleType standardScale);
  
  OdString plotStyleSheet() const;
 
  OdString effectivePlotStyleSheet() const;
 
  void setPlotStyleSheet(
    const OdString& plotStyleSheetName);
  
  bool isNonRectClipOn() const;
 
  void setNonRectClipOn();
 
  void setNonRectClipOff();
  
  OdDbObjectId nonRectClipEntityId() const;
 
  void setNonRectClipEntityId(
    OdDbObjectId clipEntityId);
  
  /*
     virtual void erased(const OdDbObject* , bool);
     virtual void modified(const OdDbObject *);
     virtual void copied(const OdDbObject* pDbObj,const OdDbObject* pNewObj);
     virtual void subObjModified(const OdDbObject* pDbObj, const OdDbObject* pSubObj);
  */
  
  void getUcs(OdGePoint3d& origin, 
    OdGeVector3d& xAxis, 
    OdGeVector3d& yAxis) const;
 
  bool isUcsOrthographic(
    OdDb::OrthographicView& viewType,
    const OdDbDatabase* pDb = 0) const;
 
  OdDbObjectId ucsName() const;
 
  double elevation() const;
  
  void setUcs(
    const OdGePoint3d& origin, 
    const OdGeVector3d& xAxis, 
    const OdGeVector3d& yAxis);
 
  void setUcs(
    OdDb::OrthographicView viewType, const OdDbDatabase* pDb = 0);
 
  void setUcs(
    const OdDbObjectId& ucsId);
 
  void setUcsToWorld();
 
  void setElevation(
    double elevation);
  
  /*
  bool isViewOrthographic(OdDb::OrthographicView& view) const;
 
  void setViewDirection(OdDb::OrthographicView view);
  */
  
  bool isUcsSavedWithViewport() const;
 
  void setUcsPerViewport(
    bool ucsPerViewport);
  
  void setRenderMode(
    OdDb::RenderMode renderMode);
 
  OdDb::RenderMode renderMode() const;
 
  ShadePlotType shadePlot() const;
 
  void setShadePlot(
    const ShadePlotType shadePlot);
 
  // New in R21 functions
 
  OdDbObjectId shadePlotId() const;
  
  void         setShadePlot(const ShadePlotType type, const OdDbObjectId& shadePlotId);
 
  bool         plotWireframe() const;
  bool         plotAsRaster() const;
 
  OdDbObjectId background() const;
  void         setBackground(const OdDbObjectId& backgroundId);
 
  // Visual Styles
 
  OdDbObjectId visualStyle() const;
  void         setVisualStyle(const OdDbObjectId& visualStyle);
 
  // Viewport Lighting
 
  bool                isDefaultLightingOn() const;
  void                setDefaultLightingOn(bool on);
  OdGiViewportTraits::DefaultLightingType defaultLightingType() const;
  void                setDefaultLightingType(OdGiViewportTraits::DefaultLightingType typ);
 
  // Brightness controls the relative intensity of lights.
 
  double              brightness() const;
  void                setBrightness(double);
 
  // Contrast controls intensity of ambient light, relative to other lights.
 
  double              contrast() const;
  void                setContrast(double);
 
  OdCmColor           ambientLightColor() const;
  void                setAmbientLightColor(const OdCmColor& clr);
 
  // A single sun (distant light) can be associated with each viewport.
 
  OdDbObjectId        sunId() const;
  OdDbObjectId        setSun(OdDbSun* pSun);
 
  void toneOperatorParameters(OdGiToneOperatorParameters &params) const;
  void setToneOperatorParameters(const OdGiToneOperatorParameters &params);
 
  OdResult setAnnotationScale(const OdDbAnnotationScale* pScaleObj);
  OdDbAnnotationScalePtr annotationScale() const;
  
  bool isGridBoundToLimits() const;
  void setGridBoundToLimits(bool bNewVal);
 
  bool isGridAdaptive() const;
  void setGridAdaptive(bool bNewVal);
 
  bool isGridSubdivisionRestricted() const;
  void setGridSubdivisionRestricted(bool bNewVal);
 
  bool isGridFollow() const;
  void setGridFollow(bool bNewVal);
 
  OdUInt16 gridMajor() const;
  void setGridMajor(OdUInt16);
 
  // View association methods
 
  void setModelView(const OdDbXrefObjectId &objId);
  OdDbXrefObjectId getModelView() const;
  void removeModelView();
  OdResult syncModelView();
 
  void setSheetView(const OdDbObjectId &objId);
  OdDbObjectId getSheetView() const;
  void removeSheetView();
 
  void setLabelBlock(const OdDbObjectId objId);
  OdDbObjectId getLabelBlock() const;
  void removeLabelBlock();
 
  // OdGsView association methods
 
  OdGsView* gsView() const;
  void setGsView(OdGsView*);
 
  // OdDbEntity overrides
 
  virtual void subSetDatabaseDefaults(
    OdDbDatabase* pDb, 
    bool doSubents);
 
  virtual OdResult dwgInFields(
    OdDbDwgFiler* pFiler);
 
  virtual void dwgOutFields(
    OdDbDwgFiler* pFiler) const;
 
  virtual OdResult dxfInFields(
    OdDbDxfFiler* pFiler);
 
  virtual void dxfOutFields(
    OdDbDxfFiler* pFiler) const;
 
  virtual OdResult dxfInFields_R12(
    OdDbDxfFiler* pFiler);
 
  virtual void dxfOutFields_R12(
    OdDbDxfFiler* pFiler) const;
 
  virtual OdResult subGetClassID(
    void* pClsid) const;
 
  void subClose();
 
  OdResult subErase(
    bool erasing);
 
  void zoomExtents();
 
  virtual OdResult subGetGeomExtents(
    OdGeExtents3d& extents) const;
 
  virtual OdResult subTransformBy(
  const OdGeMatrix3d& xfm) ODRX_OVERRIDE;
 
  void modified(const OdDbObject* pObj);
 
  void erased(const OdDbObject* pObj, bool pErasing);
 
  virtual OdResult subGetTransformedCopy(const OdGeMatrix3d& mat, OdDbEntityPtr& pCopy) const;
 
  virtual OdResult explodeGeometry(OdRxObjectPtrArray& entitySet) const;
};
 
typedef OdSmartPtr<OdDbViewport> OdDbViewportPtr;
 
#include "TD_PackPop.h"
 
#endif