#include <DbSectionViewStyle.h>
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 objects.
Corresponding C++ library: TD_Db <group OdDb_Classes>
Definition at line 38 of file DbSectionViewStyle.h.
Member Enumeration Documentation
◆ ArrowDirection
Defines section view symbol arrowhead direction.
| Enumerator | |
|---|---|
| kTowardsCuttingPlane | |
| kAwayFromCuttingPlane | |
Definition at line 57 of file DbSectionViewStyle.h.
◆ IdentifierPosition
Defines identifier position types.
| Enumerator | |
|---|---|
| kEndCuttingPlane | |
| kAboveDirectionArrowLine | |
| kAboveDirectionArrowSymbol | |
| kStartDirectionArrow | |
| kEndDirectionArrow | |
Definition at line 46 of file DbSectionViewStyle.h.
Constructor & Destructor Documentation
◆ OdDbSectionViewStyle()
| OdDbSectionViewStyle::OdDbSectionViewStyle | ( | ) |
Default constructor. Creates an OdDbSectionViewStyle instance.
◆ ~OdDbSectionViewStyle()
| OdDbSectionViewStyle::~OdDbSectionViewStyle | ( | ) |
Member Function Documentation
◆ arrowEndSymbolId()
| OdDbObjectId OdDbSectionViewStyle::arrowEndSymbolId | ( | ) | const |
Returns the object ID of the arrow end symbol.
◆ arrowPosition()
| OdDbSectionViewStyle::ArrowDirection OdDbSectionViewStyle::arrowPosition | ( | ) | const |
Returns arrow position type for this OdDbSectionViewStyle object as an OdDbSectionViewStyle::ArrowDirection value.
◆ arrowStartSymbolId()
| OdDbObjectId OdDbSectionViewStyle::arrowStartSymbolId | ( | ) | const |
Returns the object ID of the arrow start symbol.
◆ arrowSymbolColor()
| OdCmColor OdDbSectionViewStyle::arrowSymbolColor | ( | ) | const |
Returns the arrow symbol's color.
◆ arrowSymbolExtensionLength()
| double OdDbSectionViewStyle::arrowSymbolExtensionLength | ( | ) | const |
Returns the arrow symbol's extension length.
◆ arrowSymbolSize()
| double OdDbSectionViewStyle::arrowSymbolSize | ( | ) | const |
Returns the arrow symbol's size.
◆ bendLineColor()
| OdCmColor OdDbSectionViewStyle::bendLineColor | ( | ) | const |
Returns the bend line's color.
◆ bendLineLength()
| double OdDbSectionViewStyle::bendLineLength | ( | ) | const |
Returns the bend line's length.
◆ bendLineTypeId()
| OdDbObjectId OdDbSectionViewStyle::bendLineTypeId | ( | ) | const |
Returns the object ID of the bend line's linetype.
◆ bendLineWeight()
| OdDb::LineWeight OdDbSectionViewStyle::bendLineWeight | ( | ) | const |
Returns the bend 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.
◆ endLineLength()
| double OdDbSectionViewStyle::endLineLength | ( | ) | const |
Returns the end line's length.
◆ endLineOvershoot()
| double OdDbSectionViewStyle::endLineOvershoot | ( | ) | const |
Returns the end line's overshoot value.
◆ getViewLabelPattern()
Returns the view label's pattern.
pField (Optional) If the pattern uses fields, they are copied 'pField'.
- Returns
- Pattern of the view label.
◆ hatchAngles()
| const OdGeDoubleArray & OdDbSectionViewStyle::hatchAngles | ( | ) | const |
Returns the hatch's angle array as a pointer to an OdGeDoubleArray object.
◆ hatchBackgroundColor()
| OdCmColor OdDbSectionViewStyle::hatchBackgroundColor | ( | ) | const |
Returns the hatch's background color.
◆ hatchColor()
| OdCmColor OdDbSectionViewStyle::hatchColor | ( | ) | const |
Returns the hatch's color.
◆ hatchPattern()
| OdString OdDbSectionViewStyle::hatchPattern | ( | ) | const |
Returns the hatch pattern.
◆ hatchScale()
| double OdDbSectionViewStyle::hatchScale | ( | ) | const |
Returns the hatch's scale.
◆ hatchTransparency()
| OdCmTransparency OdDbSectionViewStyle::hatchTransparency | ( | ) | const |
Returns the hatch's transparency as an OdCmTransparency object.
◆ identifierColor()
| OdCmColor OdDbSectionViewStyle::identifierColor | ( | ) | const |
Returns the identifier's color.
◆ identifierExcludeCharacters()
| OdString OdDbSectionViewStyle::identifierExcludeCharacters | ( | ) | const |
Returns the excluded characters that are specified for the identifier.
◆ identifierHeight()
| double OdDbSectionViewStyle::identifierHeight | ( | ) | const |
Returns the identifier's height.
◆ identifierStyleId()
| OdDbObjectId OdDbSectionViewStyle::identifierStyleId | ( | ) | const |
Returns the object ID of the style assigned to the identifier.
◆ isContinuousLabeling()
| bool OdDbSectionViewStyle::isContinuousLabeling | ( | ) | const |
Returns whether continuous labeling is enabled.
◆ ODDB_DECLARE_MEMBERS()
| OdDbSectionViewStyle::ODDB_DECLARE_MEMBERS | ( | OdDbSectionViewStyle | ) |
◆ planeLineColor()
| OdCmColor OdDbSectionViewStyle::planeLineColor | ( | ) | const |
Returns the plane line's color.
◆ planeLineTypeId()
| OdDbObjectId OdDbSectionViewStyle::planeLineTypeId | ( | ) | const |
Returns the object ID of the plane line's linetype.
◆ planeLineWeight()
| OdDb::LineWeight OdDbSectionViewStyle::planeLineWeight | ( | ) | const |
Returns the plane line's lineweight.
◆ 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.
◆ setArrowEndSymbolId()
| OdResult OdDbSectionViewStyle::setArrowEndSymbolId | ( | const OdDbObjectId & | arrowSymbolId | ) |
Sets the arrow end symbol to use a specified block.
◆ setArrowPosition()
| OdResult OdDbSectionViewStyle::setArrowPosition | ( | OdDbSectionViewStyle::ArrowDirection | type | ) |
Sets section view symbol arrowhead direction for this OdDbSectionViewStyle object.
- Parameters
-
type [in] Arrowhead direction.
- Returns
- eOk if successful.
◆ setArrowStartSymbolId()
| OdResult OdDbSectionViewStyle::setArrowStartSymbolId | ( | const OdDbObjectId & | arrowSymbolId | ) |
Sets the arrow start symbol to use a specified block.
◆ setArrowSymbolColor()
Sets the arrow symbol's color.
◆ setArrowSymbolExtensionLength()
| OdResult OdDbSectionViewStyle::setArrowSymbolExtensionLength | ( | double | length | ) |
Sets the arrow symbol's extension length.
◆ setArrowSymbolSize()
| OdResult OdDbSectionViewStyle::setArrowSymbolSize | ( | double | size | ) |
Sets the arrow symbol's size.
◆ setBendLineColor()
Sets the bend line's color.
◆ setBendLineLength()
| OdResult OdDbSectionViewStyle::setBendLineLength | ( | double | length | ) |
Sets the bend line's length.
◆ setBendLineTypeId()
| OdResult OdDbSectionViewStyle::setBendLineTypeId | ( | const OdDbObjectId & | objId | ) |
Sets the bend line's linetype.
◆ setBendLineWeight()
| OdResult OdDbSectionViewStyle::setBendLineWeight | ( | OdDb::LineWeight | lineweight | ) |
Sets the bend line's lineweight.
◆ setContinuousLabeling()
| OdResult OdDbSectionViewStyle::setContinuousLabeling | ( | bool | bValue | ) |
Sets whether continuous labeling is enabled or disabled.
- Parameters
-
bValue [in] True if continuous labeling is to be enabled, false otherwise.
- Returns
- eOk if successful.
◆ setEndLineLength()
| OdResult OdDbSectionViewStyle::setEndLineLength | ( | double | length | ) |
Sets the end line's length.
◆ setEndLineOvershoot()
| OdResult OdDbSectionViewStyle::setEndLineOvershoot | ( | double | length | ) |
Sets the end line's overshoot value.
- Parameters
-
length [in] Line's overshoot length.
- Returns
- eOk if successful.
◆ setHatchAngles()
| OdResult OdDbSectionViewStyle::setHatchAngles | ( | const OdGeDoubleArray & | angleArray | ) |
Sets the hatch's angle array.
- Parameters
-
angleArray [in] Array of doubles to set hatch's angles used by section views.
- Returns
- eOk if successful.
- Remarks
- Angles are set in radians. At least one angle value must be present in the array. The first element is used by the first section view component, the second element is used by the second component and so on. If the component number is more than the array size then the sequence is cycled.
◆ setHatchBackgroundColor()
Sets the hatch's background color.
◆ setHatchColor()
◆ setHatchPattern()
◆ setHatchScale()
| OdResult OdDbSectionViewStyle::setHatchScale | ( | double | scale | ) |
Sets the hatch's scale.
◆ setHatchTransparency()
| OdResult OdDbSectionViewStyle::setHatchTransparency | ( | const OdCmTransparency & | transparency | ) |
Sets the hatch's transparency.
- Parameters
-
transparency [in] Transparency object to set hatch's transparency.
- Returns
- eOk if successful.
◆ setIdentifierColor()
Sets the identifier's color.
◆ setIdentifierExcludeCharacters()
Sets the characters to exclude for the identifier.
str Characters to exclude, each separated by a comma.
- Returns
- eOk if successful or eInvalidInput if incorrect format or invalid characters.
◆ setIdentifierHeight()
| OdResult OdDbSectionViewStyle::setIdentifierHeight | ( | double | height | ) |
Sets the identifier's height.
◆ setIdentifierStyleId()
| OdResult OdDbSectionViewStyle::setIdentifierStyleId | ( | const OdDbObjectId & | objId | ) |
Sets the identifier's text style.
ObjectId The ID of the text style for the identifier.
\returns OdDb::eOk if successful.
◆ setPlaneLineColor()
Sets the plane line's color.
◆ setPlaneLineTypeId()
| OdResult OdDbSectionViewStyle::setPlaneLineTypeId | ( | const OdDbObjectId & | objId | ) |
Sets the plane line's linetype according to the linetype's object ID.
◆ setPlaneLineWeight()
| OdResult OdDbSectionViewStyle::setPlaneLineWeight | ( | OdDb::LineWeight | lineweight | ) |
Sets the plane line's lineweight.
◆ setShowAllBendIndentifiers()
| OdResult OdDbSectionViewStyle::setShowAllBendIndentifiers | ( | bool | bValue | ) |
Sets whether identifiers at all bends are shown or not.
- Parameters
-
bValue [in] True if identifiers at all bends are to be shown, false otherwise.
- Returns
- eOk if successful.
◆ setShowAllPlaneLines()
| OdResult OdDbSectionViewStyle::setShowAllPlaneLines | ( | bool | bValue | ) |
Sets whether plane lines are shown or not.
- Parameters
-
bValue [in] True if plane lines are to be shown, false otherwise.
- Returns
- eOk if successful.
◆ setShowArrowheads()
| OdResult OdDbSectionViewStyle::setShowArrowheads | ( | bool | bValue | ) |
Sets whether arrowheads are shown or not.
- Parameters
-
bValue [in] True if arrowheads are to be shown, false otherwise.
- Returns
- eOk if successful.
◆ setShowEndAndBendLines()
| OdResult OdDbSectionViewStyle::setShowEndAndBendLines | ( | bool | bValue | ) |
Sets whether end lines and bend lines are shown or not.
- Parameters
-
bValue [in] True if end lines and bend lines are to be shown, false otherwise.
- Returns
- eOk if successful.
◆ setShowHatching()
| OdResult OdDbSectionViewStyle::setShowHatching | ( | bool | bValue | ) |
Sets whether hatches are shown or not.
- Parameters
-
bValue [in] True if hatches are to be shown, false otherwise.
- Returns
- eOk if successful.
◆ setShowViewLabel()
| OdResult OdDbSectionViewStyle::setShowViewLabel | ( | bool | bValue | ) |
Sets whether view labels are shown or not.
- Parameters
-
bValue [in] True if view labels are to be shown, false otherwise.
- Returns
- eOk if successful.
◆ setViewIdentifierOffset()
| OdResult OdDbSectionViewStyle::setViewIdentifierOffset | ( | double | offset | ) |
Sets view identifier offset.
- Parameters
-
offset [in] View identifier offset.
- Returns
- eOk if successful.
◆ setViewIdentifierPosition()
| OdResult OdDbSectionViewStyle::setViewIdentifierPosition | ( | OdDbSectionViewStyle::IdentifierPosition | type | ) |
Sets view identifier position type.
- Parameters
-
type [in] Identifier position type.
- Returns
- eOk if successful.
◆ setViewLabelAlignment()
| OdResult OdDbSectionViewStyle::setViewLabelAlignment | ( | OdDbModelDocViewStyle::TextAlignment | alignment | ) |
Sets the view label's text alignment.
◆ setViewLabelAttachment()
| OdResult OdDbSectionViewStyle::setViewLabelAttachment | ( | OdDbModelDocViewStyle::AttachmentPoint | attachment | ) |
Sets the view label's attachment point.
◆ setViewLabelOffset()
| OdResult OdDbSectionViewStyle::setViewLabelOffset | ( | double | offset | ) |
Sets the view label's offset.
◆ setViewLabelPattern()
| OdResult OdDbSectionViewStyle::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 OdDbSectionViewStyle::setViewLabelTextHeight | ( | double | height | ) |
Sets the view label's text height.
◆ setViewLabelTextStyleId()
| OdResult OdDbSectionViewStyle::setViewLabelTextStyleId | ( | const OdDbObjectId & | objId | ) |
Sets the view label's text style.
◆ showAllBendIndentifiers()
| bool OdDbSectionViewStyle::showAllBendIndentifiers | ( | ) | const |
Returns whether identifiers at all bends of the cutting plane lines display.
◆ showAllPlaneLines()
| bool OdDbSectionViewStyle::showAllPlaneLines | ( | ) | const |
Returns whether plane lines display.
◆ showArrowheads()
| bool OdDbSectionViewStyle::showArrowheads | ( | ) | const |
Returns whether arrowheads display.
◆ showEndAndBendLines()
| bool OdDbSectionViewStyle::showEndAndBendLines | ( | ) | const |
Returns whether end lines and bend lines display.
◆ showHatching()
| bool OdDbSectionViewStyle::showHatching | ( | ) | const |
Returns whether hatches display.
◆ showViewLabel()
| bool OdDbSectionViewStyle::showViewLabel | ( | ) | const |
Returns whether view labels display.
◆ subWblockClone()
|
protectedvirtual |
Reimplemented from OdDbObject.
◆ viewIdentifierOffset()
| double OdDbSectionViewStyle::viewIdentifierOffset | ( | ) | const |
Returns view identifier offset as a double value.
◆ viewIdentifierPosition()
| OdDbSectionViewStyle::IdentifierPosition OdDbSectionViewStyle::viewIdentifierPosition | ( | ) | const |
**
Returns view identifier position as an OdDbSectionViewStyle::IdentifierPosition value.
◆ viewLabelAlignment()
| OdDbModelDocViewStyle::TextAlignment OdDbSectionViewStyle::viewLabelAlignment | ( | ) | const |
Returns the view label's text alignment.
◆ viewLabelAttachment()
| OdDbModelDocViewStyle::AttachmentPoint OdDbSectionViewStyle::viewLabelAttachment | ( | ) | const |
Returns the view label's attachment point.
◆ viewLabelOffset()
| double OdDbSectionViewStyle::viewLabelOffset | ( | ) | const |
Returns the view label's offset.
◆ viewLabelPattern()
| OdString OdDbSectionViewStyle::viewLabelPattern | ( | ) | const |
Returns the view label's pattern.
◆ viewLabelTextColor()
| OdCmColor OdDbSectionViewStyle::viewLabelTextColor | ( | ) | const |
Returns the view label's color.
◆ viewLabelTextHeight()
| double OdDbSectionViewStyle::viewLabelTextHeight | ( | ) | const |
Returns the view label's text height.
◆ viewLabelTextStyleId()
| OdDbObjectId OdDbSectionViewStyle::viewLabelTextStyleId | ( | ) | const |
Returns the object ID of the view label's text style.
The documentation for this class was generated from the following file: