Dokumentacja klasy Obstacle

#include <obstacle.hpp>

Diagram dziedziczenia dla Obstacle

Lista wszystkich składowych.

---

Opis szczegółowy

Klasa definiujaca przeszkode.

Autor:

Arkadiusz Lisiecki

Wersja:

1.0

Data:

2007-11-26

Metody publiczne
virtual double	getAngle (Vector2D &vec, double orient)
virtual Vector2D	getCross (Vector2D &vec, double orient)
std::string	getType ()
	Obstacle ()
void	setConfig (SceneConfig &cfg)
Atrybuty chronione
Vector2D	_bufRetPoint
double	_bufSrcOrient
Vector2D	_bufSrcPoint
SceneConfig	_cfg
std::string	_type

---

Dokumentacja konstruktora i destruktora

Obstacle::Obstacle

(

)

Konstruktor.

---

Dokumentacja funkcji składowych

double Obstacle::getAngle	(	Vector2D &	vec,
		double	orient
	)			[virtual]

Zwraca 'kat natarcia' do najblizszej krawedzi przedzkody

Parametry:

	punkt	odniesienia
	kierunek	[rad]

Zwraca:

kat [rad] w przedziale -PI/2 do PI/2, albo PI w przypadku, gdy nie mozna okreslic katu

Reimplementowana w Obstacle_Circle.

Vector2D Obstacle::getCross	(	Vector2D &	vec,
		double	orient
	)			[virtual]

Zwraca punkt przeciecia najblizszej krawedzi przeszkody.

Parametry:

	punkt	odniesienia
	kierunek	[rad]

Zwraca:

punkt przeciecia, gdy zwrocony punkt przeciecia pokrywa sie z vec, to znaczy, ze przeciecie nie zachodzi

Reimplementowana w Obstacle_Circle.

std::string Obstacle::getType

(

)

Zwraca typ przeszkody

Zwraca:

typ przeszkody

void Obstacle::setConfig

(

SceneConfig &

cfg

)

Pobiera konfiguracje, parametry symulacji

---

Dokumentacja atrybutów składowych

Vector2D Obstacle::_bufRetPoint [protected]

double Obstacle::_bufSrcOrient [protected]

Vector2D Obstacle::_bufSrcPoint [protected]

SceneConfig Obstacle::_cfg [protected]

std::string Obstacle::_type [protected]

---

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

• inc/obstacle.hpp
• src/obstacle.cpp

---