A screw joint. More...

#include <BulletScrewJoint.hh>

Inheritance diagram for gazebo::physics::BulletScrewJoint:

Public Member Functions
	BulletScrewJoint (btDynamicsWorld *world, BasePtr _parent)
	Constructor.

virtual	~BulletScrewJoint ()
	Destructor.

void	Attach (LinkPtr _one, LinkPtr _two)
	Attach the two bodies with this joint.

virtual math::Angle	GetAngle (int _index) const
	Get the position of the joint.

virtual math::Angle	GetAngleImpl (int _index) const
	Get the angle of rotation.

virtual math::Vector3	GetGlobalAxis (int _index) const
	Get the axis of rotation.

virtual math::Angle	GetHighStop (int _index)
	Get the high stop of an axis(index).

virtual math::Angle	GetLowStop (int _index)
	Get the low stop of an axis(index).

virtual double	GetMaxForce (int _index)
	Get the max allowed force of an axis(index).

virtual double	GetVelocity (int _index) const
	Get the rate of change.

void	SetAxis (int _index, const math::Vector3 &_axis)
	Set the axis of motion.

virtual void	SetDamping (int _index, double _damping)
	Set joint damping, not yet implemented.

virtual void	SetForce (int _index, double _force)
	Set the screw force.

virtual void	SetHighStop (int _index, const math::Angle &_angle)
	Set the high stop of an axis(index).

virtual void	SetLowStop (int _index, const math::Angle &_angle)
	Set the low stop of an axis(index).

virtual void	SetMaxForce (int _index, double _t)
	Set the max allowed force of an axis(index).

virtual void	SetVelocity (int _index, double _angle)
	Set the velocity of an axis(index).

Public Member Functions inherited from gazebo::physics::ScrewJoint< BulletJoint >
	ScrewJoint (BasePtr _parent)
	Constructor.

virtual	~ScrewJoint ()
	Destructor.

virtual math::Vector3	GetAnchor (int) const
	Get the anchor.

virtual void	SetAnchor (int, const math::Vector3 &anchor)
	Set the anchor.

virtual void	SetThreadPitch (int _index, double _threadPitch)=0
	Set screw joint thread pitch.

Public Member Functions inherited from gazebo::physics::BulletJoint
	BulletJoint (BasePtr _parent)
	Constructor.

virtual	~BulletJoint ()
	Destructor.

bool	AreConnected (LinkPtr _one, LinkPtr _two) const
	Determines of the two bodies are connected by a joint.

virtual void	Detach ()
	Detach this joint from all bodies.

LinkPtr	GetJointLink (int _index) const
	Get the body to which the joint is attached according the _index.

virtual math::Vector3	GetLinkForce (unsigned int) const
	Get the force the joint applies to the first body.

virtual math::Vector3	GetLinkTorque (unsigned int) const
	Get the torque the joint applies to the first body.

virtual void	Reset ()
	Reset the joint.

virtual void	SetAttribute (Attribute, int, double)
	Set a parameter for the joint.

Public Member Functions inherited from gazebo::physics::Joint
	Joint (BasePtr _parent)
	Constructor.

virtual	~Joint ()
	Destructor.

template<typename T >
event::ConnectionPtr	ConnectJointUpdate (T _subscriber)
	Connect a boost::slot the the joint update signal.

void	DisconnectJointUpdate (event::ConnectionPtr &_conn)
	Disconnect a boost::slot the the joint update signal.

void	FillJointMsg (msgs::Joint &_msg) GAZEBO_DEPRECATED
	DEPRECATED.

void	FillMsg (msgs::Joint &_msg)
	Fill a joint message.

math::Angle	GetAngle (int _index) const
	Get the angle of rotation of an axis(index)

LinkPtr	GetChild () const
	Get the child link.

virtual double	GetForce (int _index)

math::Vector3	GetLocalAxis (int _index) const
	Get the axis of rotation.

LinkPtr	GetParent () const
	Get the parent link.

JointState	GetState ()
	Get the joint state.

virtual void	Init ()
	Initialize a joint.

void	Load (LinkPtr _parent, LinkPtr _child, const math::Pose &_pose)
	Set pose, parent and child links of a physics::Joint.

void	SetAngle (int _index, math::Angle _angle)
	If the Joint is static, Gazebo stores the state of this Joint as a scalar inside the Joint class, so this call will NOT move the joint dynamically for a static Model.

void	SetModel (ModelPtr _model)
	Set the model this joint belongs too.

void	SetState (const JointState &_state)
	Set the joint state.

void	Update ()
	Update the joint.

virtual void	UpdateParameters (sdf::ElementPtr _sdf)
	Update the parameters using new sdf values.

Public Member Functions inherited from gazebo::physics::Base
	Base (BasePtr parent)
	Constructor.

virtual	~Base ()
	Destructor.

void	AddChild (BasePtr _child)
	Add a child to this entity.

void	AddType (EntityType _type)
	Add a type specifier.

virtual void	Fini ()
	Finialize the object.

BasePtr	GetById (unsigned int _id) const
	Get a child or self by id.

BasePtr	GetByName (const std::string &_name)
	Get by name.

BasePtr	GetChild (unsigned int _i) const
	Get a child by index.

BasePtr	GetChild (const std::string &_name)
	Get a child by name.

unsigned int	GetChildCount () const
	Get the number of children.

unsigned int	GetId () const
	Return the ID of this entity.

std::string	GetName () const
	Return the name of the entity.

BasePtr	GetParent () const
	Get the parent.

int	GetParentId () const
	Return the ID of the parent.

bool	GetSaveable () const
	Get whether the object should be "saved", when the user selects to save the world to xml.

std::string	GetScopedName () const
	Return the name of this entity with the model scope world::model1::...::modelN::entityName.

virtual const sdf::ElementPtr	GetSDF ()
	Get the SDF values for the object.

unsigned int	GetType () const
	Get the full type definition.

const WorldPtr &	GetWorld () const
	Get the World this object is in.

bool	HasType (const EntityType &_t) const
	Returns true if this object's type definition has the given type.

bool	IsSelected () const
	True if the entity is selected by the user.

bool	operator== (const Base &_ent) const
	Returns true if the entities are the same.

void	Print (const std::string &_prefix)
	Print this object to screen via gzmsg.

virtual void	RemoveChild (unsigned int _id)
	Remove a child from this entity.

void	RemoveChild (const std::string &_name)
	Remove a child by name.

void	RemoveChildren ()
	Remove all children.

virtual void	Reset (Base::EntityType _resetType)
	Calls recursive Reset on one of the Base::EntityType's.

virtual void	SetName (const std::string &_name)
	Set the name of the entity.

void	SetParent (BasePtr _parent)
	Set the parent.

void	SetSaveable (bool _v)
	Set whether the object should be "saved", when the user selects to save the world to xml.

virtual bool	SetSelected (bool _show)
	Set whether this entity has been selected by the user through the gui.

void	SetWorld (const WorldPtr &_newWorld)
	Set the world this object belongs to.

Protected Member Functions
virtual void	Load (sdf::ElementPtr _sdf)
	Load the BulletScrewJoint.

Additional Inherited Members
Public Types inherited from gazebo::physics::Joint
enum	Attribute { FUDGE_FACTOR, SUSPENSION_ERP, SUSPENSION_CFM, STOP_ERP, STOP_CFM, ERP, CFM, FMAX, VEL, HI_STOP, LO_STOP }
	Joint attribute types. More...

Protected Attributes inherited from gazebo::physics::ScrewJoint< BulletJoint >
math::Vector3	fakeAnchor

double	threadPitch

Detailed Description

A screw joint.

Constructor & Destructor Documentation

gazebo::physics::BulletScrewJoint::BulletScrewJoint	(	btDynamicsWorld *	world,
		BasePtr	_parent
	)

Constructor.

virtual gazebo::physics::BulletScrewJoint::~BulletScrewJoint ( )

virtual

Destructor.

Member Function Documentation

void gazebo::physics::BulletScrewJoint::Attach	(	LinkPtr	_one,
		LinkPtr	_two
	)

virtual

Attach the two bodies with this joint.

Reimplemented from gazebo::physics::Joint.

virtual math::Angle gazebo::physics::BulletScrewJoint::GetAngle ( int _index ) const

virtual

Get the position of the joint.

virtual math::Angle gazebo::physics::BulletScrewJoint::GetAngleImpl ( int _index ) const

virtual

Get the angle of rotation.

Implements gazebo::physics::Joint.

virtual math::Vector3 gazebo::physics::BulletScrewJoint::GetGlobalAxis ( int _index ) const

virtual

Get the axis of rotation.

Implements gazebo::physics::Joint.

virtual math::Angle gazebo::physics::BulletScrewJoint::GetHighStop ( int _index )

virtual

Get the high stop of an axis(index).

Implements gazebo::physics::Joint.

virtual math::Angle gazebo::physics::BulletScrewJoint::GetLowStop ( int _index )

virtual

Get the low stop of an axis(index).

Implements gazebo::physics::Joint.

virtual double gazebo::physics::BulletScrewJoint::GetMaxForce ( int _index )

virtual

Get the max allowed force of an axis(index).

Implements gazebo::physics::Joint.

virtual double gazebo::physics::BulletScrewJoint::GetVelocity ( int _index ) const

virtual

Get the rate of change.

Implements gazebo::physics::Joint.

virtual void gazebo::physics::BulletScrewJoint::Load ( sdf::ElementPtr _sdf )

protectedvirtual

Load the BulletScrewJoint.

Reimplemented from gazebo::physics::ScrewJoint< BulletJoint >.

void gazebo::physics::BulletScrewJoint::SetAxis	(	int	_index,
		const math::Vector3 &	_axis
	)

virtual

Set the axis of motion.

Implements gazebo::physics::Joint.

virtual void gazebo::physics::BulletScrewJoint::SetDamping	(	int	_index,
		double	_damping
	)

virtual

Set joint damping, not yet implemented.

Reimplemented from gazebo::physics::BulletJoint.

virtual void gazebo::physics::BulletScrewJoint::SetForce	(	int	_index,
		double	_force
	)

virtual

Set the screw force.

Reimplemented from gazebo::physics::Joint.

virtual void gazebo::physics::BulletScrewJoint::SetHighStop	(	int	_index,
		const math::Angle &	_angle
	)

virtual

Set the high stop of an axis(index).

Implements gazebo::physics::Joint.

virtual void gazebo::physics::BulletScrewJoint::SetLowStop	(	int	_index,
		const math::Angle &	_angle
	)

virtual

Set the low stop of an axis(index).

Implements gazebo::physics::Joint.

virtual void gazebo::physics::BulletScrewJoint::SetMaxForce	(	int	_index,
		double	_t
	)

virtual

Set the max allowed force of an axis(index).

Implements gazebo::physics::Joint.

virtual void gazebo::physics::BulletScrewJoint::SetVelocity	(	int	_index,
		double	_angle
	)

virtual

Set the velocity of an axis(index).

Implements gazebo::physics::Joint.

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

BulletScrewJoint.hh

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation