CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
OdDbPlotSettings Class Reference

#include <DbPlotSettings.h>

Inheritance diagram for OdDbPlotSettings:
OdDbObject OdGiDrawable OdRxObject OdDbLayout

Public Types

enum  PlotPaperUnits { kInches = 0 , kMillimeters = 1 , kPixels = 2 }
 
enum  PlotRotation { k0degrees = 0 , k90degrees = 1 , k180degrees = 2 , k270degrees = 3 }
 
enum  PlotType {
  kDisplay = 0 , kExtents = 1 , kLimits = 2 , kView = 3 ,
  kWindow = 4 , kLayout = 5
}
 
enum  StdScaleType {
  kScaleToFit = 0 , k1_128in_1ft = 1 , k1_64in_1ft = 2 , k1_32in_1ft = 3 ,
  k1_16in_1ft = 4 , k3_32in_1ft = 5 , k1_8in_1ft = 6 , k3_16in_1ft = 7 ,
  k1_4in_1ft = 8 , k3_8in_1ft = 9 , k1_2in_1ft = 10 , k3_4in_1ft = 11 ,
  k1in_1ft = 12 , k3in_1ft = 13 , k6in_1ft = 14 , k1ft_1ft = 15 ,
  k1_1 = 16 , k1_2 = 17 , k1_4 = 18 , k1_5 = 19 ,
  k1_8 = 20 , k1_10 = 21 , k1_16 = 22 , k1_20 = 23 ,
  k1_30 = 24 , k1_40 = 25 , k1_50 = 26 , k1_100 = 27 ,
  k2_1 = 28 , k4_1 = 29 , k8_1 = 30 , k10_1 = 31 ,
  k100_1 = 32 , k1000_1 = 33 , k1and1_2in_1ft = 34
}
 
enum  ShadePlotType {
  kAsDisplayed = 0 , kWireframe = 1 , kHidden = 2 , kRendered = 3 ,
  kVisualStyle = 4 , kRenderPreset = 5
}
 
enum  ShadePlotResLevel {
  kDraft = 0 , kPreview = 1 , kNormal = 2 , kPresentation = 3 ,
  kMaximum = 4 , kCustom = 5
}
 
- Public Types inherited from OdGiDrawable
enum  SetAttributesFlags {
  kDrawableNone = 0 , kDrawableIsAnEntity = 1 , kDrawableUsesNesting = 2 , kDrawableIsCompoundObject = 4 ,
  kDrawableViewIndependentViewportDraw = 8 , kDrawableIsInvisible = 16 , kDrawableHasAttributes = 32 , kDrawableRegenTypeDependantGeometry = 64 ,
  kDrawableIsDimension = (kDrawableIsAnEntity + kDrawableIsCompoundObject + 128) , kDrawableRegenDraw = 256 , kDrawableStandardDisplaySingleLOD = 512 , kDrawableShadedDisplaySingleLOD = 1024 ,
  kDrawableViewDependentViewportDraw = 2048 , kDrawableBlockDependentViewportDraw = 4096 , kDrawableIsExternalReference = 8192 , kDrawableNotPlottable = 16384 ,
  kDrawableNotAllowLCS = 32768 , kDrawableMergeControlOff = 65536 , kLastFlag = kDrawableMergeControlOff
}
 
enum  DrawableType {
  kGeometry = 0 , kDistantLight = 1 , kPointLight = 2 , kSpotLight = 3 ,
  kAmbientLight , kSolidBackground , kGradientBackground , kImageBackground ,
  kGroundPlaneBackground , kViewport , kWebLight , kSkyBackground ,
  kImageBasedLightingBackground
}
 

Public Member Functions

 ODDB_DECLARE_MEMBERS (OdDbPlotSettings)
 
 OdDbPlotSettings ()
 
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)
 
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)
 
OdDbObjectId shadePlotId () const
 
OdResult setShadePlot (OdDbPlotSettings::ShadePlotType type, OdDbObjectId shadePlotId)
 
bool plotWireframe () const
 
bool plotAsRaster () const
 
bool plotTransparency () const
 
void setPlotTransparency (bool bSet)
 
- Public Member Functions inherited from OdDbObject
 ODDB_DECLARE_MEMBERS (OdDbObject)
 
 ~OdDbObject ()
 
void addRef ()
 
void release ()
 
long numRefs () const
 
OdDbObjectId objectId () const
 
OdDbHandle getDbHandle () const
 
OdDbHandle handle () const
 
OdDbObjectId ownerId () const
 
virtual void setOwnerId (OdDbObjectId ownerId)
 
OdDbDatabasedatabase () const
 
void createExtensionDictionary ()
 
OdDbObjectId extensionDictionary () const
 
