include/opencascade/Vrml_SpotLight.hxx

0001 // Created on: 1997-02-12
0002 // Created by: Alexander BRIVIN
0003 // Copyright (c) 1997-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 _Vrml_SpotLight_HeaderFile
0018 #define _Vrml_SpotLight_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <Quantity_Color.hxx>
0025 #include <gp_Vec.hxx>
0026 #include <Standard_OStream.hxx>
0027
0028 //! specifies a spot light node of VRML nodes specifying
0029 //! properties of lights.
0030 //! This  node  defines  a  spotlight  light  source.
0031 //! A  spotlight  is  placed  at  a  fixed  location  in  3D-space
0032 //! and  illuminates in  a  cone  along  a  particular  direction.
0033 //! The  intensity  of  the  illumination  drops  off  exponentially
0034 //! as  a  ray  of  light  diverges  from  this  direction  toward
0035 //! the  edges  of  cone.
0036 //! The  rate  of  drop-off  and  agle  of  the  cone  are  controlled
0037 //! by  the  dropOfRate  and  cutOffAngle
0038 //! Color is  written  as  an  RGB  triple.
0039 //! Light intensity must be in the range 0.0 to 1.0, inclusive.
0040 class Vrml_SpotLight
0041 {
0042 public:
0043   DEFINE_STANDARD_ALLOC
0044
0045   Standard_EXPORT Vrml_SpotLight();
0046
0047   Standard_EXPORT Vrml_SpotLight(const Standard_Boolean aOnOff,
0048                                  const Standard_Real    aIntensity,
0049                                  const Quantity_Color&  aColor,
0050                                  const gp_Vec&          aLocation,
0051                                  const gp_Vec&          aDirection,
0052                                  const Standard_Real    aDropOffRate,
0053                                  const Standard_Real    aCutOffAngle);
0054
0055   Standard_EXPORT void SetOnOff(const Standard_Boolean anOnOff);
0056
0057   Standard_EXPORT Standard_Boolean OnOff() const;
0058
0059   Standard_EXPORT void SetIntensity(const Standard_Real aIntensity);
0060
0061   Standard_EXPORT Standard_Real Intensity() const;
0062
0063   Standard_EXPORT void SetColor(const Quantity_Color& aColor);
0064
0065   Standard_EXPORT Quantity_Color Color() const;
0066
0067   Standard_EXPORT void SetLocation(const gp_Vec& aLocation);
0068
0069   Standard_EXPORT gp_Vec Location() const;
0070
0071   Standard_EXPORT void SetDirection(const gp_Vec& aDirection);
0072
0073   Standard_EXPORT gp_Vec Direction() const;
0074
0075   Standard_EXPORT void SetDropOffRate(const Standard_Real aDropOffRate);
0076
0077   Standard_EXPORT Standard_Real DropOffRate() const;
0078
0079   Standard_EXPORT void SetCutOffAngle(const Standard_Real aCutOffAngle);
0080
0081   Standard_EXPORT Standard_Real CutOffAngle() const;
0082
0083   Standard_EXPORT Standard_OStream& Print(Standard_OStream& anOStream) const;
0084
0085 protected:
0086 private:
0087   Standard_Boolean myOnOff;
0088   Standard_Real    myIntensity;
0089   Quantity_Color   myColor;
0090   gp_Vec           myLocation;
0091   gp_Vec           myDirection;
0092   Standard_Real    myDropOffRate;
0093   Standard_Real    myCutOffAngle;
0094 };
0095
0096 #endif // _Vrml_SpotLight_HeaderFile