Ogre2Light.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2018 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 IGNITION_RENDERING_OGRE2_OGRE2LIGHT_HH_
#define IGNITION_RENDERING_OGRE2_OGRE2LIGHT_HH_

#include <memory>

#include "ignition/rendering/base/BaseLight.hh"
#include "ignition/rendering/ogre2/Ogre2Node.hh"
#include "ignition/rendering/ogre2/Ogre2Includes.hh"

namespace Ogre
{
  class Light;
}

namespace ignition
{
  namespace rendering
  {
    inline namespace IGNITION_RENDERING_VERSION_NAMESPACE {
    //
    // forward declaration
    class Ogre2LightPrivate;

    class IGNITION_RENDERING_OGRE2_VISIBLE Ogre2Light :
      public BaseLight<Ogre2Node>
    {
      protected: Ogre2Light();

      public: virtual ~Ogre2Light();

      // Documentation Inherited
      public: virtual math::Color DiffuseColor() const override;

      // Documentation Inherited
      public: virtual void SetDiffuseColor(const math::Color &_color) override;

      // Documentation Inherited
      public: virtual math::Color SpecularColor() const override;

      // Documentation Inherited
      public: virtual void SetSpecularColor(const math::Color &_color) override;

      // Documentation Inherited
      public: virtual double AttenuationConstant() const override;

      // Documentation Inherited
      public: virtual void SetAttenuationConstant(double _value) override;

      // Documentation Inherited
      public: virtual double AttenuationLinear() const override;

      // Documentation Inherited
      public: virtual void SetAttenuationLinear(double _value) override;

      // Documentation Inherited
      public: virtual double AttenuationQuadratic() const override;

      // Documentation Inherited
      public: virtual void SetAttenuationQuadratic(double _value) override;

      // Documentation Inherited
      public: virtual double AttenuationRange() const override;

      // Documentation Inherited
      public: virtual void SetAttenuationRange(double _range) override;

      // Documentation Inherited
      public: virtual bool CastShadows() const override;

      // Documentation Inherited
      public: virtual void SetCastShadows(bool _castShadows) override;

      public: virtual Ogre::Light *Light() const;

      public: virtual void Destroy() override;

      protected: virtual void Init() override;

      private: void CreateLight();

      private: void UpdateAttenuation();

      protected: double attenConstant = 1.0;

      protected: double attenLinear = 0.0;

      protected: double attenQuadratic = 0.0;

      protected: double attenRange = 100.0;

      protected: Ogre::Light *ogreLight = nullptr;

      protected: Ogre::Light::LightTypes ogreLightType;

      private: std::unique_ptr<Ogre2LightPrivate> dataPtr;
    };

    class IGNITION_RENDERING_OGRE2_VISIBLE Ogre2DirectionalLight :
      public BaseDirectionalLight<Ogre2Light>
    {
      protected: Ogre2DirectionalLight();

      public: virtual ~Ogre2DirectionalLight();

      // Documentation Inherited
      public: virtual math::Vector3d Direction() const override;

      // Documentation Inherited
      public: virtual void SetDirection(const math::Vector3d &_dir) override;

      private: friend class Ogre2Scene;
    };

    class IGNITION_RENDERING_OGRE2_VISIBLE Ogre2PointLight :
      public BasePointLight<Ogre2Light>
    {
      protected: Ogre2PointLight();

      public: virtual ~Ogre2PointLight();

      private: friend class Ogre2Scene;
    };

    class IGNITION_RENDERING_OGRE2_VISIBLE Ogre2SpotLight :
      public BaseSpotLight<Ogre2Light>
    {
      protected: Ogre2SpotLight();

      public: virtual ~Ogre2SpotLight();

      // Documentation inherited.
      public: virtual math::Vector3d Direction() const override;

      // Documentation Inherited
      public: virtual void SetDirection(const math::Vector3d &_dir) override;

      // Documentation Inherited
      public: virtual math::Angle InnerAngle() const override;

      // Documentation Inherited
      public: virtual void SetInnerAngle(const math::Angle &_angle) override;

      // Documentation Inherited
      public: virtual math::Angle OuterAngle() const override;

      // Documentation Inherited
      public: virtual void SetOuterAngle(const math::Angle &_angle) override;

      // Documentation Inherited
      public: virtual double Falloff() const override;

      // Documentation Inherited
      public: virtual void SetFalloff(double _falloff) override;

      private: friend class Ogre2Scene;
    };
    }
  }
}
#endif