Signals | Public Member Functions | List of all members
gazebo::gui::JointInspector Class Reference

A class to inspect and modify joints. More...

#include <JointInspector.hh>

Inheritance diagram for gazebo::gui::JointInspector:
Inheritance graph
[legend]

Signals

void Applied ()
 Qt signal emitted to indicate that changes should be applied. More...
 

Public Member Functions

 JointInspector (JointMaker::JointType _jointType, QWidget *_parent=0)
 Constructor. More...
 
 ~JointInspector ()
 Destructor. More...
 
math::Vector3 GetAxis (unsigned int _index) const
 Get axis. More...
 
double GetLowerLimit (unsigned int _index) const
 Get axis lower limit. More...
 
std::string GetName () const
 Get joint name. More...
 
math::Pose GetPose () const
 Get joint pose. More...
 
JointMaker::JointType GetType () const
 Get joint type. More...
 
double GetUpperLimit (unsigned int _index) const
 Get axis upper limit. More...
 
void SetAxis (unsigned int _index, const math::Vector3 &_axis)
 Set axis. More...
 
void SetChild (const std::string &_child)
 Set the joint child name. More...
 
void SetLowerLimit (unsigned int _index, double _lower)
 Set axis lower limit. More...
 
void SetName (const std::string &_name)
 Set the joint name. More...
 
void SetParent (const std::string &_parent)
 Set the joint parent name. More...
 
void SetPose (const math::Pose &_pose)
 Set joint pose. More...
 
void SetType (JointMaker::JointType _type)
 Set joint type. More...
 
void SetUpperLimit (unsigned int _index, double _upper)
 Set axis upper limit. More...
 

Detailed Description

A class to inspect and modify joints.

Constructor & Destructor Documentation

gazebo::gui::JointInspector::JointInspector ( JointMaker::JointType  _jointType,
QWidget *  _parent = 0 
)

Constructor.

Parameters
[in]_modeDialog mode
[in]_parentParent QWidget.
gazebo::gui::JointInspector::~JointInspector ( )

Destructor.

Member Function Documentation

void gazebo::gui::JointInspector::Applied ( )
signal

Qt signal emitted to indicate that changes should be applied.

math::Vector3 gazebo::gui::JointInspector::GetAxis ( unsigned int  _index) const

Get axis.

Parameters
[in]_indexIndex of axis
Returns
Axis direction.
double gazebo::gui::JointInspector::GetLowerLimit ( unsigned int  _index) const

Get axis lower limit.

Parameters
[in]_indexIndex of axis
Returns
Lower limit.
std::string gazebo::gui::JointInspector::GetName ( ) const

Get joint name.

Returns
Joint name.
math::Pose gazebo::gui::JointInspector::GetPose ( ) const

Get joint pose.

Returns
Joint pose.
JointMaker::JointType gazebo::gui::JointInspector::GetType ( ) const

Get joint type.

Returns
Joint type.
double gazebo::gui::JointInspector::GetUpperLimit ( unsigned int  _index) const

Get axis upper limit.

Parameters
[in]_indexIndex of axis
Returns
Upper limit.
void gazebo::gui::JointInspector::SetAxis ( unsigned int  _index,
const math::Vector3 _axis 
)

Set axis.

Parameters
[in]_indexIndex of axis.
[in]_axisAxis direction.
void gazebo::gui::JointInspector::SetChild ( const std::string &  _child)

Set the joint child name.

Parameters
[in]_nameName of joint child.
void gazebo::gui::JointInspector::SetLowerLimit ( unsigned int  _index,
double  _lower 
)

Set axis lower limit.

Parameters
[in]_indexIndex of axis.
[in]_lowerLower limit.
void gazebo::gui::JointInspector::SetName ( const std::string &  _name)

Set the joint name.

Parameters
[in]_nameName to set to.
void gazebo::gui::JointInspector::SetParent ( const std::string &  _parent)

Set the joint parent name.

Parameters
[in]_nameName of joint parent.
void gazebo::gui::JointInspector::SetPose ( const math::Pose _pose)

Set joint pose.

Parameters
[in]_poseJoint pose.
void gazebo::gui::JointInspector::SetType ( JointMaker::JointType  _type)

Set joint type.

Parameters
[in]_typejoint type.
void gazebo::gui::JointInspector::SetUpperLimit ( unsigned int  _index,
double  _upper 
)

Set axis upper limit.

Parameters
[in]_indexIndex of axis.
[in]_upperUpper limit.

The documentation for this class was generated from the following file: