palCompassSensor Class Reference

#include <palSensors.h>

Inheritance diagram for palCompassSensor:

palSensor

List of all members.

Public Member Functions

void Init (palBody *body, Float north_x, Float north_y, Float north_z)
Float GetAngle ()


Detailed Description

A Compass Sensor

Member Function Documentation

Float palCompassSensor::GetAngle (  ) 

Returns the angle (radians) between compass direction and world north measured in the plane normal to sensor axis

Returns:
The angle (radians)

void palCompassSensor::Init ( palBody body,
Float  north_x,
Float  north_y,
Float  north_z 
)

Initializes the compass sensor. Attaches a compass to a given body, with a given initial direction for north.

Parameters:
body The body which the sensor is attached to.
north_x The axis which the angle is measured about w.r.t. the body (x)
north_y The axis which the angle is measured about w.r.t. the body (y)
north_z The axis which the angle is measured about w.r.t. the body (z)


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

Generated on Mon Aug 31 13:58:02 2009 for pal by  doxygen 1.5.7.1