30215cc9c3ebefb1036d7a4a08ed45957a6bf5c5
[occt.git] / src / V3d / V3d_DirectionalLight.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_DirectionalLight_HeaderFile
18 #define _V3d_DirectionalLight_HeaderFile
19
20 #include <V3d_PositionLight.hxx>
21 #include <V3d_TypeOfOrientation.hxx>
22
23 //! Directional light source for a viewer.
24 class V3d_DirectionalLight : public V3d_PositionLight
25 {
26   DEFINE_STANDARD_RTTIEXT(V3d_DirectionalLight, V3d_PositionLight)
27 public:
28
29   //! Creates a directional light source in the viewer.
30   Standard_EXPORT V3d_DirectionalLight (const V3d_TypeOfOrientation theDirection = V3d_XposYposZpos,
31                                         const Quantity_Color& theColor = Quantity_NOC_WHITE,
32                                         const Standard_Boolean theIsHeadlight = Standard_False);
33
34   //! Creates a directional light source in the viewer.
35   Standard_EXPORT V3d_DirectionalLight (const gp_Dir& theDirection,
36                                         const Quantity_Color& theColor = Quantity_NOC_WHITE,
37                                         const Standard_Boolean theIsHeadlight = Standard_False);
38
39   //! Defines the direction of the light source by a predefined orientation.
40   Standard_EXPORT void SetDirection (V3d_TypeOfOrientation theDirection);
41   using Graphic3d_CLight::SetDirection;
42
43 public:
44
45   Standard_DEPRECATED("This constructor is deprecated - the light source should be added to V3d_Viewer explicitly by method V3d_Viewer::AddLight()")
46   Standard_EXPORT V3d_DirectionalLight (const Handle(V3d_Viewer)& theViewer,
47                                         const V3d_TypeOfOrientation theDirection = V3d_XposYposZpos,
48                                         const Quantity_Color& theColor = Quantity_NOC_WHITE,
49                                         const Standard_Boolean theIsHeadlight = Standard_False);
50
51   //! Creates a directional light source in the viewer.
52   //! theXt, theYt, theZt : Coordinate of light source Target.
53   //! theXp, theYp, theZp : Coordinate of light source Position.
54   //! The others parameters describe before.
55   Standard_DEPRECATED("This constructor is deprecated - the light source should be added to V3d_Viewer explicitly by method V3d_Viewer::AddLight()")
56   Standard_EXPORT V3d_DirectionalLight (const Handle(V3d_Viewer)& theViewer,
57                                         const Standard_Real theXt,
58                                         const Standard_Real theYt,
59                                         const Standard_Real theZt,
60                                         const Standard_Real theXp,
61                                         const Standard_Real theYp,
62                                         const Standard_Real theZp,
63                                         const Quantity_Color& theColor = Quantity_NOC_WHITE,
64                                         const Standard_Boolean theIsHeadlight = Standard_False);
65
66 //! @name hidden properties not applicable to directional light
67 private:
68
69   using Graphic3d_CLight::Position;
70   using Graphic3d_CLight::SetPosition;
71   using Graphic3d_CLight::ConstAttenuation;
72   using Graphic3d_CLight::LinearAttenuation;
73   using Graphic3d_CLight::Attenuation;
74   using Graphic3d_CLight::SetAttenuation;
75   using Graphic3d_CLight::Angle;
76   using Graphic3d_CLight::SetAngle;
77   using Graphic3d_CLight::Concentration;
78   using Graphic3d_CLight::SetConcentration;
79
80 };
81
82 DEFINE_STANDARD_HANDLE(V3d_DirectionalLight, V3d_PositionLight)
83
84 #endif // _V3d_DirectionalLight_HeaderFile