#include <DbRasterVariables.h>
Static Public Member Functions | |
| static OdDbRasterVariablesPtr | openRasterVariables (OdDbDatabase *pDb, OdDb::OpenMode openMode=OdDb::kForRead) |
 Static Public Member Functions inherited from OdRxObject | |
| static OdRxObjectPtr | cast (const OdRxObject *pointer) |
| static OdRxClass * | desc () |
Additional Inherited Members | |
| 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 | subViewportDrawLogicalFlags (OdGiViewportDraw *vd) const |
| virtual OdUInt32 | subRegenSupportFlags () const |
| Protected Attributes inherited from OdDbObject | |
| OdDbObjectImpl * | m_pImpl |
Detailed Description
This class represents RasterVariables objects in an OdDbDatabase instance.
- See also
- TD_Db
- Remarks
- RasterVariables objects contain settings applicable to raster images.
A single instance of this class is stored with every OdDbDatabase that contains raster images.
<group OdDb_Classes>
Definition at line 50 of file DbRasterVariables.h.
Member Enumeration Documentation
◆ FrameSettings
| Enumerator | |
|---|---|
| kImageFrameInvalid | |
| kImageFrameOff | |
| kImageFrameAbove | |
| kImageFrameBelow | |
| kImageFrameOnNoPlot | |
Definition at line 58 of file DbRasterVariables.h.
◆ ImageQuality
| Enumerator | |
|---|---|
| kImageQualityInvalid | |
| kImageQualityDraft | |
| kImageQualityHigh | |
Definition at line 68 of file DbRasterVariables.h.
Constructor & Destructor Documentation
◆ OdDbRasterVariables()
| OdDbRasterVariables::OdDbRasterVariables | ( | ) |
Member Function Documentation
◆ dwgInFields()
|
virtual |
Reads the .dwg file data of this object.
- Parameters
-
pFiler [in] Filer object from which data are read.
- Returns
- Returns the filer status.
This function is called by dwgIn() to allow the object to read its data.
When overriding this function:
1) Call assertWriteEnabled(). 2) Call the parent class's dwgInFields(pFiler). 3) If it returns eOK, continue; otherwise return whatever the parent's dwgInFields(pFiler) returned. 4) Call the OdDbDwgFiler(pFiler) methods to read each of the object's data items in the order they were written. 5) Return pFiler->filerStatus().
Reimplemented from OdDbObject.
◆ dwgOutFields()
|
virtual |
Writes the .dwg file data of this object.
- Parameters
-
pFiler [in] Pointer to the filer to which data are written.
- Remarks
This function is called by dwgIn() to allow the object to write its data.
When overriding this function:
1) Call assertReadEnabled(). 2) Call the parent class's dwgOutFields(pFiler). 3) Call the OdDbDwgFiler(pFiler) methods to write each of the object's data items in the order they were written.
Reimplemented from OdDbObject.
◆ dxfInFields()
|
virtual |
Reads the DXF data of this object.
- Parameters
-
pFiler [in] Pointer to the filer from which data are read.
- Returns
- Returns the filer status.
This function is called by dxfIn() to allow the object to read its data.
When overriding this function:
1) Call assertWriteEnabled(). 2) Call the parent class's dwgInFields(pFiler). 3) If it returns eOK, continue; otherwise return whatever the parent's dxfInFields(pFiler) returned. 4) Call the OdDbDxfFiler(pFiler) methods to read each of the object's data items in the order they were written. 5) Return pFiler->filerStatus().
Reimplemented from OdDbObject.
◆ dxfOutFields()
|
virtual |
Writes the DXF data of this object.
- Parameters
-
pFiler [in] Pointer to the filer to which data are to be written.
- Remarks
This function is called by dxfOut() to allow the object to write its data.
When overriding this function:
1) Call assertReadEnabled(). 2) Call the parent class's dxfOutFields(pFiler). 4) Use pFiler to call the OdDbDxfFiler methods to write each of the object's data items in the order they were written.
Reimplemented from OdDbObject.
◆ imageFrame()
|
virtual |
Returns the image frame display (DXF 70).
- Remarks
- imageFrame() returns one of the following:
Value Description kImageFrameInvalid -1 Invalid kImageFrameOff 0 Frame is off kImageFrameAbove 1 Frame is above the image kImageFrameBelow 2 Frame is below the image
◆ imageQuality()
|
virtual |
Returns the image display quality (DXF 71).
- Remarks
- imageQuality() returns one of the following:
Value Description kImageQualityInvalid -1 Invalid kImageQualityDraft 0 Draft quality kImageQualityHigh 1 High quality
◆ ODDB_DECLARE_MEMBERS()
| OdDbRasterVariables::ODDB_DECLARE_MEMBERS | ( | OdDbRasterVariables | ) |
◆ openRasterVariables()
|
static |
Opens the RasterVariables object in the specified database. Creates a RasterVariables object if one does not exist.
- Parameters
-
openMode [in] Mode in which to open the RasterVariables object. pDb [in] Pointer to the database containg the RasterVariables object.
- Returns
- Returns a SmartPointer to the RasterVariables object.
◆ setImageFrame()
|
virtual |
Sets the image frame display (DXF 70).
- Parameters
-
imageFrame [in] Image frame display.
- Remarks
- imageFrame must be one of the following:
Value Description kImageFrameOff 0 Frame is off kImageFrameAbove 1 Frame is above the image kImageFrameBelow 2 Frame is below the image
◆ setImageQuality()
|
virtual |
Sets the image display quality (DXF 71).
- Parameters
-
imageQuality [in] Image Quality.
- Remarks
- imageQuality must be one of the following:
Value Description kImageQualityInvalid -1 Invalid kImageQualityDraft 0 Draft quality kImageQualityHigh 1 High quality
◆ setUserScale()
|
virtual |
Specifies the real-world units corresponding to drawing units (DXF 72).
- Parameters
-
units [in] Real-world units.
- Remarks
- units must be one of the following:
Value OdDbRasterImageDef::kNone 0 OdDbRasterImageDef::kMillimeter 1 OdDbRasterImageDef::kCentimeter 2 OdDbRasterImageDef::kMeter 3 OdDbRasterImageDef::kKilometer 4 OdDbRasterImageDef::kInch 5 OdDbRasterImageDef::kFoot 6 OdDbRasterImageDef::kYard 7 OdDbRasterImageDef::kMile 8 OdDbRasterImageDef::kMicroinches 9 OdDbRasterImageDef::kMils 10 OdDbRasterImageDef::kAngstroms 11 OdDbRasterImageDef::kNanometers 12 OdDbRasterImageDef::kMicrons 13 OdDbRasterImageDef::kDecimeters 14 OdDbRasterImageDef::kDekameters 15 OdDbRasterImageDef::kHectometers 16 OdDbRasterImageDef::kGigameters 17 OdDbRasterImageDef::kAstronomical 18 OdDbRasterImageDef::kLightYears 19 OdDbRasterImageDef::kParsecs 20
◆ userScale()
|
virtual |
Returns the real-world units corresponding to drawing units (DXF 72).
- Remarks
- units() returns one of the following:
Value OdDbRasterImageDef::kNone 0 OdDbRasterImageDef::kMillimeter 1 OdDbRasterImageDef::kCentimeter 2 OdDbRasterImageDef::kMeter 3 OdDbRasterImageDef::kKilometer 4 OdDbRasterImageDef::kInch 5 OdDbRasterImageDef::kFoot 6 OdDbRasterImageDef::kYard 7 OdDbRasterImageDef::kMile 8 OdDbRasterImageDef::kMicroinches 9 OdDbRasterImageDef::kMils 10 OdDbRasterImageDef::kAngstroms 11 OdDbRasterImageDef::kNanometers 12 OdDbRasterImageDef::kMicrons 13 OdDbRasterImageDef::kDecimeters 14 OdDbRasterImageDef::kDekameters 15 OdDbRasterImageDef::kHectometers 16 OdDbRasterImageDef::kGigameters 17 OdDbRasterImageDef::kAstronomical 18 OdDbRasterImageDef::kLightYears 19 OdDbRasterImageDef::kParsecs 20
The documentation for this class was generated from the following file: