#include <DbBaseDatabase.h>

Inheritance diagram for OdDbBaseDatabasePE:

Classes
class	DatabaseUnloadReactor

Public Types
enum	ExtentsFlags { kZeroFlags = 0 , kExactExtents = 1 , kUseViewExtents = 2 , kUseGivenExtents = 4 , kUseGivenView = 8 , kIncludeOffLayers = 16 , kClipDisabled = 0x10000000 }

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdDbBaseDatabasePE)

virtual OdDbBaseHostAppServices *	appServices (OdDbBaseDatabase *pDb) const =0

virtual OdString	getFilename (OdDbBaseDatabase *pDb) const =0

virtual void	startTransaction (OdDbBaseDatabase *pDb)=0

virtual void	abortTransaction (OdDbBaseDatabase *pDb)=0

virtual OdResult	startUndoRecord (OdDbBaseDatabase *pDb)=0

virtual OdResult	evaluateFields (OdDbBaseDatabase *pDb, int nContext)=0

virtual OdResult	undo (OdDbBaseDatabase *pDb)=0

virtual OdGiDefaultContextPtr	createGiContext (OdDbBaseDatabase *pDb) const =0

virtual void	putNamedViewInfo (OdDbBaseDatabase pDb, OdDbStub layoutId, OdStringArray &names, OdGePoint3dArray &points, const OdGsDevice *pDevice=0)=0

virtual OdBaseTextIteratorPtr	createTextIterator (OdDbBaseDatabase db, const OdChar textString, int length, bool raw, const OdGiTextStyle *pTextStyle) const =0

virtual OdGsDevicePtr	setupActiveLayoutViews (OdGsDevice pDevice, OdGiDefaultContext pGiCtx)=0

virtual OdGsDevicePtr	setupLayoutView (OdGsDevice pDevice, OdGiDefaultContext pGiCtx, OdDbStub *layoutId)=0

virtual void	setupPalette (OdGsDevice device, OdGiDefaultContext giContext, OdDbStub *layoutId=0, ODCOLORREF palBg=ODRGBA(0, 0, 0, 0))=0

virtual OdDbStub *	getNextViewForActiveLayout (OdGiDefaultContext pGiCtx, OdDbStub )=0

virtual void	applyLayoutSettings (OdGsDCRect &clipBox, OdGsDevice pDevice, OdDbBaseDatabase db, OdUInt32 extentsFlags=kZeroFlags, OdUInt32 dpi=72)=0

virtual void	zoomToExtents (const OdGsDCRect &outputRect, OdGsDevice pDevice, OdDbBaseDatabase db, OdGeBoundBlock3d &plotExtents, OdUInt32 extentsFlags=kZeroFlags, OdDbStub *objectId=NULL)=0

virtual void	loadPlotstyleTableForActiveLayout (OdGiDefaultContext pDwgContext, OdDbBaseDatabase db)=0

virtual bool	isContextDependentLayers (OdDbBaseDatabase *) const

virtual OdRxIteratorPtr	layers (OdDbBaseDatabase *db) const =0

virtual OdRxIteratorPtr	layers (OdDbBaseDatabase db, OdGiContext ) const

virtual OdRxIteratorPtr	visualStyles (OdDbBaseDatabase *db) const =0

virtual OdDbStub *	getVisualStyleId (OdDbBaseDatabase *db, const OdString &name) const =0

OdRxObjectPtr	currentLayout (OdDbBaseDatabase *pDb)

virtual void	setCurrentLayout (OdDbBaseDatabase *db, const OdString &name)=0

virtual void	setCurrentLayoutId (OdDbBaseDatabase pDb, OdDbStub id)=0

virtual OdRxIteratorPtr	layouts (OdDbBaseDatabase *db) const =0

virtual OdRxObjectPtr	getLayout (OdDbBaseDatabase *pDb, const OdString &name)

OdRxObjectPtr	findLayoutByViewport (OdDbBaseDatabase db, OdDbStub pViewportId)

virtual OdDbStub *	findLayoutIdByViewport (OdDbBaseDatabase db, OdDbStub pViewportId)=0

virtual OdDbStub *	findLayoutNamed (OdDbBaseDatabase *db, const OdString &name)=0

OdRxObjectPtr	getFirstLayout (OdDbBaseDatabase *db)

virtual OdDbStub *	getFirstLayoutId (OdDbBaseDatabase *db)=0

virtual OdTimeStamp	getCreationTime (OdDbBaseDatabase *db)=0

virtual OdTimeStamp	getUpdateTime (OdDbBaseDatabase *db)=0

virtual OdString	getFingerPrintGuid (OdDbBaseDatabase *db)=0

virtual OdString	getVersionGuid (OdDbBaseDatabase *db)=0

virtual int	getUnits (OdDbBaseDatabase *db)=0

virtual OdUnitsFormatter *	baseFormatter (OdDbBaseDatabase *db)=0

virtual int	getMeasurement (OdDbBaseDatabase *db)=0

virtual bool	getLineTypeById (OdDbBaseDatabase db, OdDbStub pLTypeId, OdGiLinetype &LType)=0

virtual bool	getTextStyleById (OdDbBaseDatabase db, OdDbStub idStyle, OdGiTextStyle &shapeInfo)=0

virtual OdDbStub *	getId (const OdRxObject *obj) const =0

virtual OdDbStub *	getObject (OdDbBaseDatabase *db, OdUInt64 handle)=0

virtual OdDbHandle	getHandle (OdDbStub *id)

virtual OdDbBaseDatabase *	getDatabase (OdDbStub *id)

virtual OdDbStub *	getOwner (OdDbStub *id)

virtual OdCodePageId	getCodePage (OdDbBaseDatabase *db)=0

virtual OdDbStub *	getModelBlockId (OdDbBaseDatabase *pDb)=0

virtual OdDbStub *	getPaperBlockId (OdDbBaseDatabase *pDb)=0

virtual OdDbStub *	currentLayoutId (OdDbBaseDatabase *pDb)=0

virtual OdDbStub *	xrefBlockId (OdDbBaseDatabase *pDb)=0

virtual void	setMultiThreadedRender (OdDbBaseDatabase *pDb, bool bOn)=0

virtual bool	isExclusiveReadingEnabled (const OdDbBaseDatabase *pDb)=0

virtual bool	isAProxy (OdRxObject *pDrw)=0

virtual OdRxObjectPtr	openObject (OdDbStub *pId)=0

virtual OdRxObjectPtr	openObject (OdDbStub *pId, bool bForWrite)=0

virtual bool	upgradeOpen (OdRxObject *pObj)=0

virtual void	downgradeOpen (OdRxObject *pObj)=0

virtual bool	getAnnoScaleSet (OdDbStub *drawableId, OdGiAnnoScaleSet &res)=0

virtual OdDbStub *	getCurrentLongTransation (const OdDbBaseDatabase *pDb)=0

virtual OdRxObjectPtr	addDatabaseUnloadReactor (OdDbBaseDatabase pDb, OdRxObject pPrevReactor, DatabaseUnloadReactor *pReactorRedirect)=0

virtual void	removeDatabaseUnloadReactor (OdDbBaseDatabase pDb, OdRxObject pReactor)=0

virtual OdResult	faceConversionHelper (OdDbStub &material, OdDbBaseDatabase pSourceDb, OdDbBaseDatabase pDestinationDb, const OdGiMaterialTraits pMaterialTraits, const OdGiMapper pMaterialMapper=0, const OdCmEntityColor pMaterialColor=0)=0

virtual bool	getDatabasePartialViewingMode (OdDbBaseDatabase *) const

virtual OdRxObjectPtr	getGeoData (const OdDbBaseDatabase pDb, const OdGsDevice pDevice=0, const OdGsView *pView=0) const =0

virtual OdGiDefaultContextPtr	createFilteredGiContextForExport (OdDbBaseDatabase *pDb, const OdRxObjectPtr &pSSet) const =0

virtual OdInt16	getObscuredLtype (OdDbBaseDatabase &, OdInt16 &color) const

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
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)

static OdRxClass *	desc ()

static void	rxInit ()

static void	rxUninit ()

Detailed Description

This class is the base Protocol Extension class for database classes.

See also: TD_DbRoot <group OdDbRoot_Classes>

Definition at line 60 of file DbBaseDatabase.h.

Member Enumeration Documentation

◆ ExtentsFlags

enum OdDbBaseDatabasePE::ExtentsFlags

Determines extents parameter values.

Enumerator
kZeroFlags	No parameter flags are used.
kExactExtents	Zoom to extents exact to device/paper size without any margins if this flag is set.
kUseViewExtents	Use view extents instead of plot extents (default) for calculation of drawing extents if this flag is set.
kUseGivenExtents	Zoom to given extents
kUseGivenView	Use view from GsDevice to calculate extents
kIncludeOffLayers	Include entities from frozen and off layers to extents
kClipDisabled

Definition at line 70 of file DbBaseDatabase.h.

Member Function Documentation

◆ abortTransaction()

virtual void OdDbBaseDatabasePE::abortTransaction ( OdDbBaseDatabase * pDb )

pure virtual

Aborts (rolls back) the current database transaction.

Parameters

pDb	[in] A pointer to a database where the transaction should be aborted.

◆ addDatabaseUnloadReactor()

