eccc5a012444fe6e3a6a8c56d8e90b3b67adb51e
[occt.git] / src / V3d / V3d_AmbientLight.hxx
1 // Created on: 1992-01-21
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_AmbientLight_HeaderFile
18 #define _V3d_AmbientLight_HeaderFile
19
20 #include <V3d_Light.hxx>
21
22 class V3d_Viewer;
23
24 //! Creation of an ambient light source in a viewer.
25 class V3d_AmbientLight : public Graphic3d_CLight
26 {
27   DEFINE_STANDARD_RTTIEXT(V3d_AmbientLight, Graphic3d_CLight)
28 public:
29
30   //! Constructs an ambient light source in the viewer.
31   //! The default Color of this light source is WHITE.
32   Standard_EXPORT V3d_AmbientLight (const Quantity_Color& theColor = Quantity_NOC_WHITE);
33
34   //! Constructs an ambient light source in the viewer.
35   //! The default Color of this light source is WHITE.
36   Standard_DEPRECATED("This constructor is deprecated - the light source should be added to V3d_Viewer explicitly by method V3d_Viewer::AddLight()")
37   Standard_EXPORT V3d_AmbientLight (const Handle(V3d_Viewer)& theViewer,
38                                     const Quantity_Color& theColor = Quantity_NOC_WHITE);
39
40 //! @name hidden properties not applicable to ambient light
41 private:
42
43   using Graphic3d_CLight::IsHeadlight;
44   using Graphic3d_CLight::Headlight;
45   using Graphic3d_CLight::SetHeadlight;
46   using Graphic3d_CLight::Position;
47   using Graphic3d_CLight::SetPosition;
48   using Graphic3d_CLight::ConstAttenuation;
49   using Graphic3d_CLight::LinearAttenuation;
50   using Graphic3d_CLight::Attenuation;
51   using Graphic3d_CLight::SetAttenuation;
52   using Graphic3d_CLight::Direction;
53   using Graphic3d_CLight::SetDirection;
54   using Graphic3d_CLight::Angle;
55   using Graphic3d_CLight::SetAngle;
56   using Graphic3d_CLight::Concentration;
57   using Graphic3d_CLight::SetConcentration;
58   using Graphic3d_CLight::Smoothness;
59   using Graphic3d_CLight::SetSmoothRadius;
60   using Graphic3d_CLight::SetSmoothAngle;
61
62 };
63
64 DEFINE_STANDARD_HANDLE(V3d_AmbientLight, Graphic3d_CLight)
65
66 #endif // _V3d_AmbientLight_HeaderFile