gz/math/Capsule.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 GZ_MATH_CAPSULE_HH_
#define GZ_MATH_CAPSULE_HH_
 
#include <optional>
#include "gz/math/MassMatrix3.hh"
#include "gz/math/Material.hh"
#include "gz/math/Plane.hh"
 
namespace ignition
{
  namespace math
  {
    // Foward declarations
    class CapsulePrivate;
 
    // Inline bracket to help doxygen filtering.
    inline namespace IGNITION_MATH_VERSION_NAMESPACE {
    //
    template<typename Precision>
    class Capsule
    {
      public: Capsule() = default;
 
      public: Capsule(const Precision _length, const Precision _radius);
 
      public: Capsule(const Precision _length, const Precision _radius,
                  const Material &_mat);
 
      public: Precision Radius() const;
 
      public: void SetRadius(const Precision _radius);
 
      public: Precision Length() const;
 
      public: void SetLength(const Precision _length);
 
      public: const Material &Mat() const;
 
      public: void SetMat(const Material &_mat);
 
      public: std::optional< MassMatrix3<Precision> > MassMatrix() const;
 
      public: bool operator==(const Capsule &_capsule) const;
 
      public: Precision Volume() const;
 
      public: Precision VolumeBelow(const Plane<Precision> &_plane) const;
 
      public: std::optional<Vector3<Precision>>
        CenterOfVolumeBelow(const Plane<Precision> &_plane) const;
 
      public: Vector3<Precision> Centroid() const;
 
      public: Precision DensityFromMass(const Precision _mass) const;
 
      public: bool SetDensityFromMass(const Precision _mass);
 
      private: Precision radius = 0.0;
 
      private: Precision length = 0.0;
 
      private: Material material;
    };
 
    typedef Capsule<int> Capsulei;
 
    typedef Capsule<double> Capsuled;
 
    typedef Capsule<float> Capsulef;
    }
  }
}
#include "gz/math/detail/Capsule.hh"
 
#endif