The class modelling a kephera II robot. More...

Inheritance diagram for PhyKhepera:

Public Member Functions
	PhyKhepera (World *world, QString name, const wMatrix &transformation=wMatrix::identity())
	Creates a khepera II robot. More...

virtual	~PhyKhepera ()
	Destructor. More...

void	doKinematicSimulation (bool k)
	Changes the robot model from dynamic to kinematic and vice-versa. More...

bool	getDrawFrontMarker () const
	Returns whether a marker in the front part of the robot is drawn or not. More...

bool	isKinematic () const
	Returns true if we are using the kinematic model. More...

virtual void	postUpdate ()
	Post-updates the robot. More...

virtual void	preUpdate ()
	Pre-updates the robot. More...

SimulatedIRProximitySensorController *	proximityIRSensorController ()
	Returns the proximity infrared sensors controller. More...

void	setDrawFrontMarker (bool drawMarker)
	Whether to draw a marker in the front part of the robot or not. More...

void	setProximityIRSensorsGraphicalProperties (bool drawSensor, bool drawRay=false, bool drawRealRay=false)
	Sets whether proximity IR sensors are drawn or not and how. More...

WheelMotorController *	wheelsController ()
	Returns the motor controller for the wheels. More...

Public Member Functions inherited from WObject
	WObject (World *world, QString name="unamed", const wMatrix &tm=wMatrix::identity(), bool addToWorld=true)
	create the object and automatically put this into the world More...

virtual	~WObject ()
	destroy the Object and drop it from the world More...

QColor	color () const
	return the color of this object More...

void	drawLocalAxes (bool d)
	Sets whether the object local frame of reference should be drawn or not. More...

bool	isInvisible () const
	return if it is invisible More...

const QString &	label () const
	Returns the text label to render along with the object. More...

const QColor &	labelColor () const
	Returns the color of the label. More...

const wVector &	labelPosition () const
	Returns the label position relative to this object. More...

bool	labelShown () const
	Returns whether the label is shown or not. More...

bool	localAxesDrawn () const
	Returns true if the local frame of refecence of the object should be drawn. More...

const wMatrix &	matrix () const
	return a reference to the transformation matrix More...

QString	name () const
	Return the name of this object. More...

void	setAlpha (int alpha)
	set the value of alpha channel (the transparency) More...

void	setColor (QColor c)
	Set the color to use on rendering. More...

void	setInvisible (bool b)
	set invisibility More...

void	setLabel (QString label)
	Sets a text label to render along with the object. More...

void	setLabel (QString label, wVector pos)
	Sets a text label to render along with the object and its position. More...

void	setLabel (QString label, wVector pos, QColor color)
	Sets a text label to render along with the object and its position and color. More...

void	setLabelColor (const QColor &color)
	Sets the color of the label. More...

void	setLabelPosition (const wVector &pos)
	Sets the label position relative to this object. More...

void	setMatrix (const wMatrix &newm)
	set a new matrix More...

void	setPosition (const wVector &newpos)
	set the position specified in global coordinate frame More...

void	setPosition (real x, real y, real z)
	set the position specified in global coordinate frame More...

void	setTexture (QString textureName)
	Set the texture to use for this WObject when rendered. More...

void	setUseColorTextureOfOwner (bool b)
	set if the object will be rendered with the color and texture of our owner (if we have one) More...

void	showLabel (bool show)
	Sets whether to show the label or not. More...

QString	texture () const
	Return the texture name. More...

bool	useColorTextureOfOwner () const
	if true, we will use color and texture of our owner (if we have one) More...

World *	world ()
	Return the world. More...

const World *	world () const
	Return the world (const version) More...

Public Member Functions inherited from Ownable
	Ownable ()
	Constructor. More...

virtual	~Ownable ()
	Destructor. More...

const QList< Owned > &	owned () const
	Returns the list of objects owned by this one. More...

Ownable *	owner () const
	Returns the owner of this object. More...

void	setOwner (Ownable *owner, bool destroy=true)
	Sets the owner of this object. More...

Static Public Attributes
static const real	axletrack = 0.055f
	The distance between the two motorized wheels. More...

static const real	bodydistancefromground = 0.0015f
	The distance of the body from the ground. More...

static const real	bodyh = 0.030f
	The height of the body of the robot. More...

static const real	bodym = 0.066f
	The mass of the robot without the wheels. More...

static const real	bodyr = 0.035f
	The radius of the body of the robot. More...

static const real	passivewheelm = 0.002f
	The mass of the passive wheels. More...

static const real	passivewheelr = 0.003f
	The radius of the passive wheels. More...

static const real	wheelh = 0.003f
	The height of the motorized wheels. More...

static const real	wheelm = 0.005f
	The mass of one motorized wheel. More...

static const real	wheelr = 0.015f
	The radius of the motorized wheels. More...

Protected Slots
void	setLeftWheelDesideredVelocity (real velocity)
	Sets the desidered velocity of the left wheel. More...

void	setRightWheelDesideredVelocity (real velocity)
	Sets the desidered velocity of the right wheel. More...

Protected Member Functions
virtual void	changedMatrix ()
	The function called when the transformation matrix of the robot is changed. More...

Additional Inherited Members
Public Types inherited from Ownable
typedef QList< Owned >	OwnedList
	The type for the list of owned objects. More...

Protected Attributes inherited from WObject
QColor	colorv
	Color, it contains also alpha channel. More...

bool	invisible
	if TRUE it will not renderized More...

QColor	labelcol
	The color of the label. More...

bool	labeldrawn
	Whether the label should be rendered or not. More...

wVector	labelpos
	The position of the label in the object frame of reference. More...

QString	labelv
	The text label of the object. More...

bool	localFrameOfReferenceDrawn
	If true, the local frame of reference of the object is drawn. More...

QString	namev
	Name of the WObject. More...

QString	texturev
	Texture name. More...

wMatrix	tm
	Trasformation matrix. More...

bool	usecolortextureofowner
	if true, we will use color and texture of our owner (if we have one). More...

World *	worldv
	World. More...

Detailed Description

The class modelling a kephera II robot.

This class models a khepera II robot. For more information about the robot go to http://www.k-team.com/mobile-robotics-products/khepera-ii/introduction

Definition at line 45 of file phykhepera.h.

Constructor & Destructor Documentation

PhyKhepera	(	World *	world,
		QString	name,
		const wMatrix &	transformation = `wMatrix::identity()`
	)

Creates a khepera II robot.

Parameters

world	the world in which the robot lives
name	the name of the robots
transformation	the transformation matrix of the robot

Definition at line 52 of file phykhepera.cpp.

References PhyKhepera::axletrack, PhyKhepera::bodydistancefromground, PhyKhepera::bodyh, PhyKhepera::bodym, PhyKhepera::bodyr, MaterialDB::createMaterial(), PhyJoint::dofs(), wMatrix::identity(), wMatrix::inverse(), World::materials(), WObject::matrix(), PhyKhepera::passivewheelm, PhyKhepera::passivewheelr, wMatrix::roll(), WObject::setColor(), PhyKhepera::setLeftWheelDesideredVelocity(), PhyObject::setMass(), WObject::setMatrix(), Ownable::setOwner(), MaterialDB::setProperties(), PhyKhepera::setRightWheelDesideredVelocity(), WheelMotorController::setSpeedLimits(), WObject::tm, farsa::toRad(), wMatrix::untransformVector(), PhyJoint::updateJointInfo(), PhyKhepera::wheelh, PhyKhepera::wheelm, PhyKhepera::wheelr, wVectorT< false >::X(), wMatrix::yaw(), and wVectorT< false >::Z().

~PhyKhepera ( )

virtual

Destructor.

Definition at line 248 of file phykhepera.cpp.

Member Function Documentation

void changedMatrix ( )

protectedvirtual

The function called when the transformation matrix of the robot is changed.

This updates the matrix of all sub-objects

Reimplemented from WObject.

Definition at line 363 of file phykhepera.cpp.

References WObject::matrix(), WObject::setMatrix(), WObject::tm, and PhyJoint::updateJointInfo().

void doKinematicSimulation ( bool k )

Changes the robot model from dynamic to kinematic and vice-versa.

Parameters

k	if true switches to the kinematic Kephera II model, if false to the dynamic one (at creation the model is always dynamic)

Definition at line 320 of file phykhepera.cpp.

References PhyObject::setKinematic().

bool getDrawFrontMarker ( ) const

Returns whether a marker in the front part of the robot is drawn or not.

Returns: true if a marker in the front part of the robot is drawn

Definition at line 315 of file phykhepera.cpp.

Referenced by PhyKhepera::setDrawFrontMarker().

bool isKinematic ( ) const

inline

Returns true if we are using the kinematic model.

Returns: true if we are using the kinematic model

Definition at line 201 of file phykhepera.h.

void postUpdate ( )

virtual

Post-updates the robot.

This method is called at each step of the world just after the physic update

Reimplemented from WObject.

Definition at line 278 of file phykhepera.cpp.

References SensorController::isEnabled(), WObject::matrix(), WObject::tm, and SimulatedIRProximitySensorController::update().

void preUpdate ( )

virtual

Pre-updates the robot.

This method is called at each step of the world just before the physic update

Reimplemented from WObject.

Definition at line 261 of file phykhepera.cpp.

References PhyKhepera::axletrack, MotorController::isEnabled(), WObject::matrix(), WObject::setMatrix(), WheelMotorController::update(), PhyKhepera::wheelr, and WObject::world().

SimulatedIRProximitySensorController* proximityIRSensorController ( )

inline

Returns the proximity infrared sensors controller.

Returns: the proximity infrared sensors controller

Definition at line 135 of file phykhepera.h.

void setDrawFrontMarker ( bool drawMarker )

Whether to draw a marker in the front part of the robot or not.

Parameters

drawMarker if true draws a marker in the front part of the robot

Definition at line 294 of file phykhepera.cpp.

References GraphicalWObject::attachToObject(), PhyKhepera::bodydistancefromground, PhyKhepera::bodyh, PhyKhepera::bodyr, PhyKhepera::getDrawFrontMarker(), wMatrix::roll(), WObject::setColor(), WObject::setTexture(), WObject::setUseColorTextureOfOwner(), and WObject::world().

void setLeftWheelDesideredVelocity ( real velocity )

protectedslot

Sets the desidered velocity of the left wheel.

This is used when in kinematic to move the robot. We only use velocity because robots can only move by setting wheel velocities

Parameters

velocity the desidered velocity (in radiants per second)

Definition at line 353 of file phykhepera.cpp.

Referenced by PhyKhepera::PhyKhepera().

void setProximityIRSensorsGraphicalProperties	(	bool	drawSensor,
		bool	drawRay = `false`,
		bool	drawRealRay = `false`
	)

Sets whether proximity IR sensors are drawn or not and how.

Parameters

drawSensor	whether to draw the sensor or not
drawRay	whether to draw the IR rays or not
drawRealRay	if true rays are drawn in their actual length, otherwise only the direction is given

Definition at line 289 of file phykhepera.cpp.

References SimulatedIRProximitySensorController::setGraphicalProperties().

void setRightWheelDesideredVelocity ( real velocity )

protectedslot

Sets the desidered velocity of the right wheel.

This is used when in kinematic to move the robot. We only use velocity because robots can only move by setting wheel velocities

Parameters

velocity the desidered velocity (in radiants per second)

Definition at line 358 of file phykhepera.cpp.

Referenced by PhyKhepera::PhyKhepera().

WheelMotorController* wheelsController ( )

inline