#include <DbViewport.h>
Public Types inherited from Detailed Description
This class represents PaperSpace Viewport entities in an OdDbDatabase instance.
- See also
- TD_Db <group OdDb_Classes>
Definition at line 48 of file DbViewport.h.
Member Enumeration Documentation
◆ ShadePlotType
| Enumerator | |
|---|---|
| kAsDisplayed | |
| kWireframe | |
| kHidden | |
| kRendered | |
| kVisualStyle | |
| kRenderPreset | |
Definition at line 647 of file DbViewport.h.
◆ StandardScaleType
Definition at line 608 of file DbViewport.h.
Constructor & Destructor Documentation
◆ OdDbViewport()
| OdDbViewport::OdDbViewport | ( | ) |
Member Function Documentation
◆ ambientLightColor()
| OdCmColor OdDbViewport::ambientLightColor | ( | ) | const |
◆ annotationScale()
| OdDbAnnotationScalePtr OdDbViewport::annotationScale | ( | ) | const |
◆ backClipDistance()
| double OdDbViewport::backClipDistance | ( | ) | const |
Returns the back clip distance of this Viewport object (DXF 44).
◆ background()
| OdDbObjectId OdDbViewport::background | ( | ) | const |
◆ brightness()
| double OdDbViewport::brightness | ( | ) | const |
◆ centerPoint()
| OdGePoint3d OdDbViewport::centerPoint | ( | ) | const |
Returns the WCS center point of this Viewport object (DXF 10).
◆ circleSides()
| OdUInt16 OdDbViewport::circleSides | ( | ) | const |
Returns the circle zoom percent of this Viewport object (DXF 72).
- Remarks
- circleSides() has a range of [1..20000]
◆ contrast()
| double OdDbViewport::contrast | ( | ) | const |
◆ customScale()
| double OdDbViewport::customScale | ( | ) | const |
Returns the custom scale of this Viewport object.
◆ defaultLightingType()
| OdGiViewportTraits::DefaultLightingType OdDbViewport::defaultLightingType | ( | ) | const |
◆ 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 OdDbEntity.
◆ 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 OdDbEntity.
◆ 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 OdDbEntity.
◆ 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 OdDbEntity.
◆ 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 OdDbEntity.
◆ 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 OdDbEntity.
◆ effectivePlotStyleSheet()
| OdString OdDbViewport::effectivePlotStyleSheet | ( | ) | const |
Returns the plot style sheet name associated with this Viewport object.
◆ elevation()
| double OdDbViewport::elevation | ( | ) | const |
Returns the elevation of the UCS plane of this entity (DXF 146).
- Remarks
- The elevation is the distance from the WCS origin to the UCS plane of this entity.
◆ erased()
|
virtual |
Notification function called whenever an object has been erased or unerased.
- Parameters
-
pObject [in] Pointer to the object that was erased/unerased. erasing [in] True if and only if this object is being erased.
- Remarks
- The default implementation of this function does nothing. This function can be overridden in custom classes.
Reimplemented from OdDbObject.
◆ explodeGeometry()
|
virtual |
Explodes this entity into a set of simpler entities.
- Parameters
-
entitySet [in/out] Receives an array of pointers to the new entities.
- Remarks
- The newly created entities will be not database resident. Entities resulting from the explosion are appended to the specified array. The default implementation of this function calls subWorldDraw() and makes entities from geometry generated by subWorldDraw(). This function can be overridden in custom classes.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
Reimplemented from OdDbEntity.
◆ freezeLayersInViewport()
| void OdDbViewport::freezeLayersInViewport | ( | const OdDbObjectIdArray & | layerIds | ) |
Freezes the specified layers in this Viewport object (DXF 341)
- Parameters
-
layerIds [in] Object IDs of the layers to be frozen.
- Remarks
- Other viewports are unaffected by this function.
◆ frontClipDistance()
| double OdDbViewport::frontClipDistance | ( | ) | const |
Returns the front clip distance of this Viewport object (DXF 43).
◆ getFrozenLayerList()
| void OdDbViewport::getFrozenLayerList | ( | OdDbObjectIdArray & | layerIds | ) | const |
Returns all layers that are frozen in this Viewport object.
- Parameters
-
layerIds [out] Receives the Object IDs of the frozen layers.
◆ getLabelBlock()
| OdDbObjectId OdDbViewport::getLabelBlock | ( | ) | const |
◆ getModelView()
| OdDbXrefObjectId OdDbViewport::getModelView | ( | ) | const |
◆ getSheetView()
| OdDbObjectId OdDbViewport::getSheetView | ( | ) | const |
◆ getUcs()
| void OdDbViewport::getUcs | ( | OdGePoint3d & | origin, |
| OdGeVector3d & | xAxis, | ||
| OdGeVector3d & | yAxis | ||
| ) | const |
Returns the origin, X-axis, and Y-Axis of the UCS associated with this Viewport object.
- Parameters
-
origin [out] Receives the UCS origin (DXF 110). xAxis [out] Receives the UCS X-axis (DXF 111). yAxis [out] Receives the UCS Y-axis (DXF 112).
◆ gridIncrement()
| OdGeVector2d OdDbViewport::gridIncrement | ( | ) | const |
Returns the grid increment of this Viewport object (DXF 15).
◆ gridMajor()
| OdUInt16 OdDbViewport::gridMajor | ( | ) | const |
◆ gsView()
| OdGsView* OdDbViewport::gsView | ( | ) | const |
◆ height()
| double OdDbViewport::height | ( | ) | const |
Returns the height of this Viewport object (DXF 41).
- Remarks
- If this Viewport object is an overall viewport, the values returned by width() and height() must be divided by a factor of 1.058, and the parameters of setWidth and setHeight() must be multiplied by a like factor.
◆ hiddenLinesRemoved()
| bool OdDbViewport::hiddenLinesRemoved | ( | ) | const |
Returns true if and only if this Viewport object will have hidden lines removed during plotting. (DXF 90, bit 0x800).
◆ isBackClipOn()
| bool OdDbViewport::isBackClipOn | ( | ) | const |
Returns true if and only if back clipping is on for this Viewport object (DXF 90, bit 0x04).
◆ isDefaultLightingOn()
| bool OdDbViewport::isDefaultLightingOn | ( | ) | const |
◆ isFastZoomOn()
| bool OdDbViewport::isFastZoomOn | ( | ) | const |
Returns true if and only if fast zooms are on for this Viewport object (DXF 90, bit 0x80).
◆ isFrontClipAtEyeOn()
| bool OdDbViewport::isFrontClipAtEyeOn | ( | ) | const |
Returns true if and only if the front clipping plane passes through the camera (DXF 90, bit 0x10).
- Remarks
- If true, the front clipping plane ignores the front clip distance.
◆ isFrontClipOn()
| bool OdDbViewport::isFrontClipOn | ( | ) | const |
Returns true if and only if front clipping is on for this Viewport object (DXF 90, bit 0x02).
◆ isGridAdaptive()
| bool OdDbViewport::isGridAdaptive | ( | ) | const |
◆ isGridBoundToLimits()
| bool OdDbViewport::isGridBoundToLimits | ( | ) | const |
◆ isGridFollow()
| bool OdDbViewport::isGridFollow | ( | ) | const |
◆ isGridOn()
| bool OdDbViewport::isGridOn | ( | ) | const |
Returns true if and only if the grid is on for this Viewport object (DXF 90, bit 0x200).
◆ isGridSubdivisionRestricted()
| bool OdDbViewport::isGridSubdivisionRestricted | ( | ) | const |
◆ isLayerFrozenInViewport()
| bool OdDbViewport::isLayerFrozenInViewport | ( | const OdDbObjectId & | layerId | ) | const |
Returns true and only if the specified layer is frozen in this Viewport object.
- Parameters
-
layerId [in] Layer ID of the layer to be queried.
◆ isLocked()
| bool OdDbViewport::isLocked | ( | ) | const |
Returns true if and only if scale factor of this Viewport object is locked (DXF 90, bit 0x4000).
◆ isNonRectClipOn()
| bool OdDbViewport::isNonRectClipOn | ( | ) | const |
Returns true if and only if non-rectangular clipping is enabled for this Viewport object (DXF 90, bit 0x10000).
◆ isOn()
| bool OdDbViewport::isOn | ( | ) | const |
Returns true if and only if this Viewport object is on (DXF 90, bit 0x20000).
◆ isPerspectiveOn()
| bool OdDbViewport::isPerspectiveOn | ( | ) | const |
Returns true if and only if perspective is on for this Viewport object (DXF 90, bit 0x01).
◆ isSnapIsometric()
| bool OdDbViewport::isSnapIsometric | ( | ) | const |
Returns true if and only if isometric snap style is on for this Viewport object (DXF 90, bit 0x400).
◆ isSnapOn()
| bool OdDbViewport::isSnapOn | ( | ) | const |
Returns true if and only if the snap mode is on for this Viewport object (DXF 90, bit 0x100).
◆ isTransparent()
| bool OdDbViewport::isTransparent | ( | ) | const |
Not implemented. The value returned is not saved to file. Always returns true.
◆ isUcsFollowModeOn()
| bool OdDbViewport::isUcsFollowModeOn | ( | ) | const |
Returns true if and only if UCS follow mode is on for this Viewport object (DXF 90, bit 0x08).
◆ isUcsIconAtOrigin()
| bool OdDbViewport::isUcsIconAtOrigin | ( | ) | const |
Returns true if and only if the UCS icon is at the UCS origin for this Viewport object (DXF 90, bit 0x40).
◆ isUcsIconVisible()
| bool OdDbViewport::isUcsIconVisible | ( | ) | const |
Returns true if and only if the UCS icon is visible for this Viewport object (DXF 90, bit 0x20).
◆ isUcsOrthographic()
| bool OdDbViewport::isUcsOrthographic | ( | OdDb::OrthographicView & | viewType, |
| const OdDbDatabase * | pDb = 0 |
||
| ) | const |
True if and only if the UCS associated with this Viewport object is orthographic with respect to UCSBASE (DXF 79).
- Parameters
-
viewType [out] Receives the orthographic view type. pDb [in] Working database. If object is a database resident this parameter is ignored.
- Returns
- Returns the type of orthographic view.
- Remarks
- viewType must be one of the following:
Value View type OdDb::kNonOrthoView 0 Non-orthographic with respect to the UCS OdDb::kTopView 1 Top view with respect to the UCS OdDb::kBottomView 2 Bottom view with respect to the UCS OdDb::kFrontView 3 Front view with respect to the UCS OdDb::kBackView 4 Back view with respect to the UCS OdDb::kLeftView 5 Left view with respect to the UCS OdDb::kRightView 6 Right view with respect to the UCS
◆ isUcsSavedWithViewport()
| bool OdDbViewport::isUcsSavedWithViewport | ( | ) | const |
Returns true if and only if the UCS that is associated with this Viewport object will become active with the activation of this Viewport object.
◆ lensLength()
| double OdDbViewport::lensLength | ( | ) | const |
Returns the perspective mode lens length (in mm) of this Viewport object (DXF 42).
◆ modified()
|
virtual |
Notification function called whenever an object is opened OdDb::kForWrite, a function has been called that could modify the contents of this object, and this object is now being closed.
- Parameters
-
pObject [in] Pointer to the object that is being closed after being modified.
- Remarks
- The default implementation of this function does nothing. This function can be overridden in custom classes.
Reimplemented from OdDbObject.
◆ nonRectClipEntityId()
| OdDbObjectId OdDbViewport::nonRectClipEntityId | ( | ) | const |
Returns the Object ID of the clipping entity for this Viewport object (DXF 340).
◆ number()
| OdInt16 OdDbViewport::number | ( | ) | const |
Returns the ID number of this Viewport object.
- Returns
- Returns -1 if this Viewport object is inactive.
◆ ODDB_DECLARE_MEMBERS()
| OdDbViewport::ODDB_DECLARE_MEMBERS | ( | OdDbViewport | ) |
◆ plotAsRaster()
| bool OdDbViewport::plotAsRaster | ( | ) | const |
◆ plotStyleSheet()
| OdString OdDbViewport::plotStyleSheet | ( | ) | const |
Returns the name of the plot style sheet applied to objects in this Viewport object (DXF 1).
◆ plotWireframe()
| bool OdDbViewport::plotWireframe | ( | ) | const |
◆ removeHiddenLines()
| void OdDbViewport::removeHiddenLines | ( | ) |
Sets this Viewport object to have hidden lines removed during plotting. (DXF 90, bit 0x800).
◆ removeLabelBlock()
| void OdDbViewport::removeLabelBlock | ( | ) |
◆ removeModelView()
| void OdDbViewport::removeModelView | ( | ) |
◆ removeSheetView()
| void OdDbViewport::removeSheetView | ( | ) |
◆ renderMode()
| OdDb::RenderMode OdDbViewport::renderMode | ( | ) | const |
Returns the render mode of this Viewport object (DXF 281).
- Remarks
- renderMode() returns one of the following:
Value Description kBoundingBox -1 Bounding box. For internal use only. k2DOptimized 0 Standard display. Optimized for 2D. kWireframe 1 Standard display. Uses 3D pipeline. kHiddenLine 2 Wireframe display. Hidden lines removed. kFlatShaded 3 Faceted display. One color per face. kGouraudShaded 4 Smooth shaded display. Colors interpolated between vertices. kFlatShadedWithWireframe 5 Faceted display with wireframe overlay. kGouraudShadedWithWireframe 6 Smooth shaded display with wireframe overlay.
◆ setAmbientLightColor()
◆ setAnnotationScale()
| OdResult OdDbViewport::setAnnotationScale | ( | const OdDbAnnotationScale * | pScaleObj | ) |
◆ setBackClipDistance()
| void OdDbViewport::setBackClipDistance | ( | double | backClipDistance | ) |
Sets the back distance of this Viewport object (DXF 44).
- Parameters
-
backClipDistance [in] Back clip distance.
◆ setBackClipOff()
| void OdDbViewport::setBackClipOff | ( | ) |
Turns off back clipping for this Viewport object (DXF 90, bit 0x04).
◆ setBackClipOn()
| void OdDbViewport::setBackClipOn | ( | ) |
Turns on back clipping for this Viewport object (DXF 90, bit 0x04).
◆ setBackground()
| void OdDbViewport::setBackground | ( | const OdDbObjectId & | backgroundId | ) |
◆ setBrightness()
| void OdDbViewport::setBrightness | ( | double | ) |
◆ setCenterPoint()
| void OdDbViewport::setCenterPoint | ( | const OdGePoint3d & | centerPoint | ) |
Sets the WCS center point of this Viewport object (DXF 10).
- Parameters
-
centerPoint [in] Center point.
◆ setCircleSides()
Sets the circle zoom percent of this Viewport object (DXF 72).
- Parameters
-
circleSides [in] circle zoom percent [1,20000].
◆ setContrast()
| void OdDbViewport::setContrast | ( | double | ) |
◆ setCustomScale()
| void OdDbViewport::setCustomScale | ( | double | customScale | ) |
Sets the custom scale of this Viewport object.
- Parameters
-
customScale [in] Custom scale.
◆ setDefaultLightingOn()
| void OdDbViewport::setDefaultLightingOn | ( | bool | on | ) |
◆ setDefaultLightingType()
| void OdDbViewport::setDefaultLightingType | ( | OdGiViewportTraits::DefaultLightingType | typ | ) |
◆ setElevation()
| void OdDbViewport::setElevation | ( | double | elevation | ) |
Sets the elevation of the UCS plane of this Viewport object (DXF 146).
- Parameters
-
elevation [in] Elevation.
- Remarks
- The elevation is the distance from the WCS origin to the plane of this Viewport object.
◆ setFastZoomOff()
| void OdDbViewport::setFastZoomOff | ( | ) |
Sets fast zooms off for this Viewport object (DXF 90, bit 0x80).
◆ setFastZoomOn()
| void OdDbViewport::setFastZoomOn | ( | ) |
Sets fast zooms on for this Viewport object (DXF 90, bit 0x80).
◆ setFrontClipAtEyeOff()
| void OdDbViewport::setFrontClipAtEyeOff | ( | ) |
Sets the front clipping plane to utilize the front clip distance (DXF 90, bit 0x10).
◆ setFrontClipAtEyeOn()
| void OdDbViewport::setFrontClipAtEyeOn | ( | ) |
Sets the front clipping plane to pass through the camera (DXF 90, bit 0x10).
- Remarks
- The front clipping plane ignores the front clip distance.
◆ setFrontClipDistance()
| void OdDbViewport::setFrontClipDistance | ( | double | frontClipDistance | ) |
Sets the front clip distance of this Viewport object (DXF 43).
- Parameters
-
frontClipDistance [in] Front clip distance.
◆ setFrontClipOff()
| void OdDbViewport::setFrontClipOff | ( | ) |
Turns off front clipping for this Viewport object (DXF 90, bit 0x02).
◆ setFrontClipOn()
| void OdDbViewport::setFrontClipOn | ( | ) |
Turns on front clipping for this Viewport object (DXF 90, bit 0x02).
◆ setGridAdaptive()
| void OdDbViewport::setGridAdaptive | ( | bool | bNewVal | ) |
◆ setGridBoundToLimits()
| void OdDbViewport::setGridBoundToLimits | ( | bool | bNewVal | ) |
◆ setGridFollow()
| void OdDbViewport::setGridFollow | ( | bool | bNewVal | ) |
◆ setGridIncrement()
| void OdDbViewport::setGridIncrement | ( | const OdGeVector2d & | gridIncrement | ) |
Sets the grid increment of this Viewport object (DXF 15).
- Parameters
-
gridIncrement [in] Grid increment.
◆ setGridMajor()
◆ setGridOff()
| void OdDbViewport::setGridOff | ( | ) |
Sets the grid off for this Viewport object (DXF 90, bit 0x200).
◆ setGridOn()
| void OdDbViewport::setGridOn | ( | ) |
Sets the grid on for this Viewport object (DXF 90, bit 0x200).
◆ setGridSubdivisionRestricted()
| void OdDbViewport::setGridSubdivisionRestricted | ( | bool | bNewVal | ) |
◆ setGsView()
◆ setHeight()
| void OdDbViewport::setHeight | ( | double | height | ) |
Sets the height of this Viewport object (DXF 41).
- Parameters
-
height [in] Height.
- Remarks
- If this Viewport object is an overall viewport, the values returned by width() and height() must be divided by a factor of 1.058, and the parameters of setWidth and setHeight() must be multiplied by a like factor.
◆ setLabelBlock()
| void OdDbViewport::setLabelBlock | ( | const OdDbObjectId | objId | ) |
◆ setLensLength()
| void OdDbViewport::setLensLength | ( | double | lensLength | ) |
Sets the perspective mode lens length of this Viewport object (DXF 42).
- Parameters
-
lensLength [in] Lens length (mm).
◆ setLocked()
| void OdDbViewport::setLocked | ( | ) |
Locks the scale factor of this Viewport object (DXF 90, bit 0x4000).
◆ setModelView()
| void OdDbViewport::setModelView | ( | const OdDbXrefObjectId & | objId | ) |
◆ setNonRectClipEntityId()
| void OdDbViewport::setNonRectClipEntityId | ( | OdDbObjectId | clipEntityId | ) |
Sets the Object ID of the clipping entity for this Viewport object (DXF 340).
- Parameters
-
clipEntityId [in] Object ID of the clipping entity.
- Remarks
- The following entity types are acceptable clipping entities:
@untitled table OdDb2dPolyline OdDb3dPolyline OdDbCircle OdDbEllipse OdDbFace OdDbPolyline OdDbRegion OdDbSpline
- Remarks
- A clipping entity must be in the same PaperSpace as this Viewport.
◆ setNonRectClipOff()
| void OdDbViewport::setNonRectClipOff | ( | ) |
Sets non-rectangular clipping off for this Viewport object (DXF 90, bit 0x10000).
◆ setNonRectClipOn()
| void OdDbViewport::setNonRectClipOn | ( | ) |
Sets non-rectangular clipping on for this Viewport object (DXF 90, bit 0x10000).
◆ setOff()
| void OdDbViewport::setOff | ( | ) |
Turns off this Viewport object (DXF 90, bit 0x20000, DXF 68 zero).
◆ setOn()
| void OdDbViewport::setOn | ( | ) |
Turns on this Viewport object (DXF 90, bit 0x20000, DXF 68 non-zero).
◆ setOpaque()
| void OdDbViewport::setOpaque | ( | ) |
Not implemented. The set value is not saved to file.
◆ setPerspectiveOff()
| void OdDbViewport::setPerspectiveOff | ( | ) |
Sets perspective off for this Viewport object (DXF 90, bit 0x01).
◆ setPerspectiveOn()
| void OdDbViewport::setPerspectiveOn | ( | ) |
Sets perspective on for this Viewport object (DXF 90, bit 0x01).
◆ setPlotStyleSheet()
Sets the plot style sheet name associated with this Viewport object.
◆ setRenderMode()
| void OdDbViewport::setRenderMode | ( | OdDb::RenderMode | renderMode | ) |
Set the render mode of this Viewport object (DXF 281).
- Parameters
-
renderMode [in] Render mode.
- Remarks
- renderMode must be one of the following:
Value Description kBoundingBox -1 Bounding box. For internal use only. k2DOptimized 0 Standard display. Optimized for 2D. kWireframe 1 Standard display. Uses 3D pipeline. kHiddenLine 2 Wireframe display. Hidden lines removed. kFlatShaded 3 Faceted display. One color per face. kGouraudShaded 4 Smooth shaded display. Colors interpolated between vertices. kFlatShadedWithWireframe 5 Faceted display with wireframe overlay. kGouraudShadedWithWireframe 6 Smooth shaded display with wireframe overlay.
◆ setShadePlot() [1/2]
| void OdDbViewport::setShadePlot | ( | const ShadePlotType | shadePlot | ) |
Set the shade plot type of this Viewport object (DXF 281).
- Parameters
-
shadePlot [in] Shade plot type.
- Remarks
- shadePlot determines how this Viewport object will plot.
◆ setShadePlot() [2/2]
| void OdDbViewport::setShadePlot | ( | const ShadePlotType | type, |
| const OdDbObjectId & | shadePlotId | ||
| ) |
Set the shade plot type of this Viewport object (DXF 281).
- Parameters
-
type [in] Shade plot type.
- Remarks
- type determines how this Viewport object will plot.
◆ setSheetView()
| void OdDbViewport::setSheetView | ( | const OdDbObjectId & | objId | ) |
◆ setSnapAngle()
| void OdDbViewport::setSnapAngle | ( | double | snapAngle | ) |
Sets the UCS snap angle of this Viewport object (DXF 50).
- Parameters
-
snapAngle [in] Snap angle.
- Remarks
- All angles are expressed in radians.
◆ setSnapBasePoint()
| void OdDbViewport::setSnapBasePoint | ( | const OdGePoint2d & | snapBasePoint | ) |
Sets the UCS snap base point of this Viewport object (DXF 13).
- Parameters
-
snapBasePoint [in] Snap base point.
◆ setSnapIncrement()
| void OdDbViewport::setSnapIncrement | ( | const OdGeVector2d & | snapIncrement | ) |
Sets the snap increment of this Viewport object (DXF 14).
- Parameters
-
snapIncrement [in] Snap increment.
◆ setSnapIsometric()
| void OdDbViewport::setSnapIsometric | ( | ) |
Sets the isometric snap style on for this Viewport object (DXF 90, bit 0x400).
◆ setSnapIsoPair()
Sets the snap IsoPair of this Viewport object (DXF 14).
- Parameters
-
snapIsoPair [in] Snap IsoPair.
- Remarks
- snapIsoPair must be one of the following:
Description 0 Left isoplane 1 Top isoplane 2 Right isoplane
◆ setSnapOff()
| void OdDbViewport::setSnapOff | ( | ) |
Sets the snap mode off for this Viewport object (DXF 90, bit 0x100).
◆ setSnapOn()
| void OdDbViewport::setSnapOn | ( | ) |
Sets the snap mode on for this Viewport object (DXF 90, bit 0x100).
◆ setSnapStandard()
| void OdDbViewport::setSnapStandard | ( | ) |
Sets the isometric snap style off for this Viewport object (DXF 90, bit 0x400).
◆ setStandardScale()
| void OdDbViewport::setStandardScale | ( | const StandardScaleType | standardScale | ) |
Sets the standard scale type of this Viewport object.
- Parameters
-
standardScale [in] Standard scale type.
◆ setSun()
| OdDbObjectId OdDbViewport::setSun | ( | OdDbSun * | pSun | ) |
◆ setToneOperatorParameters()
| void OdDbViewport::setToneOperatorParameters | ( | const OdGiToneOperatorParameters & | params | ) |
◆ setTransparent()
| void OdDbViewport::setTransparent | ( | ) |
Not implemented. The set value is not saved to file.
◆ setTwistAngle()
| void OdDbViewport::setTwistAngle | ( | double | twistAngle | ) |
Sets the DCS twist angle of this Viewport object (DXF 51).
- Parameters
-
twistAngle [in] Twist angle.
- Remarks
- All angles are expressed in radians.
◆ setUcs() [1/3]
| void OdDbViewport::setUcs | ( | const OdDbObjectId & | ucsId | ) |
Sets the UCS associated with this Viewport object
- Parameters
-
ucsId [in] Object ID of the UCS (DXF 345 or 346).
◆ setUcs() [2/3]
| void OdDbViewport::setUcs | ( | const OdGePoint3d & | origin, |
| const OdGeVector3d & | xAxis, | ||
| const OdGeVector3d & | yAxis | ||
| ) |
Sets the UCS associated with this Viewport object
- Parameters
-
origin [in] The WCS origin of the UCS (DXF 110). xAxis [in] The WCS X-axis of the UCS (DXF 111). yAxis [in] The WCS Y-axis of the UCS(DXF 112).
◆ setUcs() [3/3]
| void OdDbViewport::setUcs | ( | OdDb::OrthographicView | viewType, |
| const OdDbDatabase * | pDb = 0 |
||
| ) |
Sets the UCS associated with this Viewport object
- Parameters
-
viewType [in] Orthographic view type (DXF 79). pDb [in] Working database. If object is a database resident this parameter is ignored.
- Remarks
- viewType must be one of the following:
Value View type OdDb::kNonOrthoView 0 Non-orthographic with respect to the UCS OdDb::kTopView 1 Top view with respect to the UCS OdDb::kBottomView 2 Bottom view with respect to the UCS OdDb::kFrontView 3 Front view with respect to the UCS OdDb::kBackView 4 Back view with respect to the UCS OdDb::kLeftView 5 Left view with respect to the UCS OdDb::kRightView 6 Right view with respect to the UCS
◆ setUcsFollowModeOff()
| void OdDbViewport::setUcsFollowModeOff | ( | ) |
Sets UCS follow mode off for this Viewport object (DXF 90, bit 0x08).
◆ setUcsFollowModeOn()
| void OdDbViewport::setUcsFollowModeOn | ( | ) |
Sets UCS follow mode on for this Viewport object (DXF 90, bit 0x08).
◆ setUcsIconAtCorner()
| void OdDbViewport::setUcsIconAtCorner | ( | ) |
Sets the UCS icon to the corner of this Viewport object (DXF 90, bit 0x40).
◆ setUcsIconAtOrigin()
| void OdDbViewport::setUcsIconAtOrigin | ( | ) |
Sets the UCS icon to the UCS origin for this Viewport object (DXF 90, bit 0x40).
◆ setUcsIconInvisible()
| void OdDbViewport::setUcsIconInvisible | ( | ) |
Sets UCS icon visible false for this Viewport object (DXF 90, bit 0x20).
◆ setUcsIconVisible()
| void OdDbViewport::setUcsIconVisible | ( | ) |
Sets UCS icon visible on for this Viewport object (DXF 90, bit 0x20).
◆ setUcsPerViewport()
| void OdDbViewport::setUcsPerViewport | ( | bool | ucsPerViewport | ) |
Controls the activation of the UCS that is associated with this Viewport object with the activation of this Viewport object.
- Parameters
-
ucsPerViewport [in] Controls activation of the UCS.
◆ setUcsToWorld()
| void OdDbViewport::setUcsToWorld | ( | ) |
Sets the UCS associated with this Viewport object to the WCS.
◆ setUnlocked()
| void OdDbViewport::setUnlocked | ( | ) |
Unlocks the scale factor of this Viewport object (DXF 90, bit 0x4000).
◆ setViewCenter()
| void OdDbViewport::setViewCenter | ( | const OdGePoint2d & | viewCenter | ) |
Sets the DCS view center of this Viewport object (DXF 12).
- Parameters
-
viewCenter [in] View center.
◆ setViewDirection()
| void OdDbViewport::setViewDirection | ( | const OdGeVector3d & | viewDirection | ) |
Sets the WCS view direction of this Viewport object (DXF 16).
- Parameters
-
viewDirection [in] View direction.
◆ setViewHeight()
| void OdDbViewport::setViewHeight | ( | double | viewHeight | ) |
Sets the DCS view height of this Viewport object (DXF 45).
- Parameters
-
viewHeight [in] View height.
◆ setViewTarget()
| void OdDbViewport::setViewTarget | ( | const OdGePoint3d & | viewTarget | ) |
Sets the WCS view target of this Viewport object (DXF 17).
- Parameters
-
viewTarget [in] View target.
◆ setVisualStyle()
| void OdDbViewport::setVisualStyle | ( | const OdDbObjectId & | visualStyle | ) |
◆ setWidth()
| void OdDbViewport::setWidth | ( | double | width | ) |
Sets the width of this Viewport object (DXF 40).
- Parameters
-
width [in] Width.
- Remarks
- If this Viewport object is an overall viewport, the values returned by width() and height() must be divided by a factor of 1.058, and the parameters of setWidth and setHeight() must be multiplied by a like factor.
◆ shadePlot()
| ShadePlotType OdDbViewport::shadePlot | ( | ) | const |
Returns the shade plot type of the current viewport.
- Remarks
- shadePlot determines how this Viewport object will plot.
◆ shadePlotId()
| OdDbObjectId OdDbViewport::shadePlotId | ( | ) | const |
◆ showHiddenLines()
| void OdDbViewport::showHiddenLines | ( | ) |
Sets this Viewport object to have hidden shown lines during plotting. (DXF 90, bit 0x800).
◆ snapAngle()
| double OdDbViewport::snapAngle | ( | ) | const |
Returns the UCS snap angle of this Viewport object (DXF 50).
◆ snapBasePoint()
| OdGePoint2d OdDbViewport::snapBasePoint | ( | ) | const |
Returns the UCS snap base point of this Viewport object (DXF 13).
◆ snapIncrement()
| OdGeVector2d OdDbViewport::snapIncrement | ( | ) | const |
Returns the snap increment of this Viewport object (DXF 14).
◆ snapIsoPair()
| OdUInt16 OdDbViewport::snapIsoPair | ( | ) | const |
Returns the snap IsoPair of this Viewport object (DXF 14).
- Remarks
- snapIsoPair() returns one of the following:
Description 0 Left isoplane 1 Top isoplane 2 Right isoplane
◆ standardScale()
| StandardScaleType OdDbViewport::standardScale | ( | ) | const |
Returns the standard scale type of this Viewport object/
◆ 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.
◆ subErase()
|
virtual |
Called as the first operation as this object is being erased or unerased.
- Parameters
-
erasing [in] A copy of the erasing argument passed to erase().
- Remarks
- This function is notified just before the current object is to be erased, giving this function the ability to cancel the erase.
Returns eOk if and only if erase() is to continue.
When overriding this function:
1) If the OdDbObject's state is incorrect, return something other than eOk.
2) If the parent class's subErase() returns anything other than eOk, immediately return it.
3) If other actions are required before erase, do them.
4) Return eOk.
If you must make changes to this object's state, either make them after step 2, or roll them back if step 2 returns other than eOk.
The default implementation of this function does nothing but return eOk. This function can be overridden in custom classes.
Reimplemented from OdDbEntity.
◆ subGetClassID()
Reimplemented from OdDbEntity.
◆ subGetGeomExtents()
|
virtual |
Reimplemented from OdDbEntity.
◆ subGetTransformedCopy()
|
virtual |
Reimplemented from OdDbEntity.
◆ subSetAttributes()
|
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 OdDbEntity.
◆ subSetDatabaseDefaults()
|
virtual |
Called by setDatabaseDefaults() after the values are set.
- Parameters
-
pDb [in] Pointer to the database whose default values are to be used. doSubents [in] Set to true if subentities should be processed
- Remarks
- If pDb is null, the database containing this entity is used.
This function allows custom classes to inspect and modify the values set by setDatabaseDefaults.
The default implementation of this function returns eNotApplicable. This function can be overridden in custom classes.
- Remarks
- This function is not intended to be called by the user.
Reimplemented from OdDbEntity.
◆ subTransformBy()
|
virtual |
Reimplemented from OdDbEntity.
◆ subWorldDraw()
|
virtual |
Reimplemented from OdDbEntity.
◆ sunId()
| OdDbObjectId OdDbViewport::sunId | ( | ) | const |
◆ syncModelView()
| OdResult OdDbViewport::syncModelView | ( | ) |
◆ thawAllLayersInViewport()
| void OdDbViewport::thawAllLayersInViewport | ( | ) |
Thaws all layers in this Viewport object.
◆ thawLayersInViewport()
| void OdDbViewport::thawLayersInViewport | ( | const OdDbObjectIdArray & | layerIds | ) |
Thaws the specified layers in this Viewport object (DXF 341)
- Parameters
-
layerIds [in] Object IDs of the layers to be thawed.
- Remarks
- Other viewports are unaffected by this function.
◆ toneOperatorParameters()
| void OdDbViewport::toneOperatorParameters | ( | OdGiToneOperatorParameters & | params | ) | const |
◆ twistAngle()
| double OdDbViewport::twistAngle | ( | ) | const |
Returns the DCS twist angle of this Viewport object (DXF 51).
- Remarks
- All angles are expressed in radians.
◆ ucsName()
| OdDbObjectId OdDbViewport::ucsName | ( | ) | const |
Returns the Object ID of the UCS associated with this Viewport object (DXF 345 or 346).
◆ updateDisplay()
| void OdDbViewport::updateDisplay | ( | ) | const |
Updates the display to reflect changes in this Viewport object.
- Remarks
- Closing this Viewport object automatically calls this function.
Throws: eNotImplemented
◆ viewCenter()
| OdGePoint2d OdDbViewport::viewCenter | ( | ) | const |
Returns the DCS view center of this Viewport object (DXF 12).
◆ viewDirection()
| OdGeVector3d OdDbViewport::viewDirection | ( | ) | const |
Returns the WCS view direction of this Viewport object (DXF 16).
◆ viewHeight()
| double OdDbViewport::viewHeight | ( | ) | const |
Returns the DCS view height of this Viewport object (DXF 45).
◆ viewTarget()
| OdGePoint3d OdDbViewport::viewTarget | ( | ) | const |
Returns the WCS view target of this Viewport object (DXF 17).
◆ visualStyle()
| OdDbObjectId OdDbViewport::visualStyle | ( | ) | const |
◆ width()
| double OdDbViewport::width | ( | ) | const |
Returns the width of this Viewport object (DXF 40).
- Remarks
- If this Viewport object is an overall viewport, the values returned by width() and height() must be divided by a factor of 1.058, and the parameters of setWidth and setHeight() must be multiplied by a like factor.
◆ zoomExtents()
| void OdDbViewport::zoomExtents | ( | ) |
Adjusts the parameters of this Viewport object such that the view is zoomed to the extents of the drawing.
The documentation for this class was generated from the following file: