OdDbLayout Class

Syntax

C++

class OdDbLayout : public OdDbPlotSettings;

Description

This class represents Layout objects in an OdDbDatabase instance.

Class Hierarchy

File: DbLayout.h

Module: API Reference

Methods

Show:Inherited

No members matching the current filter

OdDbLayout	Constructor (no arguments).
OdDbPlotSettings	(Inherited from OdDbPlotSettings)
~OdDbObject	(Inherited from OdDbObject)

Enumerations

PlotPaperUnits
PlotRotation
PlotType
ShadePlotResLevel
ShadePlotType
StdScaleType

Friends

Show:Inherited

No members matching the current filter

class OdDbObjectImpl	(Inherited from OdDbObject)
class OdDbObjectOverrule	(Inherited from OdDbObject)
class OdDbPropertiesOverrule	(Inherited from OdDbObject)
class OdDbSystemInternals	(Inherited from OdDbObject)

Methods

Show:Inherited

No members matching the current filter

DWGMAP_DECLARE_MEMBERS
ODDB_DECLARE_MEMBERS	(Inherited from OdDbObject)
ODDB_DECLARE_MEMBERS	(Inherited from OdDbPlotSettings)
activeViewportId	Returns the Object ID of the viewport that was last active in this Layout object (DXF 331).
addPersistentReactor	Adds the specified persistent reactor to this object's reactor list. (Inherited from OdDbObject)
addReactor	Adds the specified transient reactor to this object's reactor list. (Inherited from OdDbObject)
addRef	Increments the reference count of this object. (Inherited from OdDbObject)
addToLayoutDict	Adds this Layout object to the layout dictionary in the specified database, and associates this Layout object with the specified PaperSpace OdDbBlockTableRecord.
addToPlotSettingsDict	Adds this PlotSettings object to the PlotSettings dictionary in the specified database. (Inherited from OdDbPlotSettings)
annoAllVisible
appendToOwner	This function appends this object to the specified owner object during the deep or wblock clone operation.
appendToOwner	This function appends this object to the specified owner object during the deep or wblock clone operation. (Inherited from OdDbObject)
applyPartialUndo	Notification function called each time an Undo operation is performed this object is using partial Undo. (Inherited from OdDbObject)
assertNotifyEnabled	Throws an exception if this object is not open OdDb::kForNotify. (Inherited from OdDbObject)
assertReadEnabled	Throws an exception if this object is not open OdDb::kForRead. (Inherited from OdDbObject)
assertWriteEnabled	Throws an exception if this object is not open OdDb::kForWrite, and controls automatic undo and notification of modifications. (Inherited from OdDbObject)
audit	Perform an audit operation on this object. (Inherited from OdDbObject)
composeForLoad	After loading from file, performs necessary actions which require accessing other Database objects. For example, processing round-trip data. (Inherited from OdDbObject)
convertForSave	The method should be called from decomposeForSave() of custom container objects for owned child objects. It calls child's decomposeForSave() method plus performs other required actions (handOverTo, exchanging XData, etc.) (Inherited from OdDbObject)
copied	Notification function called whenever the notifying object has had its clone() member function called. (Inherited from OdDbObject)
copyFrom	Copies the contents of the specified object into this object when possible. (Inherited from OdDbObject)
copyFrom	Copies the contents of the specified object into this object when possible. (Inherited from OdDbPlotSettings)
createExtensionDictionary	Creates an OdDbDictionary extension dictionary of this object. (Inherited from OdDbObject)
createXrecord	Creates or retrieves the specified Xrecord in this object's extension dictionary. (Inherited from OdDbObject)
database	Returns the OdDbDatabase that contains this object. (Inherited from OdDbObject)
decomposeForSave(OdDb::DwgVersion, OdDbObjectId&, bool&)	This is the overview for the decomposeForSave method overload.
deepClone	Performs a deep clone of this object. (Inherited from OdDbObject)
disableUndoRecording	Controls the undo recording of this object in OdDbDatabase. (Inherited from OdDbObject)
downgradeOpen	Downgrades this object from OdDb::kForWrite to OdDb::kForRead (Inherited from OdDbObject)
drawViewportsFirst	Returns true if and only if viewports are to be plotted before other objects in PaperSpace for this PlotSettings object (DXF 70, bit 0x200). (Inherited from OdDbPlotSettings)
drawable	Returns a pointer to the OdGiDrawable for the object. If the object doesn't have an associated OdGiDrawable object, this function returns NULL. (Inherited from OdDbObject)
dwgIn	Reads the .dwg file format data of this object from the specified file. (Inherited from OdDbObject)
dwgInFields	Reads the .dwg file data of this object.
dwgInFields	Reads the .dwg file data of this object. (Inherited from OdDbObject)
dwgInFields	Reads the .dwg file data of this object. (Inherited from OdDbPlotSettings)
dwgOut	Writes the .dwg file format data of this object to the specified filer. (Inherited from OdDbObject)
dwgOutFields	Writes the .dwg file data of this object.
dwgOutFields	Writes the .dwg file data of this object. (Inherited from OdDbObject)
dwgOutFields	Writes the .dwg file data of this object. (Inherited from OdDbPlotSettings)
dxfIn	Reads the DXF format data of this object from the specified filer. (Inherited from OdDbObject)
dxfInFields	Reads the DXF data of this object.
dxfInFields	Reads the DXF data of this object. (Inherited from OdDbObject)
dxfInFields	Reads the DXF data of this object. (Inherited from OdDbPlotSettings)
dxfInFields_R12	Reads the DXF R12 format data of this object. (Inherited from OdDbObject)
dxfOut	Writes the DXF format data of this object to the specified filer. (Inherited from OdDbObject)
dxfOutFields	Writes the DXF data of this object.
dxfOutFields	Writes the DXF data of this object. (Inherited from OdDbObject)
dxfOutFields	Writes the DXF data of this object. (Inherited from OdDbPlotSettings)
dxfOutFields_R12	Writes the DXF data of this object. (Inherited from OdDbObject)
erase	Sets the erased mode of this object. (Inherited from OdDbObject)
erased	Notification function called whenever an object has been erased or unerased. (Inherited from OdDbObject)
extensionDictionary	Returns the Object ID of this object's extension dictionary. (Inherited from OdDbObject)
getBlockTableRecordId	Returns the Object ID of the PaperSpace OdDbBlockTableRecord associated with this Layout object (DXF 330).
getBottomMargin	Returns the bottom margin of the paper for this PlotSettings object (DXF 41). (Inherited from OdDbPlotSettings)
getCanonicalMediaName	Returns the canonical media name for the paper id of this PlotSettings object (DXF 4). (Inherited from OdDbPlotSettings)
getClassID	Returns the CLSID value associated with this object. (Inherited from OdDbObject)
getCurrentStyleSheet	Returns the current style sheet (DXF 7). (Inherited from OdDbPlotSettings)
getCustomPrintScale	Returns the custom print scale for this PlotSettings object (DXF 142, 143). (Inherited from OdDbPlotSettings)
getDbHandle	Returns the persistent handle of this database object. (Inherited from OdDbObject)
getEXTMAX	Returns the maximum extents for this Layout object (DXF 15).
getEXTMIN	Returns the minimum extents for this Layout object (DXF 14).
getField(const OdString&)	This is the overview for the getField method overload.
getFieldDictionary()	This is the overview for the getFieldDictionary method overload.
getGeomExtents
getINSBASE	Returns the insertion base for this Layout object (DXF 12).
getLIMCHECK	Returns the LIMCHECK variable for this Layout object (DXF 70, bit 0x02).
getLIMMAX	Returns the maximum limits for this Layout object (DXF 11).
getLIMMIN	Returns the minimum limits for this Layout object (DXF 10).
getLayoutName	Returns the name of this Layout object (DXF 1).
getLeftMargin	Returns the left margin of the paper for this PlotSettings object (DXF 40). (Inherited from OdDbPlotSettings)
getObjectSaveVersion	Returns the drawing and maintenance release version into which this object must be stored. (Inherited from OdDbObject)
getPSLTSCALE	Returns the PSLTSCALE variable for this Layout object (DXF 70, bit 0x01).
getPaperImageOrigin	Returns the paper image origin of the paper for this PlotSettings object (DXF 148, 149). (Inherited from OdDbPlotSettings)
getPersistentReactors	Returns Object IDs of this object's persistent reactors. (Inherited from OdDbObject)
getPlotCfgName	Returns the name of the system printer or plot configuration file for this PlotSettings object (DXF 2). (Inherited from OdDbPlotSettings)
getPlotOrigin	Returns the plot origin offset for this PlotSettings object (DXF 46, 47). (Inherited from OdDbPlotSettings)
getPlotPaperMargins	Returns the margins of the paper for this PlotSettings object. (Inherited from OdDbPlotSettings)
getPlotPaperSize	Returns the size of the paper for this PlotSettings object (DXF 44, 45). (Inherited from OdDbPlotSettings)
getPlotSettingsName	Returns the name of this PlotSettings object (DXF 1). (Inherited from OdDbPlotSettings)
getPlotViewName	Returns the plot view name for this PlotSettings object (DXF 6). (Inherited from OdDbPlotSettings)
getPlotWindowArea	Returns the corners of the plot window area for this PlotSettings object (DXF 48, 49, 140, 141). (Inherited from OdDbPlotSettings)
getPreviewImage	Returns the preview image associated with the layout object.
getRightMargin	Returns the right margin of the paper for this PlotSettings object (DXF 42). (Inherited from OdDbPlotSettings)
getStdScale	Returns the standard scale, as a floating point value, for this PlotSettings object (DXF 147). (Inherited from OdDbPlotSettings)
getTabOrder	Returns the tab order for this Layout object (DXF 71).
getTabSelected	Returns true if and only if this layout tab is selected.
getTopMargin	Returns the top margin of the paper for this PlotSettings object (DXF 43). (Inherited from OdDbPlotSettings)
getTransientReactors	Returns this object's transient reactors. (Inherited from OdDbObject)
getViewportArray	Returns an array of OdDbObjectIds of all the OdDbViewports that exist in the Paper Space layout. The first ID in the list will be the overall Paper Space viewport. If the list returned is empty, then this layout is Model Space or has never been switched to (activated).
goodbye	Notification function called just before an object is deleted from memory. (Inherited from OdDbObject)
gsNode	Returns the OdGsCache of an OdGiDrawable object. (Inherited from OdDbObject)
handOverTo	Replaces this database -resident (DBRO) object with the specified non- database -resident (NDBRO) object, while retaining this object's objectId, handle, owner, and reactor list. (Inherited from OdDbObject)
handle	Returns the persistent handle of this database object. (Inherited from OdDbObject)
hasFields	Returns true if and only if this object has fields. (Inherited from OdDbObject)
hasPersistentReactor	This method returns true if objId is the Object ID of a reactor attached to this object. Otherwise, it returns false. (Inherited from OdDbObject)
hasSaveVersionOverride	Returns true if and only if this object has its bit set to override the filer version. (Inherited from OdDbObject)
id	Returns the database ID corresponding to this object. (Inherited from OdDbObject)
isAProxy	Returns true if and only if this object is a proxy object or entity. (Inherited from OdDbObject)
isDBRO	Returns true if and only this object is a database -resident object. (Inherited from OdDbObject)
isEraseStatusToggled	Returns true if and only if this object's erased status has been toggled since it was opened. (Inherited from OdDbObject)
isErased	Returns true if and only if this object is marked as erased. (Inherited from OdDbObject)
isModified	Returns true if and only if this object's assertWriteEnabled() has been called since it was opened. (Inherited from OdDbObject)
isModifiedGraphics	Returns true if and only if an object derived from OdDbEntity has been modified. (Inherited from OdDbObject)
isModifiedXData	Returns true if and only this object's assertWriteEnabled() and setXData() have been called since it was opened. (Inherited from OdDbObject)
isNewObject	Returns true if and only if this object has not been closed since it was created. (Inherited from OdDbObject)
isNotifyEnabled	Returns true if and only if this object is open OdDb::kForNotify. (Inherited from OdDbObject)
isNotifying	Returns true if and only if this object is sending notification. (Inherited from OdDbObject)
isOdDbObjectIdsInFlux	Returns true if and only if this object's Object ID is not valid because the OdDbObject::subDeepClone or OdDbObject::subWblockClone() have yet to be completed. (Inherited from OdDbObject)
isPersistent	Return true if and only if this object is database -resident (DBRO). (Inherited from OdDbObject)
isReadEnabled	Returns true if and only if this object is open OdDb::kForRead. (Inherited from OdDbObject)
isReallyClosing	Returns true if and only if a call to close would completely close this object at this time. (Inherited from OdDbObject)
isUndoing	Returns true if and only if this object is taking part in an Undo operation. (Inherited from OdDbObject)
isWriteEnabled	Returns true if and only if this object is open OdDb::kForWrite. (Inherited from OdDbObject)
mergeStyle	Returns the merge style of this object. (Inherited from OdDbObject)
modelType	Returns true if and only if this PlotSettings object is of ModelSpace type (DXF 70, bit 0x400). (Inherited from OdDbPlotSettings)
modified	Notification function called whenever an object is opened OdDb::kForWrite, a function has been called that could modify the contents of this object, and this object is now being closed. (Inherited from OdDbObject)
modifiedGraphics	Notification function called whenever an object derived from OdDbEntity is modified. (Inherited from OdDbObject)
modifiedXData	Notification function called whenever the XData has been written to the notifying object. (Inherited from OdDbObject)
modifyUndone	Notification function called whenever the notifying object is in the midst an Undo operation that is undoing modifications. (Inherited from OdDbObject)
numRefs	Returns the reference count of this object. (Inherited from OdDbObject)
objectClosed	Notification function called immediately before an object is closed. (Inherited from OdDbObject)
objectId	Returns the Object ID of this object. (Inherited from OdDbObject)
openedForModify	Notification function called whenever an object is opened for modify OdDb::kForWrite. (Inherited from OdDbObject)
overallVportId	Returns the Object ID of the overall viewport of this Layout object.
ownerId	Returns the Object ID of this object's owner. (Inherited from OdDbObject)
plotAsRaster	Controls whether the output is raster-based when using shade plot settings of a viewport. (Inherited from OdDbPlotSettings)
plotCentered	Returns true if an only if the plot is to be centered for this PlotSettings object (DXF 70, bit 0x04). (Inherited from OdDbPlotSettings)
plotHidden	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). (Inherited from OdDbPlotSettings)
plotPaperUnits	Returns the plot paper units used for margins, offsets, paper size, and drawing units of this PlotSettings object (DXF 72). (Inherited from OdDbPlotSettings)
plotPlotStyles	Returns whether plotstyles are applied for this PlotSettings object (DXF 70, bit 0x20). (Inherited from OdDbPlotSettings)
plotRotation	Returns the plot rotation for this PlotSettings object (DXF 73). (Inherited from OdDbPlotSettings)
plotTransparency	Returns true if and only if transparencies plotting is enabled for this OdDbRenderSettings object. (Inherited from OdDbPlotSettings)
plotType	Returns the plot type for this PlotSettings Object (DXF 74). (Inherited from OdDbPlotSettings)
plotViewportBorders	Returns whether viewport borders are plotted for this PlotSettings object (DXF 70, bit 0x01). (Inherited from OdDbPlotSettings)
plotWireframe	Controls whether the output is vector-based when using shade plot settings of a viewport. (Inherited from OdDbPlotSettings)
printLineweights	Returns true if an only if lineweights are printed for this PlotSettings object (DXF 70, bit 0x80). (Inherited from OdDbPlotSettings)
reappended	Notification function called whenever a Redo process processes the reappending of the notifying object to the database. (Inherited from OdDbObject)
recvPropagateModify	Allows a subobject of a complex object to notify its root object that it has been changed. (Inherited from OdDbObject)
release	Decrements the reference count of this object. (Inherited from OdDbObject)
releaseExtensionDictionary	Releases and erases this object's extension dictionary if it exists and is empty. (Inherited from OdDbObject)
removeField(OdDbObjectId)	This is the overview for the removeField method overload.
removePersistentReactor	Removes the specified persistent reactor from this object's reactor list. (Inherited from OdDbObject)
removeReactor	Removes the specified transient reactor from this object's reactor list. (Inherited from OdDbObject)
saveAsClass	!DOM (Inherited from OdDbObject)
scaleLineweights	Returns true if an only if lineweights are scaled for this PlotSettings object (DXF 70, bit 0x40). (Inherited from OdDbPlotSettings)
setActiveViewportId	Makes the specified viewport the active viewport of this Layout object (DXF 331).
setAnnoAllVisible
setBlockTableRecordId	Associates this Layout object with the specified PaperSpace OdDbBlockTableRecord (DXF 330).
setDrawViewportsFirst	Controls the plotting of viewports before other objects in PaperSpace for this PlotSettings object (DXF 70, bit 0x200). (Inherited from OdDbPlotSettings)
setEXTMAX	Sets the maximum extents for this Layout object (DXF 15).
setEXTMIN	Sets the minimum extents for this Layout object (DXF 14).
setField	Adds the specified field to the field dictionary of this object. (Inherited from OdDbObject)
setGsNode	Assigns the specified OdGsCache to the calling object. (Inherited from OdDbObject)
setHasSaveVersionOverride	Controls the flag specifying that this object overrides the save filer version. (Inherited from OdDbObject)
setINSBASE	Sets the insertion base for this Layout object (DXF 12).
setLIMCHECK	Sets the LIMCHECK variable for this Layout object (DXF 70, bit 0x02).
setLIMMAX	Sets the maximum limits for this Layout object (DXF 11).
setLIMMIN	Sets the minimum limits for this Layout object (DXF 10).
setLayoutName	Sets the name of this Layout object (DXF 1).
setModelType	Controls the ModelSpace type of this PlotSettings object (DXF 70, bit 0x400). (Inherited from OdDbPlotSettings)
setOdDbObjectIdsInFlux	Called on a new created cloned object to indicate that its Object ID is not valid. (Inherited from OdDbObject)
setOwnerId	Sets this object's ownerId data member. (Inherited from OdDbObject)
setPSLTSCALE	Sets the PSLTSCALE variable for this Layout object (DXF 70, bit 0x01).
setPaperImageOrigin	Sets the paper image origin (DXF 148, 149). (Inherited from OdDbPlotSettings)
setPlotHidden	Controls the application of the hidden line removal algorithm to PaperSpace entities for this PlotSettings object (DXF 70, bit 0x08). (Inherited from OdDbPlotSettings)
setPlotPlotStyles	Controls whether plotstyles are applied for this PlotSettings object (DXF 70, bit 0x20). (Inherited from OdDbPlotSettings)
setPlotSettingsName	Sets the name of this PlotSettings object (DXF 1). (Inherited from OdDbPlotSettings)
setPlotTransparency	Enables or disables transparencies plotting for this OdDbRenderSettings object. (Inherited from OdDbPlotSettings)
setPlotViewportBorders	Controls whether viewport borders are plotted for this PlotSettings object (DXF 70, bit 0x01). (Inherited from OdDbPlotSettings)
setPreviewImage	Sets a new preview image for the layout object.
setPrintLineweights	Controls the printing of lineweights for this PlotSettings object (DXF 70, bit 0x80). (Inherited from OdDbPlotSettings)
setScaleLineweights	Controls the scaling of lineweights for this PlotSettings object (DXF 70, bit 0x40). (Inherited from OdDbPlotSettings)
setShadePlot(OdDbPlotSettings::ShadePlotType)	This is the overview for the setShadePlot method overload.
setShadePlotCustomDPI	Sets the shade plot custom DPI for this PlotSettings object. (Inherited from OdDbPlotSettings)
setShadePlotResLevel	Sets the shade plot resolution level for this PlotSettings object. (Inherited from OdDbPlotSettings)
setShowPlotStyles	Controls whether plotstyles display for this PlotSettings object during layout mode (DXF 70, bit 0x02). (Inherited from OdDbPlotSettings)
setTabOrder	Sets the tab order for this Layout Object (DXF 71).
setTabSelected	Controls the selected status for this Layout object.
setThumbnailBitmap	Sets the thumbnail bitmap associated with this layout object.
setXData	Sets the XData of this object. (Inherited from OdDbObject)
shadePlot	Returns the shade plot type for this PlotSettings object (DXF 76). (Inherited from OdDbPlotSettings)
shadePlotCustomDPI	Returns the shade plot custom DPI for this PlotSettings object. (Inherited from OdDbPlotSettings)
shadePlotId	Returns the OdDbObjectId of the OdDbVisualStyle or OdDbRenderSettings object referenced by this object. (Inherited from OdDbPlotSettings)
shadePlotResLevel	Returns the shade plot resolution level for this PlotSettings object. (Inherited from OdDbPlotSettings)
showPlotStyles	Returns whether plotstyles display for this PlotSettings object during layout mode (DXF 70, bit 0x02). (Inherited from OdDbPlotSettings)
stdScaleType	Returns the standard scale type for this PlotSettings object (DXF 75). (Inherited from OdDbPlotSettings)
subClose	Called as the first operation as this object is being closed, for database -resident objects only.
subClose	Called as the first operation as this object is being closed, for database -resident objects only. (Inherited from OdDbObject)
subClose	Called as the first operation as this object is being closed, for database -resident objects only. (Inherited from OdDbPlotSettings)
subErase	Called as the first operation as this object is being erased or unerased. (Inherited from OdDbObject)
subErase	Called as the first operation as this object is being erased or unerased. (Inherited from OdDbPlotSettings)
subGetClassID	overridables
subGetClassID	overridables (Inherited from OdDbPlotSettings)
subHandOverTo	Called as the first operation of the handOverTo function. (Inherited from OdDbObject)
subHandOverTo	Called as the first operation of the handOverTo function. (Inherited from OdDbPlotSettings)
subObjModified	Notification function called whenever a method of the specified subobject has called assertWriteEnabled() (Inherited from OdDbObject)
subOpen	Notification function called by the Drawings framework immediately before an object is opened. (Inherited from OdDbObject)
subSetAttributes	Sets the values of this object's subentity traits, and returns with the calling object's subentity traits.
subSetAttributes	Sets the values of this object's subentity traits, and returns with the calling object's subentity traits. (Inherited from OdDbObject)
subSwapIdWith	Called as the first operation of swapIdWith (Inherited from OdDbObject)
subViewportDraw
subViewportDraw	(Inherited from OdDbObject)
subWorldDraw
subWorldDraw	(Inherited from OdDbObject)
swapIdWith	Swaps the objectIDs, handles, XData,and extension dictionary between this object and another object. (Inherited from OdDbObject)
thumbnailBitmap	Returns the thumbnail bitmap associated with this layout object.
unappended	Notification function called whenever the Undo process processes the appending of the notifying object to the database. (Inherited from OdDbObject)
undoFiler	Returns the undo filer associated with this object. (Inherited from OdDbObject)
upgradeOpen	Upgrades this object from OdDb::kForRead to OdDb::kForWrite. (Inherited from OdDbObject)
useStandardScale	Returns true if and only if this PlotSettings object uses a standard scale (DXF 70, bit 0x10). (Inherited from OdDbPlotSettings)
wblockClone	Performs a shallow clone of this object. (Inherited from OdDbObject)
xData	Returns a linked list of ResBufs containing a copy of the XData of this object. (Inherited from OdDbObject)
xDataTransformBy	Applies the 3D transformation matrix to the XData of this object. (Inherited from OdDbObject)
xmitPropagateModify	Allows a subobject of a complex object to notify its root object that it has been changed. (Inherited from OdDbObject)

Links

OdDbLayout Methods

Relief for ODA Team in Ukraine