HeightmapDescriptor.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2020 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_HEIGHTMAPDESCRIPTOR_HH_
#define IGNITION_RENDERING_HEIGHTMAPDESCRIPTOR_HH_

#include <memory>
#include <string>
#include <ignition/common/HeightmapData.hh>
#include <ignition/common/SuppressWarning.hh>

#include "ignition/rendering/config.hh"
#include "ignition/rendering/Export.hh"

namespace ignition
{
namespace rendering
{
inline namespace IGNITION_RENDERING_VERSION_NAMESPACE {
  class HeightmapDescriptorPrivate;
  class HeightmapTexturePrivate;
  class HeightmapBlendPrivate;

  class IGNITION_RENDERING_VISIBLE HeightmapTexture
  {
    public: HeightmapTexture();

    public: HeightmapTexture(const HeightmapTexture &_texture);

    public: HeightmapTexture(HeightmapTexture &&_texture) noexcept;

    public: virtual ~HeightmapTexture();

    public: HeightmapTexture &operator=(HeightmapTexture &&_texture);

    public: HeightmapTexture &operator=(const HeightmapTexture &_texture);

    public: double Size() const;

    public: void SetSize(double _size);

    public: std::string Diffuse() const;

    public: void SetDiffuse(const std::string &_diffuse);

    public: std::string Normal() const;

    public: void SetNormal(const std::string &_normal);

    IGN_COMMON_WARN_IGNORE__DLL_INTERFACE_MISSING
    private: std::unique_ptr<HeightmapTexturePrivate> dataPtr;
    IGN_COMMON_WARN_RESUME__DLL_INTERFACE_MISSING
  };

  class IGNITION_RENDERING_VISIBLE HeightmapBlend
  {
    public: HeightmapBlend();

    public: HeightmapBlend(const HeightmapBlend &_blend);

    public: HeightmapBlend(HeightmapBlend &&_blend) noexcept;

    public: virtual ~HeightmapBlend();

    public: HeightmapBlend &operator=(HeightmapBlend &&_blend);

    public: HeightmapBlend &operator=(const HeightmapBlend &_blend);

    public: double MinHeight() const;

    public: void SetMinHeight(double _minHeight);

    public: double FadeDistance() const;

    public: void SetFadeDistance(double _fadeDistance);

    IGN_COMMON_WARN_IGNORE__DLL_INTERFACE_MISSING
    private: std::unique_ptr<HeightmapBlendPrivate> dataPtr;
    IGN_COMMON_WARN_RESUME__DLL_INTERFACE_MISSING
  };

  class IGNITION_RENDERING_VISIBLE HeightmapDescriptor
  {
    public: HeightmapDescriptor();

    public: HeightmapDescriptor(const HeightmapDescriptor &_desc);

    public: HeightmapDescriptor(HeightmapDescriptor &&_desc) noexcept;

    public: virtual ~HeightmapDescriptor();

    public: HeightmapDescriptor &operator=(HeightmapDescriptor &&_desc);

    public: HeightmapDescriptor &operator=(const HeightmapDescriptor &_desc);

    public: const std::string &Name() const;

    public: void SetName(const std::string &_name);

    public: std::shared_ptr<common::HeightmapData> Data() const;

    public: void SetData(const std::shared_ptr<common::HeightmapData> &_data);

    public: ignition::math::Vector3d Size() const;

    public: void SetSize(const ignition::math::Vector3d &_size);

    public: ignition::math::Vector3d Position() const;

    public: void SetPosition(const ignition::math::Vector3d &_position);

    public: bool UseTerrainPaging() const;

    public: void SetUseTerrainPaging(bool _use);

    public: unsigned int Sampling() const;

    public: void SetSampling(unsigned int _sampling);

    public: uint64_t TextureCount() const;

    public: const HeightmapTexture *TextureByIndex(uint64_t _index) const;

    public: void AddTexture(const HeightmapTexture &_texture);

    public: uint64_t BlendCount() const;

    public: const HeightmapBlend *BlendByIndex(uint64_t _index) const;

    public: void AddBlend(const HeightmapBlend &_blend);

    IGN_COMMON_WARN_IGNORE__DLL_INTERFACE_MISSING
    private: std::unique_ptr<HeightmapDescriptorPrivate> dataPtr;
    IGN_COMMON_WARN_RESUME__DLL_INTERFACE_MISSING
  };
}
}
}
#endif