Dokumentacja klasy SceneConfig

#include <sceneConfig.hpp>

Lista wszystkich składowych.

---

Opis szczegółowy

Klasa przechowuje informacje o konfiguracji sceny.

Autor:

Arkadiusz Lisiecki

Wersja:

1.0

Data:

2007-12-04

Metody publiczne
double	getELen ()
double	getEPhi ()
double	getLevelAvoidObstacles ()
double	getLevelBasicFlee ()
double	getLevelCohesion ()
double	getLevelSeparation ()
unsigned int	getMinRM ()
int	getMinRT ()
double	getRadiusAvoidObstacles ()
double	getRadiusBasicFlee ()
double	getRadiusCohesion ()
double	getRadiusSeparation ()
int	getStepTime ()
double	getWarningDistance ()
	SceneConfig (int stepTime=5, unsigned int minRM=10)
void	setLevelAvoidObstacles (double lc)
void	setLevelBasicFlee (double lbf)
void	setLevelCohesion (double lc)
void	setLevelSeparation (double ls)
void	setMinRM (unsigned int minRM)
void	setRadiusAvoidObstacles (double rs)
void	setRadiusBasicFlee (double rbf)
void	setRadiusCohesion (double rc)
void	setRadiusSeparation (double rs)
void	setStepTime (int stepTime)
void	setWarningDistance (double wd)
Atrybuty chronione
double	_e_len
double	_e_phi
double	_levelAvoidObstacles
double	_levelBasicFlee
double	_levelCohesion
double	_levelSeparation
unsigned int	_minReactionMultiplicity
int	_minReactionTime
double	_radiusAvoidObstacles
double	_radiusBasicFlee
double	_radiusCohesion
double	_radiusSeparation
int	_stepTime
double	_warningDistance

---

Dokumentacja konstruktora i destruktora

SceneConfig::SceneConfig	(	int	stepTime = 5,
		unsigned int	minRM = 10
	)

Konstruktor. Ustala elementarny czas kroku symulacji. Dokladnosc katowa (

Zobacz również:

_e_phi) ustawiana jest na 0.1 Dokladnosc odleglosci (

_e_len) ustawiana jest na 1.

Parametry:

	czas	kroku symulacji
	krotnosc	kroku symulacji dla min. czasu reakcji

---

Dokumentacja funkcji składowych

double SceneConfig::getELen

(

)

Pobiera dokladnosc odleglosci [m]

Zwraca:

dokladnosc odleglosci

double SceneConfig::getEPhi

(

)

Pobiera dokladnosc katowa [rad]

Zwraca:

dokladnosc kata [rad]

double SceneConfig::getLevelAvoidObstacles

(

)

Pobiera mnoznik przeszkod

Zwraca:

mnoznik przeszkod

double SceneConfig::getLevelBasicFlee

(

)

Pobiera mnoznik algorytmu BasicFlee

Zwraca:

mnoznik algorytmu BasicFlee

double SceneConfig::getLevelCohesion

(

)

Pobiera mnoznik algorytmu Cohesion

Zwraca:

mnoznik algorytmu Cohesion

double SceneConfig::getLevelSeparation

(

)

Pobiera mnoznik algorytmu Separation

Zwraca:

mnoznik algorytmu Separation

unsigned int SceneConfig::getMinRM

(

)

Pobiera krotnosc kroku symulacji dla min. czasu reakcji

Zwraca:

minRM

int SceneConfig::getMinRT

(

)

Pobiera min. czas reakcji zwierzecia

Zwraca:

min. czas reakcji zwierzecia [ms]

double SceneConfig::getRadiusAvoidObstacles

(

)

Pobiera promien krytycznej odl. od przeszkody

Zwraca:

promien krytycznej odl. od przeszkody

double SceneConfig::getRadiusBasicFlee

(

)

Pobiera promien algorytmu BasicFlee

Zwraca:

promien algorytmu BasicFlee

double SceneConfig::getRadiusCohesion

(

)

Pobiera promien algorytmu Cohesion

Zwraca:

promien algorytmu Cohesion

double SceneConfig::getRadiusSeparation

(

)

Pobiera promien algorytmu Separation

Zwraca:

promien algorytmu Separation

int SceneConfig::getStepTime

(

)

Pobiera czas kroku symulacji

Zwraca:

czas kroku symulacji [ms]

double SceneConfig::getWarningDistance

(

)

Pobiera parametr minimalnej odleglosci od przeszkody

Zwraca:

min. odleglosc od przedzkody, wyzwalajaca funkcje wplywu przeszkody na kierunek ruchu zwierzaka

void SceneConfig::setLevelAvoidObstacles

(

double

lc

)

Ustala mnoznik przeszkod

Parametry:

mnoznik

przeszkod

void SceneConfig::setLevelBasicFlee

(

double

lbf

)

Ustala mnoznik algorytmu BasicFlee

Parametry:

mnoznik

algorytmu BasicFlee

void SceneConfig::setLevelCohesion

(

double

lc

)

Ustala mnoznik algorytmu Cohesion

Parametry:

mnoznik

algorytmu Cohesion

void SceneConfig::setLevelSeparation

(

double

ls

)

Ustala mnoznik algorytmu Separation

Parametry:

mnoznik

algorytmu Separation

void SceneConfig::setMinRM

(

unsigned int

minRM

)

Zapisuje krotnosc kroku symulacji dla min. czasu reakcji

Parametry:

krotnosc

kroku symulacji

void SceneConfig::setRadiusAvoidObstacles

(

double

rs

)

Ustala promien krytycznej odl. od przeszkody

Parametry:

promien

krytycznej odl. od przeszkody

void SceneConfig::setRadiusBasicFlee

(

double

rbf

)

Ustala promien algorytmu BasicFlee

Parametry:

promien

algorytmu BasicFlee

void SceneConfig::setRadiusCohesion

(

double

rc

)

Ustala promien algorytmu Cohesion

Parametry:

promien

algorytmu Cohesion

void SceneConfig::setRadiusSeparation

(

double

rs

)

Ustala promien algorytmu Separation

Parametry:

promien

algorytmu Separation

void SceneConfig::setStepTime

(

int

stepTime

)

Zapisuje czas kroku symulacji.

Parametry:

czas

kroku symulacji [ms]

void SceneConfig::setWarningDistance

(

double

wd

)

Ustala min. odleglosc od przeszkody.

Parametry:

min.

odleglosc od przedzkody, wyzwalajaca funkcje wplywu przeszkody na kierunek ruchu zwierzaka

---

Dokumentacja atrybutów składowych

double SceneConfig::_e_len [protected]

double SceneConfig::_e_phi [protected]

double SceneConfig::_levelAvoidObstacles [protected]

double SceneConfig::_levelBasicFlee [protected]

double SceneConfig::_levelCohesion [protected]

double SceneConfig::_levelSeparation [protected]

unsigned int SceneConfig::_minReactionMultiplicity [protected]

int SceneConfig::_minReactionTime [protected]

double SceneConfig::_radiusAvoidObstacles [protected]

double SceneConfig::_radiusBasicFlee [protected]

double SceneConfig::_radiusCohesion [protected]

double SceneConfig::_radiusSeparation [protected]

int SceneConfig::_stepTime [protected]

double SceneConfig::_warningDistance [protected]

---

Dokumentacja dla tej klasy została wygenerowana z plików:

• inc/sceneConfig.hpp
• src/sceneConfig.cpp

---