include/opencascade/V3d_PositionalLight.hxx

0001 // Created on: 1992-01-22
0002 // Created by: GG
0003 // Copyright (c) 1992-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _V3d_PositionalLight_HeaderFile
0018 #define _V3d_PositionalLight_HeaderFile
0019
0020 #include <V3d_PositionLight.hxx>
0021
0022 //! Creation and modification of an isolated (positional) light source.
0023 //! It is also defined by the color and two attenuation factors ConstAttentuation() and
0024 //! LinearAttentuation(). The resulting attenuation factor determining the illumination of a surface
0025 //! depends on the following formula:
0026 //! @code
0027 //!   F = 1 / (ConstAttenuation() + LinearAttenuation() * Distance)
0028 //! @endcode
0029 //! Where Distance is the distance of the isolated source from the surface.
0030 class V3d_PositionalLight : public V3d_PositionLight
0031 {
0032   DEFINE_STANDARD_RTTIEXT(V3d_PositionalLight, V3d_PositionLight)
0033 public:
0034   //! Creates an isolated light source in the viewer with default attenuation factors (1.0, 0.0).
0035   Standard_EXPORT V3d_PositionalLight(const gp_Pnt&         thePos,
0036                                       const Quantity_Color& theColor = Quantity_NOC_WHITE);
0037
0038   using Graphic3d_CLight::Position;
0039   using Graphic3d_CLight::SetPosition;
0040
0041   //! @name hidden properties not applicable to positional light
0042 private:
0043   using Graphic3d_CLight::Angle;
0044   using Graphic3d_CLight::Concentration;
0045   using Graphic3d_CLight::Direction;
0046   using Graphic3d_CLight::SetAngle;
0047   using Graphic3d_CLight::SetConcentration;
0048   using Graphic3d_CLight::SetDirection;
0049 };
0050
0051 #endif // _V3d_PositionalLight_HeaderFile