include/opencascade/V3d_SpotLight.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_SpotLight_HeaderFile
0018 #define _V3d_SpotLight_HeaderFile
0019
0020 #include <V3d_PositionLight.hxx>
0021 #include <V3d_TypeOfOrientation.hxx>
0022
0023 //! Creation and modification of a spot.
0024 //! The attenuation factor F determines the illumination of a surface:
0025 //! @code
0026 //!   F = 1/(ConstAttenuation() + LinearAttenuation() * Distance)
0027 //! @endcode
0028 //! Where Distance is the distance from the source to the surface.
0029 //! The default values (1.0, 0.0) correspond to a minimum of attenuation.
0030 //! The concentration factor determines the dispersion of the light on the surface, the default value (1.0) corresponds to a minimum of dispersion.
0031 class V3d_SpotLight : public V3d_PositionLight
0032 {
0033   DEFINE_STANDARD_RTTIEXT(V3d_SpotLight, V3d_PositionLight)
0034 public:
0035
0036   //! Creates a light source of the Spot type in the viewer with default attenuation factors (1.0, 0.0),
0037   //! concentration factor 1.0 and spot angle 30 degrees.
0038   Standard_EXPORT V3d_SpotLight (const gp_Pnt& thePos,
0039                                  const V3d_TypeOfOrientation theDirection = V3d_XnegYnegZpos,
0040                                  const Quantity_Color& theColor = Quantity_NOC_WHITE);
0041
0042   //! Creates a light source of the Spot type in the viewer with default attenuation factors (1.0, 0.0),
0043   //! concentration factor 1.0 and spot angle 30 degrees.
0044   Standard_EXPORT V3d_SpotLight (const gp_Pnt& thePos,
0045                                  const gp_Dir& theDirection,
0046                                  const Quantity_Color& theColor = Quantity_NOC_WHITE);
0047
0048   //! Defines the direction of the light source
0049   //! according to a predefined directional vector.
0050   Standard_EXPORT void SetDirection (V3d_TypeOfOrientation theOrientation);
0051   using Graphic3d_CLight::SetDirection;
0052   using Graphic3d_CLight::Position;
0053   using Graphic3d_CLight::SetPosition;
0054
0055 };
0056
0057 DEFINE_STANDARD_HANDLE(V3d_SpotLight, V3d_PositionLight)
0058
0059 #endif // _V3d_SpotLight_HeaderFile