ODEGearboxJoint.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2012-2016 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 _ODEGEARBOXJOINT_HH_
19 #define _ODEGEARBOXJOINT_HH_
20 
21 #include "gazebo/math/Angle.hh"
22 #include "gazebo/math/Vector3.hh"
23 
26 #include "gazebo/util/system.hh"
27 
28 namespace gazebo
29 {
30  namespace physics
31  {
34 
37  class GZ_PHYSICS_VISIBLE ODEGearboxJoint : public GearboxJoint<ODEJoint>
38  {
42  public: ODEGearboxJoint(dWorldID _worldId, BasePtr _parent);
43 
45  public: virtual ~ODEGearboxJoint();
46 
47  // Documentation inherited
48  public: virtual void Load(sdf::ElementPtr _sdf);
49 
50  // Documentation inherited
51  public: virtual void Init();
52 
53  // Documentation inherited
54  public: virtual math::Vector3 GetAnchor(unsigned int _index) const;
55 
56  // Documentation inherited
57  public: virtual void SetAnchor(unsigned int _index,
58  const math::Vector3 &_anchor);
59 
60  // Documentation inherited
61  public: virtual math::Vector3 GetGlobalAxis(unsigned int _index) const;
62 
63  // Documentation inherited
64  public: virtual void SetAxis(unsigned int _index,
65  const math::Vector3 &_axis);
66 
67  // Documentation inherited
68  public: virtual void SetGearboxRatio(double _gearRatio);
69 
70  // Documentation inherited
71  public: virtual math::Angle GetAngleImpl(unsigned int _index) const;
72 
73  // Documentation inherited
74  public: virtual void SetVelocity(unsigned int _index, double _angle);
75 
76  // Documentation inherited
77  public: virtual double GetVelocity(unsigned int _index) const;
78 
79  // Documentation inherited
80  public: virtual double GetParam(unsigned int _parameter) const;
81 
82  // Documentation inherited
83  public: virtual void SetParam(unsigned int _parameter, double _value);
84 
85  // Documentation inherited
86  protected: virtual void SetForceImpl(unsigned int _index, double _effort);
87 
90  private: void SetReferenceBody(LinkPtr _body);
91  };
93  }
94 }
95 #endif
boost::shared_ptr< Link > LinkPtr
Definition: PhysicsTypes.hh:100
Forward declarations for the common classes.
Definition: Animation.hh:33
The Vector3 class represents the generic vector containing 3 elements.
Definition: Vector3.hh:39
A double axis gearbox joint.
Definition: ODEGearboxJoint.hh:37
A double axis gearbox joint.
Definition: GearboxJoint.hh:44
GAZEBO_VISIBLE void Init(google::protobuf::Message &_message, const std::string &_id="")
Initialize a message.
An angle and related functions.
Definition: Angle.hh:53
boost::shared_ptr< Base > BasePtr
Definition: PhysicsTypes.hh:72