Material.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_MATH_MATERIAL_HH_
#define IGNITION_MATH_MATERIAL_HH_

#include <limits>
#include <map>
#include <string>
#include <ignition/math/Export.hh>
#include <ignition/math/config.hh>
#include <ignition/math/MaterialType.hh>

namespace ignition
{
  namespace math
  {
    // Inline bracket to help doxygen filtering.
    inline namespace IGNITION_MATH_VERSION_NAMESPACE {
    // Forward declarations
    class MaterialPrivate;

    class IGNITION_MATH_VISIBLE Material
    {
      public: Material();

      public: explicit Material(const MaterialType _type);

      public: explicit Material(const std::string &_typename);

      public: explicit Material(const double _density);

      public: Material(const Material &_material);

      public: Material(Material &&_material);

      public: ~Material();

      public: static const std::map<MaterialType, Material> &Predefined();

      public: void SetToNearestDensity(
                  const double _value,
                  const double _epsilon = std::numeric_limits<double>::max());

      public: Material &operator=(const Material &_material);

      public: Material &operator=(Material &&_material);

      public: bool operator==(const Material &_material) const;

      public: bool operator!=(const Material &_material) const;

      public: MaterialType Type() const;

      public: void SetType(const MaterialType _type);

      public: std::string Name() const;

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

      public: double Density() const;

      public: void SetDensity(const double _density);

      private: MaterialPrivate *dataPtr = nullptr;
    };
    }
  }
}
#endif