bool releaseExtensionDictionary ()
 
OdDbXrecordPtr createXrecord (const OdString &xrecordName, OdDb::DuplicateRecordCloning style=OdDb::kDrcIgnore)
 
void upgradeOpen ()
 
void downgradeOpen ()
 
void cancel ()
 
virtual OdResult subOpen (OdDb::OpenMode mode)
 
virtual void subClose ()
 
OdResult erase (bool eraseIt=true)
 
virtual OdResult subErase (bool erasing)
 
void handOverTo (OdDbObject *pNewObject, bool keepXData=true, bool keepExtDict=true)
 
virtual void subHandOverTo (OdDbObject *pNewObject)
 
void swapIdWith (OdDbObjectId otherId, bool swapXdata=false, bool swapExtDict=false)
 
virtual void subSwapIdWith (const OdDbObjectId &otherId, bool swapXdata=false, bool swapExtDict=false)
 
virtual void audit (OdDbAuditInfo *pAuditInfo)
 
void dwgIn (OdDbDwgFiler *pFiler)
 
void dwgOut (OdDbDwgFiler *pFiler) const
 
virtual OdResult dxfIn (OdDbDxfFiler *pFiler)
 
virtual void dxfOut (OdDbDxfFiler *pFiler) const
 
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 OdDb::DuplicateRecordCloning mergeStyle () const
 
virtual OdResBufPtr xData (const OdString &regappName=OdString::kEmpty) const
 
virtual void setXData (const OdResBuf *pRb)
 
bool isEraseStatusToggled () const
 
bool isErased () const
 
bool isReadEnabled () const
 
bool isWriteEnabled () const
 
bool isNotifyEnabled () const
 
bool isModified () const
 
bool isModifiedXData () const
 
bool isModifiedGraphics () const
 
bool isNewObject () const
 
bool isNotifying () const
 
bool isUndoing () const
 
bool isReallyClosing () const
 
bool isDBRO () const
 
void assertReadEnabled () const
 
void assertWriteEnabled (bool autoUndo=true, bool recordModified=true)
 
void assertNotifyEnabled () const
 
void disableUndoRecording (bool disable)
 
bool isUndoRecordingDisabled () const
 
OdDbDwgFilerundoFiler ()
 
virtual void applyPartialUndo (OdDbDwgFiler *pUndoFiler, OdRxClass *pClassObj)
 
void addReactor (OdDbObjectReactor *pReactor) const
 
void removeReactor (OdDbObjectReactor *pReactor) const
 
virtual void addPersistentReactor (const OdDbObjectId &objId)
 
virtual void removePersistentReactor (const OdDbObjectId &objId)
 
bool hasPersistentReactor (const OdDbObjectId &objId) const
 
OdDbObjectIdArray getPersistentReactors () const
 
OdDbObjectReactorArray getTransientReactors () const
 
virtual void recvPropagateModify (const OdDbObject *pSubObj)
 
virtual void xmitPropagateModify () const
 
ODRX_SEALED_VIRTUAL OdDbObjectPtr deepClone (OdDbIdMapping &idMap, OdDbObject *pOwner, bool bPrimary=true) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdDbObjectPtr wblockClone (OdDbIdMapping &idMap, OdDbObject *pOwner, bool bPrimary=true) const ODRX_SEALED
 
virtual void appendToOwner (OdDbIdPair &idPair, OdDbObject *pOwnerObject, OdDbIdMapping &idMap)
 
void setOdDbObjectIdsInFlux ()
 
bool isOdDbObjectIdsInFlux () const
 
virtual void copied (const OdDbObject *pObject, const OdDbObject *pNewObject)
 
virtual void erased (const OdDbObject *pObject, bool erasing=true)
 
virtual void goodbye (const OdDbObject *pObject)
 
virtual void openedForModify (const OdDbObject *pObject)
 
virtual void modified (const OdDbObject *pObject)
 
virtual void subObjModified (const OdDbObject *pObject, const OdDbObject *pSubObj)
 
virtual void modifyUndone (const OdDbObject *pObject)
 
virtual void modifiedXData (const OdDbObject *pObject)
 
virtual void unappended (const OdDbObject *pObject)
 
virtual void reappended (const OdDbObject *pObject)
 
bool isAProxy () const
 
virtual void objectClosed (const OdDbObjectId &objectId)
 
virtual void modifiedGraphics (const OdDbObject *pObject)
 
virtual void copyFrom (const OdRxObject *pSource)
 
bool hasSaveVersionOverride () const
 
void setHasSaveVersionOverride (bool hasSaveVersionOverride)
 
virtual OdDb::DwgVersion getObjectSaveVersion (const OdDbFiler *pFiler, OdDb::MaintReleaseVer *pMaintVer=0) const
 
virtual OdDbObjectPtr decomposeForSave (OdDb::DwgVersion ver, OdDbObjectId &replaceId, bool &exchangeXData)
 
virtual OdDbObjectPtr decomposeForSave (OdDb::SaveType format, OdDb::DwgVersion ver, OdDbObjectId &replaceId, bool &exchangeXData)
 
void convertForSave (OdDb::DwgVersion ver)
 
virtual void composeForLoad (OdDb::SaveType format, OdDb::DwgVersion version, OdDbAuditInfo *pAuditInfo)
 
virtual OdGiDrawabledrawable ()
 
virtual OdUInt32 subSetAttributes (OdGiDrawableTraits *pTraits) const
 
virtual bool subWorldDraw (OdGiWorldDraw *pWd) const
 
virtual void subViewportDraw (OdGiViewportDraw *pVd) const
 
virtual bool isPersistent () const
 
virtual OdDbStub * id () const
 
ODRX_SEALED_VIRTUAL OdResult getClassID (void *pClsid) const ODRX_SEALED
 
void setGsNode (OdGsCache *pNode)
 
OdGsCachegsNode () const
 
void xDataTransformBy (const OdGeMatrix3d &xfm)
 
bool hasFields () const
 
OdDbObjectId getField (const OdString &fieldName) const
 
OdDbObjectPtr getField (const OdString &fieldName, OdDb::OpenMode mode) const
 
virtual OdDbObjectId setField (const OdString &fieldName, OdDbField *pField)
 
virtual OdResult removeField (OdDbObjectId fieldId)
 
virtual OdDbObjectId removeField (const OdString &fieldName)
 
OdDbObjectId getFieldDictionary () const
 
OdDbObjectPtr getFieldDictionary (OdDb::OpenMode mode) const
 
virtual OdRxClasssaveAsClass (OdRxClass *pClass) const
 
- Public Member Functions inherited from OdGiDrawable
 ODRX_DECLARE_MEMBERS (OdGiDrawable)
 
virtual DrawableType drawableType () const
 
ODRX_SEALED_VIRTUAL OdUInt32 setAttributes (OdGiDrawableTraits *pTraits) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL bool worldDraw (OdGiWorldDraw *pWd) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL void viewportDraw (OdGiViewportDraw *pVd) const ODRX_SEALED
 
virtual bool isPersistent () const =0
 
virtual OdDbStub * id () const =0
 
virtual void setGsNode (OdGsCache *pGsNode)=0
 
virtual OdGsCachegsNode () const =0
 
ODRX_SEALED_VIRTUAL OdUInt32 viewportDrawLogicalFlags (OdGiViewportDraw *pVd) const ODRX_SEALED
 
virtual OdResult getGeomExtents (OdGeExtents3d &extents) const
 
ODRX_SEALED_VIRTUAL OdUInt32 regenSupportFlags () const ODRX_SEALED
 
- Public Member Functions inherited from OdRxObject
 ODRX_HEAP_OPERATORS ()
 
 OdRxObject ()
 
virtual ~OdRxObject ()
 
virtual OdRxObjectqueryX (const OdRxClass *pClass) const
 
virtual OdRxObjectx (const OdRxClass *pClass) const
 
virtual OdRxClassisA () const
 
virtual void addRef ()=0
 
virtual void release ()=0
 
virtual long numRefs () const
 
bool isKindOf (const OdRxClass *pClass) const
 
virtual OdRxObjectPtr clone () const
 
virtual void copyFrom (const OdRxObject *pSource)
 
virtual OdRx::Ordering comparedTo (const OdRxObject *pOther) const
 
virtual bool isEqualTo (const OdRxObject *pOther) const
 

Additional Inherited Members

- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 
- Protected Member Functions inherited from OdDbObject
 OdDbObject ()
 
virtual OdResult subGetClassID (void *pClsid) const
 
virtual OdDbObjectPtr subDeepClone (OdDbIdMapping &ownerIdMap, OdDbObject *pOwner, bool bPrimary) const
 
virtual OdDbObjectPtr subWblockClone (OdDbIdMapping &ownerIdMap, OdDbObject *pOwner, bool bPrimary) const
 
- Protected Member Functions inherited from OdGiDrawable
 OdGiDrawable ()
 
virtual OdUInt32 subSetAttributes (OdGiDrawableTraits *traits) const =0
 
virtual bool subWorldDraw (OdGiWorldDraw *wd) const =0
 
virtual void subViewportDraw (OdGiViewportDraw *vd) const =0
 
virtual OdUInt32 subViewportDrawLogicalFlags (OdGiViewportDraw *vd) const
 
virtual OdUInt32 subRegenSupportFlags () const
 
- Protected Attributes inherited from OdDbObject
OdDbObjectImplm_pImpl
 

Detailed Description

This class represents PlotSettings objects in an OdDbDatabase instance.

<group OdDb_Classes>

Definition at line 38 of file DbPlotSettings.h.

Member Enumeration Documentation

◆ PlotPaperUnits

Enumerator
kInches 
kMillimeters 
kPixels 

Definition at line 45 of file DbPlotSettings.h.

◆ PlotRotation

Enumerator
k0degrees 
k90degrees 
k180degrees 
k270degrees 

Definition at line 52 of file DbPlotSettings.h.

◆ PlotType

Enumerator
kDisplay 
kExtents 
kLimits 
kView 
kWindow 
kLayout 

Definition at line 60 of file DbPlotSettings.h.

◆ ShadePlotResLevel

Enumerator
kDraft 
kPreview 
kNormal 
kPresentation 
kMaximum 
kCustom 

Definition at line 119 of file DbPlotSettings.h.

◆ ShadePlotType

Enumerator
kAsDisplayed 
kWireframe 
kHidden 
kRendered 
kVisualStyle 
kRenderPreset 

Definition at line 109 of file DbPlotSettings.h.

◆ StdScaleType

Enumerator
kScaleToFit 
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 
k1_1 
k1_2 
k1_4 
k1_5 
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 
k1000_1 
k1and1_2in_1ft 

Definition at line 70 of file DbPlotSettings.h.

Constructor & Destructor Documentation

◆ OdDbPlotSettings()

OdDbPlotSettings::OdDbPlotSettings ( )

Member Function Documentation

◆ addToPlotSettingsDict()

void OdDbPlotSettings::addToPlotSettingsDict ( OdDbDatabase pDb)

Adds this PlotSettings object to the PlotSettings dictionary in the specified database.

Parameters
pDb[in] Pointer to the database.

◆ copyFrom()

virtual void OdDbPlotSettings::copyFrom ( const OdRxObject pSource)
virtual

Copies the contents of the specified object into this object when possible.

Parameters
pSource[in] Pointer to the source object.
Remarks
The source object and this object need not be of the same type.
This function is meaningful only when implemented by custom classes.

Throws:

Cause eNullObjectPointer pSource->isNull()

Reimplemented from OdDbObject.

◆ drawViewportsFirst()

bool OdDbPlotSettings::drawViewportsFirst ( ) const

TBC.
bool textFill() const;

TBC. void setTextFill(bool textFill);

TBC. int getTextQuality() const;

TBC. void setTextQuality(int quality);

Returns true if and only if viewports are to be plotted before other objects in PaperSpace for this PlotSettings object (DXF 70, bit 0x200).

◆ dwgInFields()

virtual OdResult OdDbPlotSettings::dwgInFields ( OdDbDwgFiler pFiler)
virtual

Reads the .dwg file data of this object.

Parameters
pFiler[in] Filer object from which data are read.
Returns
Returns the filer status.

This function is called by dwgIn() to allow the object to read its data.

When overriding this function:

1) Call assertWriteEnabled(). 2) Call the parent class's dwgInFields(pFiler). 3) If it returns eOK, continue; otherwise return whatever the parent's dwgInFields(pFiler) returned. 4) Call the OdDbDwgFiler(pFiler) methods to read each of the object's data items in the order they were written. 5) Return pFiler->filerStatus().

Reimplemented from OdDbObject.

Reimplemented in OdDbLayout.

◆ dwgOutFields()

virtual void OdDbPlotSettings::dwgOutFields ( OdDbDwgFiler pFiler) const
virtual

Writes the .dwg file data of this object.

Parameters
pFiler[in] Pointer to the filer to which data are written.
Remarks

This function is called by dwgIn() to allow the object to write its data.

When overriding this function:

1) Call assertReadEnabled(). 2) Call the parent class's dwgOutFields(pFiler). 3) Call the OdDbDwgFiler(pFiler) methods to write each of the object's data items in the order they were written.

Reimplemented from OdDbObject.

Reimplemented in OdDbLayout.

◆ dxfInFields()

virtual OdResult OdDbPlotSettings::dxfInFields ( OdDbDxfFiler pFiler)
virtual

Reads the DXF data of this object.

Parameters
pFiler[in] Pointer to the filer from which data are read.
Returns
Returns the filer status.

This function is called by dxfIn() to allow the object to read its data.

When overriding this function:

1) Call assertWriteEnabled(). 2) Call the parent class's dwgInFields(pFiler). 3) If it returns eOK, continue; otherwise return whatever the parent's dxfInFields(pFiler) returned. 4) Call the OdDbDxfFiler(pFiler) methods to read each of the object's data items in the order they were written. 5) Return pFiler->filerStatus().

