#include <DbViewRep.h>
Static Public Member Functions | |
| static OdSmartPtr< OdDbViewRep > | createViewRep (OdDbDatabase *db, const OdDbViewInitParams ¶ms, const OdDbViewSymbol *viewSymbol=nullptr) |
 Static Public Member Functions inherited from OdRxObject | |
| static OdRxObjectPtr | cast (const OdRxObject *pointer) |
| static OdRxClass * | desc () |
| static void | rxInit () |
| static void | rxUninit () |
Protected Member Functions | |
| virtual OdResult | dwgInFields (OdDbDwgFiler *pFiler) |
| virtual void | dwgOutFields (OdDbDwgFiler *pFiler) const |
| virtual OdResult | dxfInFields (OdDbDxfFiler *pFiler) |
| virtual void | dxfOutFields (OdDbDxfFiler *pFiler) const |
| void | applyPartialUndo (OdDbDwgFiler *undoFiler, OdRxClass *pClass) override |
| 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 |
Friends | |
| class | OdDbImpAssocViewRepActionBody |
| class | OdDbAssocViewRepActionBodyEvaluator |
Additional Inherited Members | |
| Protected Attributes inherited from OdDbObject | |
| OdDbObjectImpl * | m_pImpl |
Detailed Description
Corresponding C++ library: AcModelDocObj <group OdModelDocObj_Classes>
The key class in the model documentation functionality. Represents every ModelDoc view in the database. An OdDbViewRep instance resides in an associated network and owned by an instance of the OdDbAssocViewRepActionBody class. Call OdDbViewRep::createViewRep() to add a new view representation.
Definition at line 48 of file DbViewRep.h.
Member Enumeration Documentation
◆ SourceType
| Enumerator | |
|---|---|
| kSourceNotDefined | |
| kInventorSource | |
| kFusionSource | |
| kModelSpaceSource | |
Definition at line 61 of file DbViewRep.h.
◆ ViewOrientType
Definition at line 79 of file DbViewRep.h.
◆ ViewStyleType
| Enumerator | |
|---|---|
| kVisibleAndHiddenLines | |
| kVisibleLinesOnly | |
Definition at line 55 of file DbViewRep.h.
◆ ViewType
| Enumerator | |
|---|---|
| kBase | |
| kAuxiliary | |
| kDetail | |
| kSection | |
| kProjected | |
Definition at line 69 of file DbViewRep.h.
Constructor & Destructor Documentation
◆ OdDbViewRep()
| OdDbViewRep::OdDbViewRep | ( | ) |
◆ ~OdDbViewRep()
|
virtual |
Member Function Documentation
◆ applyPartialUndo()
|
overrideprotectedvirtual |
Notification function called each time an Undo operation is performed this object is using partial Undo.
- Parameters
-
pUndoFiler [in] A pointer to the undo filer with the partial undo information. pClassObj [in] A pointer to the OdRxClass object for the class that will handle the Undo.
- Remarks
- An object indicates it's using the partial undo mechanism, if and only if it has set autoUndo false in all calls to assertWriteEnabled().
This member function must know which types of fields to scan, and must stop after reading what it it needs.
If the class type specified by pClassObj does not matches the class of this object, this member function must call the parent class's applyPartialUndo() and return whatever it returns.
If it does match the class of this object, this member function must use pUndoFiler to read the undo data, then typically use this object's set() method.
Throws:
Cause eNotThatKindOfClass pClassObj != OdDbObject::desc()
Reimplemented from OdDbObject.
◆ bodyManager() [1/2]
| OdDbViewRepBodyManager * OdDbViewRep::bodyManager | ( | ) |
Generates projected HLR segments and fills them with database entities in the displayed view representation block. It checks whether the view or source model was changed and regenerates graphics only when necessary.
For internal use.
◆ bodyManager() [2/2]
| const OdDbViewRepBodyManager * OdDbViewRep::bodyManager | ( | ) | const |
For internal use.
◆ bodyOverridesLoaded()
| bool OdDbViewRep::bodyOverridesLoaded | ( | ) | const |
For internal use.
◆ camera()
| void OdDbViewRep::camera | ( | OdGePoint3d & | eye, |
| OdGePoint3d & | target, | ||
| OdGeVector3d & | upVector ) const |
Gets the camera's rotation angle.
- Returns
- Camera's rotation angle as a double value.
- Parameters
-
target [out] Receives the camera's target position. eye [out] Receives the camera's eye position. up [out] Receives the camera's up vector.
◆ center()
| OdGePoint3d OdDbViewRep::center | ( | ) | const |
For internal use.
◆ clearBodyManager()
| void OdDbViewRep::clearBodyManager | ( | ) |
For internal use.
◆ createViewRep()
|
static |
Creates a new view representation in the specified database.
- Parameters
-
db [in] Database in which to create the view representation. params [in] Structure filled with initial params for the new view representation. viewSymbol [in] Optional. The filled template view symbol entity. When creating a section view representation, this parameter points to an OdDbSectionSymbol entity with section points and optionally other properties defined. When creating a detail view representation, this parameter points to an OdDbDetailSymbol entity with position, size, and optionally other properties defined.
- Returns
- Smart pointer to the newly created OdDbViewRep object.
- Remarks
- This method also creates all necessary associated network and model documentation infrastructure objects in the specified OdDbDatabase. If this function succeeds, it returns a pointer to a ready-to-use view representation object. You can use this pointer to set or extract a view's properties and traits that were initialized with defaults during execution.
◆ cutDefinitionId()
| OdDbObjectId OdDbViewRep::cutDefinitionId | ( | OdUInt32 | index = 0 | ) | const |
For internal use.
◆ dwgInFields()
|
protectedvirtual |
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()
|
protectedvirtual |
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()
|
protectedvirtual |
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()
|
protectedvirtual |
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.
◆ entityBackupBlockRef()
| OdDbObjectId OdDbViewRep::entityBackupBlockRef | ( | ) | const |
For internal use.
◆ foreshortened()
| bool OdDbViewRep::foreshortened | ( | ) | const |
Gets the flag indicating whether tangent edges should be foreshortened.
- Returns
- The true value if the tangent edge should be foreshortened, or false otherwise.
◆ getSketchManager() [1/2]
| OdRxSketchManager * OdDbViewRep::getSketchManager | ( | ) |
For internal use.
◆ getSketchManager() [2/2]
| const class OdRxSketchManager * OdDbViewRep::getSketchManager | ( | ) | const |
For internal use.
◆ inheritSection()
| bool OdDbViewRep::inheritSection | ( | ) | const |
Checks whether the view representation inherits sections from parent views.
- Returns
- The true value if the view representation inherits sections from parent views, or false otherwise.
- Remarks
- If this flag is false for a projected or section view based on a section view, view content is generated ignoring the parent view section operation.
◆ inheritViewStyle()
| bool OdDbViewRep::inheritViewStyle | ( | ) | const |
Gets the flag indicating view style inheritance.
- Returns
- The true value if the view inherits a view style from the parent view, or false if the view has its own view style.
- See also
- <link OdDbViewRep::ViewStyleType>
◆ interferenceEdgesVisibility()
| bool OdDbViewRep::interferenceEdgesVisibility | ( | ) | const |
Gets the flag indicating the visibility of bodies' interference edges.
- Returns
- The true value if bodies' interference edges are visible, or false otherwise.
◆ inventorDrawingViewId()
| OdUInt64 OdDbViewRep::inventorDrawingViewId | ( | ) | const |
For internal use.
◆ isPartialMSView()
| bool OdDbViewRep::isPartialMSView | ( | ) | const |
For internal use.
◆ isScaleFromParent()
| bool OdDbViewRep::isScaleFromParent | ( | ) | const |
Gets a value of the flag indicating whether the view representation scale is inherited from the parent view representation.
- Returns
- The true value if the scale is inherited from the parent view representation, or false if the view has its own scale.
◆ isShaded()
| bool OdDbViewRep::isShaded | ( | ) | const |
Checks whether the view is shaded.
- Returns
- The true value if the view is shaded, or false otherwise.
◆ label()
| OdString OdDbViewRep::label | ( | ) | const |
Gets view label content.
- Returns
- View label (caption) string as an OdString object.
◆ labelVisibility()
| bool OdDbViewRep::labelVisibility | ( | ) | const |
Gets the label's visibility.
- Returns
- The true value if the label (caption) is visible, or false otherwise.
◆ layoutId()
| OdDbObjectId OdDbViewRep::layoutId | ( | ) | const |
Gets the OdDbLayout object where this view representation resides.
- Returns
- Object ID of the OdDbLayout object.
◆ loadBodyOverrides()
| OdResult OdDbViewRep::loadBodyOverrides | ( | ) |
For internal use.
◆ logical()
| OdDbViewRepLogical * OdDbViewRep::logical | ( | ) |
For internal use.
◆ lookUpSectionSymbol()
| OdDbObjectId OdDbViewRep::lookUpSectionSymbol | ( | ) | const |
Traverses the internal object structure to find an associated view symbol (section or detail).
- Returns
- Object ID of either an OdDbSectionSymbol or OdDbDetailSymbol entity that defines the content of this view representation.
◆ ODDB_DECLARE_MEMBERS()
| OdDbViewRep::ODDB_DECLARE_MEMBERS | ( | OdDbViewRep | ) |
◆ orientationId()
| OdDbObjectId OdDbViewRep::orientationId | ( | ) | const |
For internal use.
◆ rotationAngle()
| double OdDbViewRep::rotationAngle | ( | ) | const |
Returns the camera's rotation angle.
◆ scale()
| double OdDbViewRep::scale | ( | ) | const |
Gets a view scale.
- Returns
- The current view scale.
◆ selSetObjId()
| OdDbObjectId OdDbViewRep::selSetObjId | ( | ) | const |
Gets a set of source entities.
- Returns
- Object ID of an OdDbViewRepModelSpaceViewSelSet object that represents a set of source entities for this view representation.
◆ setCamera()
| void OdDbViewRep::setCamera | ( | const OdGePoint3d & | target, |
| const OdGePoint3d & | eye, | ||
| const OdGeVector3d & | up ) |
For internal use.
◆ setForeshortened()
| void OdDbViewRep::setForeshortened | ( | bool | val | ) |
Sets a new value of the flag indicating whether tangent edges should be foreshortened.
- Parameters
-
val [in] A new value of the flag indicating whether tangent edges should be foreshortened.
◆ setInheritSection()
| void OdDbViewRep::setInheritSection | ( | bool | inherit | ) |
Sets the flag indicating whether this view representation should inherit sections from parent views.
- Parameters
-
inherit [in] A new value of the flag to set.
◆ setInheritViewStyle()
| void OdDbViewRep::setInheritViewStyle | ( | bool | value | ) |
Turns view style inheritance on or off.
- Parameters
-
value [in] A new value of the flag indicating the view style inheritance.
◆ setInterferenceEdgesVisibility()
| void OdDbViewRep::setInterferenceEdgesVisibility | ( | bool | val | ) |
Turns bodies' interference edge visibility on or off.
- Parameters
-
val [in] A new value of the flag indicating the interference edge visibility.
◆ setInventorDrawingViewId()
◆ setIsShaded()
| void OdDbViewRep::setIsShaded | ( | bool | doIt | ) |
Turns shaded image visibility on or off.
- Parameters
-
doIt [in] A new shaded image visibility value to set.
◆ setLabelVisibility()
| void OdDbViewRep::setLabelVisibility | ( | bool | vis | ) |
Sets a label's visibility.
- Parameters
-
vis [in] View label (caption) visibility value to set.
◆ setModelSpaceSourceId()
| void OdDbViewRep::setModelSpaceSourceId | ( | OdDbObjectId | id | ) |
For internal use.
◆ setScaleFromParent()
| void OdDbViewRep::setScaleFromParent | ( | bool | fromParent | ) |
Sets the flag indicating whether this view representation should inherit the scale from the parent view representation.
- Parameters
-
fromParent [in] A new value of the flag to set.
- Remarks
- This flag is true by default for a projected or section view.
◆ setSelSetObjId()
| void OdDbViewRep::setSelSetObjId | ( | OdDbObjectId | id | ) |
For internal use.
◆ setTangentEdgeVisibility()
| void OdDbViewRep::setTangentEdgeVisibility | ( | bool | val | ) |
Sets the tangent edge visibility.
- Parameters
-
val [in] Tangent visibility to set: true to turn on and false to turn off.
◆ setViewOrientType()
| void OdDbViewRep::setViewOrientType | ( | OdDbViewRep::ViewOrientType | type | ) |
For internal use.
◆ setViewStyleType()
| void OdDbViewRep::setViewStyleType | ( | OdDbViewRep::ViewStyleType | vst | ) |
Sets a new view style type.
- Parameters
-
vst [in] A new style type value to set from the OdDbViewRep::ViewStyleType enum.
Value kVisibleAndHiddenLines 1 kVisibleLinesOnly 2
◆ setViewType()
| void OdDbViewRep::setViewType | ( | OdDbViewRep::ViewType | type | ) |
For internal use.
◆ shadedImageViewportId()
| OdDbObjectId OdDbViewRep::shadedImageViewportId | ( | ) | const |
Gets a viewport entity for the shaded image of this view representation.
- Returns
- Object ID of the the OdDbViewport entity.
◆ shadeResolution()
| OdDbViewRepStandard::DpiResolutionType OdDbViewRep::shadeResolution | ( | ) | const |
Gets the shaded image resolution DPI.
- Returns
- Shaded image resolution in DPI as an OdDbViewRepStandard::DpiResolutionType value.
Value k50dpi 50
k100dpi 100
k150dpi 150
k200dpi 200
k300dpi 300
◆ sketchModelSpaceToModelSpaceXform()
| OdResult OdDbViewRep::sketchModelSpaceToModelSpaceXform | ( | OdGeMatrix3d & | mat | ) | const |
For internal use.
◆ sketchModelSpaceToPaperSpaceXform()
| OdResult OdDbViewRep::sketchModelSpaceToPaperSpaceXform | ( | OdGeMatrix3d & | mat | ) | const |
For internal use.
◆ sketchModelSpaceToViewModelSpaceXform()
| OdResult OdDbViewRep::sketchModelSpaceToViewModelSpaceXform | ( | OdGeMatrix3d & | mat | ) | const |
For internal use.
◆ sourceType()
| OdDbViewRep::SourceType OdDbViewRep::sourceType | ( | ) | const |
Gets the source type of this view representation.
- Remarks
- Only OdDbViewRep::kModelSpaceSource is currently supported.
- Returns
- The source type of this view representation.
◆ subClose()
|
overridevirtual |
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.
◆ tangentEdgeVisibility()
| bool OdDbViewRep::tangentEdgeVisibility | ( | ) | const |
Gets the tangent edge visibility.
- Returns
- The true value if tangent edges are visible, or false otherwise.
◆ updateViewportScale()
| OdResult OdDbViewRep::updateViewportScale | ( | double | scale | ) |
Updates the view scale and marks the view representation to be regenerated using a new scale value.
- Parameters
-
scale [in] New scale value.
◆ viewBasePoint()
| OdGePoint2d OdDbViewRep::viewBasePoint | ( | ) | const |
For internal use.
◆ viewBlockReference()
| OdDbObjectId OdDbViewRep::viewBlockReference | ( | ) | const |
Gets the block reference entity that refers to an anonymous block filled with generated projected geometry of the source model.
- Returns
- Object ID of the OdDbBlockReference entity.
◆ viewBorderId()
| OdDbObjectId OdDbViewRep::viewBorderId | ( | ) | const |
Gets the view border entity representing the view representation in paper space.
- Returns
- Object ID of the OdDbViewBorder entity.
◆ viewIndex()
| unsigned long OdDbViewRep::viewIndex | ( | ) | const |
Not implemented yet.
◆ viewModelSpaceToModelSpaceXform()
| OdResult OdDbViewRep::viewModelSpaceToModelSpaceXform | ( | OdGeMatrix3d & | mat | ) | const |
For internal use.
◆ viewModelSpaceToPaperSpaceXform()
| OdResult OdDbViewRep::viewModelSpaceToPaperSpaceXform | ( | OdGeMatrix3d & | mat | ) | const |
For internal use.
◆ viewOrientType()
| OdDbViewRep::ViewOrientType OdDbViewRep::viewOrientType | ( | ) | const |
Gets a view orientation type.
- Returns
- A view orientation type as one of the ViewOrientType enum's values.
Value Description kFront 0 Front
kTop 1 Top
kRight 2 Right
kBack 3 Back
kBottom 4 Bottom
kLeft 5 Left
kNEIsometric 6 NE Isometric kNWIsometric 7 NW Isometric kSEIsometric 8 SE Isometric kSWIsometric 9 SW Isometric kCurrent 21 Same as source model view orientation
◆ viewportId()
| OdDbObjectId OdDbViewRep::viewportId | ( | ) | const |
Gets a viewport entity representing the view representation in paper space.
- Returns
- Object ID of the OdDbViewport entity.
◆ viewStyleType()
| OdDbViewRep::ViewStyleType OdDbViewRep::viewStyleType | ( | ) | const |
Gets a view style type.
- Returns
- The view style type as an OdDbViewRep::ViewStyleType value.
Value kVisibleAndHiddenLines 1 kVisibleLinesOnly 2
◆ viewType()
| OdDbViewRep::ViewType OdDbViewRep::viewType | ( | ) | const |
Gets a view type.
- Returns
- A view type as one of the ViewType enum's values.
Value kBase 0 kDetail 2 kSection 3 kProjected 4
Friends And Related Symbol Documentation
◆ OdDbAssocViewRepActionBodyEvaluator
|
friend |
Definition at line 541 of file DbViewRep.h.
◆ OdDbImpAssocViewRepActionBody
|
friend |
Definition at line 540 of file DbViewRep.h.
The documentation for this class was generated from the following file:
Generated on Tue Apr 15 2025 11:30:27