gz/rendering/ogre2/Ogre2Heightmap.hh

Go to the documentation of this file.

/*
 * 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_OGRE2HEIGHTMAP_HH_
#define GZ_RENDERING_OGRE2_OGRE2HEIGHTMAP_HH_
 
#include <memory>
 
#include "gz/rendering/base/BaseHeightmap.hh"
#include "gz/rendering/ogre2/Ogre2Geometry.hh"
 
// Ignoring warning: "non dll-interface class
// 'gz::rendering::v5::Heightmap' used as base for dll-interface class"
// because `Heightmap` and `BaseHeightmap` are header-only
#ifdef _MSC_VER
 #pragma warning(push)
 #pragma warning(disable:4275)
#endif
 
namespace Ogre
{
  class Camera;
  class Terra;
}
 
namespace gz
{
  namespace rendering
  {
    inline namespace GZ_RENDERING_VERSION_NAMESPACE {
    //
    // Forward declaration
    class Ogre2HeightmapPrivate;
 
    class GZ_RENDERING_OGRE2_VISIBLE Ogre2Heightmap
      : public BaseHeightmap<Ogre2Geometry>
    {
      public: explicit Ogre2Heightmap(const HeightmapDescriptor &_desc);
 
      public: virtual ~Ogre2Heightmap() override;
 
      // Documentation inherited.
      public: virtual void Init() override;
 
      // Documentation inherited.
      public: virtual void PreRender() override;
 
      public: virtual Ogre::MovableObject *OgreObject() const override;
 
      public: virtual MaterialPtr Material() const override;
 
      public: virtual void SetMaterial(MaterialPtr _material, bool _unique)
          override;
 
      public: Ogre::Terra* Terra();
 
      public: void UpdateForRender(Ogre::Camera *_activeCamera);
 
      // Documentation inherited.
      // \todo(iche033) rename this to Destroy and
      // make this function public and virtual
      private: void DestroyImpl();
 
      private: friend class OgreScene;
 
      private: std::unique_ptr<Ogre2HeightmapPrivate> dataPtr;
    };
    }
  }
}
#ifdef _MSC_VER
 #pragma warning(pop)
#endif
 
#endif