Enki Namespace Reference


Detailed Description

Enki is the namespace of the Enki simulator. All Enki functions and classes excepted the math one are inside this namespace.


Classes

class  BluetoothBase
 Implementation of a Bluetooth base coordinating the Bluetooth modules. More...
struct  Vector
 A vector in a 2D space. More...
struct  Matrix22
 A 2x2 matrix. More...
struct  Segment
 A segment in a 2D space, basically two points. More...
struct  Polygone
 Polygone, which is a vector of points. Anti-clockwise, standard trigonometric orientation. More...
class  LocalInteraction
 Interacts with another object or wall only up to a certain distance. More...
class  GlobalInteraction
 Interacts with the whole world. More...
class  ActiveSoundSource
 Time limited sound emitter. More...
class  ActiveSoundObject
 ActiveSoundObject can be inherited by any robot that want to emit sound. More...
class  Bluetooth
 Implementation of an onboard Bluetooth module. More...
struct  DepthTest
 Standard depth test. More...
struct  PixelOperationFunctor
 Functor for pixel operation. More...
class  CircularCam
 1D Circular camera More...
class  OmniCam
 1D omnidirectional circular camera, based on 2 CircularCam Pixels start at -PI and then follow mathematical orientation to PI More...
struct  SensorResponseFunctor
 Functor for the sensor response. More...
class  IRSensor
 A generic infrared sensor. More...
class  Microphone
 A generic sound sensor/microphone. More...
class  FourWayMic
 A generic sound sensor/microphone. More...
struct  InteractionRadiusCompare
 A functor then compares the radius of two local interactions. More...
class  PhysicalObject
 A situated object in the world with mass, geometry properties, physical properties, ... More...
class  Robot
 A robot is a PhysicalObject that has additional interactions and a controller. More...
class  World
 The world is the container of all objects and robots. More...
class  FastRandom
 A fast random generator. More...
struct  UniformRand
 Functor to be used with <algorithm>. More...
struct  AliceBoundingSurface
 The bounding surface of an Alice. More...
struct  AliceIRNormalSensorModel
 Calculate the signal strength as a function of the distance. More...
struct  AliceIRLeftSensorModel
 Calculate the signal strength as a function of the distance. More...
struct  AliceIRRightSensorModel
 Calculate the signal strength as a function of the distance. More...
struct  AliceIRHighSensorModel
 Calculate the signal strength as a function of the distance. More...
struct  ZeroSensorModel
 Response function which returns zero all the time. More...
class  Alice
 A simple model of the Alice robot. More...
class  AliceCam
 Linear camera for the Alice. More...
class  AliceCommunication
 Communication module for the Alice. More...
class  DifferentialWheeled
struct  EPuckIRSensorModel
 Calculate the signal strength as a function of the distance. More...
class  EPuckScannerTurret
 The rotating, long range distance sensor turret of the E-puck robot. More...
class  EPuck
 A simple model of the E-puck robot. More...
struct  KheperaIRSensorModel
 Calculate the signal strength as a function of the distance. More...
class  Khepera
 A simple model of the Khepera robot. More...
class  Marxbot
 A very simplified model of the Sbot mobile robot. More...
class  SbotGlobalSound
 Interaction sound between all Sbots. More...
class  SbotMicrophone
 Specific microphone for S-bots. More...
class  Sbot
 A very simplified model of the Sbot mobile robot. More...
class  FeedableSbot
 An "improved" Sbot that can interact with SbotActiveObject. More...
class  SoundSbot
 This Sbot version has sound capabilities inherited from ActiveSoundObject, as well as the feeding and usual capabilities of an Sbot. More...
class  SbotFeeding
 Feeding interaction gives or remove energy to nearby Sbots. More...
class  SbotActiveObject
 SbotActiveObject give or remove energy to nearby Sbots through an SbotFeeding interaction. More...
class  SbotActiveSoundObject
 SbotActiveSoundObject give or remove energy to nearby Sbots through an SbotFeeding interaction. More...
struct  Color
 A color in RGBA. More...

Typedefs

typedef Vector Point
 A point in a 2D space, another name for a vector.
typedef double(*) MicrophoneResponseModel (double, double)
 A function for manipulating acquired sound, normally to model saturation, distance decreasing or frequency response.
typedef std::valarray< ColorTexture
 A texture.
typedef std::valarray< TextureTextures
 Textures for all sides of an object.

Functions

std::ostream & operator<< (std::ostream &outs, const Vector &vector)
 Dump a vector to a stream.
double normalizeAngle (double angle)
 Normlize an angle to be between -PI and +PI.
Point getIntersection (const Segment &s1, const Segment &s2)
 get the intersection point between two line segments returns Point(HUGE_VAL, HUGE_VAL) if there's no intersection added by yvan.bourquin@epfl.ch
double uniformRand (void)
 Return a number in [0;1[ in a uniform distribution.
unsigned intRand (unsigned max)
 Return a number between [0;max[ in integer in a uniform distribution.
bool boolRand (double prob=0.5)
 Return true with a probability prob. If no argument is given, prob = 0.5.
double gaussianRand (double mean, double sigm)
 Return a random number with a gaussian distribution of a certain mean and standard deviation.
template<typename T>
clamp (T v, T min, T max)
double marxbotVirtualBumperResponseFunction (double dist)
double MicrophonePseudoRealResponseModel (double signal, double distance)
 Response model for sound on s-bot.

Variables

Enki::DepthTest depthTest
 Standard depth test Standard depth test instance.
FastRandom random
 Fast random for use by Enki.
FastRandom random
 Fast random for use by Enki.
Enki::AliceBoundingSurface aliceBoundingSurface
 The bounding surface of an Alice.
EPuckIRSensorModel epuckIRSensorModel
 We use only one ray per sensor for the e-puck.
SensorResponseFunctorepuckIRSensorModelPtr = &epuckIRSensorModel
 Pointer to sensor model for e-puck, one value C array.
KheperaIRSensorModel kheperaIRSensorModel
 We use only one ray per sensor for the Khepera.
SensorResponseFunctorkheperaIRSensorModelPtr = &kheperaIRSensorModel
 Pointer to sensor model for Khepera, one value C array.


Generated on Tue Jan 6 03:10:12 2009 for Enki by  doxygen 1.5.1