include/opencascade/Vrml_DirectionalLight.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_DirectionalLight_HeaderFile
0018 #define _Vrml_DirectionalLight_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 //! defines a directional  light node of VRML specifying
0030 //! properties of lights.
0031 //! This  node  defines  a  directional  light  source  that  illuminates
0032 //! along  rays  parallel  to  a  given  3-dimensional  vector
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_DirectionalLight
0036 {
0037 public:
0038
0039   DEFINE_STANDARD_ALLOC
0040
0041
0042   Standard_EXPORT Vrml_DirectionalLight();
0043
0044   Standard_EXPORT Vrml_DirectionalLight(const Standard_Boolean aOnOff, const Standard_Real aIntensity, const Quantity_Color& aColor, const gp_Vec& aDirection);
0045
0046   Standard_EXPORT void SetOnOff (const Standard_Boolean aOnOff);
0047
0048   Standard_EXPORT Standard_Boolean OnOff() const;
0049
0050   Standard_EXPORT void SetIntensity (const Standard_Real aIntensity);
0051
0052   Standard_EXPORT Standard_Real Intensity() const;
0053
0054   Standard_EXPORT void SetColor (const Quantity_Color& aColor);
0055
0056   Standard_EXPORT Quantity_Color Color() const;
0057
0058   Standard_EXPORT void SetDirection (const gp_Vec& aDirection);
0059
0060   Standard_EXPORT gp_Vec Direction() const;
0061
0062   Standard_EXPORT Standard_OStream& Print (Standard_OStream& anOStream) const;
0063
0064
0065
0066
0067 protected:
0068
0069
0070
0071
0072
0073 private:
0074
0075
0076
0077   Standard_Boolean myOnOff;
0078   Standard_Real myIntensity;
0079   Quantity_Color myColor;
0080   gp_Vec myDirection;
0081
0082
0083 };
0084
0085
0086
0087
0088
0089
0090
0091 #endif // _Vrml_DirectionalLight_HeaderFile