#include <DbViewTableRecord.h>
Public Member Functions inherited from Detailed Description
This class represents View records in the OdDbViewTable in an OdDbDatabase instance.
<group OdDb_Classes>
Definition at line 42 of file DbViewTableRecord.h.
Constructor & Destructor Documentation
◆ OdDbViewTableRecord()
| OdDbViewTableRecord::OdDbViewTableRecord | ( | ) |
Member Function Documentation
◆ annotationScale()
| OdDbAnnotationScalePtr OdDbViewTableRecord::annotationScale | ( | ) | const |
◆ camera()
| OdDbObjectId OdDbViewTableRecord::camera | ( | ) | const |
◆ disassociateUcsFromView()
| void OdDbViewTableRecord::disassociateUcsFromView | ( | ) |
Disassociates any UCS associated with this View.
◆ 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 OdDbAbstractViewTableRecord.
◆ DWGMAP_DECLARE_MEMBERS()
| OdDbViewTableRecord::DWGMAP_DECLARE_MEMBERS | ( | OdDbViewTableRecord | ) |
◆ 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 OdDbAbstractViewTableRecord.
◆ 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 OdDbSymbolTableRecord.
◆ dxfInFields_R12()
|
virtual |
Reads the DXF R12 format data of this object.
- Parameters
-
pFiler [in] Pointer to the filer from which data are to be 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 dxfInFields_R12(pFiler). 3) If it returns eOK, continue; otherwise return whatever the parent's dxfOutFields_R12(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 OdDbSymbolTableRecord.
◆ dxfOutFields_R12()
|
virtual |
Writes the DXF data of this object.
- Parameters
-
pFiler [in] Pointer to the filer to which data are to be written.
- Returns
- Returns the filer status.
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). 3) Use pFiler to call the OdDbDxfFiler methods to write each of the object's data items in the order they were written.
Reimplemented from OdDbSymbolTableRecord.
◆ getCategoryName()
| OdString OdDbViewTableRecord::getCategoryName | ( | ) | const |
Returns the name of the category of this View.
◆ getLayerState()
| OdString OdDbViewTableRecord::getLayerState | ( | ) | const |
Returns the name of the layer state of this View.
◆ getLayout()
| OdDbObjectId OdDbViewTableRecord::getLayout | ( | ) | const |
Returns the Object ID of the OdDbLayout of this View.
◆ getThumbnail()
| void OdDbViewTableRecord::getThumbnail | ( | OdBinaryData * | pThumbnail | ) | const |
Returns the thumbnail information for this view.
- Parameters
-
pThumbnail [out] Receives a pointer to the thumbnail.
- Remarks
- Thumbnail information consists of a packed BITMAPINFO structure immediately followed in memory by the thumbnail data.
◆ isCameraPlottable()
| bool OdDbViewTableRecord::isCameraPlottable | ( | ) | const |
◆ isPaperspaceView()
| bool OdDbViewTableRecord::isPaperspaceView | ( | ) | const |
Returns true if and only if this View is a Paper Space view (DXF 70, bit 0x01).
◆ isUcsAssociatedToView()
| bool OdDbViewTableRecord::isUcsAssociatedToView | ( | ) | const |
Returns true if and only if there is a UCS associated with this View.
◆ isViewAssociatedToViewport()
| bool OdDbViewTableRecord::isViewAssociatedToViewport | ( | ) | const |
Returns true if and only if this View is associated with a Paper Space Viewport.
◆ liveSection()
| OdDbObjectId OdDbViewTableRecord::liveSection | ( | ) | const |
◆ setAnnotationScale()
| OdResult OdDbViewTableRecord::setAnnotationScale | ( | const OdDbAnnotationScale * | pScaleObj | ) |
◆ setCamera()
| void OdDbViewTableRecord::setCamera | ( | const OdDbObjectId & | cameraId | ) |
◆ setCategoryName()
Sets the name of the category of this View.
- Parameters
-
categoryName [in] Category name.
◆ setIsCameraPlottable()
| void OdDbViewTableRecord::setIsCameraPlottable | ( | bool | plottable | ) |
◆ setIsPaperspaceView()
| void OdDbViewTableRecord::setIsPaperspaceView | ( | bool | pspaceView | ) |
Controls if this View is a Paper Space view (DXF 70, bit 0x01).
- Parameters
-
pspaceView [in] True for Paper Space, false for Model space.
◆ setLayerState()
Sets the name of the layer state of this View.
- Parameters
-
layerStateName [in] Layer State name.
◆ setLayout()
| void OdDbViewTableRecord::setLayout | ( | OdDbObjectId | layoutId | ) |
Sets the Object ID of the Layout of this View.
- Parameters
-
layoutId [in] Layout ID.
◆ setLiveSection()
| void OdDbViewTableRecord::setLiveSection | ( | const OdDbObjectId & | liveSectionId | ) |
◆ setThumbnail()
| void OdDbViewTableRecord::setThumbnail | ( | const OdBinaryData * | pThumbnail | ) |
Sets the thumbnail information for this view.
- Parameters
-
pThumbnail [in] Pointer to the thumbnail.
- Remarks
- Thumbnail information consists of a packed BITMAPINFO structure immediately followed in memory by the thumbnail data.
◆ setViewAssociatedToViewport()
| void OdDbViewTableRecord::setViewAssociatedToViewport | ( | bool | viewAssociated | ) |
Controls if this View is associated with a Viewport.
- Parameters
-
viewAssociated [in] Controls association.
◆ 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 OdDbObject.
◆ subGetClassID()
Reimplemented from OdDbObject.
◆ subSwapIdWith()
|
virtual |
Called as the first operation of swapIdWith
- Parameters
-
otherId [in] Object ID to be swapped with this object's Object ID. swapXdata [in] If and only if true, extended data are swapped. swapExtDict [in] If and only if true, extension dictionaries are swapped.
- Remarks
- This function is notified just before an object is to be opened; giving this function the ability to cancel the object being swapped or perform necessary actions.
When overriding this function:
1) If the OdDbObject's state is incorrect, throw exception.
2) Call parent class's subSwapIdWith().
3) If other actions are required before swapping IDs, do them.
The default implementation of this function does nothing. This function can be overridden in custom classes.
Reimplemented from OdDbSymbolTableRecord.
The documentation for this class was generated from the following file: