Joint Class Reference
[Physics]
#include <Joint.hh>
Detailed Description
Base class for all jointsPublic Types | |
| enum | Type { SLIDER, HINGE, HINGE2, BALL, UNIVERSAL } |
Public Member Functions | |
| Joint () | |
| virtual | ~Joint () |
| void | Load (XMLConfigNode *node) |
| Joint::Type | GetType () const |
| Body * | GetJointBody (int index) const |
| bool | AreConnected (Body *one, Body *two) const |
| virtual double | GetParam (int parameter) const |
| void | SetFixed () |
| void | Attach (Body *one, Body *two) |
| void | Detach () |
| virtual void | SetAnchor (const gazebo::Vector3 &) |
| virtual gazebo::Vector3 | GetAnchor () const |
| virtual void | SetParam (int parameter, double value) |
| std::string | GetName () const |
| void | SetName (const std::string &name) |
Protected Member Functions | |
| virtual void | LoadChild (XMLConfigNode *node) |
Protected Attributes | |
| dJointID | jointId |
| Type | type |
Member Enumeration Documentation
| enum Type |
Type of joint
Constructor & Destructor Documentation
| Joint | ( | ) |
Constructor
| virtual ~Joint | ( | ) | [virtual] |
Destructor
Member Function Documentation
| void Load | ( | XMLConfigNode * | node | ) |
Load a joint
| virtual void LoadChild | ( | XMLConfigNode * | node | ) | [inline, protected, virtual] |
Load child joint
Reimplemented in BallJoint, Hinge2Joint, HingeJoint, SliderJoint, and UniversalJoint.
| Joint::Type GetType | ( | ) | const |
Get the type of the joint
| Body* GetJointBody | ( | int | index | ) | const |
Get the body to which the joint is attached according the _index
Determines of the two bodies are connected by a joint
| virtual double GetParam | ( | int | parameter | ) | const [virtual] |
Get the _parameter
Reimplemented in Hinge2Joint, HingeJoint, and SliderJoint.
| void SetFixed | ( | ) |
Make this joint a fixed joint Use this only when absolutely necessary
| void Detach | ( | ) |
Detach this joint from all bodies
| virtual void SetAnchor | ( | const gazebo::Vector3 & | ) | [inline, virtual] |
Set the anchor point
Reimplemented in BallJoint, Hinge2Joint, HingeJoint, SliderJoint, and UniversalJoint.
| virtual gazebo::Vector3 GetAnchor | ( | ) | const [inline, virtual] |
Set the anchor point
Reimplemented in BallJoint, Hinge2Joint, HingeJoint, and UniversalJoint.
| virtual void SetParam | ( | int | parameter, | |
| double | value | |||
| ) | [virtual] |
Set the _parameter to _value
Reimplemented in Hinge2Joint, HingeJoint, SliderJoint, and UniversalJoint.
| std::string GetName | ( | ) | const |
Set the name of this joint
| void SetName | ( | const std::string & | name | ) |
Get the name of this joint
Member Data Documentation
dJointID jointId [protected] |
This is our id
The documentation for this class was generated from the following file: