defines the attributes when drawing a Length Presentation. More...
#include <Prs3d_DimensionAspect.hxx>
Inheritance diagram for Prs3d_DimensionAspect:
Public Member Functions | |
| Prs3d_DimensionAspect () | |
| Constructs an empty framework to define the display of dimensions. More... | |
| Handle< Prs3d_LineAspect > | LineAspect () const |
| Returns the settings for the display of lines used in presentation of dimensions. More... | |
| void | SetLineAspect (const Handle< Prs3d_LineAspect > &theAspect) |
| Sets the display attributes of lines used in presentation of dimensions. More... | |
| Handle< Prs3d_TextAspect > | TextAspect () const |
| Returns the settings for the display of text used in presentation of dimensions. More... | |
| void | SetTextAspect (const Handle< Prs3d_TextAspect > &theAspect) |
| Sets the display attributes of text used in presentation of dimensions. More... | |
| Standard_Boolean | IsText3d () const |
| Check if text for dimension label is 3d. More... | |
| void | MakeText3d (const Standard_Boolean isText3d) |
| Sets type of text. More... | |
| Standard_Boolean | IsTextShaded () const |
| Check if 3d text for dimension label is shaded. More... | |
| void | MakeTextShaded (const Standard_Boolean isTextShaded) |
| Turns on/off text shading for 3d text. More... | |
| Standard_Boolean | IsArrows3d () const |
| Gets type of arrows. More... | |
| void | MakeArrows3d (const Standard_Boolean isArrows3d) |
| Sets type of arrows. More... | |
| Standard_Boolean | IsUnitsDisplayed () const |
| Shows if Units are to be displayed along with dimension value. More... | |
| void | MakeUnitsDisplayed (const Standard_Boolean theIsDisplayed) |
| Specifies whether the units string should be displayed along with value label or not. More... | |
| void | SetArrowOrientation (const Prs3d_DimensionArrowOrientation theArrowOrient) |
| Sets orientation of arrows (external or internal). By default orientation is chosen automatically according to situation and text label size. More... | |
| Prs3d_DimensionArrowOrientation | ArrowOrientation () const |
| Gets orientation of arrows (external or internal). More... | |
| void | SetTextVerticalPosition (const Prs3d_DimensionTextVerticalPosition thePosition) |
| Sets vertical text alignment for text label. More... | |
| Prs3d_DimensionTextVerticalPosition | TextVerticalPosition () const |
| Gets vertical text alignment for text label. More... | |
| void | SetTextHorizontalPosition (const Prs3d_DimensionTextHorizontalPosition thePosition) |
| Sets horizontal text alignment for text label. More... | |
| Prs3d_DimensionTextHorizontalPosition | TextHorizontalPosition () const |
| Gets horizontal text alignment for text label. More... | |
| Handle< Prs3d_ArrowAspect > | ArrowAspect () const |
| Returns the settings for displaying arrows. More... | |
| void | SetArrowAspect (const Handle< Prs3d_ArrowAspect > &theAspect) |
| Sets the display attributes of arrows used in presentation of dimensions. More... | |
| void | SetCommonColor (const Quantity_Color &theColor) |
| Sets the same color for all parts of dimension: lines, arrows and text. More... | |
| void | SetExtensionSize (const Standard_Real theSize) |
| Sets extension size. More... | |
| Standard_Real | ExtensionSize () const |
| Returns extension size. More... | |
| void | SetArrowTailSize (const Standard_Real theSize) |
| Set size for arrow tail (extension without text). More... | |
| Standard_Real | ArrowTailSize () const |
| Returns arrow tail size. More... | |
| void | SetValueStringFormat (const TCollection_AsciiString &theFormat) |
| Sets "sprintf"-syntax format for formatting dimension value labels. More... | |
| TCollection_AsciiString | ValueStringFormat () const |
| Returns format. More... | |
 Public Member Functions inherited from MMgt_TShared | |
| virtual void | Delete () const override |
| Memory deallocator for transient classes. More... | |
| Public Member Functions inherited from Standard_Transient | |
| Standard_Transient () | |
| Empty constructor. More... | |
| Standard_Transient (const Standard_Transient &) | |
| Copy constructor – does nothing. More... | |
| Standard_Transient & | operator= (const Standard_Transient &) |
| Assignment operator, needed to avoid copying reference counter. More... | |
| virtual | ~Standard_Transient () |
| Destructor must be virtual. More... | |
| virtual const opencascade::handle< Standard_Type > & | DynamicType () const |
| Returns a type descriptor about this object. More... | |
| Standard_Boolean | IsInstance (const opencascade::handle< Standard_Type > &theType) const |
| Returns a true value if this is an instance of Type. More... | |
| Standard_Boolean | IsInstance (const Standard_CString theTypeName) const |
| Returns a true value if this is an instance of TypeName. More... | |
| Standard_Boolean | IsKind (const opencascade::handle< Standard_Type > &theType) const |
| Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More... | |
| Standard_Boolean | IsKind (const Standard_CString theTypeName) const |
| Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More... | |
| Standard_Transient * | This () const |
| Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More... | |
| Standard_Integer | GetRefCount () const |
| Get the reference counter of this object. More... | |
| void | IncrementRefCounter () const |
| Increments the reference counter of this object. More... | |
| Standard_Integer | DecrementRefCounter () const |
| Decrements the reference counter of this object; returns the decremented value. More... | |
Additional Inherited Members | |
| Public Types inherited from Standard_Transient | |
| typedef void | base_type |
| Returns a type descriptor about this object. More... | |
| Static Public Member Functions inherited from Standard_Transient | |
| static const char * | get_type_name () |
| Returns a type descriptor about this object. More... | |
| static const opencascade::handle< Standard_Type > & | get_type_descriptor () |
| Returns type descriptor of Standard_Transient class. More... | |
Detailed Description
defines the attributes when drawing a Length Presentation.
Constructor & Destructor Documentation
| Prs3d_DimensionAspect::Prs3d_DimensionAspect | ( | ) |
Constructs an empty framework to define the display of dimensions.
Member Function Documentation
| Handle< Prs3d_ArrowAspect > Prs3d_DimensionAspect::ArrowAspect | ( | ) | const |
Returns the settings for displaying arrows.
| Prs3d_DimensionArrowOrientation Prs3d_DimensionAspect::ArrowOrientation | ( | ) | const |
Gets orientation of arrows (external or internal).
| Standard_Real Prs3d_DimensionAspect::ArrowTailSize | ( | ) | const |
Returns arrow tail size.
| Standard_Real Prs3d_DimensionAspect::ExtensionSize | ( | ) | const |
Returns extension size.
| Standard_Boolean Prs3d_DimensionAspect::IsArrows3d | ( | ) | const |
Gets type of arrows.
| Standard_Boolean Prs3d_DimensionAspect::IsText3d | ( | ) | const |
Check if text for dimension label is 3d.
| Standard_Boolean Prs3d_DimensionAspect::IsTextShaded | ( | ) | const |
Check if 3d text for dimension label is shaded.
| Standard_Boolean Prs3d_DimensionAspect::IsUnitsDisplayed | ( | ) | const |
Shows if Units are to be displayed along with dimension value.
| Handle< Prs3d_LineAspect > Prs3d_DimensionAspect::LineAspect | ( | ) | const |
Returns the settings for the display of lines used in presentation of dimensions.
| void Prs3d_DimensionAspect::MakeArrows3d | ( | const Standard_Boolean | isArrows3d | ) |
Sets type of arrows.
| void Prs3d_DimensionAspect::MakeText3d | ( | const Standard_Boolean | isText3d | ) |
Sets type of text.
| void Prs3d_DimensionAspect::MakeTextShaded | ( | const Standard_Boolean | isTextShaded | ) |
Turns on/off text shading for 3d text.
| void Prs3d_DimensionAspect::MakeUnitsDisplayed | ( | const Standard_Boolean | theIsDisplayed | ) |
Specifies whether the units string should be displayed along with value label or not.
| void Prs3d_DimensionAspect::SetArrowAspect | ( | const Handle< Prs3d_ArrowAspect > & | theAspect | ) |
Sets the display attributes of arrows used in presentation of dimensions.
| void Prs3d_DimensionAspect::SetArrowOrientation | ( | const Prs3d_DimensionArrowOrientation | theArrowOrient | ) |
Sets orientation of arrows (external or internal). By default orientation is chosen automatically according to situation and text label size.
| void Prs3d_DimensionAspect::SetArrowTailSize | ( | const Standard_Real | theSize | ) |
Set size for arrow tail (extension without text).
| void Prs3d_DimensionAspect::SetCommonColor | ( | const Quantity_Color & | theColor | ) |
Sets the same color for all parts of dimension: lines, arrows and text.
| void Prs3d_DimensionAspect::SetExtensionSize | ( | const Standard_Real | theSize | ) |
Sets extension size.
| void Prs3d_DimensionAspect::SetLineAspect | ( | const Handle< Prs3d_LineAspect > & | theAspect | ) |
Sets the display attributes of lines used in presentation of dimensions.
| void Prs3d_DimensionAspect::SetTextAspect | ( | const Handle< Prs3d_TextAspect > & | theAspect | ) |
Sets the display attributes of text used in presentation of dimensions.
| void Prs3d_DimensionAspect::SetTextHorizontalPosition | ( | const Prs3d_DimensionTextHorizontalPosition | thePosition | ) |
Sets horizontal text alignment for text label.
| void Prs3d_DimensionAspect::SetTextVerticalPosition | ( | const Prs3d_DimensionTextVerticalPosition | thePosition | ) |
Sets vertical text alignment for text label.
| void Prs3d_DimensionAspect::SetValueStringFormat | ( | const TCollection_AsciiString & | theFormat | ) |
Sets "sprintf"-syntax format for formatting dimension value labels.
| Handle< Prs3d_TextAspect > Prs3d_DimensionAspect::TextAspect | ( | ) | const |
Returns the settings for the display of text used in presentation of dimensions.
| Prs3d_DimensionTextHorizontalPosition Prs3d_DimensionAspect::TextHorizontalPosition | ( | ) | const |
Gets horizontal text alignment for text label.
| Prs3d_DimensionTextVerticalPosition Prs3d_DimensionAspect::TextVerticalPosition | ( | ) | const |
Gets vertical text alignment for text label.
| TCollection_AsciiString Prs3d_DimensionAspect::ValueStringFormat | ( | ) | const |
Returns format.
The documentation for this class was generated from the following file:
