0026936: Drawbacks of inlining in new type system in OCCT 7.0 -- automatic
[occt.git] / src / Aspect / Aspect_AspectMarker.hxx
1 // Created on: 1991-09-02
2 // Created by: NW,JPB,CAL
3 // Copyright (c) 1991-1999 Matra Datavision
4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
5 //
6 // This file is part of Open CASCADE Technology software library.
7 //
8 // This library is free software; you can redistribute it and/or modify it under
9 // the terms of the GNU Lesser General Public License version 2.1 as published
10 // by the Free Software Foundation, with special exception defined in the file
11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12 // distribution for complete text of the license and disclaimer of any warranty.
13 //
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
16
17 #ifndef _Aspect_AspectMarker_HeaderFile
18 #define _Aspect_AspectMarker_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
22
23 #include <Quantity_Color.hxx>
24 #include <Aspect_TypeOfMarker.hxx>
25 #include <Standard_Real.hxx>
26 #include <MMgt_TShared.hxx>
27 class Aspect_AspectMarkerDefinitionError;
28 class Quantity_Color;
29
30
31 class Aspect_AspectMarker;
32 DEFINE_STANDARD_HANDLE(Aspect_AspectMarker, MMgt_TShared)
33
34 //! This class allows the definition of a group
35 //! of attributes for the primitive MARKER.
36 //! the attributes are:
37 //! * Colour
38 //! * Type
39 //! * Scale factor
40 //! When any value of the group is modified
41 //! all graphic objects using the group are modified
42 class Aspect_AspectMarker : public MMgt_TShared
43 {
44
45 public:
46
47   
48   //! Modifies the colour of <me>.
49   Standard_EXPORT void SetColor (const Quantity_Color& AColor);
50   
51   //! Modifies the scale factor of <me>.
52   //! Marker type Aspect_TOM_POINT is not affected
53   //! by the marker size scale factor. It is always
54   //! the smallest displayable dot.
55   //! Warning: Raises AspectMarkerDefinitionError if the
56   //! scale is a negative value.
57   Standard_EXPORT void SetScale (const Standard_Real AScale);
58   
59   //! Modifies the type of marker <me>.
60   Standard_EXPORT void SetType (const Aspect_TypeOfMarker AType);
61   
62   //! Returns the current values of the group <me>.
63   Standard_EXPORT void Values (Quantity_Color& AColor, Aspect_TypeOfMarker& AType, Standard_Real& AScale) const;
64
65
66
67
68   DEFINE_STANDARD_RTTIEXT(Aspect_AspectMarker,MMgt_TShared)
69
70 protected:
71
72   
73   //! Initialise the constructor for Graphic3d_AspectMarker3d.
74   //!
75   //! defaults values :
76   //!
77   //! Color     = Quantity_NOC_YELLOW;
78   //! Type      = Aspect_TOM_X;
79   //! Scale     = 1.0;
80   Standard_EXPORT Aspect_AspectMarker();
81   
82   //! Initialise the values for the
83   //! constructor of Graphic3d_AspectMarker3d.
84   //! Warning: Raises AspectMarkerDefinitionError if the
85   //! scale is a negative value.
86   Standard_EXPORT Aspect_AspectMarker(const Quantity_Color& AColor, const Aspect_TypeOfMarker AType, const Standard_Real AScale);
87
88
89
90 private:
91
92
93   Quantity_Color MyColor;
94   Aspect_TypeOfMarker MyType;
95   Standard_Real MyScale;
96
97
98 };
99
100
101
102
103
104
105
106 #endif // _Aspect_AspectMarker_HeaderFile