Reimplemented from OdDbObject.

Reimplemented in OdDbLayout.

◆ dxfOutFields()

virtual void OdDbPlotSettings::dxfOutFields ( OdDbDxfFiler pFiler) const
virtual

Writes the DXF data of this object.

Parameters
pFiler[in] Pointer to the filer to which data are to be written.
Remarks

This function is called by dxfOut() to allow the object to write its data.

When overriding this function:

1) Call assertReadEnabled(). 2) Call the parent class's dxfOutFields(pFiler). 4) Use pFiler to call the OdDbDxfFiler methods to write each of the object's data items in the order they were written.

Reimplemented from OdDbObject.

Reimplemented in OdDbLayout.

◆ getBottomMargin()

double OdDbPlotSettings::getBottomMargin ( ) const

Returns the bottom margin of the paper for this PlotSettings object (DXF 41).

◆ getCanonicalMediaName()

OdString OdDbPlotSettings::getCanonicalMediaName ( ) const

Returns the canonical media name for the paper id of this PlotSettings object (DXF 4).

See also
<link !!OVERLOADED_getLocaleMediaName_OdDbPlotSettingsValidator, OdDbPlotSettingsValidator::getLocaleMediaName() methods>

◆ getCurrentStyleSheet()

OdString OdDbPlotSettings::getCurrentStyleSheet ( ) const

Returns the current style sheet (DXF 7).

◆ getCustomPrintScale()

void OdDbPlotSettings::getCustomPrintScale ( double &  numerator,
double &  denominator 
) const

Returns the custom print scale for this PlotSettings object (DXF 142, 143).

Parameters
numerator[in] Receives PaperSpace units.
denominator[in] Receives media units.
Remarks
The custom print scale always reflects the scale that this PlotSettings object will use to plot.

◆ getLeftMargin()

double OdDbPlotSettings::getLeftMargin ( ) const

Returns the left margin of the paper for this PlotSettings object (DXF 40).

◆ getPaperImageOrigin()

OdGePoint2d OdDbPlotSettings::getPaperImageOrigin ( ) const

Returns the paper image origin of the paper for this PlotSettings object (DXF 148, 149).

◆ getPlotCfgName()

OdString OdDbPlotSettings::getPlotCfgName ( ) const

Returns the name of the system printer or plot configuration file for this PlotSettings object (DXF 2).

◆ getPlotOrigin()

void OdDbPlotSettings::getPlotOrigin ( double &  xCoordinate,
double &  yCoordinate 
) const

Returns the plot origin offset for this PlotSettings object (DXF 46, 47).

Parameters
xCoordinate[out] Receives the X-coordinate of the origin offset.
yCoordinate[out] Receives the Y-coordinate of the origin offset.
Remarks
The plot origin offset is measured with respect to the plot margin. All distances are returned in millimeters, regardless of the drawing units.

◆ getPlotPaperMargins()

void OdDbPlotSettings::getPlotPaperMargins ( double &  leftMargin,
double &  bottomMargin,
double &  rightMargin,
double &  topMargin 
) const

Returns the margins of the paper for this PlotSettings object.

Parameters
leftMargin[out] Receives the left margin.
bottomMargin[out]Receives the bottom margin.
rightMargin[out] Receives the right margin.
topMargin[out] Receives the top margin.
Remarks
Margins are measured from their respective edges to the plot area and are independent of plot rotation. All distances are returned in millimeters, regardless of the drawing units.

◆ getPlotPaperSize()

void OdDbPlotSettings::getPlotPaperSize ( double &  paperWidth,
double &  paperHeight 
) const

Returns the size of the paper for this PlotSettings object (DXF 44, 45).

Remarks
Paper size is the physical paper size and includes margins. All distances are returned in millimeters, regardless of the drawing units.

◆ getPlotSettingsName()

OdString OdDbPlotSettings::getPlotSettingsName ( ) const

Returns the name of this PlotSettings object (DXF 1).

◆ getPlotViewName()

OdString OdDbPlotSettings::getPlotViewName ( ) const

Returns the plot view name for this PlotSettings object (DXF 6).

Remarks
This string specifies the named view to be plotted if and only if plotType == kView.

◆ getPlotWindowArea()

void OdDbPlotSettings::getPlotWindowArea ( double &  xMin,
double &  yMin,
double &  xMax,
double &  yMax 
) const

Returns the corners of the plot window area for this PlotSettings object (DXF 48, 49, 140, 141).

