#include <DbLayout.h>

Inheritance diagram for OdDbLayout:

Public Member Functions
	DWGMAP_DECLARE_MEMBERS (OdDbLayout)

	OdDbLayout ()

const OdGePoint2d &	getLIMMIN () const

void	setLIMMIN (const OdGePoint2d &limMin)

const OdGePoint2d &	getLIMMAX () const

void	setLIMMAX (const OdGePoint2d &limMax)

const OdGePoint3d &	getEXTMIN () const

void	setEXTMIN (const OdGePoint3d &extMin)

const OdGePoint3d &	getEXTMAX () const

void	setEXTMAX (const OdGePoint3d &extMax)

const OdGePoint3d &	getINSBASE () const

void	setINSBASE (const OdGePoint3d &insBase)

bool	getLIMCHECK () const

void	setLIMCHECK (bool limCheck)

bool	getPSLTSCALE () const

void	setPSLTSCALE (bool psLtScale)

OdDbObjectId	getBlockTableRecordId () const

virtual void	setBlockTableRecordId (const OdDbObjectId &blockTableRecordId)

virtual void	addToLayoutDict (OdDbDatabase *pDb, OdDbObjectId blockTableRecordId)

OdString	getLayoutName () const

virtual void	setLayoutName (const OdString &layoutName)

int	getTabOrder () const

virtual void	setTabOrder (int tabOrder)

bool	getTabSelected () const

virtual void	setTabSelected (bool tabSelected)

OdDbObjectIdArray	getViewportArray () const

const void *	thumbnailBitmap (OdUInt32 &dataLength) const

void	setThumbnailBitmap (const void *pBMPData, OdUInt32 dataLength)

OdGiRasterImagePtr	getPreviewImage () const

void	setPreviewImage (const OdGiRasterImage *image)

virtual OdResult	subGetClassID (void *pClsid) const

virtual OdResult	dwgInFields (OdDbDwgFiler *pFiler)

virtual void	dwgOutFields (OdDbDwgFiler *pFiler) const

virtual void	appendToOwner (OdDbIdPair &idPair, OdDbObject *pOwnerObject, OdDbIdMapping &ownerIdMap)

virtual OdResult	dxfInFields (OdDbDxfFiler *pFiler)

virtual void	dxfOutFields (OdDbDxfFiler *pFiler) const

OdDbObjectId	activeViewportId () const

void	setActiveViewportId (OdDbObjectId viewportId)

OdDbObjectId	overallVportId () const

OdUInt32	subSetAttributes (OdGiDrawableTraits *pTraits) const

bool	subWorldDraw (OdGiWorldDraw *pWd) const

void	subViewportDraw (OdGiViewportDraw *vPd) const

OdResult	getGeomExtents (OdGeExtents3d &extents) const

void	subClose ()

bool	annoAllVisible () const

void	setAnnoAllVisible (bool newVal)

Public Member Functions inherited from OdDbPlotSettings
	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)

OdDbDatabase *	database () 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

OdDbDwgFiler *	undoFiler ()

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 OdGiDrawable *	drawable ()

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)

OdGsCache *	gsNode () 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 OdRxClass *	saveAsClass (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 OdGsCache *	gsNode () 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 OdRxObject *	queryX (const OdRxClass *pClass) const

virtual OdRxObject *	x (const OdRxClass *pClass) const

virtual OdRxClass *	isA () 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
Public Types inherited from OdDbPlotSettings
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 }

Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)

static OdRxClass *	desc ()

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
OdDbObjectImpl *	m_pImpl

Detailed Description

This class represents Layout objects in an OdDbDatabase instance.

Definition at line 46 of file DbLayout.h.

Constructor & Destructor Documentation

◆ OdDbLayout()

OdDbLayout::OdDbLayout ( )

Constructor (no arguments).

Member Function Documentation

◆ activeViewportId()

OdDbObjectId OdDbLayout::activeViewportId ( ) const

Returns the Object ID of the viewport that was last active in this Layout object (DXF 331).

◆ addToLayoutDict()

virtual void OdDbLayout::addToLayoutDict	(	OdDbDatabase *	pDb,
		OdDbObjectId	blockTableRecordId
	)

virtual

Adds this Layout object to the layout dictionary in the specified database, and associates this Layout object with the specified PaperSpace OdDbBlockTableRecord.

Parameters

pDb	[in] Pointer to the database
blockTableRecordId	[in] Block table record Object Id.

◆ annoAllVisible()

bool OdDbLayout::annoAllVisible ( ) const

◆ appendToOwner()

virtual void OdDbLayout::appendToOwner	(	OdDbIdPair &	idPair,
		OdDbObject *	pOwnerObject,
		OdDbIdMapping &	idMap
	)

virtual

This function appends this object to the specified owner object during the deep or wblock clone operation.

Parameters

idPair	[in] Original-to-clone ID mapping record for this clone.
pOwnerObject	[in] Pointer to the owner object.
idMap	[in/out] ID mapping object of the cloning operation in progress.

Remarks: This callback is called before the IDs are translated in the target database so the implementer should use only methods certainly not traversing hierarchy in the target database. To follow clone's references properly they should be translated using the ID mapping object.

The default implementation appends this object to OdDbDictionary or throws the eInvalidOwnerObject exception if the owner object is not a kind of dictionary.

See also: <link OdDbObject::subDeepClone@OdDbIdMapping&@OdDbObject*@bool@const, subDeepClone()> <link OdDbObject::subWblockClone@OdDbIdMapping&@OdDbObject*@bool@const, subWblockClone()> <link OdDbObject::deepClone@OdDbIdMapping&@OdDbObject*@bool@const, deepClone()> <link OdDbObject::wblockClone@OdDbIdMapping&@OdDbObject*@bool@const, wblockClone()>

Reimplemented from OdDbObject.

◆ dwgInFields()

virtual OdResult OdDbLayout::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 OdDbPlotSettings.

◆ DWGMAP_DECLARE_MEMBERS()

OdDbLayout::DWGMAP_DECLARE_MEMBERS ( OdDbLayout )

◆ dwgOutFields()

virtual void OdDbLayout::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 OdDbPlotSettings.

◆ dxfInFields()

virtual OdResult OdDbLayout::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 OdDbPlotSettings.

◆ dxfOutFields()

virtual void OdDbLayout::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 OdDbPlotSettings.

◆ getBlockTableRecordId()

OdDbObjectId OdDbLayout::getBlockTableRecordId ( ) const

Returns the Object ID of the PaperSpace OdDbBlockTableRecord associated with this Layout object (DXF 330).

◆ getEXTMAX()

const OdGePoint3d & OdDbLayout::getEXTMAX ( ) const

Returns the maximum extents for this Layout object (DXF 15).

◆ getEXTMIN()

const OdGePoint3d & OdDbLayout::getEXTMIN ( ) const

Returns the minimum extents for this Layout object (DXF 14).

◆ getGeomExtents()

OdResult OdDbLayout::getGeomExtents ( OdGeExtents3d & extents ) const

virtual

Retrieves a WCS bounding box that represents the extents of this entity.

Parameters

extents [out] Receives the WCS extents.

Returns: Returns eOk if successful or an appropriate error code if not.

Remarks: The default implementation of this function always returns eInvalidExtents.

Reimplemented from OdGiDrawable.

◆ getINSBASE()

const OdGePoint3d & OdDbLayout::getINSBASE ( ) const

Returns the insertion base for this Layout object (DXF 12).

◆ getLayoutName()

OdString OdDbLayout::getLayoutName ( ) const

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

◆ getLIMCHECK()

bool OdDbLayout::getLIMCHECK ( ) const

Returns the LIMCHECK variable for this Layout object (DXF 70, bit 0x02).

◆ getLIMMAX()

const OdGePoint2d & OdDbLayout::getLIMMAX ( ) const

Returns the maximum limits for this Layout object (DXF 11).

◆ getLIMMIN()

const OdGePoint2d & OdDbLayout::getLIMMIN ( ) const

Returns the minimum limits for this Layout object (DXF 10).

◆ getPreviewImage()

OdGiRasterImagePtr OdDbLayout::getPreviewImage ( ) const

Returns the preview image associated with the layout object.

Remarks: Layout previews are stored as .png images. To create layout preview, the Drawings requires Raster Services module supporting .png format.

◆ getPSLTSCALE()

bool OdDbLayout::getPSLTSCALE ( ) const

Returns the PSLTSCALE variable for this Layout object (DXF 70, bit 0x01).

◆ getTabOrder()

int OdDbLayout::getTabOrder ( ) const

Returns the tab order for this Layout object (DXF 71).

Remarks: The tab order determines the order in which layout tabs are to be displayed.

◆ getTabSelected()

bool OdDbLayout::getTabSelected ( ) const

Returns true if and only if this layout tab is selected.

◆ getViewportArray()

OdDbObjectIdArray OdDbLayout::getViewportArray ( ) const

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).

◆ overallVportId()

OdDbObjectId OdDbLayout::overallVportId ( ) const

Returns the Object ID of the overall viewport of this Layout object.

◆ setActiveViewportId()

void OdDbLayout::setActiveViewportId ( OdDbObjectId viewportId )

Makes the specified viewport the active viewport of this Layout object (DXF 331).

Parameters

viewportId [in] Object ID of the active viewport.

◆ setAnnoAllVisible()

void OdDbLayout::setAnnoAllVisible ( bool newVal )

◆ setBlockTableRecordId()

virtual void OdDbLayout::setBlockTableRecordId ( const OdDbObjectId & blockTableRecordId )

virtual

Associates this Layout object with the specified PaperSpace OdDbBlockTableRecord (DXF 330).

Parameters

blockTableRecordId [in] Block table record Object Id.

◆ setEXTMAX()

void OdDbLayout::setEXTMAX ( const OdGePoint3d & extMax )

Sets the maximum extents for this Layout object (DXF 15).

Parameters

extMax [in] Maximum extents.

◆ setEXTMIN()

void OdDbLayout::setEXTMIN ( const OdGePoint3d & extMin )

Sets the minimum extents for this Layout object (DXF 14).

Parameters

extMin [in] Minimum extents.

◆ setINSBASE()

void OdDbLayout::setINSBASE ( const OdGePoint3d & insBase )

Sets the insertion base for this Layout object (DXF 12).

Parameters

insBase [in] Insertion base.

◆ setLayoutName()

virtual void OdDbLayout::setLayoutName ( const OdString & layoutName )

virtual

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

Parameters

layoutName [in] Layout name.

◆ setLIMCHECK()

void OdDbLayout::setLIMCHECK ( bool limCheck )

Sets the LIMCHECK variable for this Layout object (DXF 70, bit 0x02).

Parameters

limCheck [in] LIMCHECK variable.

◆ setLIMMAX()

void OdDbLayout::setLIMMAX ( const OdGePoint2d & limMax )

Sets the maximum limits for this Layout object (DXF 11).

Parameters

limMax [in] Maximum limits.

◆ setLIMMIN()

void OdDbLayout::setLIMMIN ( const OdGePoint2d & limMin )

Sets the minimum limits for this Layout object (DXF 10).

Parameters

limMin [in] Minimum limits.

◆ setPreviewImage()

void OdDbLayout::setPreviewImage ( const OdGiRasterImage * image )

Sets a new preview image for the layout object.

Parameters

image [in] A pointer to an OdGiRasterImage object to be set as a new preivew thumbnail.

Remarks: Layout previews are stored as .png images. To create layout preview, the Drawings requires Raster Services module supporting .png format.

◆ setPSLTSCALE()

void OdDbLayout::setPSLTSCALE ( bool psLtScale )

Sets the PSLTSCALE variable for this Layout object (DXF 70, bit 0x01).

Parameters

psLtScale [in] PSLTSCALE variable.

◆ setTabOrder()

virtual void OdDbLayout::setTabOrder ( int tabOrder )

virtual

Sets the tab order for this Layout Object (DXF 71).

Parameters

tabOrder [in] Tab order.

Remarks: The tab order determines the order in which layout tabs are to be displayed.

Tab order should be sequential for all Layout objects in the database.

◆ setTabSelected()

virtual void OdDbLayout::setTabSelected ( bool tabSelected )

virtual

Controls the selected status for this Layout object.

Parameters

tabSelected [in] Controls selected status.

Remarks: Selected Layout objects are included in selection sets for operations effecting multiple layouts.

◆ setThumbnailBitmap()

void OdDbLayout::setThumbnailBitmap	(	const void *	pBMPData,
		OdUInt32	dataLength
	)

Sets the thumbnail bitmap associated with this layout object.

Remarks: The thumbnail is in Windows BITMAPINFO* format.

Parameters

dataLength	[in] Data length of the thumbnail.
pBMPData	[in] Pointer to the bitmap data.

◆ subClose()

void OdDbLayout::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 OdDbPlotSettings.

◆ subGetClassID()

virtual OdResult OdDbLayout::subGetClassID ( void * pClsid ) const

virtual

Reimplemented from OdDbPlotSettings.

◆ subSetAttributes()

OdUInt32 OdDbLayout::subSetAttributes ( OdGiDrawableTraits * pTraits ) const

virtual

Sets the values of this object's subentity traits, and returns with the calling object's subentity traits.

Parameters

pTraits [in] Pointer to the OdGiDrawableTraits object to be set.

Remarks: When overriding subSetAttributes(), you must OR (|) the return value of <base class>::subSetAttributes(pTraits) with any flags you add.

A derived class may not remove flags for any reason.

The default implementation does nothing but returns kDrawableNone. This function can be overridden in custom classes.

Reimplemented from OdDbObject.

◆ subViewportDraw()

void OdDbLayout::subViewportDraw ( OdGiViewportDraw * vPd ) const

virtual

Reimplemented from OdDbObject.

◆ subWorldDraw()

bool OdDbLayout::subWorldDraw ( OdGiWorldDraw * pWd ) const

virtual

Reimplemented from OdDbObject.

◆ thumbnailBitmap()

const void * OdDbLayout::thumbnailBitmap ( OdUInt32 & dataLength ) const

Returns the thumbnail bitmap associated with this layout object.

Remarks: The thumbnail is in Windows BITMAPINFO* format.

Parameters

dataLength [out] Receives the data length of the thumbnail.

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

DbLayout.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OdDbLayout()

Member Function Documentation

◆ activeViewportId()

◆ addToLayoutDict()

◆ annoAllVisible()

◆ appendToOwner()

◆ dwgInFields()

◆ DWGMAP_DECLARE_MEMBERS()

◆ dwgOutFields()

◆ dxfInFields()

◆ dxfOutFields()

◆ getBlockTableRecordId()

◆ getEXTMAX()

◆ getEXTMIN()

◆ getGeomExtents()

◆ getINSBASE()

◆ getLayoutName()

◆ getLIMCHECK()

◆ getLIMMAX()

◆ getLIMMIN()

◆ getPreviewImage()

◆ getPSLTSCALE()

◆ getTabOrder()

◆ getTabSelected()

◆ getViewportArray()

◆ overallVportId()

◆ setActiveViewportId()

◆ setAnnoAllVisible()

◆ setBlockTableRecordId()

◆ setEXTMAX()

◆ setEXTMIN()

◆ setINSBASE()

◆ setLayoutName()

◆ setLIMCHECK()

◆ setLIMMAX()

◆ setLIMMIN()

◆ setPreviewImage()

◆ setPSLTSCALE()

◆ setTabOrder()

◆ setTabSelected()

◆ setThumbnailBitmap()

◆ subClose()

◆ subGetClassID()

◆ subSetAttributes()

◆ subViewportDraw()

◆ subWorldDraw()

◆ thumbnailBitmap()