gazebo::gui::JointMaker Class Reference

Joint visualization. More...

#include <JointMaker.hh>

Inheritance diagram for gazebo::gui::JointMaker:

Collaboration diagram for gazebo::gui::JointMaker:

Public Types
enum	JointType {   JOINT_NONE, JOINT_FIXED, JOINT_SLIDER, JOINT_HINGE,   JOINT_HINGE2, JOINT_SCREW, JOINT_UNIVERSAL, JOINT_BALL }

Signals
void	JointAdded ()
	Qt signal when the joint creation process has ended. More...

Public Member Functions
	JointMaker ()
	Constructor. More...
virtual	~JointMaker ()
	Destructor. More...
void	CreateJoint (JointType _type)
	Create a joint. More...
void	GenerateSDF ()
	Generate SDF for all joints. More...
sdf::ElementPtr	GetSDF () const
	Generate SDF for all joints. More...
JointMaker::JointType	GetState () const
	Get state. More...
void	RemoveJoint (const std::string &_jointName)
	Remove joint by name. More...
void	RemoveJointsByPart (const std::string &_partName)
	Remove all joints connected to part. More...
void	Reset ()
	Reset the joint maker;. More...
void	Stop ()
	Stop the process of adding joint to the model. More...
void	Update ()
	Update callback on PreRender. More...

Static Public Member Functions
static int	GetJointAxisCount (JointMaker::JointType _type)
	Get the axis count for joint type. More...
static std::string	GetTypeAsString (JointMaker::JointType _type)
	Get the joint type in string. More...

Detailed Description

Joint visualization.

Member Enumeration Documentation

enum gazebo::gui::JointMaker::JointType

Enumerator
JOINT_NONE	none
JOINT_FIXED	Fixed joint.
JOINT_SLIDER	Slider joint.
JOINT_HINGE	Hinge joint.
JOINT_HINGE2	Hinge2 joint.
JOINT_SCREW	Screw joint.
JOINT_UNIVERSAL	Universal joint.
JOINT_BALL	Revolute joint.

Constructor & Destructor Documentation

gazebo::gui::JointMaker::JointMaker

(

)

Constructor.

virtual gazebo::gui::JointMaker::~JointMaker ( )

virtual

Destructor.

Member Function Documentation

void gazebo::gui::JointMaker::CreateJoint

(

JointType

_type

)

Create a joint.

Parameters

_type]

Type of joint to be created

void gazebo::gui::JointMaker::GenerateSDF

(

)

Generate SDF for all joints.

static int gazebo::gui::JointMaker::GetJointAxisCount ( JointMaker::JointType  _type )

static

Get the axis count for joint type.

Parameters

[in]

_type

Type of joint.

sdf::ElementPtr gazebo::gui::JointMaker::GetSDF

(

)

const

Generate SDF for all joints.

JointMaker::JointType gazebo::gui::JointMaker::GetState

(

)

const

Get state.

Returns

State of JointType if joint creation is in process, otherwise JOINT_NONE

static std::string gazebo::gui::JointMaker::GetTypeAsString ( JointMaker::JointType  _type )

static

Get the joint type in string.

Parameters

[in]

_type

Type of joint.

Returns

Joint type in string.

void gazebo::gui::JointMaker::JointAdded ( )

signal

Qt signal when the joint creation process has ended.

void gazebo::gui::JointMaker::RemoveJoint

(

const std::string &

_jointName

)

Remove joint by name.

Parameters

[in]

_jointName

Name of joint to be removed.

void gazebo::gui::JointMaker::RemoveJointsByPart

(

const std::string &

_partName

)

Remove all joints connected to part.

Parameters

[in]

_partName

Name of joint to be removed.

void gazebo::gui::JointMaker::Reset

(

)

Reset the joint maker;.

void gazebo::gui::JointMaker::Stop

(

)

Stop the process of adding joint to the model.

void gazebo::gui::JointMaker::Update

(

)

Update callback on PreRender.

---

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

• JointMaker.hh