include/opencascade/Vrml_PointLight.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_PointLight_HeaderFile
0018 #define _Vrml_PointLight_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 //! defines a point  light node of VRML specifying
0029 //! properties of lights.
0030 //! This  node  defines  a  point  light  source   at  a  fixed  3D  location
0031 //! A  point  source  illuminates equally  in  all  directions;
0032 //! that  is  omni-directional.
0033 //! Color is  written  as  an  RGB  triple.
0034 //! Light intensity must be in the range 0.0 to 1.0, inclusive.
0035 class Vrml_PointLight
0036 {
0037 public:
0038   DEFINE_STANDARD_ALLOC
0039
0040   Standard_EXPORT Vrml_PointLight();
0041
0042   Standard_EXPORT Vrml_PointLight(const Standard_Boolean aOnOff,
0043                                   const Standard_Real    aIntensity,
0044                                   const Quantity_Color&  aColor,
0045                                   const gp_Vec&          aLocation);
0046
0047   Standard_EXPORT void SetOnOff(const Standard_Boolean aOnOff);
0048
0049   Standard_EXPORT Standard_Boolean OnOff() const;
0050
0051   Standard_EXPORT void SetIntensity(const Standard_Real aIntensity);
0052
0053   Standard_EXPORT Standard_Real Intensity() const;
0054
0055   Standard_EXPORT void SetColor(const Quantity_Color& aColor);
0056
0057   Standard_EXPORT Quantity_Color Color() const;
0058
0059   Standard_EXPORT void SetLocation(const gp_Vec& aLocation);
0060
0061   Standard_EXPORT gp_Vec Location() const;
0062
0063   Standard_EXPORT Standard_OStream& Print(Standard_OStream& anOStream) const;
0064
0065 protected:
0066 private:
0067   Standard_Boolean myOnOff;
0068   Standard_Real    myIntensity;
0069   Quantity_Color   myColor;
0070   gp_Vec           myLocation;
0071 };
0072
0073 #endif // _Vrml_PointLight_HeaderFile