Open CASCADE Technology  7.1.0.beta
Public Member Functions

Prs3d_LineAspect Class Reference

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>

Inheritance diagram for Prs3d_LineAspect:
Inheritance graph
[legend]

Public Member Functions

 Prs3d_LineAspect (const Quantity_NameOfColor aColor, const Aspect_TypeOfLine aType, const Standard_Real aWidth)
 Constructs a framework for line aspect defined by. More...
 
 Prs3d_LineAspect (const Quantity_Color &aColor, const Aspect_TypeOfLine aType, const Standard_Real aWidth)
 
 Prs3d_LineAspect (const Handle< Graphic3d_AspectLine3d > &theAspect)
 
void SetColor (const Quantity_Color &aColor)
 
void SetColor (const Quantity_NameOfColor aColor)
 Sets the line color defined at the time of construction. Default value: Quantity_NOC_YELLOW. More...
 
void SetTypeOfLine (const Aspect_TypeOfLine aType)
 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 aWidth)
 Sets the line width defined at the time of construction. Default value: 1. More...
 
Handle< Graphic3d_AspectLine3dAspect () 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)
 
- 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_Transientoperator= (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_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...
 

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::Prs3d_LineAspect ( const Quantity_NameOfColor  aColor,
const Aspect_TypeOfLine  aType,
const Standard_Real  aWidth 
)

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::Prs3d_LineAspect ( const Quantity_Color aColor,
const Aspect_TypeOfLine  aType,
const Standard_Real  aWidth 
)
Prs3d_LineAspect::Prs3d_LineAspect ( const Handle< Graphic3d_AspectLine3d > &  theAspect)

Member Function Documentation

Handle< Graphic3d_AspectLine3d > Prs3d_LineAspect::Aspect ( ) const

Returns the line aspect. This is defined as the set of color, type and thickness attributes.

void Prs3d_LineAspect::SetAspect ( const Handle< Graphic3d_AspectLine3d > &  theAspect)
void Prs3d_LineAspect::SetColor ( const Quantity_Color aColor)
void Prs3d_LineAspect::SetColor ( const Quantity_NameOfColor  aColor)

Sets the line color defined at the time of construction. Default value: Quantity_NOC_YELLOW.

void Prs3d_LineAspect::SetTypeOfLine ( const Aspect_TypeOfLine  aType)

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.

void Prs3d_LineAspect::SetWidth ( const Standard_Real  aWidth)

Sets the line width defined at the time of construction. Default value: 1.


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