CFx SDK Documentation
2022 SP0
|
#include <DbBaseDatabase.h>
Classes | |
class | DatabaseUnloadReactor |
Public Types | |
enum | ExtentsFlags { kZeroFlags = 0 , kExactExtents = 1 , kUseViewExtents = 2 , kClipDisabled = 0x10000000 } |
Additional Inherited Members | |
Static Public Member Functions inherited from OdRxObject | |
static OdRxObjectPtr | cast (const OdRxObject *pointer) |
static OdRxClass * | desc () |
This class is the base Protocol Extension class for database classes.
Definition at line 59 of file DbBaseDatabase.h.
Determines extents parameter values.
Definition at line 69 of file DbBaseDatabase.h.
|
pure virtual |
Aborts (rolls back) the current database transaction.
pDb | [in] A pointer to a database where the transaction should be aborted. |
|
pure virtual |
Adds a new database unload reactor object to a specified database.
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. |
|
pure virtual |
Sets current layout plot settings (such as paper size, rotation, scale, etc.) to a specified Gs device.
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. |
|
pure virtual |
Returns the OdDbBaseHostAppServices object associated with this database object.
|
pure virtual |
Returns the current units formatter for the specified database.
db | [in] A pointer to a database. |
|
pure virtual |
Creates a Gi context object for a specified database.
pDb | [in] A pointer to a database to create a context object for. |
|
pure virtual |
Creates a TextIterator object for the specified data.
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. |
|
inline |
Returns the current layout for the specified database.
pDb | [in] A pointer to a database. |
Definition at line 239 of file DbBaseDatabase.h.
|
pure virtual |
Returns the identifier of the current layout for a specified database.
db | [in] A pointer to a database. |
|
inline |
Returns a layout related with a specified viewport from the specified database.
db | [in] A pointer to a database. |
pViewportId | [in] A viewport identifier. |
Definition at line 280 of file DbBaseDatabase.h.
|
pure virtual |
Returns a pointer to an identifier of a layout related to a specified viewport from the specified database.
db | [in] A pointer to a database. |
pViewportId | [in] A viewport identifier. |
|
pure virtual |
Returns a pointer to an identifier of a layout with a specified name from the specified database.
db | [in] A pointer to a database. |
name | [in] A name of a layout. |
|
pure virtual |
|
pure virtual |
Returns the code page identifier for a specified database.
db | [in] A pointer to a database. |
|
pure virtual |
Returns the specified database's creation date and time.
db | [in] A pointer to a database. |
|
pure virtual |
Returns an identifier of the current long transaction in a specified database.
pId | [in] A pointer to a database. |
|
virtual |
Returns a pointer to a database that a specified object belongs to.
id | [in] A database object identifier. |
|
pure virtual |
Returns the name of the file associated with this database object.
|
pure virtual |
Returns the specified database's fingerprint GUID. The fingerprint GUID uniquely identifies the database. It is created when the database is created.
db | [in] A pointer to a database. |
|
inline |
Returns a layout that is related to model space of the specified database.
db | [in] A pointer to a database. |
Definition at line 307 of file DbBaseDatabase.h.
|
pure virtual |
Returns an identifier of a layout related to model space of the specified database.
db | [in] A pointer to a database. |
|
virtual |
Returns a handle of an object using its identifier.
id | [in] A database object identifier. |
|
pure virtual |
Returns an object's identifier.
obj | [in] A pointer to an object in a database. |
|
inlinevirtual |
Returns a layout with a specified name from the specified database.
pDb | [in] A pointer to a database. |
name | [in] A name of a layout to be retrieved. |
Definition at line 268 of file DbBaseDatabase.h.
|
pure virtual |
Searches for a linetype object by its identifier in the specified database.
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. |
|
pure virtual |
Returns the measurement system that is used for linetypes and hatches for the specified database.
db | [in] A pointer to a database. |
|
pure virtual |
Returns the identifier of the model space block for a specified database.
db | [in] A pointer to a database. |
|
pure virtual |
Gets the next view associated with the active layout.
pGiCtx | [in] A pointer to a default Gi context object. |
|
pure virtual |
Returns an identifier of a specified database object using its 64-bit handle.
db | [in] A pointer to a database. |
handle | [in] A database object handle. |
|
virtual |
Returns an identifier of an owner object for a specified database object.
id | [in] A database object identifier. |
|
pure virtual |
Returns the identifier of the paper space block for a specified database.
db | [in] A pointer to a database. |
|
pure virtual |
Searches for a text style object by its identifier in the specified database.
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. |
|
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.
db | [in] A pointer to a database. |
|
pure virtual |
Returns the specified database's last update date and time.
db | [in] A pointer to a database. |
|
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.
db | [in] A pointer to a database. |
|
pure virtual |
Returns an object identifier of a visual style with a specified name from a specified database.
db | [in] A pointer to a database, from which the visual style data will be retrieved. |
name | [in] A visual style name. |
|
pure virtual |
Determines whether a specified object is a proxy object.
|
pure virtual |
Returns a smart pointer to the iterator of the specified database's layers.
db | [in] A pointer to a drawing database, from which the method retrieves information about layers. |
|
pure virtual |
Returns layouts for the specified database.
db | [in] A pointer to a database. |
|
pure virtual |
Loads plot styles of the active layout to a specified Gi context object.
pDwgContext | [in] A pointer to a Gi context object. Plot styles will be loaded into it. |
db | [in] A pointer to a drawing database. |
OdDbBaseDatabasePE::ODRX_DECLARE_MEMBERS | ( | OdDbBaseDatabasePE | ) |
|
pure virtual |
Returns a smart pointer to the object determined with its identifier.
pId | [in] A pointer to an object's identifier. |
|
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 layoutId [out] An array of viewport names. Filled and returned by the method. \params layoutId [out] An array of viewport points. Filled and returned by the method.
|
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.
pDb | [in] A pointer to a database object. |
pReactor | [in] A pointer to a reactor object to be removed. |
|
pure virtual |
Sets the current layout for the specified database.
db | [in] A pointer to a database. |
name | [in] A name of a layout to be set as current. |
|
pure virtual |
Switches multi-threaded rendering on or off for a specified database.
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). |
|
pure virtual |
Sets up Gs views for a specified device, according to the active database layout data.
pDevice | [in] A pointer to the device. |
pGiCtx | [in] A pointer to the Gi context object with active layout data. |
|
pure virtual |
Sets up Gs views for a specified device according to the specified database layout data.
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. |
|
pure virtual |
Sets up a palette associated with a specified device layout.
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. |
|
pure virtual |
Starts a database transaction.
pDb | [in] A pointer to a database where the transaction should be started. |
|
pure virtual |
Returns a smart pointer to the iterator of the specified database's visual styles.
db | [in] A pointer to a drawing database, from which the method retrieves information about visual styles. |
|
pure virtual |
Returns the identifier of the XRef block for a specified database.
db | [in] A pointer to a database. |
|
pure virtual |
Makes the specified Gs device render the current layout zoomed to extents.
outputRect | [out] 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 | [out] Eye coordinate system plotting extents of the device viewport. |
extentsFlags | [in] Extents flags. |
objectId | [in] Object identifier. |