Light.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2015 Open Source Robotics Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */
#ifndef GZ_RENDERING_LIGHT_HH_
#define GZ_RENDERING_LIGHT_HH_
 
#include "gz/math/Color.hh"
#include "gz/rendering/config.hh"
#include "gz/rendering/Node.hh"
 
namespace gz
{
  namespace rendering
  {
    inline namespace GZ_RENDERING_VERSION_NAMESPACE {
 
    enum class GZ_RENDERING_VISIBLE LightType
    {
      EMPTY = 0,
 
      POINT = 1,
 
      DIRECTIONAL = 2,
 
      SPOT = 3
    };
 
    //
    class GZ_RENDERING_VISIBLE Light :
      public virtual Node
    {
      public: virtual ~Light();
 
      public: virtual math::Color DiffuseColor() const = 0;
 
      public: virtual void SetDiffuseColor(double _r, double _g, double _b,
                  double _a = 1.0) = 0;
 
      public: virtual void SetDiffuseColor(const math::Color &_color) = 0;
 
      public: virtual math::Color SpecularColor() const = 0;
 
      public: virtual void SetSpecularColor(double _r, double _g, double _b,
                  double _a = 1.0) = 0;
 
      public: virtual void SetSpecularColor(const math::Color &_color) = 0;
 
      public: virtual double AttenuationConstant() const = 0;
 
      public: virtual void SetAttenuationConstant(double _value) = 0;
 
      public: virtual double AttenuationLinear() const = 0;
 
      public: virtual void SetAttenuationLinear(double _value) = 0;
 
      public: virtual double AttenuationQuadratic() const = 0;
 
      public: virtual void SetAttenuationQuadratic(double _value) = 0;
 
      public: virtual double AttenuationRange() const = 0;
 
      public: virtual void SetAttenuationRange(double _range) = 0;
 
      public: virtual bool CastShadows() const = 0;
 
      public: virtual void SetCastShadows(bool _castShadows) = 0;
 
      public: virtual double Intensity() const = 0;
 
      public: virtual void SetIntensity(double _intensity) = 0;
    };
 
    class GZ_RENDERING_VISIBLE DirectionalLight :
      public virtual Light
    {
      public: virtual ~DirectionalLight();
 
      public: virtual math::Vector3d Direction() const = 0;
 
      public: virtual void SetDirection(double _x, double _y, double _z) = 0;
 
      public: virtual void SetDirection(const math::Vector3d &_dir) = 0;
    };
 
    class GZ_RENDERING_VISIBLE PointLight :
      public virtual Light
    {
      public: virtual ~PointLight();
    };
 
    class GZ_RENDERING_VISIBLE SpotLight :
      public virtual Light
    {
      public: virtual ~SpotLight();
 
      public: virtual math::Vector3d Direction() const = 0;
 
      public: virtual void SetDirection(double _x, double _y, double _z) = 0;
 
      public: virtual void SetDirection(const math::Vector3d &_dir) = 0;
 
      public: virtual math::Angle InnerAngle() const = 0;
 
      public: virtual void SetInnerAngle(double _radians) = 0;
 
      public: virtual void SetInnerAngle(const math::Angle &_angle) = 0;
 
      public: virtual math::Angle OuterAngle() const = 0;
 
      public: virtual void SetOuterAngle(double _radians) = 0;
 
      public: virtual void SetOuterAngle(const math::Angle &_angle) = 0;
 
      public: virtual double Falloff() const = 0;
 
      public: virtual void SetFalloff(double _falloff) = 0;
    };
    }
  }
}
#endif