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