CylinderShape.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_PHYSICS_CYLINDERSHAPE_HH_
#define IGNITION_PHYSICS_CYLINDERSHAPE_HH_

#include <string>

#include <ignition/physics/DeclareShapeType.hh>
#include <ignition/physics/Geometry.hh>

namespace ignition
{
  namespace physics
  {
    IGN_PHYSICS_DECLARE_SHAPE_TYPE(CylinderShape)

    class IGNITION_PHYSICS_VISIBLE GetCylinderShapeProperties
        : public virtual FeatureWithRequirements<CylinderShapeCast>
    {
      public: template <typename PolicyT, typename FeaturesT>
      class CylinderShape : public virtual Entity<PolicyT, FeaturesT>
      {
        public: using Scalar = typename PolicyT::Scalar;

        public: Scalar GetRadius() const;

        public: Scalar GetHeight() const;
      };

      public: template <typename PolicyT>
      class Implementation : public virtual Feature::Implementation<PolicyT>
      {
        public: using Scalar = typename PolicyT::Scalar;

        public: virtual Scalar GetCylinderShapeRadius(
            const Identity &_cylinderID) const = 0;

        public: virtual Scalar GetCylinderShapeHeight(
            const Identity &_cylinderID) const = 0;
      };
    };

    class IGNITION_PHYSICS_VISIBLE SetCylinderShapeProperties
        : public virtual FeatureWithRequirements<CylinderShapeCast>
    {
      public: template <typename PolicyT, typename FeaturesT>
      class CylinderShape : public virtual Entity<PolicyT, FeaturesT>
      {
        public: using Scalar = typename PolicyT::Scalar;

        public: void SetRadius(Scalar _radius);

        public: void SetHeight(Scalar _height);
      };

      public: template <typename PolicyT>
      class Implementation : public virtual Feature::Implementation<PolicyT>
      {
        public: using Scalar = typename PolicyT::Scalar;

        public: virtual void SetCylinderShapeRadius(
            const Identity &_cylinderID, Scalar _radius) = 0;

        public: virtual void SetCylinderShapeHeight(
            const Identity &_cylinderID, Scalar _height) = 0;
      };
    };

    class IGNITION_PHYSICS_VISIBLE AttachCylinderShapeFeature
        : public virtual FeatureWithRequirements<CylinderShapeCast>
    {
      public: template <typename PolicyT, typename FeaturesT>
      class Link : public virtual Feature::Link<PolicyT, FeaturesT>
      {
        public: using Scalar = typename PolicyT::Scalar;

        public: using PoseType =
            typename FromPolicy<PolicyT>::template Use<Pose>;

        public: using ShapePtrType = CylinderShapePtr<PolicyT, FeaturesT>;

        public: ShapePtrType AttachCylinderShape(
            const std::string &_name = "cylinder",
            Scalar _radius = 1.0,
            Scalar _height = 1.0,
            const PoseType &_pose = PoseType::Identity());
      };

      public: template <typename PolicyT>
      class Implementation : public virtual Feature::Implementation<PolicyT>
      {
        public: using Scalar = typename PolicyT::Scalar;

        public: using PoseType =
            typename FromPolicy<PolicyT>::template Use<Pose>;

        public: virtual Identity AttachCylinderShape(
            const Identity &_linkID,
            const std::string &_name,
            Scalar _radius,
            Scalar _height,
            const PoseType &_pose) = 0;
      };
    };
  }
}

#include <ignition/physics/detail/CylinderShape.hh>

#endif