Open CASCADE Technology  7.4.1.dev
Public Member Functions | Protected Attributes
Prs3d_DimensionAspect Class Reference

defines the attributes when drawing a Length Presentation. More...

#include <Prs3d_DimensionAspect.hxx>

Inheritance diagram for Prs3d_DimensionAspect:
Inheritance graph
[legend]

Public Member Functions

 Prs3d_DimensionAspect ()
 Constructs an empty framework to define the display of dimensions. More...
 
const 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...
 
const 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 theIsTextShaded)
 Turns on/off text shading for 3d text. More...
 
Standard_Boolean IsArrows3d () const
 Gets type of arrows. More...
 
void MakeArrows3d (const Standard_Boolean theIsArrows3d)
 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...
 
const 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...
 
const TCollection_AsciiStringValueStringFormat () const
 Returns format. More...
 
virtual void DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const override
 Dumps the content of me into the stream. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. 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_TransientThis () 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...
 

Protected Attributes

Handle< Prs3d_LineAspectmyLineAspect
 
Handle< Prs3d_TextAspectmyTextAspect
 
Handle< Prs3d_ArrowAspectmyArrowAspect
 
TCollection_AsciiString myValueStringFormat
 
Standard_Real myExtensionSize
 
Standard_Real myArrowTailSize
 
Prs3d_DimensionArrowOrientation myArrowOrientation
 
Prs3d_DimensionTextHorizontalPosition myTextHPosition
 
Prs3d_DimensionTextVerticalPosition myTextVPosition
 
Standard_Boolean myToDisplayUnits
 
Standard_Boolean myIsText3d
 
Standard_Boolean myIsTextShaded
 
Standard_Boolean myIsArrows3d
 

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::Prs3d_DimensionAspect ( )

Constructs an empty framework to define the display of dimensions.

Member Function Documentation

◆ ArrowAspect()

const Handle< Prs3d_ArrowAspect >& Prs3d_DimensionAspect::ArrowAspect ( ) const
inline

Returns the settings for displaying arrows.

◆ ArrowOrientation()

Prs3d_DimensionArrowOrientation Prs3d_DimensionAspect::ArrowOrientation ( ) const
inline

Gets orientation of arrows (external or internal).

◆ ArrowTailSize()

Standard_Real Prs3d_DimensionAspect::ArrowTailSize ( ) const
inline

Returns arrow tail size.

◆ DumpJson()

virtual void Prs3d_DimensionAspect::DumpJson ( Standard_OStream theOStream,
Standard_Integer  theDepth = -1 
) const
overridevirtual

Dumps the content of me into the stream.

Implements Prs3d_BasicAspect.

◆ ExtensionSize()

Standard_Real Prs3d_DimensionAspect::ExtensionSize ( ) const
inline

Returns extension size.

◆ IsArrows3d()

Standard_Boolean Prs3d_DimensionAspect::IsArrows3d ( ) const
inline

Gets type of arrows.

◆ IsText3d()

Standard_Boolean Prs3d_DimensionAspect::IsText3d ( ) const
inline

Check if text for dimension label is 3d.

◆ IsTextShaded()

Standard_Boolean Prs3d_DimensionAspect::IsTextShaded ( ) const
inline

Check if 3d text for dimension label is shaded.

◆ IsUnitsDisplayed()

Standard_Boolean Prs3d_DimensionAspect::IsUnitsDisplayed ( ) const
inline

Shows if Units are to be displayed along with dimension value.

◆ LineAspect()

const Handle< Prs3d_LineAspect >& Prs3d_DimensionAspect::LineAspect ( ) const
inline

Returns the settings for the display of lines used in presentation of dimensions.

◆ MakeArrows3d()

void Prs3d_DimensionAspect::MakeArrows3d ( const Standard_Boolean  theIsArrows3d)
inline

Sets type of arrows.

◆ MakeText3d()

void Prs3d_DimensionAspect::MakeText3d ( const Standard_Boolean  isText3d)
inline

Sets type of text.

◆ MakeTextShaded()

void Prs3d_DimensionAspect::MakeTextShaded ( const Standard_Boolean  theIsTextShaded)
inline

Turns on/off text shading for 3d text.

◆ MakeUnitsDisplayed()

void Prs3d_DimensionAspect::MakeUnitsDisplayed ( const Standard_Boolean  theIsDisplayed)
inline

Specifies whether the units string should be displayed along with value label or not.

◆ SetArrowAspect()

void Prs3d_DimensionAspect::SetArrowAspect ( const Handle< Prs3d_ArrowAspect > &  theAspect)
inline

Sets the display attributes of arrows used in presentation of dimensions.

◆ SetArrowOrientation()

void Prs3d_DimensionAspect::SetArrowOrientation ( const Prs3d_DimensionArrowOrientation  theArrowOrient)
inline

Sets orientation of arrows (external or internal). By default orientation is chosen automatically according to situation and text label size.

◆ SetArrowTailSize()

void Prs3d_DimensionAspect::SetArrowTailSize ( const Standard_Real  theSize)
inline

Set size for arrow tail (extension without text).

◆ SetCommonColor()

void Prs3d_DimensionAspect::SetCommonColor ( const Quantity_Color theColor)

Sets the same color for all parts of dimension: lines, arrows and text.

◆ SetExtensionSize()

void Prs3d_DimensionAspect::SetExtensionSize ( const Standard_Real  theSize)
inline

Sets extension size.

◆ SetLineAspect()

void Prs3d_DimensionAspect::SetLineAspect ( const Handle< Prs3d_LineAspect > &  theAspect)
inline

Sets the display attributes of lines used in presentation of dimensions.

◆ SetTextAspect()

void Prs3d_DimensionAspect::SetTextAspect ( const Handle< Prs3d_TextAspect > &  theAspect)
inline

Sets the display attributes of text used in presentation of dimensions.

◆ SetTextHorizontalPosition()

void Prs3d_DimensionAspect::SetTextHorizontalPosition ( const Prs3d_DimensionTextHorizontalPosition  thePosition)
inline

Sets horizontal text alignment for text label.

◆ SetTextVerticalPosition()

void Prs3d_DimensionAspect::SetTextVerticalPosition ( const Prs3d_DimensionTextVerticalPosition  thePosition)
inline

Sets vertical text alignment for text label.

◆ SetValueStringFormat()

void Prs3d_DimensionAspect::SetValueStringFormat ( const TCollection_AsciiString theFormat)
inline

Sets "sprintf"-syntax format for formatting dimension value labels.

◆ TextAspect()

const Handle< Prs3d_TextAspect >& Prs3d_DimensionAspect::TextAspect ( ) const
inline

Returns the settings for the display of text used in presentation of dimensions.

◆ TextHorizontalPosition()

Prs3d_DimensionTextHorizontalPosition Prs3d_DimensionAspect::TextHorizontalPosition ( ) const
inline

Gets horizontal text alignment for text label.

◆ TextVerticalPosition()

Prs3d_DimensionTextVerticalPosition Prs3d_DimensionAspect::TextVerticalPosition ( ) const
inline

Gets vertical text alignment for text label.

◆ ValueStringFormat()

const TCollection_AsciiString& Prs3d_DimensionAspect::ValueStringFormat ( ) const
inline

Returns format.

Field Documentation

◆ myArrowAspect

Handle< Prs3d_ArrowAspect > Prs3d_DimensionAspect::myArrowAspect
protected

◆ myArrowOrientation

Prs3d_DimensionArrowOrientation Prs3d_DimensionAspect::myArrowOrientation
protected

◆ myArrowTailSize

Standard_Real Prs3d_DimensionAspect::myArrowTailSize
protected

◆ myExtensionSize

Standard_Real Prs3d_DimensionAspect::myExtensionSize
protected

◆ myIsArrows3d

Standard_Boolean Prs3d_DimensionAspect::myIsArrows3d
protected

◆ myIsText3d

Standard_Boolean Prs3d_DimensionAspect::myIsText3d
protected

◆ myIsTextShaded

Standard_Boolean Prs3d_DimensionAspect::myIsTextShaded
protected

◆ myLineAspect

Handle< Prs3d_LineAspect > Prs3d_DimensionAspect::myLineAspect
protected

◆ myTextAspect

Handle< Prs3d_TextAspect > Prs3d_DimensionAspect::myTextAspect
protected

◆ myTextHPosition

Prs3d_DimensionTextHorizontalPosition Prs3d_DimensionAspect::myTextHPosition
protected

◆ myTextVPosition

Prs3d_DimensionTextVerticalPosition Prs3d_DimensionAspect::myTextVPosition
protected

◆ myToDisplayUnits

Standard_Boolean Prs3d_DimensionAspect::myToDisplayUnits
protected

◆ myValueStringFormat

TCollection_AsciiString Prs3d_DimensionAspect::myValueStringFormat
protected

The documentation for this class was generated from the following file: