Dokumentacja klasy Obstacle_Circle

#include <obs_circle.hpp>

Diagram dziedziczenia dla Obstacle_Circle

Lista wszystkich składowych.

---

Opis szczegółowy

Klasa definiujaca przeszkode (okrag).

Autor:

Arkadiusz Lisiecki

Wersja:

1.0

Data:

2007-11-26

Metody publiczne
double	getAngle (Vector2D &vec, double orient)
Vector2D	getCross (Vector2D &vec, double orient)
	Obstacle_Circle (Vector2D center, double r)
Atrybuty prywatne
Vector2D	_center
double	_r

---

Dokumentacja konstruktora i destruktora

Obstacle_Circle::Obstacle_Circle	(	Vector2D	center,
		double	r
	)

Konstruktor. Ustala typ przedzkody na 'Circle'

Parametry:

	srodek	okregu
	promien	okregu

---

Dokumentacja funkcji składowych

double Obstacle_Circle::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 z Obstacle.

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

Zwraca punkr przeciecia najblizszej krawedzi przeszkody.

Parametry:

	punkt	odniesienia
	kierunek	[rad]

Zwraca:

odleglosc [m] albo -1, gdy polprosta nie przecina krawedzi przeszkody

Reimplementowana z Obstacle.

---

Dokumentacja atrybutów składowych

Vector2D Obstacle_Circle::_center [private]

double Obstacle_Circle::_r [private]

---

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

• inc/obs_circle.hpp
• src/obs_circle.cpp

---