A framework for defining how a line will be displayed in a presentation. Aspects of line display include width, color and type of line. The definition set by this class is then passed to the attribute manager Prs3d_Drawer. Any object which requires a value for line aspect as an argument may then be given the attribute manager as a substitute argument in the form of a field such as myDrawer for example. More...
#include <Prs3d_LineAspect.hxx>
Public Member Functions | |
| Prs3d_LineAspect (const Quantity_Color &theColor, const Aspect_TypeOfLine theType, const Standard_Real theWidth) | |
| Constructs a framework for line aspect defined by. More... | |
| Prs3d_LineAspect (const Handle< Graphic3d_AspectLine3d > &theAspect) | |
| void | SetColor (const Quantity_Color &theColor) |
| Sets the line color defined at the time of construction. Default value: Quantity_NOC_YELLOW. More... | |
| void | SetTypeOfLine (const Aspect_TypeOfLine theType) |
| Sets the type of line defined at the time of construction. This could, for example, be solid, dotted or made up of dashes. Default value: Aspect_TOL_SOLID. More... | |
| void | SetWidth (const Standard_Real theWidth) |
| Sets the line width defined at the time of construction. Default value: 1. More... | |
| const Handle< Graphic3d_AspectLine3d > & | Aspect () const |
| Returns the line aspect. This is defined as the set of color, type and thickness attributes. More... | |
| void | SetAspect (const Handle< Graphic3d_AspectLine3d > &theAspect) |
| virtual void | DumpJson (Standard_OStream &theOStream, const 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_Transient & | operator= (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_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... | |
Protected Attributes | |
| Handle< Graphic3d_AspectLine3d > | myAspect |
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
A framework for defining how a line will be displayed in a presentation. Aspects of line display include width, color and type of line. The definition set by this class is then passed to the attribute manager Prs3d_Drawer. Any object which requires a value for line aspect as an argument may then be given the attribute manager as a substitute argument in the form of a field such as myDrawer for example.
Constructor & Destructor Documentation
◆ Prs3d_LineAspect() [1/2]
| Prs3d_LineAspect::Prs3d_LineAspect | ( | const Quantity_Color & | theColor, |
| const Aspect_TypeOfLine | theType, | ||
| const Standard_Real | theWidth | ||
| ) |
Constructs a framework for line aspect defined by.
- the color aColor
- the type of line aType and
- the line thickness aWidth. Type of line refers to whether the line is solid or dotted, for example.
◆ Prs3d_LineAspect() [2/2]
|
inline |
Member Function Documentation
◆ Aspect()
|
inline |
Returns the line aspect. This is defined as the set of color, type and thickness attributes.
◆ DumpJson()
|
overridevirtual |
Dumps the content of me into the stream.
Implements Prs3d_BasicAspect.
◆ SetAspect()
|
inline |
◆ SetColor()
|
inline |
Sets the line color defined at the time of construction. Default value: Quantity_NOC_YELLOW.
◆ SetTypeOfLine()
|
inline |
Sets the type of line defined at the time of construction. This could, for example, be solid, dotted or made up of dashes. Default value: Aspect_TOL_SOLID.
◆ SetWidth()
|
inline |
Sets the line width defined at the time of construction. Default value: 1.
Field Documentation
◆ myAspect
|
protected |
The documentation for this class was generated from the following file:
