PPL6-Icon Patrick's Programming Library Version 6.4.21 - Dokumentation
ppl6::grafix::Point Klassenreferenz

Repräsentiert einen Punkt in einem zweidimensionalen Koordinatensystem. Mehr ...

Öffentliche Methoden

 Point ()
 Konstruktor mit Initialisierung auf (0/0) Mehr ...
 
 Point (int x, int y)
 Konstruktor mit Initialisierung auf die angegebenen Koordinaten. Mehr ...
 
bool isNull () const
 Liefert true zurück, wenn sowohl x als auch y 0 sind. Mehr ...
 
int manhattanLength () const
 Länge des Vektors in "Manhattan Distance". Mehr ...
 
Pointoperator*= (double factor)
 Multiplikation mit einem Faktor. Mehr ...
 
Pointoperator+= (const Point &point)
 Addition mit einem anderen Point. Mehr ...
 
Pointoperator-= (const Point &point)
 Subtraktion mit einem anderen Point. Mehr ...
 
Pointoperator/= (double divisor)
 Division mit einem Divisor. Mehr ...
 
int & rx ()
 Gibt eine Referenz auf die X-Koordinate zurück. Mehr ...
 
int & ry ()
 Gibt eine Referenz auf die Y-Koordinate zurück. Mehr ...
 
void setPoint (int x, int y)
 X und Y-Koordinate gleichzeitig setzen. Mehr ...
 
void setX (int x)
 X-Koordinate setzen. Mehr ...
 
void setY (int y)
 Y-Koordinate setzen. Mehr ...
 
double vectorLength () const
 Länge des Vektors. Mehr ...
 
int x () const
 Gibt die X-Koordinate zurück. Mehr ...
 
int y () const
 Gibt die Y-Koordinate zurück. Mehr ...
 

Private Attribute

int px
 Speichert die X-Koordinate des Punktes. Mehr ...
 
int py
 Speichert die Y-Koordinate des Punktes. Mehr ...
 

Freundbeziehungen

double Distance (const Point &p1, const Point &p2)
 
bool operator!= (const Point &p1, const Point &p2)
 
const Point operator* (const Point &point, double factor)
 
const Point operator* (double factor, const Point &point)
 
const Point operator+ (const Point &p1, const Point &p2)
 
const Point operator- (const Point &p1, const Point &p2)
 
const Point operator- (const Point &point)
 
const Point operator/ (const Point &point, double divisor)
 
bool operator== (const Point &p1, const Point &p2)
 

Verwandte Funktionen

(Es handelt sich hierbei nicht um Elementfunktionen.)

double Distance (const Point &p1, const Point &p2)
 Berechnet den Abstand zwischen zwei Punkten. Mehr ...
 

Ausführliche Beschreibung

Beschreibung:
Diese Klasse repräsentiert einen Punkt in einem zweidimensionalen Koordinatensystem. Zum Speichern der Koordinaten werden Integer (Ganzzahlen) verwendet.
Class_Point.png
Ein Punkt wird durch seine X- und Y-Koordinate definiert, die mit den Funktionen setX() und setY() gesetzt und mit x() und y() ausgelesen werden können. Dir Funktionen rx() und ry() liefern Referenzen auf die Koordinaten und erlauben es so die Werte direkt zu manipulieren.
Beispiele:
Point p1(4,12);
Point p2;
Point p3;
p2.setX(4);
p2.setY(12);
p3.rx()=4;
p3.ry()=12;
Ein Punkt kann auch als Vektor benutzt werden. Bei Addition und Subtraktion wird jede Komponente separat berechnet. Ein Point-Object kann ausserdem mit einem Integer oder Double multipliziert oder geteilt werden.
Siehe auch
Die Klasse Point3D bietet die gleiche Funktionalität, repräsentiert jedoch einen Punkt in einem dreidimensionalen Koordinatensystem.

Beschreibung der Konstruktoren und Destruktoren

ppl6::grafix::Point::Point ( )
Beschreibung:
Durch Verwendung dieses Konstruktors wird der Punkt mit den Koordinaten (0/0) initialisiert.
ppl6::grafix::Point::Point ( int  x,
int  y 
)
Beschreibung:
Durch Verwendung dieses Konstruktors wird der Punkt mit den Koordinaten (x /y ) initialisiert.
Parameter
[in]xDie gewünschte X-Koordinate
[in]yDie gewünschte Y-Koordinate

Dokumentation der Elementfunktionen

bool ppl6::grafix::Point::isNull ( ) const
Beschreibung:
Diese Funktion liefert true zurück, wenn der Punkt die Koordinaten (0/0) enthält.
Rückgabe
Liefert true zurück, wenn x und y 0 sind. Ist dies nicht der Fall, gibt die Funktion false zurück.
int ppl6::grafix::Point::manhattanLength ( ) const
Beschreibung:
Als "Manhattan Länge" bezeichnet man den Abstand zwischen zwei Punkten, berechnet anhand der Längen ihrer rechten Winkel. Auf einer Fläche mit p1=(x1/y1) und p2=(x2/y1) ist die Länge:
$length = abs(x1-x2) + abs(y1-y2)$
Der Name wurde tatsächlich in Anlehnung an den New Yorker Stadtteil Manhattan gewählt, aufgrund der schachbrettartig angeordneten Strassen.
Rückgabe
Die Länge zwischen dem Ursprung des Koordinatensystems (0/0) und dem Punkt als Integer.
Point & ppl6::grafix::Point::operator*= ( double  factor)
Beschreibung:
Mit diesem Operator wird der aktuelle X- und Y-Wert des Punktes einzeln mit factor multipliziert.
Parameter
[in]factorDer Faktor, mit dem die Koordinate multipliziert werden soll
Rückgabe
Referenz auf den Point
Point & ppl6::grafix::Point::operator+= ( const Point point)
Beschreibung:
Der aktuelle Wert des Punktes wird mit dem Parameter point addiert. Dabei werden die einzelnen Werte X und Y jeweils miteinander addiert.
Parameter
[in]pointReferenz auf einen anderen Point
Rückgabe
Referenz auf den Point
Point & ppl6::grafix::Point::operator-= ( const Point point)
Beschreibung:
Der aktuelle Wert des Punktes wird mit dem Parameter point subtrahiert. Dabei werden die einzelnen Werte X und Y jeweils voneinander abgezogen.
Parameter
[in]pointReferenz auf einen anderen Point
Rückgabe
Referenz auf den Point
Point & ppl6::grafix::Point::operator/= ( double  divisor)
Beschreibung:
Mit diesem Operator wird der aktuelle X- und Y-Wert des Punktes einzeln durch den divisor geteilt.
Parameter
[in]divisorDer Divisor, durch den die aktuelle Koordinate geteilt werden soll
Rückgabe
Referenz auf den Point
int & ppl6::grafix::Point::rx ( )
Beschreibung:
Diese Funktion liefert eine Referenz auf die X-Koordinate des Punktes, so dass diese auch ausserhalb der Klasse verändert werden kann.
Rückgabe
Referenz auf die X-Koordinate.
Beispiel:
ppl6::Point p;
p.rx()++;
int & ppl6::grafix::Point::ry ( )
Beschreibung:
Diese Funktion liefert eine Referenz auf die Y-Koordinate des Punktes, so dass diese auch ausserhalb der Klasse verändert werden kann.
Rückgabe
Referenz auf die Y-Koordinate.
Beispiel:
ppl6::Point p;
p.ry()++;
void ppl6::grafix::Point::setPoint ( int  x,
int  y 
)
Beschreibung:
Mit dieser Funktion kann die X- und Y-Koordinate des Punktes gleichzeitig gesetzt werden.
Parameter
[in]xX-Koordinate
[in]yY-Koordinate
void ppl6::grafix::Point::setX ( int  x)
Beschreibung:
Mit dieser Funktion kann die X-Koordinate des Punktes gesetzt werden.
Parameter
[in]xX-Koordinate
void ppl6::grafix::Point::setY ( int  y)
Beschreibung:
Mit dieser Funktion kann die Y-Koordinate des Punktes gesetzt werden.
Parameter
[in]yY-Koordinate
double ppl6::grafix::Point::vectorLength ( ) const
Beschreibung:
Diese Funktion berechnet die Länge des Vektors, gerechnet vom Ursprung (0/0) bis zu den aktuellen Koordinaten anhand des "Satz des Pythagoras", und liefert diese als double zurück.
Die Formel lautet: $length = \sqrt{x^2+y^2}$
Siehe auch
Siehe auch die verwandte Funktion Distance, die den Abstand zwischen zwei Punkten berechnet.
int ppl6::grafix::Point::x ( ) const
Beschreibung:
Diese Funktion liefert die aktuelle X-Koordinate des Punktes zurück.
Rückgabe
Wert der X-Koordinaten.
int ppl6::grafix::Point::y ( ) const
Beschreibung:
Diese Funktion liefert die aktuelle Y-Koordinate des Punktes zurück.
Rückgabe
Wert der Y-Koordinaten.

Freundbeziehungen und Funktionsdokumentation

double Distance ( const Point p1,
const Point p2 
)
friend
double Distance ( const Point p1,
const Point p2 
)
related
Beschreibung:
Diese Funktion berechnet die Länge des Vektors zwischen den beiden Punkten p1 und p2 anhand des "Satz des Pythagoras", und liefert diese als double zurück.
Die Formel lautet: $distance = \sqrt{(p2.x()-p1.x())^2+(p2.y()-p1.y())^2}$
Parameter
[in]p1Die Anfangskoordinate
[in]p2Die Endkoordinate
Rückgabe
Der Abstand zwischen den beiden Punkten als double.
bool operator!= ( const Point p1,
const Point p2 
)
friend
const Point operator* ( const Point point,
double  factor 
)
friend
const Point operator* ( double  factor,
const Point point 
)
friend
const Point operator+ ( const Point p1,
const Point p2 
)
friend
const Point operator- ( const Point p1,
const Point p2 
)
friend
const Point operator- ( const Point point)
friend
const Point operator/ ( const Point point,
double  divisor 
)
friend
bool operator== ( const Point p1,
const Point p2 
)
friend

Dokumentation der Datenelemente

ppl6::grafix::Point::px
private
ppl6::grafix::Point::py
private

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Dateien: