AcDbViewport.h

Go to the documentation of this file.

#pragma once
 
//
// (C) Copyright 2005-2024 by Graebert GmbH.
//
// Permission to use, copy, modify, and distribute this software in
// object code form for any purpose and without fee is hereby granted,
// provided that the above copyright notice appears in all copies and
// that both that copyright notice and the limited warranty and
// restricted rights notice below appear in all supporting
// documentation.
//
// GRAEBERT PROVIDES THIS PROGRAM "AS IS" AND WITH ALL FAULTS.
// GRAEBERT SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTY OF
// MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE.  GRAEBERT GMBH
// DOES NOT WARRANT THAT THE OPERATION OF THE PROGRAM WILL BE
// UNINTERRUPTED OR ERROR FREE.
 
#include "..\acdb17\AcDbEntity.h"
#include "..\acdb17\AcDb.h"
#include "..\acdb17\AcDbAbstractViewTableRecord.h"
#include "..\acdb17\AcGiDrawable.h"
#include "..\acdb17\AcGiViewportTraits.h"
#include "..\acad\Acad.h"
 
template < typename Param1 > class AcArrayMemCopyReallocator;
class AcCmColor;
class AcDbAnnotationScale;
class AcDbObject;
class AcDbObjectId;
class AcDbSystemInternals;
class AcDbXrefObjectId;
class AcGePoint2d;
class AcGePoint3d;
class AcGeVector2d;
class AcGeVector3d;
class AcGiDrawableTraits;
class AcGiToneOperatorParameters;
class AcGiWorldDraw;
class AcRxClass;
 
class ARX_API AcDbViewport : public AcDbEntity
{
public:
        enum ShadePlotType
        {
                kAsDisplayed = 0,
                kWireframe = 1,
                kHidden = 2,
                kRendered = 3
        };
        enum StandardScaleType
        {
                kScaleToFit,
                kCustomScale,
                k1_1,
                k1_2,
                k1_4,
                k1_8,
                k1_10,
                k1_16,
                k1_20,
                k1_30,
                k1_40,
                k1_50,
                k1_100,
                k2_1,
                k4_1,
                k8_1,
                k10_1,
                k100_1,
                k1_128in_1ft,
                k1_64in_1ft,
                k1_32in_1ft,
                k1_16in_1ft,
                k3_32in_1ft,
                k1_8in_1ft,
                k3_16in_1ft,
                k1_4in_1ft,
                k3_8in_1ft,
                k1_2in_1ft,
                k3_4in_1ft,
                k1in_1ft,
                k3in_1ft,
                k6in_1ft,
                k1ft_1ft
        };
public:
    ACRX_DECLARE_MEMBERS(AcDbViewport)
          AcDbViewport(void);
         bool  hiddenLinesRemoved(void)const ;
         bool  isBackClipOn(void)const ;
         bool  isDefaultLightingOn(void)const ;
         bool  isFrontClipAtEyeOn(void)const ;
         bool  isFrontClipOn(void)const ;
         bool  isGridAdaptive(void)const ;
         bool  isGridBoundToLimits(void)const ;
         bool  isGridFollow(void)const ;
         bool  isGridOn(void)const ;
         bool  isGridSubdivisionRestricted(void)const ;
         bool  isLayerFrozenInViewport( AcDbObjectId const &)const ;
         bool  isLocked(void)const ;
         bool  isNonRectClipOn(void)const ;
         bool  isOn(void)const ;
         bool  isPerspectiveOn(void)const ;
         bool  isSnapIsometric(void)const ;
         bool  isSnapOn(void)const ;
         bool  isTransparent(void)const ;
         bool  isUcsFollowModeOn(void)const ;
         bool  isUcsIconAtOrigin(void)const ;
         bool  isUcsIconVisible(void)const ;
         bool  isUcsOrthographic( AcDb::OrthographicView &)const ;
         bool  isUcsSavedWithViewport(void)const ;
         bool  isViewOrthographic( AcDb::OrthographicView &)const ;
         bool  plotAsRaster(void)const ;
         bool  plotWireframe(void)const ;
         bool  previousBackgroundForcedSwitch(void)const ;
          AcCmColor  ambientLightColor(void)const ;
          AcDbAnnotationScale *  annotationScale(void)const ;
          AcDbObjectId  background(void)const ;
          AcDbObjectId  nonRectClipEntityId(void)const ;
          AcDbObjectId  previousBackground( AcGiDrawable::DrawableType)const ;
          AcDbObjectId  shadePlotId(void)const ;
          AcDbObjectId  sunId(void)const ;
          AcDbObjectId  ucsName(void)const ;
          AcDbObjectId  visualStyle(void)const ;
          AcGePoint2d  snapBasePoint(void)const ;
          AcGePoint2d  viewCenter(void)const ;
          AcGePoint3d  centerPoint(void)const ;
          AcGePoint3d  viewTarget(void)const ;
          AcGeVector2d  gridIncrement(void)const ;
          AcGeVector2d  snapIncrement(void)const ;
          AcGeVector3d  viewDirection(void)const ;
         double  backClipDistance(void)const ;
         double  brightness(void)const ;
         double  contrast(void)const ;
         double  customScale(void)const ;
         double  elevation(void)const ;
         double  frontClipDistance(void)const ;
         double  height(void)const ;
         double  lensLength(void)const ;
         double  snapAngle(void)const ;
         double  twistAngle(void)const ;
         double  viewHeight(void)const ;
         double  width(void)const ;
          AcDbAbstractViewTableRecord::RenderMode  renderMode(void)const ;
          ShadePlotType  shadePlot(void)const ;
          StandardScaleType  standardScale(void)const ;
          AcGiViewportTraits::DefaultLightingType  defaultLightingType(void)const ;
          Acad::ErrorStatus  effectivePlotStyleSheet(wchar_t const * &);
          Acad::ErrorStatus  freezeLayersInViewport( AcDbObjectIdArray const &);
          Acad::ErrorStatus  getFrozenLayerList( AcDbObjectIdArray &)const ;
          Acad::ErrorStatus  getLabelBlock( AcDbObjectId &)const ;
          Acad::ErrorStatus  getModelView( AcDbXrefObjectId &)const ;
          Acad::ErrorStatus  getSheetView( AcDbObjectId &)const ;
          Acad::ErrorStatus  getThumbnail( tagBITMAPINFO * &)const ;
          Acad::ErrorStatus  getUcs( AcGePoint3d &, AcGeVector3d &, AcGeVector3d &)const ;
          Acad::ErrorStatus  plotStyleSheet(wchar_t * &)const ;
          Acad::ErrorStatus  plotStyleSheet(wchar_t const * &)const ;
          Acad::ErrorStatus  removeHiddenLines(void);
          Acad::ErrorStatus  removeLabelBlock(void);
          Acad::ErrorStatus  removeModelView(void);
          Acad::ErrorStatus  removeSheetView(void);
          Acad::ErrorStatus  setAmbientLightColor( AcCmColor const &);
          Acad::ErrorStatus  setAnnotationScale( AcDbAnnotationScale const *);
          Acad::ErrorStatus  setBackClipDistance(double);
          Acad::ErrorStatus  setBackClipOff(void);
          Acad::ErrorStatus  setBackClipOn(void);
          Acad::ErrorStatus  setBackground( AcDbObjectId);
          Acad::ErrorStatus  setBrightness(double);
          Acad::ErrorStatus  setCenterPoint( AcGePoint3d const &);
          Acad::ErrorStatus  setCircleSides(unsigned short);
          Acad::ErrorStatus  setContrast(double);
          Acad::ErrorStatus  setCustomScale(double);
          Acad::ErrorStatus  setDefaultLightingOn(bool);
          Acad::ErrorStatus  setDefaultLightingType( AcGiViewportTraits::DefaultLightingType);
          Acad::ErrorStatus  setElevation(double);
          Acad::ErrorStatus  setFrontClipAtEyeOff(void);
          Acad::ErrorStatus  setFrontClipAtEyeOn(void);
          Acad::ErrorStatus  setFrontClipDistance(double);
          Acad::ErrorStatus  setFrontClipOff(void);
          Acad::ErrorStatus  setFrontClipOn(void);
          Acad::ErrorStatus  setGridAdaptive(bool);
          Acad::ErrorStatus  setGridBoundToLimits(bool);
          Acad::ErrorStatus  setGridFollow(bool);
          Acad::ErrorStatus  setGridIncrement( AcGeVector2d const &);
          Acad::ErrorStatus  setGridMajor(unsigned short);
          Acad::ErrorStatus  setGridOff(void);
          Acad::ErrorStatus  setGridOn(void);
          Acad::ErrorStatus  setGridSubdivisionRestricted(bool);
          Acad::ErrorStatus  setHeight(double);
          Acad::ErrorStatus  setLabelBlock( AcDbObjectId);
          Acad::ErrorStatus  setLensLength(double);
          Acad::ErrorStatus  setLocked(void);
          Acad::ErrorStatus  setModelView( AcDbXrefObjectId const &);
          Acad::ErrorStatus  setNonRectClipEntityId( AcDbObjectId);
          Acad::ErrorStatus  setNonRectClipOff(void);
          Acad::ErrorStatus  setNonRectClipOn(void);
          Acad::ErrorStatus  setOff(void);
          Acad::ErrorStatus  setOn(void);
          Acad::ErrorStatus  setOpaque(void);
          Acad::ErrorStatus  setPerspectiveOff(void);
          Acad::ErrorStatus  setPerspectiveOn(void);
          Acad::ErrorStatus  setPlotStyleSheet(wchar_t const *);
          Acad::ErrorStatus  setPreviousBackground( AcDbObjectId, AcGiDrawable::DrawableType);
          Acad::ErrorStatus  setPreviousBackground( AcDbObjectId, AcGiDrawable::DrawableType,bool);
          Acad::ErrorStatus  setShadePlot( ShadePlotType);
          Acad::ErrorStatus  setShadePlot( ShadePlotType, AcDbObjectId);
          Acad::ErrorStatus  setSheetView( AcDbObjectId);
          Acad::ErrorStatus  setSnapAngle(double);
          Acad::ErrorStatus  setSnapBasePoint( AcGePoint2d const &);
          Acad::ErrorStatus  setSnapIncrement( AcGeVector2d const &);
          Acad::ErrorStatus  setSnapIsoPair(unsigned short);
          Acad::ErrorStatus  setSnapIsometric(void);
          Acad::ErrorStatus  setSnapOff(void);
          Acad::ErrorStatus  setSnapOn(void);
          Acad::ErrorStatus  setSnapStandard(void);
          Acad::ErrorStatus  setStandardScale( StandardScaleType);
          Acad::ErrorStatus  setSun( AcDbObjectId &, AcDbObject *);
          Acad::ErrorStatus  setSun( AcDbObjectId &, AcDbObject *,bool);
          Acad::ErrorStatus  setThumbnail( tagBITMAPINFO const *);
          Acad::ErrorStatus  setToneOperatorParameters( AcGiToneOperatorParameters const &);
          Acad::ErrorStatus  setTransparent(void);
          Acad::ErrorStatus  setTwistAngle(double);
          Acad::ErrorStatus  setUcs( AcDbObjectId const &);
          Acad::ErrorStatus  setUcs( AcGePoint3d const &, AcGeVector3d const &, AcGeVector3d const &);
          Acad::ErrorStatus  setUcs( AcDb::OrthographicView);
          Acad::ErrorStatus  setUcsFollowModeOff(void);
          Acad::ErrorStatus  setUcsFollowModeOn(void);
          Acad::ErrorStatus  setUcsIconAtCorner(void);
          Acad::ErrorStatus  setUcsIconAtOrigin(void);
          Acad::ErrorStatus  setUcsIconInvisible(void);
          Acad::ErrorStatus  setUcsIconVisible(void);
          Acad::ErrorStatus  setUcsToWorld(void);
          Acad::ErrorStatus  setUnlocked(void);
          Acad::ErrorStatus  setViewCenter( AcGePoint2d const &);
          Acad::ErrorStatus  setViewDirection( AcGeVector3d const &);
          Acad::ErrorStatus  setViewDirection( AcDb::OrthographicView);
          Acad::ErrorStatus  setViewHeight(double);
          Acad::ErrorStatus  setViewTarget( AcGePoint3d const &);
          Acad::ErrorStatus  setVisualStyle( AcDbObjectId);
          Acad::ErrorStatus  setWidth(double);
          Acad::ErrorStatus  showHiddenLines(void);
          Acad::ErrorStatus  syncModelView(void);
          Acad::ErrorStatus  thawAllLayersInViewport(void);
          Acad::ErrorStatus  thawLayersInViewport( AcDbObjectIdArray const &);
          Acad::ErrorStatus  toneOperatorParameters( AcGiToneOperatorParameters &)const ;
          Acad::ErrorStatus  updateDisplay(void)const ;
         short  number(void)const ;
         
         unsigned short  circleSides(void)const ;
         unsigned short  gridMajor(void)const ;
         unsigned short  snapIsoPair(void)const ;
         virtual  ~AcDbViewport(void);
         
         virtual  Acad::ErrorStatus  getClassID( _GUID *)const ;
         virtual void  copied( AcDbObject const *, AcDbObject const *);
         virtual void  erased( AcDbObject const *,int);
         virtual void  modified( AcDbObject const *);
         virtual void  subObjModified( AcDbObject const *, AcDbObject const *);
         void  setRenderMode( AcDbAbstractViewTableRecord::RenderMode);
         void  setUcsPerViewport(bool);
 
         bool  isFastZoomOn(void)const ;
 
         virtual Adesk::UInt32 subSetAttributes(AcGiDrawableTraits* pTraits);
         virtual Adesk::Boolean subWorldDraw(AcGiWorldDraw*);
         virtual Acad::ErrorStatus dwgInFields(AcDbDwgFiler*);
         virtual Acad::ErrorStatus dwgOutFields(AcDbDwgFiler*)const;
         virtual Acad::ErrorStatus dxfInFields(AcDbDxfFiler*);
         virtual Acad::ErrorStatus dxfOutFields(AcDbDxfFiler*)const;
         virtual Acad::ErrorStatus subGetClassID(_GUID*)const;
         virtual Acad::ErrorStatus subClose(void);
         virtual Acad::ErrorStatus subErase(Adesk::Boolean);
protected:
          AcDbViewport( AcDbSystemInternals *);
 
};