DbPlotSettings.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_DBPLOTSETTINGS_H
#define OD_DBPLOTSETTINGS_H
 
#include "TD_PackPush.h"
 
#include "DbObject.h"
#include "Ge/GePoint2d.h"
 
class TOOLKIT_EXPORT OdDbPlotSettings : public OdDbObject
{
public:
  ODDB_DECLARE_MEMBERS(OdDbPlotSettings);
 
  OdDbPlotSettings();
 
  enum PlotPaperUnits
  {
    kInches         = 0,   // Inches
    kMillimeters    = 1,   // Millimeters
    kPixels         = 2    // Pixels
  };
 
  enum PlotRotation
  {
    k0degrees       = 0,   // No rotation
    k90degrees      = 1,   // 90° CCW
    k180degrees     = 2,   // Inverted
    k270degrees     = 3    // 90° CW
  };
 
  enum PlotType
  {
    kDisplay        = 0,   // Display
    kExtents        = 1,   // Extents
    kLimits         = 2,   // Limits
    kView           = 3,   // View
    kWindow         = 4,   // Window
    kLayout         = 5    // Layout
  };
 
  enum StdScaleType
  {
    kScaleToFit     = 0,   // Scaled to Fit
    k1_128in_1ft    = 1,   // 1/128" = 1'
    k1_64in_1ft     = 2,   // 1/64" = 1'
    k1_32in_1ft     = 3,   // 1/32" = 1'
    k1_16in_1ft     = 4,   // 1/16" = 1'
    k3_32in_1ft     = 5,   // 3/32" = 1'
    k1_8in_1ft      = 6,   // 1/8" = 1'
    k3_16in_1ft     = 7,   // 3/16" = 1'
    k1_4in_1ft      = 8,   // 1/4" = 1'
    k3_8in_1ft      = 9,   // 3/8" = 1'
    k1_2in_1ft      = 10,  // 1/2" = 1'
    k3_4in_1ft      = 11,  // 3/4" = 1'
    k1in_1ft        = 12,  // 1" = 1'
    k3in_1ft        = 13,  // 3" = 1'
    k6in_1ft        = 14,  // 6" = 1'
    k1ft_1ft        = 15,  // 1' = 1'
    k1_1            = 16,  // 1:1
    k1_2            = 17,  // 1:2
    k1_4            = 18,  // 1:4
    k1_5            = 19,  // 1:5
    k1_8            = 20,  // 1:8
    k1_10           = 21,  // 1:10
    k1_16           = 22,  // 1:16
    k1_20           = 23,  // 1:20
    k1_30           = 24,  // 1:30
    k1_40           = 25,  // 1:40
    k1_50           = 26,  // 1:50
    k1_100          = 27,  // 1:100
    k2_1            = 28,  // 2:1
    k4_1            = 29,  // 4:1
    k8_1            = 30,  // 8:1
    k10_1           = 31,  // 10:1
    k100_1          = 32,  // 100:1
    k1000_1         = 33,  // 1000:1
    k1and1_2in_1ft  = 34  // 1.5"= 1' 
  };
 
  enum ShadePlotType 
  {
    kAsDisplayed    = 0, // As displayed
    kWireframe      = 1, // Wireframe
    kHidden         = 2, // Hidden lines removed
    kRendered       = 3, // Rendered
    kVisualStyle    = 4, // Visual style
    kRenderPreset   = 5  // Render preset
  };
 
  enum ShadePlotResLevel 
  {
    kDraft          = 0, // Draft
    kPreview        = 1, // Preview
    kNormal         = 2, // Normal
    kPresentation   = 3, // Presentation
    kMaximum        = 4, // Maximum
    kCustom         = 5  // Custom
  };
 
  void addToPlotSettingsDict(
    OdDbDatabase *pDb);
 
  OdString getPlotSettingsName() const;
 
  void setPlotSettingsName(
    const OdString& plotSettingsName);
 
  OdString getPlotCfgName() const;
 
  void getPlotPaperMargins(
    double& leftMargin, 
    double& bottomMargin,
    double& rightMargin, 
    double& topMargin) const;
 
  void getPlotPaperSize(
    double& paperWidth, 
    double& paperHeight) const;
 
  OdString getCanonicalMediaName() const;
 
  void getPlotOrigin(
    double& xCoordinate, 
    double& yCoordinate) const;
 
  OdDbPlotSettings::PlotPaperUnits plotPaperUnits() const;
 
  bool plotViewportBorders() const;
 
  void setPlotViewportBorders(
    bool plotViewportBorders);
 
  bool plotPlotStyles() const;
 
  void setPlotPlotStyles(
    bool plotPlotStyles);
 
  bool showPlotStyles() const;
 
  void setShowPlotStyles(
    bool showPlotStyles);
 
  OdDbPlotSettings::PlotRotation plotRotation() const;
 
  bool plotCentered() const;
 
  bool plotHidden() const;
 
  void setPlotHidden(bool plotHidden);
 
  OdDbPlotSettings::PlotType plotType() const;
 
  void getPlotWindowArea(
    double& xMin, 
    double& yMin,
    double& xMax, 
    double& yMax) const;
 
  OdString getPlotViewName() const;
 
  bool useStandardScale() const;
 
  void getCustomPrintScale(
    double& numerator, 
    double& denominator) const;
 
  OdString getCurrentStyleSheet() const;
 
  OdDbPlotSettings::StdScaleType stdScaleType() const;
 
 
  void getStdScale(
    double& standardScale) const;
 
  bool scaleLineweights() const;
 
  void setScaleLineweights(
    bool scaleLineweights);
 
  bool printLineweights() const;
 
  void setPrintLineweights(bool printLineweights);
 
  bool drawViewportsFirst() const;
 
  void setDrawViewportsFirst(
    bool drawViewportsFirst);
 
  bool modelType() const;
 
  void setModelType(bool modelType);
 
  double getTopMargin() const;
 
  double getRightMargin() const;
 
  double getBottomMargin() const;
 
  double getLeftMargin() const;
 
  OdGePoint2d getPaperImageOrigin() const;
 
  void setPaperImageOrigin(OdGePoint2d paperImageOrigin);
 
  // New to 2004 api
 
  OdDbPlotSettings::ShadePlotType shadePlot() const;
 
  OdResult setShadePlot(
    OdDbPlotSettings::ShadePlotType shadePlot);
 
  OdDbPlotSettings::ShadePlotResLevel shadePlotResLevel() const;
 
  void setShadePlotResLevel(
    OdDbPlotSettings::ShadePlotResLevel shadePlotResLevel);
 
  OdInt16 shadePlotCustomDPI() const;
 
  void setShadePlotCustomDPI(
    OdInt16 shadePlotCustomDPI);
 
  virtual OdResult subGetClassID(
    void* pClsid) const;
 
  virtual OdResult dwgInFields(
    OdDbDwgFiler* pFiler);
 
  virtual void dwgOutFields(
    OdDbDwgFiler* pFiler) const;
 
  virtual OdResult dxfInFields(
    OdDbDxfFiler* pFiler);
 
  virtual void dxfOutFields(
    OdDbDxfFiler* pFiler) const;
 
  virtual void subClose();
 
  virtual OdResult subErase(
    bool erasing);
  
  virtual void subHandOverTo(
    OdDbObject* pNewObject);
 
  virtual void copyFrom(
    const OdRxObject* pSource);
 
// New in AC2007
 
// Returns the OdDbObjectId of the OdDbVisualStyle or OdDbRenderSettings object
// referenced by this object.
 
  OdDbObjectId    shadePlotId() const;
 
  OdResult        setShadePlot(OdDbPlotSettings::ShadePlotType type,
                               OdDbObjectId shadePlotId);
  bool plotWireframe() const;
  bool plotAsRaster () const;
 
  bool plotTransparency() const;
  void setPlotTransparency(bool bSet);
};
 
typedef OdSmartPtr<OdDbPlotSettings> OdDbPlotSettingsPtr;
 
#include "TD_PackPop.h"
 
#endif