0028726: Quantity_NameOfColor should be replaced by Quantity_Color in function input...
[occt.git] / src / V3d / V3d_PositionalLight.hxx
1 // Created on: 1992-01-22
2 // Created by: GG
3 // Copyright (c) 1992-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 _V3d_PositionalLight_HeaderFile
18 #define _V3d_PositionalLight_HeaderFile
19
20 #include <Quantity_Coefficient.hxx>
21 #include <V3d_PositionLight.hxx>
22
23 class V3d_PositionalLight;
24 DEFINE_STANDARD_HANDLE(V3d_PositionalLight, V3d_PositionLight)
25
26 //! Creation and modification of an isolated
27 //! (positional) light source.
28 class V3d_PositionalLight : public V3d_PositionLight
29 {
30 public:
31
32   //! Creates an isolated light source theX, theY, theZ in the viewer.
33   //! It is also defined by the color theColor and
34   //! two attenuation factors theConstAttentuation, theLinearAttentuation.
35   //! The resulting attenuation factor determining the
36   //! illumination of a surface depends on the following
37   //! formula :
38   //! F = 1/(ConstAttenuation + LinearAttenuation*Length)
39   //! Length is the distance of the isolated source
40   //! from the surface.  //! Warning!  raises BadValue from V3d
41   //! if one of the attenuation coefficients is not in range [0, 1].
42   Standard_EXPORT V3d_PositionalLight (const Handle(V3d_Viewer)& theViewer,
43                                        const V3d_Coordinate theX,
44                                        const V3d_Coordinate theY,
45                                        const V3d_Coordinate theZ,
46                                        const Quantity_Color& theColor = Quantity_NOC_WHITE,
47                                        const Quantity_Coefficient theConstAttenuation = 1.0,
48                                        const Quantity_Coefficient theLinearAttenuation = 0.0);
49
50   //! Creates a light source of the Positional type in the viewer.
51   //! theXt, theYt, theZt : Coordinate of Target light source.
52   //! theXp, theYp, theZp : Coordinate of Position light source.
53   //! The light source is also defined by the color Color
54   //! and two attenuation factors theConstAttentuation,
55   //! theLinearAttentuation that determine the illumination of a
56   //! surface using the following formula :
57   //! F = 1/(ConstAttenuation + LinearAttenuation*Length)
58   //! Length is the distance of the isolated source
59   //! from the surface.  //! Warning! raises BadValue from V3d
60   //! if one of the attenuation coefficients is not between 0 et 1.
61   Standard_EXPORT V3d_PositionalLight (const Handle(V3d_Viewer)& theViewer,
62                                        const V3d_Coordinate theXt,
63                                        const V3d_Coordinate theYt,
64                                        const V3d_Coordinate theZt,
65                                        const V3d_Coordinate theXp,
66                                        const V3d_Coordinate theYp,
67                                        const V3d_Coordinate theZp,
68                                        const Quantity_Color& theColor = Quantity_NOC_WHITE,
69                                        const Quantity_Coefficient theConstAttenuation = 1.0,
70                                        const Quantity_Coefficient theLinearAttenuation = 0.0);
71
72   //! Defines the position of the light source.
73   Standard_EXPORT virtual void SetPosition (const V3d_Coordinate theX,
74                                             const V3d_Coordinate theY,
75                                             const V3d_Coordinate theZ) Standard_OVERRIDE;
76
77   //! Defines the attenuation factors.
78   //! Warning: raises BadValue from V3d
79   //! if one of the attenuation coefficients is not between 0 et 1.
80   Standard_EXPORT void SetAttenuation (const Quantity_Coefficient theConstAttenuation,
81                                        const Quantity_Coefficient theLinearAttenuation);
82
83   //! Modifies the smoothing radius
84   Standard_EXPORT void SetSmoothRadius (const Standard_Real theValue);
85
86   //! Display the graphic structure of light source
87   //! in the chosen view. We have three type of representation
88   //! - SIMPLE   : Only the light source is displayed.
89   //! - PARTIAL  : The light source and the light space are
90   //! displayed.
91   //! - COMPLETE : The light source, the light space and the
92   //! radius of light space are displayed.
93   //! We can choose the "SAMELAST" as parameter of representation
94   //! In this case the graphic structure representation will be
95   //! the last displayed.
96   Standard_EXPORT void Display (const Handle(V3d_View)& theView,
97                                 const V3d_TypeOfRepresentation theRepresentation) Standard_OVERRIDE;
98
99   //! Returns the position of the light source.
100   Standard_EXPORT void Position (V3d_Coordinate& theX,
101                                  V3d_Coordinate& theY,
102                                  V3d_Coordinate& theZ) const Standard_OVERRIDE;
103
104   //! Returns the attenuation factors.
105   Standard_EXPORT void Attenuation (Quantity_Coefficient& theConstAttenuation,
106                                     Quantity_Coefficient& theLinearAttenuation) const;
107
108   DEFINE_STANDARD_RTTIEXT(V3d_PositionalLight,V3d_PositionLight)
109
110 private:
111
112   //! Defined the representation of the positional light source.
113   Standard_EXPORT void Symbol (const Handle(Graphic3d_Group)& theSymbol,
114                                const Handle(V3d_View)& theView) const Standard_OVERRIDE;
115 };
116
117 #endif // _V3d_PositionalLight_HeaderFile