Parameters
xMin[in] Receives the X-coordinate of the lower-left corner.
yMin[in] Receives the Y-coordinate of the lower-left corner.
xMax[in] Receives the X-coordinate of the upper-right corner.
yMax[in] Receives the Y-coordinate of the upper-right corner.
Remarks
The corners define the area to be plotted if and only if plotType == kWindow.

◆ getRightMargin()

double OdDbPlotSettings::getRightMargin ( ) const

Returns the right margin of the paper for this PlotSettings object (DXF 42).

◆ getStdScale()

void OdDbPlotSettings::getStdScale ( double &  standardScale) const

Returns the standard scale, as a floating point value, for this PlotSettings object (DXF 147).

Parameters
standardScale[out] Receives the standard scale.

◆ getTopMargin()

double OdDbPlotSettings::getTopMargin ( ) const

Returns the top margin of the paper for this PlotSettings object (DXF 43).

◆ modelType()

bool OdDbPlotSettings::modelType ( ) const

Returns true if and only if this PlotSettings object is of ModelSpace type (DXF 70, bit 0x400).

Remarks
A PlotSettings object is of either ModelSpace type or PaperSpace type.

◆ ODDB_DECLARE_MEMBERS()

OdDbPlotSettings::ODDB_DECLARE_MEMBERS ( OdDbPlotSettings  )

◆ plotAsRaster()

bool OdDbPlotSettings::plotAsRaster ( ) const

Controls whether the output is raster-based when using shade plot settings of a viewport.

◆ plotCentered()

bool OdDbPlotSettings::plotCentered ( ) const

Returns true if an only if the plot is to be centered for this PlotSettings object (DXF 70, bit 0x04).

◆ plotHidden()

bool OdDbPlotSettings::plotHidden ( ) const

Returns true if and only if the hidden line removal algorithm is to be applied to PaperSpace entities for this PlotSettings object (DXF 70, bit 0x08).

◆ plotPaperUnits()

OdDbPlotSettings::PlotPaperUnits OdDbPlotSettings::plotPaperUnits ( ) const

Returns the plot paper units used for margins, offsets, paper size, and drawing units of this PlotSettings object (DXF 72).

Remarks
plotPaperUnits() returns one of the following:

Value Description kInches 0 Inches kMillimeters 1 Millimeters kPixels 2 Pixels

◆ plotPlotStyles()

bool OdDbPlotSettings::plotPlotStyles ( ) const

Returns whether plotstyles are applied for this PlotSettings object (DXF 70, bit 0x20).

Returns
Returns true if and only if plot styles are to be plotted.

◆ plotRotation()

OdDbPlotSettings::PlotRotation OdDbPlotSettings::plotRotation ( ) const

Returns the plot rotation for this PlotSettings object (DXF 73).

Remarks
plotRotation() returns one of the following:

Value Description k0degrees 0 No rotation k90degrees 1 90° CCW k180degrees 2 Inverted° k270degrees 3 90° CW

◆ plotTransparency()

bool OdDbPlotSettings::plotTransparency ( ) const

Returns true if and only if transparencies plotting is enabled for this OdDbRenderSettings object.

◆ plotType()

OdDbPlotSettings::PlotType OdDbPlotSettings::plotType ( ) const

Returns the plot type for this PlotSettings Object (DXF 74).

Remarks
plotType() returns one of the following:

Value Description kDisplay 0 Display kExtents 1 Extents kLimits 2 Limits kView 3 View kWindow 4 Window kLayout 5 Layout

◆ plotViewportBorders()

bool OdDbPlotSettings::plotViewportBorders ( ) const

Returns whether viewport borders are plotted for this PlotSettings object (DXF 70, bit 0x01).

Returns
Returns true if and only if viewport borders are to be plotted.

◆ plotWireframe()

bool OdDbPlotSettings::plotWireframe ( ) const

Controls whether the output is vector-based when using shade plot settings of a viewport.

◆ printLineweights()

bool OdDbPlotSettings::printLineweights ( ) const

Returns true if an only if lineweights are printed for this PlotSettings object (DXF 70, bit 0x80).

◆ scaleLineweights()

bool OdDbPlotSettings::scaleLineweights ( ) const

Returns true if an only if lineweights are scaled for this PlotSettings object (DXF 70, bit 0x40).

◆ setDrawViewportsFirst()

void OdDbPlotSettings::setDrawViewportsFirst ( bool  drawViewportsFirst)

Controls the plotting of viewports before other objects in PaperSpace for this PlotSettings object (DXF 70, bit 0x200).

Parameters
drawViewportsFirst[in] True if and only if viewports are to be plotted first.

◆ setModelType()

void OdDbPlotSettings::setModelType ( bool  modelType)

Controls the ModelSpace type of this PlotSettings object (DXF 70, bit 0x400).

