/*
 * Copyright (C) 2021 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_OGRE2_OGRE2LIGHTVISUAL_HH_
#define GZ_RENDERING_OGRE2_OGRE2LIGHTVISUAL_HH_

#include <memory>

#include "gz/rendering/base/BaseLightVisual.hh"
#include "gz/rendering/ogre2/Ogre2Visual.hh"

namespace Ogre
{
  class MovableObject;
}

namespace gz
{
  namespace rendering
  {
    inline namespace GZ_RENDERING_VERSION_NAMESPACE {

    // Forward declaration
    class Ogre2LightVisualPrivate;

    /// \brief Ogre2.x implementation of the light visual class
    class GZ_RENDERING_OGRE2_VISIBLE Ogre2LightVisual :
      public BaseLightVisual<Ogre2Visual>
    {
      /// \brief Constructor
      protected: Ogre2LightVisual();

      /// \brief Destructor
      public: virtual ~Ogre2LightVisual();

      // Documentation inherited.
      public: virtual void Init() override;

      // Documentation inherited.
      public: virtual void PreRender() override;

      // Documentation inherited.
      public: Ogre::MovableObject *OgreObject() const;

      /// \brief Create the Light Visual in Ogre2
      public: void CreateVisual();

      // Documentation inherited.
      public: virtual MaterialPtr Material() const override;

      // Documentation inherited.
      public: virtual void SetMaterial(
        MaterialPtr _material, bool _unique) override;

      /// \brief Set material to grid geometry.
      /// \param[in] _material Ogre material.
      protected: virtual void SetMaterialImpl(Ogre2MaterialPtr _material);

      /// \brief Only scene can instantiate an arrow visual
      private: friend class Ogre2Scene;

      /// \brief Private data class
      private: std::unique_ptr<Ogre2LightVisualPrivate> dataPtr;
    };
    }
  }
}
#endif