virtual OdRxObjectPtr OdDbBaseDatabasePE::addDatabaseUnloadReactor	(	OdDbBaseDatabase *	pDb,
		OdRxObject *	pPrevReactor,
		DatabaseUnloadReactor *	pReactorRedirect )

pure virtual

Adds a new database unload reactor object to a specified database.

Parameters

pDb	[in] A pointer to a database object.
pPrevReactor	[in] A pointer to a previous reactor object. If equal to NULL, then it is a new reactor.
pReactorRedirect	[in] A pointer to a database object.

Remarks: There can be more than one database unload reactor. When a database unload event occurs, reactors run according to the order they have been added.

◆ applyLayoutSettings()

virtual void OdDbBaseDatabasePE::applyLayoutSettings	(	OdGsDCRect &	clipBox,
		OdGsDevice *	pDevice,
		OdDbBaseDatabase *	db,
		OdUInt32	extentsFlags = kZeroFlags,
		OdUInt32	dpi = 72 )

pure virtual

Sets current layout plot settings (such as paper size, rotation, scale, etc.) to a specified Gs device.

Parameters

clipBox	[out] A visible rectangle to be returned.
pDevice	[in] A pointer to a device to apply plot settings to.
db	[in] A pointer to a drawing database.
extentsFlags	[in] Extents flags.
dpi	[in] Resolution value.

◆ appServices()

virtual OdDbBaseHostAppServices * OdDbBaseDatabasePE::appServices ( OdDbBaseDatabase * pDb ) const

pure virtual

Returns the OdDbBaseHostAppServices object associated with this database object.

◆ baseFormatter()

virtual OdUnitsFormatter * OdDbBaseDatabasePE::baseFormatter ( OdDbBaseDatabase * db )

pure virtual

Returns the current units formatter for the specified database.

Parameters

db	[in] A pointer to a database.

◆ createFilteredGiContextForExport()

virtual OdGiDefaultContextPtr OdDbBaseDatabasePE::createFilteredGiContextForExport	(	OdDbBaseDatabase *	pDb,
		const OdRxObjectPtr &	pSSet ) const

pure virtual

Creates a Gi context object for a specified database to export entities from selection set only.

Parameters

pDb	[in] A pointer to a database to create a context object for.
pSSet	[in] A pointer to a selection set

◆ createGiContext()

virtual OdGiDefaultContextPtr OdDbBaseDatabasePE::createGiContext ( OdDbBaseDatabase * pDb ) const

pure virtual

Creates a Gi context object for a specified database.

Parameters

pDb	[in] A pointer to a database to create a context object for.

◆ createTextIterator()

virtual OdBaseTextIteratorPtr OdDbBaseDatabasePE::createTextIterator	(	OdDbBaseDatabase *	db,
		const OdChar *	textString,
		int	length,
		bool	raw,
		const OdGiTextStyle *	pTextStyle ) const

pure virtual

Creates a TextIterator object for the specified data.

Parameters

textString	[in] Text string to be parsed.
length	[in] Length of string in bytes.
raw	[in] If and only if true, character sequences in the form of %c will be treated as raw text.
codePageId	[in] Object ID of the code page for the text.
pTextStyle	[in] Pointer to the TextStyle object associated with the specified text.

Returns: Returns a SmartPointer to the new OdDbTextIterator object.

◆ currentLayout()

OdRxObjectPtr OdDbBaseDatabasePE::currentLayout ( OdDbBaseDatabase * pDb )

inline

Returns the current layout for the specified database.

Parameters

pDb	[in] A pointer to a database.

Remarks: In this case the term "layout" means an abstraction that corresponds to a "sheet" in a sheet set manager, "page" in a .pdf or .dwf file, and "layout"+"block table record" in a .dwg file.

Definition at line 296 of file DbBaseDatabase.h.

◆ currentLayoutId()

virtual OdDbStub * OdDbBaseDatabasePE::currentLayoutId ( OdDbBaseDatabase * pDb )

pure virtual

Returns the identifier of the current layout for a specified database.

Parameters

db	[in] A pointer to a database.

◆ downgradeOpen()

virtual void OdDbBaseDatabasePE::downgradeOpen ( OdRxObject * pObj )

pure virtual

◆ evaluateFields()

virtual OdResult OdDbBaseDatabasePE::evaluateFields	(	OdDbBaseDatabase *	pDb,
		int	nContext )

pure virtual

Evaluates fields in database.

Parameters

pDb	[in] Pointer to the database for which fields are to be evaluated
nContext	[in] Input context in which the field is evaluated, which can be a predefined OdDbField::EvalContext enum flag or a user-defined context flag; this context flag is passed to the evaluator

◆ faceConversionHelper()

virtual OdResult OdDbBaseDatabasePE::faceConversionHelper	(	OdDbStub *&	material,
		OdDbBaseDatabase *	pSourceDb,
		OdDbBaseDatabase *	pDestinationDb,
		const OdGiMaterialTraits *	pMaterialTraits,
		const OdGiMapper *	pMaterialMapper = 0,
		const OdCmEntityColor *	pMaterialColor = 0 )

pure virtual

For internal usage only.

◆ findLayoutByViewport()

OdRxObjectPtr OdDbBaseDatabasePE::findLayoutByViewport	(	OdDbBaseDatabase *	db,
		OdDbStub *	pViewportId )

inline

Returns a layout related with a specified viewport from the specified database.

Parameters

db	[in] A pointer to a database.
pViewportId	[in] A viewport identifier.

Remarks: If a layout with the specified viewport is not found, a NULL pointer is returned.

Definition at line 345 of file DbBaseDatabase.h.

◆ findLayoutIdByViewport()

virtual OdDbStub * OdDbBaseDatabasePE::findLayoutIdByViewport	(	OdDbBaseDatabase *	db,
		OdDbStub *	pViewportId )

pure virtual

Returns a pointer to an identifier of a layout related to a specified viewport from the specified database.

Parameters

db	[in] A pointer to a database.
pViewportId	[in] A viewport identifier.

Remarks: If a layout related to the specified viewport is not found, a NULL pointer is returned.

◆ findLayoutNamed()

virtual OdDbStub * OdDbBaseDatabasePE::findLayoutNamed	(	OdDbBaseDatabase *	db,
		const OdString &	name )

pure virtual

Returns a pointer to an identifier of a layout with a specified name from the specified database.

Parameters

db	[in] A pointer to a database.
name	[in] A name of a layout.

Remarks: If a layout with the specified name is not found, a NULL pointer is returned.

◆ getAnnoScaleSet()

virtual bool OdDbBaseDatabasePE::getAnnoScaleSet	(	OdDbStub *	drawableId,
		OdGiAnnoScaleSet &	res )

pure virtual

◆ getCodePage()

virtual OdCodePageId OdDbBaseDatabasePE::getCodePage ( OdDbBaseDatabase * db )

pure virtual

Returns the code page identifier for a specified database.

Parameters

db	[in] A pointer to a database.

◆ getCreationTime()

virtual OdTimeStamp OdDbBaseDatabasePE::getCreationTime ( OdDbBaseDatabase * db )

pure virtual

Returns the specified database's creation date and time.

Parameters

db	[in] A pointer to a database.

◆ getCurrentLongTransation()

virtual OdDbStub * OdDbBaseDatabasePE::getCurrentLongTransation ( const OdDbBaseDatabase * pDb )

pure virtual

Returns an identifier of the current long transaction in a specified database.

Parameters

pId	[in] A pointer to a database.

◆ getDatabase()

virtual OdDbBaseDatabase * OdDbBaseDatabasePE::getDatabase ( OdDbStub * id )

virtual

Returns a pointer to a database that a specified object belongs to.

Parameters

id	[in] A database object identifier.

◆ getDatabasePartialViewingMode()

virtual bool OdDbBaseDatabasePE::getDatabasePartialViewingMode ( OdDbBaseDatabase * ) const

inlinevirtual

Returns database Partial Viewing Mode

Definition at line 590 of file DbBaseDatabase.h.

◆ getFilename()

virtual OdString OdDbBaseDatabasePE::getFilename ( OdDbBaseDatabase * pDb ) const

pure virtual

Returns the name of the file associated with this database object.

◆ getFingerPrintGuid()

virtual OdString OdDbBaseDatabasePE::getFingerPrintGuid ( OdDbBaseDatabase * db )

pure virtual

Returns the specified database's fingerprint GUID. The fingerprint GUID uniquely identifies the database. It is created when the database is created.

Parameters

db	[in] A pointer to a database.

◆ getFirstLayout()

OdRxObjectPtr OdDbBaseDatabasePE::getFirstLayout ( OdDbBaseDatabase * db )

inline

Returns a layout that is related to model space of the specified database.

Parameters

db	[in] A pointer to a database.

Definition at line 372 of file DbBaseDatabase.h.

◆ getFirstLayoutId()

virtual OdDbStub * OdDbBaseDatabasePE::getFirstLayoutId ( OdDbBaseDatabase * db )

pure virtual

Returns an identifier of a layout related to model space of the specified database.

Parameters

db	[in] A pointer to a database.

◆ getGeoData()

virtual OdRxObjectPtr OdDbBaseDatabasePE::getGeoData	(	const OdDbBaseDatabase *	pDb,
		const OdGsDevice *	pDevice = 0,
		const OdGsView *	pView = 0 ) const

pure virtual

Returns GeoData if it is available

Parameters

pDb	[in] A pointer to a database object.
pView	[in] A pointer to a view, which displays GeoSpatial information \params pDevice [in] A pointer to a device to render GeoSpatial information

◆ getHandle()

virtual OdDbHandle OdDbBaseDatabasePE::getHandle ( OdDbStub * id )

virtual

Returns a handle of an object using its identifier.

Parameters

id	[in] A database object identifier.

◆ getId()

virtual OdDbStub * OdDbBaseDatabasePE::getId ( const OdRxObject * obj ) const

pure virtual

Returns an object's identifier.

Parameters

obj	[in] A pointer to an object in a database.

◆ getLayout()

virtual OdRxObjectPtr OdDbBaseDatabasePE::getLayout	(	OdDbBaseDatabase *	pDb,
		const OdString &	name )

inlinevirtual

Returns a layout with a specified name from the specified database.

Parameters

pDb	[in] A pointer to a database.
name	[in] A name of a layout to be retrieved.

Remarks: If layout with the specified name is not found, NULL pointer is returned.

Definition at line 333 of file DbBaseDatabase.h.

◆ getLineTypeById()

virtual bool OdDbBaseDatabasePE::getLineTypeById	(	OdDbBaseDatabase *	db,
		OdDbStub *	pLTypeId,
		OdGiLinetype &	LType )

pure virtual

Searches for a linetype object by its identifier in the specified database.

Parameters

db	[in] A pointer to a database.
pLTypeId	[in] A linetype identifier to be searched for.
LType	[out] A reference to an OdGiLinetype object to store found linetype information.

Returns: Returns true if the linetype object was found with the specified identifier, otherwise returns false.

◆ getMeasurement()

virtual int OdDbBaseDatabasePE::getMeasurement ( OdDbBaseDatabase * db )

pure virtual

Returns the measurement system that is used for linetypes and hatches for the specified database.

Parameters

db	[in] A pointer to a database.

Remarks: See OdDb::MeasurementValue enumeration for additional information about valid measurement values.

◆ getModelBlockId()

virtual OdDbStub * OdDbBaseDatabasePE::getModelBlockId ( OdDbBaseDatabase * pDb )

pure virtual

Returns the identifier of the model space block for a specified database.

Parameters

db	[in] A pointer to a database.

◆ getNextViewForActiveLayout()

virtual OdDbStub * OdDbBaseDatabasePE::getNextViewForActiveLayout	(	OdGiDefaultContext *	pGiCtx,
		OdDbStub *	)

pure virtual

Gets the next view associated with the active layout.

Parameters

pGiCtx [in] A pointer to a default Gi context object.

Remarks: This functionality currently is not implemented.

◆ getObject()

virtual OdDbStub * OdDbBaseDatabasePE::getObject	(	OdDbBaseDatabase *	db,
		OdUInt64	handle )

pure virtual

Returns an identifier of a specified database object using its 64-bit handle.

Parameters

db	[in] A pointer to a database.
handle	[in] A database object handle.

◆ getObscuredLtype()

virtual OdInt16 OdDbBaseDatabasePE::getObscuredLtype	(	OdDbBaseDatabase &	,
		OdInt16 &	color ) const

inlinevirtual

Returns a value of the obscured linetype. Such linetype is designed for output of obscured lines in hidden views. An obscured line is a hidden line made visible by changing its color and linetype. Obscured linetype != 0 indicates that hidden lines should be drawn using linetype and color overrides as follows.

Linetypes:

Off
Solid ______________________________________________
Dashed __ __ __ __ __ __ __ __ __ __ __ __
Dotted . . . . . . . . . . . . . . . .
Short Dash __ __ __ __ __ __ __ __
Medium Dash ___ ___ ___ ___ ___ ___ ___ ___
Long Dash ____ ____ ____ ____ ____ ____ ____ ____
Double Short Dash ___ ___ ___ ___ ___
Double Medium Dash ______ ______ ______ ______ ______
Double Long Dash _________ _________ _________ _________
Medium Long Dash ____ ____ ____ ____ ____ ____ ____
Sparse Dot . . . . . . . . . Default value is 0 (off).

Colors:

Color is set ByBlock. 256 Color is set ByLayer. 257 Color is set ByEntity (or by object). 1-255 Color is based on ACI.

Default value is 257.

Parameters

pDb	[in] A reference to a database object.
color	[out] A color to override in obscured lines traits.

Returns: Obscured linetype value.

Definition at line 642 of file DbBaseDatabase.h.

◆ getOwner()

virtual OdDbStub * OdDbBaseDatabasePE::getOwner ( OdDbStub * id )

virtual

Returns an identifier of an owner object for a specified database object.

Parameters

id	[in] A database object identifier.

◆ getPaperBlockId()

virtual OdDbStub * OdDbBaseDatabasePE::getPaperBlockId ( OdDbBaseDatabase * pDb )

pure virtual

Returns the identifier of the paper space block for a specified database.

Parameters

db	[in] A pointer to a database.

◆ getTextStyleById()

virtual bool OdDbBaseDatabasePE::getTextStyleById	(	OdDbBaseDatabase *	db,
		OdDbStub *	idStyle,
		OdGiTextStyle &	shapeInfo )

pure virtual

Searches for a text style object by its identifier in the specified database.

Parameters

db	[in] A pointer to a database.
pLTypeId	[in] A text style identifier to be searched for.
LType	[out] A reference to an OdGiTextStyle object to store found text style information.

Returns: Returns true if the text style object was found with the specified identifier, otherwise returns false.

◆ getUnits()

virtual int OdDbBaseDatabasePE::getUnits ( OdDbBaseDatabase * db )

pure virtual

Returns the drawing units that are used for automatic scaling of blocks, xrefs and images that are inserted into or attached to the specified database.

Parameters

db	[in] A pointer to a database.

Remarks: See OdDb::UnitsValue enumeration for additional information about units.

◆ getUpdateTime()

virtual OdTimeStamp OdDbBaseDatabasePE::getUpdateTime ( OdDbBaseDatabase * db )

pure virtual

Returns the specified database's last update date and time.

Parameters

db	[in] A pointer to a database.

◆ getVersionGuid()

virtual OdString OdDbBaseDatabasePE::getVersionGuid ( OdDbBaseDatabase * db )

pure virtual

Returns the specified database's version GUID. The version GUID uniquely identifies the database version. It is updated each time database changes are saved.

Parameters

db	[in] A pointer to a database.

◆ getVisualStyleId()

virtual OdDbStub * OdDbBaseDatabasePE::getVisualStyleId	(	OdDbBaseDatabase *	db,
		const OdString &	name ) const

pure virtual

Returns an object identifier of a visual style with a specified name from a specified database.

Parameters

db	[in] A pointer to a database, from which the visual style data will be retrieved.
name	[in] A visual style name.

Returns: Returns the visual style object identifier if it was found or OdDbObjectId::kNull value in the other case.

◆ isAProxy()

virtual bool OdDbBaseDatabasePE::isAProxy ( OdRxObject * pDrw )

pure virtual

Determines whether a specified object is a proxy object.

Returns: Returns true if the object is a proxy one, otherwise returns false.

◆ isContextDependentLayers()

virtual bool OdDbBaseDatabasePE::isContextDependentLayers ( OdDbBaseDatabase * ) const

inlinevirtual

Checks whether layer properties (visibility, color, line type, line weight) depend on current Gi context.

Parameters

db	[in] A pointer to a drawing database from which the method retrieves information about layers.

Returns: True if layer properties depend on current Gi context, false otherwise.

Definition at line 248 of file DbBaseDatabase.h.

◆ isExclusiveReadingEnabled()

virtual bool OdDbBaseDatabasePE::isExclusiveReadingEnabled ( const OdDbBaseDatabase * pDb )

pure virtual

◆ layers() [1/2]

virtual OdRxIteratorPtr OdDbBaseDatabasePE::layers ( OdDbBaseDatabase * db ) const

pure virtual

Returns a smart pointer to the iterator of the specified database's layers.

Parameters

db	[in] A pointer to a drawing database, from which the method retrieves information about layers.

◆ layers() [2/2]

virtual OdRxIteratorPtr OdDbBaseDatabasePE::layers	(	OdDbBaseDatabase *	db,
		OdGiContext *	) const

inlinevirtual

Returns a smart pointer to the iterator of the specified database's layers for layer context-dependent databases.

Parameters

db	[in] A pointer to a drawing database, from which the method retrieves information about layers.
pContext	[in] A pointer to a Gi context, from which the method retrieves information about layers.

Returns: Smart pointer to iterate through found layers.

Definition at line 268 of file DbBaseDatabase.h.

◆ layouts()

virtual OdRxIteratorPtr OdDbBaseDatabasePE::layouts ( OdDbBaseDatabase * db ) const

pure virtual

Returns layouts for the specified database.

Parameters

db	[in] A pointer to a database.

Returns: Returns an iterator for accessing the layout objects dictionary.

◆ loadPlotstyleTableForActiveLayout()

virtual void OdDbBaseDatabasePE::loadPlotstyleTableForActiveLayout	(	OdGiDefaultContext *	pDwgContext,
		OdDbBaseDatabase *	db )

pure virtual

Loads plot styles of the active layout to a specified Gi context object.

Parameters

pDwgContext	[in] A pointer to a Gi context object. Plot styles will be loaded into it.
db	[in] A pointer to a drawing database.

◆ ODRX_DECLARE_MEMBERS()

OdDbBaseDatabasePE::ODRX_DECLARE_MEMBERS ( OdDbBaseDatabasePE )

◆ openObject() [1/2]

virtual OdRxObjectPtr OdDbBaseDatabasePE::openObject ( OdDbStub * pId )

pure virtual

Returns a smart pointer to the object determined with its identifier.

Parameters

pId	[in] A pointer to an object's identifier.

◆ openObject() [2/2]

virtual OdRxObjectPtr OdDbBaseDatabasePE::openObject	(	OdDbStub *	pId,
		bool	bForWrite )

pure virtual

◆ putNamedViewInfo()

virtual void OdDbBaseDatabasePE::putNamedViewInfo	(	OdDbBaseDatabase *	pDb,
		OdDbStub *	layoutId,
		OdStringArray &	names,
		OdGePoint3dArray &	points,
		const OdGsDevice *	pDevice = 0 )

pure virtual

Retrieves information about viewports for a specified database and layout.

\params pDb [in] A pointer to a database. \params layoutId [in] A layout identifier. \params names [out] An array of viewport names. Filled and returned by the method. \params points [out] An array of viewport points. Filled and returned by the method. \params pDevice [in] The device to find only the views, which device is able to render

◆ removeDatabaseUnloadReactor()

virtual void OdDbBaseDatabasePE::removeDatabaseUnloadReactor	(	OdDbBaseDatabase *	pDb,
		OdRxObject *	pReactor )

pure virtual

Removes a database unload reactor from a specified database. This method should be reimplemented to provide a custom reaction for a database unload event.

Parameters

pDb	[in] A pointer to a database object.
pReactor	[in] A pointer to a reactor object to be removed.

◆ setCurrentLayout()

virtual void OdDbBaseDatabasePE::setCurrentLayout	(	OdDbBaseDatabase *	db,
		const OdString &	name )

pure virtual

Sets the current layout for the specified database.

Parameters

db	[in] A pointer to a database.
name	[in] A name of a layout to be set as current.

◆ setCurrentLayoutId()

virtual void OdDbBaseDatabasePE::setCurrentLayoutId	(	OdDbBaseDatabase *	pDb,
		OdDbStub *	id )

pure virtual

Sets the current layout for the specified database.

Parameters

db	[in] A pointer to a database.
id	[in] A ID of a layout to be set as current.

◆ setMultiThreadedRender()

virtual void OdDbBaseDatabasePE::setMultiThreadedRender	(	OdDbBaseDatabase *	pDb,
		bool	bOn )

pure virtual

Switches multi-threaded rendering on or off for a specified database.

Parameters

db	[in] A pointer to a database.
bOn	[in] A value to be set (true if you want to switch multi-threaded rendering on or false in the other case).

◆ setupActiveLayoutViews()

virtual OdGsDevicePtr OdDbBaseDatabasePE::setupActiveLayoutViews	(	OdGsDevice *	pDevice,
		OdGiDefaultContext *	pGiCtx )

pure virtual

Sets up Gs views for a specified device, according to the active database layout data.

Parameters

pDevice	[in] A pointer to the device.
pGiCtx	[in] A pointer to the Gi context object with active layout data.

Returns: A smart pointer to an OdGsDevice object with views set up.

◆ setupLayoutView()

virtual OdGsDevicePtr OdDbBaseDatabasePE::setupLayoutView	(	OdGsDevice *	pDevice,
		OdGiDefaultContext *	pGiCtx,
		OdDbStub *	layoutId )

pure virtual

Sets up Gs views for a specified device according to the specified database layout data.

Parameters

pDevice	[in] A pointer to a device.
pGiCtx	[in] A pointer to a Gi context object with active layout data.
pGiCtx	[in] A pointer to a database layout identifier.

Returns: A smart pointer to an OdGsDevice object with view set up.

◆ setupPalette()

virtual void OdDbBaseDatabasePE::setupPalette	(	OdGsDevice *	device,
		OdGiDefaultContext *	giContext,
		OdDbStub *	layoutId = 0,
		ODCOLORREF	palBg = ODRGBA(0, 0, 0, 0) )

pure virtual

Sets up a palette associated with a specified device layout.

Parameters

device	[in] A pointer to a device.
giContext	[in] A pointer to a Gi context.
pGiCtx	[in] A pointer to a database layout identifier.
palBg	[in] A background color of the palette.

Remarks: To overwrite the default DB-palette color, use a non-zero value for the alpha component of RGBA color.

◆ startTransaction()

virtual void OdDbBaseDatabasePE::startTransaction ( OdDbBaseDatabase * pDb )

pure virtual

Starts a database transaction.

Parameters

pDb	[in] A pointer to a database where the transaction should be started.

◆ startUndoRecord()

virtual OdResult OdDbBaseDatabasePE::startUndoRecord ( OdDbBaseDatabase * pDb )

pure virtual

Starts undo recording of this database object.

◆ undo()

virtual OdResult OdDbBaseDatabasePE::undo ( OdDbBaseDatabase * pDb )

pure virtual

Performs an undo operation on this database object.

Remarks: All operations performed since the last call to startUndoRecording will be undone. At least 1 undo step is always supported for internal needs.

◆ upgradeOpen()

virtual bool OdDbBaseDatabasePE::upgradeOpen ( OdRxObject * pObj )

pure virtual

◆ visualStyles()

virtual OdRxIteratorPtr OdDbBaseDatabasePE::visualStyles ( OdDbBaseDatabase * db ) const

pure virtual

Returns a smart pointer to the iterator of the specified database's visual styles.

Parameters

db	[in] A pointer to a drawing database, from which the method retrieves information about visual styles.

◆ xrefBlockId()

virtual OdDbStub * OdDbBaseDatabasePE::xrefBlockId ( OdDbBaseDatabase * pDb )

pure virtual

Returns the identifier of the XRef block for a specified database.

Parameters

db	[in] A pointer to a database.

◆ zoomToExtents()

virtual void OdDbBaseDatabasePE::zoomToExtents	(	const OdGsDCRect &	outputRect,
		OdGsDevice *	pDevice,
		OdDbBaseDatabase *	db,
		OdGeBoundBlock3d &	plotExtents,
		OdUInt32	extentsFlags = kZeroFlags,
		OdDbStub *	objectId = NULL )

pure virtual

Makes the specified Gs device render the current layout zoomed to extents.

Parameters

outputRect	[in] A rectangle, which determines the printable area in device units.
pDevice	[in] A pointer to a device to render the current layout with.
db	[in] A pointer to a drawing database.
plotExtents	[in/out] Eye coordinate system plotting extents of the device viewport.
extentsFlags	[in] Extents flags.
objectId	[in] Object identifier.

Remarks: If no viewport is found, the method throws an exception. plotExtents will be used to zoomExtents if kUseGivenExtents flag is set, otherwise they will be calculated

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

DbBaseDatabase.h

Classes

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ExtentsFlags

Member Function Documentation

◆ abortTransaction()

◆ addDatabaseUnloadReactor()

◆ applyLayoutSettings()

◆ appServices()

◆ baseFormatter()

◆ createFilteredGiContextForExport()

◆ createGiContext()

◆ createTextIterator()

◆ currentLayout()

◆ currentLayoutId()

◆ downgradeOpen()

◆ evaluateFields()

◆ faceConversionHelper()

◆ findLayoutByViewport()

◆ findLayoutIdByViewport()

◆ findLayoutNamed()

◆ getAnnoScaleSet()

◆ getCodePage()

◆ getCreationTime()

◆ getCurrentLongTransation()

◆ getDatabase()

◆ getDatabasePartialViewingMode()

◆ getFilename()

◆ getFingerPrintGuid()

◆ getFirstLayout()

◆ getFirstLayoutId()

◆ getGeoData()

◆ getHandle()

◆ getId()

◆ getLayout()

◆ getLineTypeById()

◆ getMeasurement()

◆ getModelBlockId()

◆ getNextViewForActiveLayout()

◆ getObject()

◆ getObscuredLtype()

◆ getOwner()

◆ getPaperBlockId()

◆ getTextStyleById()

◆ getUnits()

◆ getUpdateTime()

◆ getVersionGuid()

◆ getVisualStyleId()

◆ isAProxy()

◆ isContextDependentLayers()

◆ isExclusiveReadingEnabled()

◆ layers() [1/2]

◆ layers() [2/2]

◆ layouts()

◆ loadPlotstyleTableForActiveLayout()

◆ ODRX_DECLARE_MEMBERS()

◆ openObject() [1/2]

◆ openObject() [2/2]

◆ putNamedViewInfo()

◆ removeDatabaseUnloadReactor()

◆ setCurrentLayout()

◆ setCurrentLayoutId()

◆ setMultiThreadedRender()

◆ setupActiveLayoutViews()

◆ setupLayoutView()

◆ setupPalette()

◆ startTransaction()

◆ startUndoRecord()

◆ undo()

◆ upgradeOpen()

◆ visualStyles()

◆ xrefBlockId()

◆ zoomToExtents()