Parameters
modelType[in] True if and only if it is of ModelSpace type.
Remarks
A PlotSettings object is of either ModelSpace type or PaperSpace type.

◆ setPaperImageOrigin()

void OdDbPlotSettings::setPaperImageOrigin ( OdGePoint2d  paperImageOrigin)

Sets the paper image origin (DXF 148, 149).

Parameters
paperImageOrigin[in] Paper image origin.

◆ setPlotHidden()

void OdDbPlotSettings::setPlotHidden ( bool  plotHidden)

Controls the application of the hidden line removal algorithm to PaperSpace entities for this PlotSettings object (DXF 70, bit 0x08).

Parameters
plotHidden[in] True if and only hidden lines are to be removed.

◆ setPlotPlotStyles()

void OdDbPlotSettings::setPlotPlotStyles ( bool  plotPlotStyles)

Controls whether plotstyles are applied for this PlotSettings object (DXF 70, bit 0x20).

Parameters
plotPlotStyles[in] True if and only if plot styles are to be plotted.

◆ setPlotSettingsName()

void OdDbPlotSettings::setPlotSettingsName ( const OdString plotSettingsName)

Sets the name of this PlotSettings object (DXF 1).

Parameters
plotSettingsName[in] PlotSettings name.

◆ setPlotTransparency()

void OdDbPlotSettings::setPlotTransparency ( bool  bSet)

Enables or disables transparencies plotting for this OdDbRenderSettings object.

Parameters
bSet[in] New transparencies plotting setting.

◆ setPlotViewportBorders()

void OdDbPlotSettings::setPlotViewportBorders ( bool  plotViewportBorders)

Controls whether viewport borders are plotted for this PlotSettings object (DXF 70, bit 0x01).

Parameters
plotViewportBorders[in] True if and only if viewport borders are to be plotted.

◆ setPrintLineweights()

void OdDbPlotSettings::setPrintLineweights ( bool  printLineweights)

Controls the printing of lineweights for this PlotSettings object (DXF 70, bit 0x80).

Parameters
printLineweights[in] True if and only if lineweights are to be printed.

◆ setScaleLineweights()

void OdDbPlotSettings::setScaleLineweights ( bool  scaleLineweights)

Controls the scaling of lineweights for this PlotSettings object (DXF 70, bit 0x40).

Parameters
scaleLineweights[in] True if and only if lineweights are to be scaled.

◆ setShadePlot() [1/2]

OdResult OdDbPlotSettings::setShadePlot ( OdDbPlotSettings::ShadePlotType  shadePlot)

Sets the shade plot type for this PlotSettings object (DXF 76).

Parameters
shadePlot[in] Shade Plot type.
Remarks
shadePlot must be one of the following:

Value Description kAsDisplayed 0 As displayed kWireframe 1 Wireframe kHidden 2 Hidden lines removed kRendered 3 Rendered

◆ setShadePlot() [2/2]

OdResult OdDbPlotSettings::setShadePlot ( OdDbPlotSettings::ShadePlotType  type,
OdDbObjectId  shadePlotId 
)

Sets the shade plot type for this PlotSettings object (DXF 76).

Parameters
type[in] Shade Plot type.
Remarks
type must be one of the following:

Value Description kAsDisplayed 0 As displayed kWireframe 1 Wireframe kHidden 2 Hidden lines removed kRendered 3 Rendered

◆ setShadePlotCustomDPI()

void OdDbPlotSettings::setShadePlotCustomDPI ( OdInt16  shadePlotCustomDPI)

Sets the shade plot custom DPI for this PlotSettings object.

Remarks
shadePlotCustomDPI specifies the custom resolution at which shaded and vectorized viewports will plot if shadePlotResLevel == ShadePlotResLevel::kCustom.
shadePlotCustomDPI should be used only if the shade plot resolution level is set to ShadePlotResLevel::kCustom.
Parameters
shadePlotCustomDPI[in] Shade plot custom DPI.

◆ setShadePlotResLevel()

void OdDbPlotSettings::setShadePlotResLevel ( OdDbPlotSettings::ShadePlotResLevel  shadePlotResLevel)

Sets the shade plot resolution level for this PlotSettings object.

Parameters
shadePlotResLevel[in] Shade plot resolution level.
Remarks
shadePlotResLevel controls the resolution at which shaded and vectorized viewports will plot.

shadePlotResLevel must be one of the following:

Value Description kDraft 0 Draft kPreview 1 Preview kNormal 2 Normal kPresentation 3 Presentation kMaximum 4 Maximum kCustom 5 Custom

◆ setShowPlotStyles()

void OdDbPlotSettings::setShowPlotStyles ( bool  showPlotStyles)

Controls whether plotstyles display for this PlotSettings object during layout mode (DXF 70, bit 0x02).

Parameters
showPlotStyles[in] True if and only if plot styles are to be shown.

◆ shadePlot()

OdDbPlotSettings::ShadePlotType OdDbPlotSettings::shadePlot ( ) const

Returns the shade plot type for this PlotSettings object (DXF 76).

Remarks
shadePlotType() returns one of the following:

Value Description kAsDisplayed 0 As displayed kWireframe 1 Wireframe kHidden 2 Hidden lines removed kRendered 3 Rendered

◆ shadePlotCustomDPI()

OdInt16 OdDbPlotSettings::shadePlotCustomDPI ( ) const

Returns the shade plot custom DPI for this PlotSettings object.

Remarks
shadePlotCustomDPI specifies the custom resolution at which shaded and vectorized viewports will plot if shadePlotResLevel == ShadePlotResLevel::kCustom.
shadePlotCustomDPI should be used only if the shade plot resolution level is set to ShadePlotResLevel::kCustom.

◆ shadePlotId()

OdDbObjectId OdDbPlotSettings::shadePlotId ( ) const

Returns the OdDbObjectId of the OdDbVisualStyle or OdDbRenderSettings object referenced by this object.

◆ shadePlotResLevel()

OdDbPlotSettings::ShadePlotResLevel OdDbPlotSettings::shadePlotResLevel ( ) const

Returns the shade plot resolution level for this PlotSettings object.

Remarks
shadePlotResLevel controls the resolution at which shaded and vectorized viewports will plot.

shadePlotResLevel() returns one of the following:

Value Description kDraft 0 Draft kPreview 1 Preview kNormal 2 Normal kPresentation 3 Presentation kMaximum 4 Maximum kCustom 5 Custom

◆ showPlotStyles()

bool OdDbPlotSettings::showPlotStyles ( ) const

Returns whether plotstyles display for this PlotSettings object during layout mode (DXF 70, bit 0x02).

◆ stdScaleType()

OdDbPlotSettings::StdScaleType OdDbPlotSettings::stdScaleType ( ) const

Returns the standard scale type for this PlotSettings object (DXF 75).

Remarks
stdScaleType() returns one of the of the following

Value Scale 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'

◆ subClose()

virtual void OdDbPlotSettings::subClose ( )
virtual

Called as the first operation as this object is being closed, for database -resident objects only.

Remarks
This function is notified just before the current open operation is to be closed, giving this function the ability to perform necessary operatons.

When overriding this function:

1) If the OdDbObject's state is incorrect, throw exception.

2) Call parent class's subClose().

3) If other actions are required before close, do them.

The default implementation of this function does nothing. This function can be overridden in custom classes.

Reimplemented from OdDbObject.

Reimplemented in OdDbLayout.

◆ subErase()

virtual OdResult OdDbPlotSettings::subErase ( bool  erasing)
virtual

Called as the first operation as this object is being erased or unerased.

Parameters
erasing[in] A copy of the erasing argument passed to erase().
Remarks
This function is notified just before the current object is to be erased, giving this function the ability to cancel the erase.

Returns eOk if and only if erase() is to continue.

When overriding this function:

1) If the OdDbObject's state is incorrect, return something other than eOk.

2) If the parent class's subErase() returns anything other than eOk, immediately return it.

3) If other actions are required before erase, do them.

4) Return eOk.

If you must make changes to this object's state, either make them after step 2, or roll them back if step 2 returns other than eOk.

The default implementation of this function does nothing but return eOk. This function can be overridden in custom classes.

Reimplemented from OdDbObject.

◆ subGetClassID()

virtual OdResult OdDbPlotSettings::subGetClassID ( void pClsid) const
virtual

Reimplemented from OdDbObject.

Reimplemented in OdDbLayout.

◆ subHandOverTo()

virtual void OdDbPlotSettings::subHandOverTo ( OdDbObject pNewObject)
virtual

Called as the first operation of the handOverTo function.

Parameters
pNewObject[in] Pointer to the object with which to replace this object in the database.
Remarks
This function allows custom classes to populate the new object.
Overriding this function in a child class allows a child instance to be notified each time an object is handed over.

This function is notified just before an object is to be handed over; giving this function the ability to cancel the handover.

When overriding this function:

1) If the OdDbObject's state is incorrect, throw exception.

2) Call parent class's subHandover().

3) If other actions are required before handover, do them.

The default implementation of this function does nothing. This function can be overridden in custom classes.

Reimplemented from OdDbObject.

◆ useStandardScale()

bool OdDbPlotSettings::useStandardScale ( ) const

Returns true if and only if this PlotSettings object uses a standard scale (DXF 70, bit 0x10).


The documentation for this class was generated from the following file: