|
| 1 | +/* |
| 2 | + * Copyright (C) 2024 Open Source Robotics Foundation |
| 3 | + * |
| 4 | + * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | + * you may not use this file except in compliance with the License. |
| 6 | + * You may obtain a copy of the License at |
| 7 | + * |
| 8 | + * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | + * |
| 10 | + * Unless required by applicable law or agreed to in writing, software |
| 11 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | + * See the License for the specific language governing permissions and |
| 14 | + * limitations under the License. |
| 15 | + * |
| 16 | + */ |
| 17 | + |
| 18 | +#ifndef GZ_PHYSICS_KINEMATICLINK_HH_ |
| 19 | +#define GZ_PHYSICS_KINEMATICLINK_HH_ |
| 20 | + |
| 21 | +#include <gz/physics/FeatureList.hh> |
| 22 | + |
| 23 | +namespace gz |
| 24 | +{ |
| 25 | + namespace physics |
| 26 | + { |
| 27 | + ///////////////////////////////////////////////// |
| 28 | + class GZ_PHYSICS_VISIBLE KinematicLink |
| 29 | + : public virtual Feature |
| 30 | + { |
| 31 | + /// \brief The Link API for setting link to be kinematic |
| 32 | + public: template <typename PolicyT, typename FeaturesT> |
| 33 | + class Link : public virtual Feature::Link<PolicyT, FeaturesT> |
| 34 | + { |
| 35 | + /// \brief Set link to be kinematic. |
| 36 | + /// A kinematic link does not react to forces, e.g. gravity or other |
| 37 | + /// dynamic objects. It reacts to pose or velocity commands that are |
| 38 | + /// set on the link (via a FreeGroup) or on the joint that connects the |
| 39 | + /// kinematic links. |
| 40 | + /// \param[i] _kinematic True to make this link kinematic. |
| 41 | + public: void SetKinematic(bool _kinematic); |
| 42 | + |
| 43 | + /// \brief Get whether this link is kinematic. |
| 44 | + /// \return True if the link is kinematic, false otherwise. |
| 45 | + /// \sa SetKinematic |
| 46 | + public: bool GetKinematic() const; |
| 47 | + }; |
| 48 | + |
| 49 | + public: template <typename PolicyT> |
| 50 | + class Implementation : public virtual Feature::Implementation<PolicyT> |
| 51 | + { |
| 52 | + /// \brief Implementation API for setting a link to be kinematic |
| 53 | + /// \param[in] _id Identity of the link |
| 54 | + /// \param[in] _kinematic True to make this link kinematic |
| 55 | + public: virtual void SetLinkKinematic( |
| 56 | + const Identity &_shapeID, bool _kinematic) = 0; |
| 57 | + |
| 58 | + /// \brief Implementation API for getting whether a link is kinematic |
| 59 | + /// \param[in] _id Identity of the link |
| 60 | + /// \return True if the link is kinematic, false otherwise. |
| 61 | + public: virtual bool GetLinkKinematic( |
| 62 | + const Identity &_shapeID) const = 0; |
| 63 | + }; |
| 64 | + }; |
| 65 | + } |
| 66 | +} |
| 67 | + |
| 68 | +#include <gz/physics/detail/KinematicLink.hh> |
| 69 | + |
| 70 | +#endif |
0 commit comments