#include <DbDetailViewStyle.h>
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 |
 Protected Member Functions inherited from OdDbModelDocViewStyle | |
| OdDbModelDocViewStyle () | |
| 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 |
Additional Inherited Members | |
| Static Public Member Functions inherited from OdRxObject | |
| static OdRxObjectPtr | cast (const OdRxObject *pointer) |
| static OdRxClass * | desc () |
| Protected Types inherited from OdDbModelDocViewStyle | |
| enum | { kCanRename = 1 } |
| Protected Attributes inherited from OdDbObject | |
| OdDbObjectImpl * | m_pImpl |
Detailed Description
This class represents detail view style object.
Corresponding C++ library: TD_Db <group OdDb_Classes>
Definition at line 37 of file DbDetailViewStyle.h.
Member Enumeration Documentation
◆ IdentifierPlacement
Defines the identifier placement inside the detail view symbol.
| Enumerator | |
|---|---|
| kOutsideBoundary | |
| kOutsideBoundaryWithLeader | |
| kOnBoundary | |
| kOnBoundaryWithLeader | |
Definition at line 45 of file DbDetailViewStyle.h.
◆ ModelEdge
Defines the edge type of the detail view symbol boundary.
| Enumerator | |
|---|---|
| kSmooth | |
| kSmoothWithBorder | |
| kSmoothWithConnectionLine | |
| kJagged | |
Definition at line 55 of file DbDetailViewStyle.h.
Constructor & Destructor Documentation
◆ OdDbDetailViewStyle()
| OdDbDetailViewStyle::OdDbDetailViewStyle | ( | ) |
Default constructor. Creates an OdDbDetailViewStyle instance.
◆ ~OdDbDetailViewStyle()
| OdDbDetailViewStyle::~OdDbDetailViewStyle | ( | ) |
Member Function Documentation
◆ arrowSymbolColor()
| OdCmColor OdDbDetailViewStyle::arrowSymbolColor | ( | ) | const |
Returns the arrow symbol's color.
◆ arrowSymbolId()
| OdDbObjectId OdDbDetailViewStyle::arrowSymbolId | ( | ) | const |
Returns the arrow symbol's object ID.
◆ arrowSymbolSize()
| double OdDbDetailViewStyle::arrowSymbolSize | ( | ) | const |
Returns the arrow symbol's size.
◆ borderLineColor()
| OdCmColor OdDbDetailViewStyle::borderLineColor | ( | ) | const |
Returns the border line's color.
◆ borderLineTypeId()
| OdDbObjectId OdDbDetailViewStyle::borderLineTypeId | ( | ) | const |
Returns the object ID of the border line's linetype.
◆ borderLineWeight()
| OdDb::LineWeight OdDbDetailViewStyle::borderLineWeight | ( | ) | const |
Returns the border line's lineweight.
◆ boundaryLineColor()
| OdCmColor OdDbDetailViewStyle::boundaryLineColor | ( | ) | const |
Returns the boundary line's color.
◆ boundaryLineTypeId()
| OdDbObjectId OdDbDetailViewStyle::boundaryLineTypeId | ( | ) | const |
Returns the object ID of the boundary line's linetype.
◆ boundaryLineWeight()
| OdDb::LineWeight OdDbDetailViewStyle::boundaryLineWeight | ( | ) | const |
Returns the boundary line's lineweight.
◆ connectionLineColor()
| OdCmColor OdDbDetailViewStyle::connectionLineColor | ( | ) | const |
Returns the connection line's color.
◆ connectionLineTypeId()
| OdDbObjectId OdDbDetailViewStyle::connectionLineTypeId | ( | ) | const |
Returns the object ID of the connection line's linetype.
◆ connectionLineWeight()
| OdDb::LineWeight OdDbDetailViewStyle::connectionLineWeight | ( | ) | const |
Returns the connection line's lineweight.
◆ 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 OdDbModelDocViewStyle.
◆ 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 OdDbModelDocViewStyle.
◆ 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 OdDbModelDocViewStyle.
◆ 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 OdDbModelDocViewStyle.
◆ getViewLabelPattern()
Returns the view label's pattern.
pField If the pattern uses fields, they are copied 'pField'.
- Returns
- Pattern of the view label.
◆ identifierColor()
| OdCmColor OdDbDetailViewStyle::identifierColor | ( | ) | const |
Returns the identifier's color.
◆ identifierHeight()
| double OdDbDetailViewStyle::identifierHeight | ( | ) | const |
Returns the identifier's text height.
◆ identifierOffset()
| double OdDbDetailViewStyle::identifierOffset | ( | ) | const |
Returns the identifier's offset between its arrow line and extension line.
◆ identifierPlacement()
| OdDbDetailViewStyle::IdentifierPlacement OdDbDetailViewStyle::identifierPlacement | ( | ) | const |
Returns the placement for the label and identifier.
◆ identifierStyleId()
| OdDbObjectId OdDbDetailViewStyle::identifierStyleId | ( | ) | const |
Returns the object ID of the identifier's text style.
- Returns
- Text style object ID.
◆ modelEdge()
| OdDbDetailViewStyle::ModelEdge OdDbDetailViewStyle::modelEdge | ( | ) | const |
Returns label and model edge.
◆ ODDB_DECLARE_MEMBERS()
| OdDbDetailViewStyle::ODDB_DECLARE_MEMBERS | ( | OdDbDetailViewStyle | ) |
◆ postViewStyleToDb()
|
virtual |
Includes this view style object in a OdDbDatabase object.
- Parameters
-
pDb [in] Pointer of the database to receive the OdDbModelDocViewStyle object. styleName [in] Name of the view style.
- Returns
- Returns the OdDbObjectID of the newly added OdDbModelDocViewStyle object.
Implements OdDbModelDocViewStyle.
◆ setArrowSymbolColor()
Sets the arrow symbol's color.
◆ setArrowSymbolId()
| OdResult OdDbDetailViewStyle::setArrowSymbolId | ( | const OdDbObjectId & | arrowSymbolId | ) |
Sets the arrow symbol's block.
◆ setArrowSymbolSize()
| OdResult OdDbDetailViewStyle::setArrowSymbolSize | ( | double | size | ) |
Sets the arrow symbol's size.
◆ setBorderLineColor()
Sets the border line's color.
◆ setBorderLineTypeId()
| OdResult OdDbDetailViewStyle::setBorderLineTypeId | ( | const OdDbObjectId & | objId | ) |
Sets the border line's linetype.
◆ setBorderLineWeight()
| OdResult OdDbDetailViewStyle::setBorderLineWeight | ( | OdDb::LineWeight | lineweight | ) |
Sets the border line's lineweight.
◆ setBoundaryLineColor()
Sets the boundary line's color.
◆ setBoundaryLineTypeId()
| OdResult OdDbDetailViewStyle::setBoundaryLineTypeId | ( | const OdDbObjectId & | objId | ) |
Sets the boundary line's linetype.
◆ setBoundaryLineWeight()
| OdResult OdDbDetailViewStyle::setBoundaryLineWeight | ( | OdDb::LineWeight | lineweight | ) |
Sets the boundary line's lineweight.
◆ setConnectionLineColor()
Sets the connection line's color.
◆ setConnectionLineTypeId()
| OdResult OdDbDetailViewStyle::setConnectionLineTypeId | ( | const OdDbObjectId & | objId | ) |
Sets the connection line's linetype.
◆ setConnectionLineWeight()
| OdResult OdDbDetailViewStyle::setConnectionLineWeight | ( | OdDb::LineWeight | lineweight | ) |
Sets the connection line's lineweight.
◆ setIdentifierColor()
Sets the identifier's color.
- Parameters
-
color [in] Color for the identifier.
- Returns
- Return OdDb::eOk if successful.
◆ setIdentifierHeight()
| OdResult OdDbDetailViewStyle::setIdentifierHeight | ( | double | height | ) |
Sets the identifier's text height.
- Parameters
-
height [in] Text height.
- Returns
- Return OdDb::eOk if successful.
◆ setIdentifierOffset()
| OdResult OdDbDetailViewStyle::setIdentifierOffset | ( | double | offset | ) |
Sets the identifier's offset between its arrow line and extension line.
◆ setIdentifierPlacement()
| OdResult OdDbDetailViewStyle::setIdentifierPlacement | ( | OdDbDetailViewStyle::IdentifierPlacement | placement | ) |
Sets the placement for the label and identifier.
- Parameters
-
placement [in] Bit coded value that defines the placements of label and identifier.
- Returns
- OdDb::eOk if successful.
◆ setIdentifierStyleId()
| OdResult OdDbDetailViewStyle::setIdentifierStyleId | ( | const OdDbObjectId & | objId | ) |
Sets the identifier's text style.
- Parameters
-
objId [in] Object ID of the text style. \returns
OdDb::eOk if successful.
◆ setModelEdge()
| OdResult OdDbDetailViewStyle::setModelEdge | ( | OdDbDetailViewStyle::ModelEdge | placement | ) |
Sets the placement of labels and identifiers.
◆ setShowArrows()
| OdResult OdDbDetailViewStyle::setShowArrows | ( | bool | bValue | ) |
◆ setShowViewLabel()
| OdResult OdDbDetailViewStyle::setShowViewLabel | ( | bool | bValue | ) |
◆ setViewLabelAlignment()
| OdResult OdDbDetailViewStyle::setViewLabelAlignment | ( | OdDbModelDocViewStyle::TextAlignment | alignment | ) |
Sets the view label's text alignment.
◆ setViewLabelAttachment()
| OdResult OdDbDetailViewStyle::setViewLabelAttachment | ( | OdDbModelDocViewStyle::AttachmentPoint | attachment | ) |
Sets the view label's attachment.
◆ setViewLabelOffset()
| OdResult OdDbDetailViewStyle::setViewLabelOffset | ( | double | offset | ) |
Sets the view label's offset.
◆ setViewLabelPattern()
| OdResult OdDbDetailViewStyle::setViewLabelPattern | ( | const OdString & | pattern, |
| const OdDbField * | pField = NULL |
||
| ) |
Sets the view label's pattern.
pattern Pattern to assign to the view label. pField (Optional) Specify a field to assign the pattern from the field (instead of the pattern itself).
- Returns
- OdDb::eOk if successful.
◆ setViewLabelTextColor()
Sets the view label's color.
◆ setViewLabelTextHeight()
| OdResult OdDbDetailViewStyle::setViewLabelTextHeight | ( | double | height | ) |
◆ setViewLabelTextStyleId()
| OdResult OdDbDetailViewStyle::setViewLabelTextStyleId | ( | const OdDbObjectId & | objId | ) |
Sets the view label's text style.
◆ showArrows()
| bool OdDbDetailViewStyle::showArrows | ( | ) | const |
Returns whether arrowheads display.
◆ showViewLabel()
| bool OdDbDetailViewStyle::showViewLabel | ( | ) | const |
Returns whether view label.
◆ viewLabelAlignment()
| OdDbModelDocViewStyle::TextAlignment OdDbDetailViewStyle::viewLabelAlignment | ( | ) | const |
Returns the view label's text alignment.
◆ viewLabelAttachment()
| OdDbModelDocViewStyle::AttachmentPoint OdDbDetailViewStyle::viewLabelAttachment | ( | ) | const |
Returns the view label's attachment.
◆ viewLabelOffset()
| double OdDbDetailViewStyle::viewLabelOffset | ( | ) | const |
Returns the view label's offset.
◆ viewLabelPattern()
| OdString OdDbDetailViewStyle::viewLabelPattern | ( | ) | const |
Returns the view label's pattern.
◆ viewLabelTextColor()
| OdCmColor OdDbDetailViewStyle::viewLabelTextColor | ( | ) | const |
Returns the view label's color.
◆ viewLabelTextHeight()
| double OdDbDetailViewStyle::viewLabelTextHeight | ( | ) | const |
Returns the view label's text height.
◆ viewLabelTextStyleId()
| OdDbObjectId OdDbDetailViewStyle::viewLabelTextStyleId | ( | ) | const |
Returns the object ID of the view label's text style.
The documentation for this class was generated from the following file: