include/opencascade/V3d_DirectionalLight.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_DirectionalLight_HeaderFile
0018 #define _V3d_DirectionalLight_HeaderFile
0019
0020 #include <V3d_PositionLight.hxx>
0021 #include <V3d_TypeOfOrientation.hxx>
0022
0023 //! Directional light source for a viewer.
0024 class V3d_DirectionalLight : public V3d_PositionLight
0025 {
0026   DEFINE_STANDARD_RTTIEXT(V3d_DirectionalLight, V3d_PositionLight)
0027 public:
0028
0029   //! Creates a directional light source in the viewer.
0030   Standard_EXPORT V3d_DirectionalLight (const V3d_TypeOfOrientation theDirection = V3d_XposYposZpos,
0031                                         const Quantity_Color& theColor = Quantity_NOC_WHITE,
0032                                         const Standard_Boolean theIsHeadlight = Standard_False);
0033
0034   //! Creates a directional light source in the viewer.
0035   Standard_EXPORT V3d_DirectionalLight (const gp_Dir& theDirection,
0036                                         const Quantity_Color& theColor = Quantity_NOC_WHITE,
0037                                         const Standard_Boolean theIsHeadlight = Standard_False);
0038
0039   //! Defines the direction of the light source by a predefined orientation.
0040   Standard_EXPORT void SetDirection (V3d_TypeOfOrientation theDirection);
0041   using Graphic3d_CLight::SetDirection;
0042
0043 //! @name hidden properties not applicable to directional light
0044 private:
0045
0046   using Graphic3d_CLight::Position;
0047   using Graphic3d_CLight::SetPosition;
0048   using Graphic3d_CLight::ConstAttenuation;
0049   using Graphic3d_CLight::LinearAttenuation;
0050   using Graphic3d_CLight::Attenuation;
0051   using Graphic3d_CLight::SetAttenuation;
0052   using Graphic3d_CLight::Angle;
0053   using Graphic3d_CLight::SetAngle;
0054   using Graphic3d_CLight::Concentration;
0055   using Graphic3d_CLight::SetConcentration;
0056
0057 };
0058
0059 DEFINE_STANDARD_HANDLE(V3d_DirectionalLight, V3d_PositionLight)
0060
0061 #endif // _V3d_DirectionalLight_HeaderFile