palTransponderReciever Class Reference

#include <palSensors.h>

Inheritance diagram for palTransponderReciever:

palSensor

List of all members.

Public Member Functions

virtual void Init (palBody *body)
virtual Float GetDistance (int transponder)
virtual int GetNumTransponders (void)


Detailed Description

A Transponder Sensor - Receiver A transponder sensor returns the distance between two objects It composes of two parts: a sender, and a receiver.

The reciever returns the distance from the senders


Member Function Documentation

Float palTransponderReciever::GetDistance ( int  transponder  )  [virtual]

Gets the distance to a transponder Note: You MUST call GetNumTransponders before you can call GetDistance

Parameters:
transponder The integer handle of the transponder to measure the distance from (ranges from 0 to max transponder - from GetNumTransponders)
Returns:
The distance to the closest object, or -1 if error

int palTransponderReciever::GetNumTransponders ( void   )  [virtual]

Gets the number of transponders in range

Returns:
The number of transponders in range.

void palTransponderReciever::Init ( palBody body  )  [virtual]

Initializes the Transponder receiver. Attaches a transponder receiver to a given body.

Parameters:
body The body which the sendor is attached to


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