summaryrefslogtreecommitdiff
path: root/inc/Prs3d_LineAspect.hxx
blob: c4d656e3fe51363e733a41ee97c6b33518c7b27c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
// This file is generated by WOK (CPPExt).
// Please do not edit this file; modify original file instead.
// The copyright and license terms as defined for the original file apply to 
// this header file considered to be the "object code" form of the original source.

#ifndef _Prs3d_LineAspect_HeaderFile
#define _Prs3d_LineAspect_HeaderFile

#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Standard_DefineHandle_HeaderFile
#include <Standard_DefineHandle.hxx>
#endif
#ifndef _Handle_Prs3d_LineAspect_HeaderFile
#include <Handle_Prs3d_LineAspect.hxx>
#endif

#ifndef _Handle_Graphic3d_AspectLine3d_HeaderFile
#include <Handle_Graphic3d_AspectLine3d.hxx>
#endif
#ifndef _Prs3d_BasicAspect_HeaderFile
#include <Prs3d_BasicAspect.hxx>
#endif
#ifndef _Quantity_NameOfColor_HeaderFile
#include <Quantity_NameOfColor.hxx>
#endif
#ifndef _Aspect_TypeOfLine_HeaderFile
#include <Aspect_TypeOfLine.hxx>
#endif
#ifndef _Standard_Real_HeaderFile
#include <Standard_Real.hxx>
#endif
#ifndef _Standard_OStream_HeaderFile
#include <Standard_OStream.hxx>
#endif
class Graphic3d_AspectLine3d;
class Quantity_Color;


//! A framework for defining how a line will be displayed <br>
//! in a presentation. Aspects of line display include <br>
//! width, color and type of line. <br>
//! The definition set by this class is then passed to the <br>
//! attribute manager Prs3d_Drawer. <br>
//! Any object which requires a value for line aspect as <br>
//! an argument may then be given the attribute manager <br>
//! as a substitute argument in the form of a field such as myDrawer for example. <br>
class Prs3d_LineAspect : public Prs3d_BasicAspect {

public:

  //! Constructs a framework for line aspect defined by <br>
//! -   the color aColor <br>
//! -   the type of line aType and <br>
//! -   the line thickness aWidth. <br>
//!   Type of line refers to whether the line is solid or dotted, for example. <br>
  Standard_EXPORT   Prs3d_LineAspect(const Quantity_NameOfColor aColor,const Aspect_TypeOfLine aType,const Standard_Real aWidth);
  
  Standard_EXPORT   Prs3d_LineAspect(const Quantity_Color& aColor,const Aspect_TypeOfLine aType,const Standard_Real aWidth);
  
  Standard_EXPORT     void SetColor(const Quantity_Color& aColor) ;
  //! Sets the line color defined at the time of construction. <br>
//!          Default value: Quantity_NOC_YELLOW <br>
  Standard_EXPORT     void SetColor(const Quantity_NameOfColor aColor) ;
  //! Sets the type of line defined at the time of construction. <br>
//! This could, for example, be solid, dotted or made up of dashes. <br>
//!          Default value: Aspect_TOL_SOLID <br>
  Standard_EXPORT     void SetTypeOfLine(const Aspect_TypeOfLine aType) ;
  //! Sets the line width defined at the time of construction. <br>
//!          Default value: 1. <br>
  Standard_EXPORT     void SetWidth(const Standard_Real aWidth) ;
  //! Returns the line aspect. This is defined as the set of <br>
//! color, type and thickness attributes. <br>
  Standard_EXPORT     Handle_Graphic3d_AspectLine3d Aspect() const;
  
  Standard_EXPORT   virtual  void Print(Standard_OStream& s) const;




  DEFINE_STANDARD_RTTI(Prs3d_LineAspect)

protected:




private: 


Handle_Graphic3d_AspectLine3d myAspect;


};





// other Inline functions and methods (like "C++: function call" methods)


#endif