.TH "SDLmm::SPoint" 3 "16 Jul 2001" "SDLmm" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SDLmm::SPoint \- A small usefull class representing a point in 2 dimensional space. 
.SH SYNOPSIS
.br
.PP
\fC#include <sdlmm_spoint.h>\fP
.PP
.SS "Public Methods"

.in +1c
.ti -1c
.RI "\fBSPoint\fP ()"
.br
.RI "\fIDefault constructor which creates an empty \fBSPoint\fP (xy variables set to zero).\fP"
.ti -1c
.RI "\fBSPoint\fP (const SPoint &point)"
.br
.RI "\fIThis is the copy constructor. Simply initializes the value of an \fBSPoint\fP to that of another \fBSPoint\fP.\fP"
.ti -1c
.RI "\fBSPoint\fP (Sint16 nx, Sint16 ny)"
.br
.RI "\fIConstructor which initializes the class from integer values.\fP"
.ti -1c
.RI "SPoint& \fBoperator=\fP (const SPoint &point)"
.br
.RI "\fISet the value of an \fBSPoint\fP to that of an existing \fBSPoint\fP.\fP"
.ti -1c
.RI "bool \fBoperator==\fP (const SPoint &point) const"
.br
.RI "\fICompare two points for equality.\fP"
.ti -1c
.RI "bool \fBoperator<\fP (const SPoint &point) const"
.br
.ti -1c
.RI "bool \fBoperator<=\fP (const SPoint &point) const"
.br
.ti -1c
.RI "bool \fBoperator>\fP (const SPoint &point) const"
.br
.ti -1c
.RI "bool \fBoperator>=\fP (const SPoint &point) const"
.br
.ti -1c
.RI "SPoint& \fBoperator+=\fP (const SPoint &point)"
.br
.ti -1c
.RI "SPoint& \fBoperator-=\fP (const SPoint &point)"
.br
.ti -1c
.RI "SPoint \fBoperator+\fP (const SPoint &point) const"
.br
.ti -1c
.RI "SPoint \fBoperator-\fP (const SPoint &point) const"
.br
.ti -1c
.RI "SPoint& \fBoperator *=\fP (Sint16 scalar)"
.br
.ti -1c
.RI "SPoint& \fBoperator/=\fP (Sint16 scalar)"
.br
.ti -1c
.RI "SPoint \fBoperator *\fP (Sint16 scalar) const"
.br
.ti -1c
.RI "SPoint \fBoperator/\fP (Sint16 scalar) const"
.br
.in -1c
.SS "Public Attributes"

.in +1c
.ti -1c
.RI "Sint16 \fBx\fP"
.br
.ti -1c
.RI "Sint16 \fBy\fP"
.br
.in -1c
.SH "DETAILED DESCRIPTION"
.PP 
A small usefull class representing a point in 2 dimensional space.
.PP
\fBAuthor: \fP
.in +1c
Adam Gates 
.PP
.SH "CONSTRUCTOR & DESTRUCTOR DOCUMENTATION"
.PP 
.SS "SDLmm::SPoint::SPoint ()\fC [inline]\fP"
.PP
Default constructor which creates an empty \fBSPoint\fP (xy variables set to zero).
.PP
.SS "SDLmm::SPoint::SPoint (const SPoint & point)\fC [inline]\fP"
.PP
This is the copy constructor. Simply initializes the value of an \fBSPoint\fP to that of another \fBSPoint\fP.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIpoint\fP\fP
an existing \fBSPoint\fP object. 
.SS "SDLmm::SPoint::SPoint (Sint16 nx, Sint16 ny)\fC [inline]\fP"
.PP
Constructor which initializes the class from integer values.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fInx, horizontal\fP\fP
position 
.TP
\fB\fIny, vertical\fP\fP
position 
.SH "MEMBER FUNCTION DOCUMENTATION"
.PP 
.SS "SPoint SDLmm::SPoint::operator * (Sint16 scalar) const\fC [inline]\fP"
.PP
.SS "SPoint & SDLmm::SPoint::operator *= (Sint16 scalar)\fC [inline]\fP"
.PP
.SS "SPoint SDLmm::SPoint::operator+ (const SPoint & point) const\fC [inline]\fP"
.PP
.SS "SPoint & SDLmm::SPoint::operator+= (const SPoint & point)\fC [inline]\fP"
.PP
.SS "SPoint SDLmm::SPoint::operator- (const SPoint & point) const\fC [inline]\fP"
.PP
.SS "SPoint & SDLmm::SPoint::operator-= (const SPoint & point)\fC [inline]\fP"
.PP
.SS "SPoint SDLmm::SPoint::operator/ (Sint16 scalar) const\fC [inline]\fP"
.PP
.SS "SPoint & SDLmm::SPoint::operator/= (Sint16 scalar)\fC [inline]\fP"
.PP
.SS "bool SDLmm::SPoint::operator< (const SPoint & point) const\fC [inline]\fP"
.PP
\fBReturns: \fP
.in +1c
true if both point.x and point.y is larger than x and y in this point. 
.SS "bool SDLmm::SPoint::operator<= (const SPoint & point) const\fC [inline]\fP"
.PP
\fBReturns: \fP
.in +1c
true if both point.x and point.y is larger than or equal to x and y in this point. 
.SS "SPoint & SDLmm::SPoint::operator= (const SPoint & point)\fC [inline]\fP"
.PP
Set the value of an \fBSPoint\fP to that of an existing \fBSPoint\fP.
.PP
.SS "bool SDLmm::SPoint::operator== (const SPoint & point) const\fC [inline]\fP"
.PP
Compare two points for equality.
.PP
\fBReturns: \fP
.in +1c
true if coordinates are identical in both points. 
.SS "bool SDLmm::SPoint::operator> (const SPoint & point) const\fC [inline]\fP"
.PP
\fBReturns: \fP
.in +1c
true if both point.x and point.y is smaller than x and y in this point. 
.SS "bool SDLmm::SPoint::operator>= (const SPoint & point) const\fC [inline]\fP"
.PP
\fBReturns: \fP
.in +1c
true if both point.x and point.y is smaller than or equal to x and y in this point. 
.SH "MEMBER DATA DOCUMENTATION"
.PP 
.SS "Sint16 SDLmm::SPoint::x"
.PP
.SS "Sint16 SDLmm::SPoint::y"
.PP


.SH "AUTHOR"
.PP 
Generated automatically by Doxygen for SDLmm from the source code.