Public Member Functions
FloatPoint () | |
FloatPoint (float in_x, float in_y) | |
FloatPoint (const PP_FloatPoint &point) | |
~FloatPoint () | |
operator PP_FloatPoint () const | |
const PP_FloatPoint & | pp_float_point () const |
PP_FloatPoint & | pp_float_point () |
float | x () const |
void | set_x (float in_x) |
float | y () const |
void | set_y (float in_y) |
FloatPoint | operator+ (const FloatPoint &other) const |
FloatPoint | operator- (const FloatPoint &other) const |
FloatPoint & | operator+= (const FloatPoint &other) |
FloatPoint & | operator-= (const FloatPoint &other) |
void | swap (FloatPoint &other) |
Detailed Description
A 2 dimensional floating-point point with 0,0 being the upper-left starting coordinate.
Constructor & Destructor Documentation
pp::FloatPoint::FloatPoint | ( | ) | [inline] |
A constructor for a point at 0,0.
pp::FloatPoint::FloatPoint | ( | float | in_x, |
float | in_y | ||
) | [inline] |
A constructor accepting two values for x and y and converting them to a FloatPoint.
- Parameters:
[in] in_x An value representing a horizontal coordinate of a point, starting with 0 as the left-most coordinate. [in] in_y An value representing a vertical coordinate of a point, starting with 0 as the top-most coordinate.
pp::FloatPoint::FloatPoint | ( | const PP_FloatPoint & | point | ) | [inline] |
A constructor accepting a pointer to a PP_FloatPoint and converting the PP_Point to a Point.
This is an implicit conversion constructor.
- Parameters:
[in] point A PP_FloatPoint.
pp::FloatPoint::~FloatPoint | ( | ) | [inline] |
Destructor.
Member Function Documentation
pp::FloatPoint::operator PP_FloatPoint | ( | ) | const [inline] |
A function allowing implicit conversion of a FloatPoint to a PP_FloatPoint.
FloatPoint pp::FloatPoint::operator+ | ( | const FloatPoint & | other | ) | const [inline] |
FloatPoint& pp::FloatPoint::operator+= | ( | const FloatPoint & | other | ) | [inline] |
FloatPoint pp::FloatPoint::operator- | ( | const FloatPoint & | other | ) | const [inline] |
Subtracts one Point from another Point by subtracting their x values and y values.
Returns a new point with the result.
- Parameters:
[in] other A FloatPoint.
- Returns:
- A new Point containing the result.
FloatPoint& pp::FloatPoint::operator-= | ( | const FloatPoint & | other | ) | [inline] |
const PP_FloatPoint& pp::FloatPoint::pp_float_point | ( | ) | const [inline] |
Getter function for returning the internal PP_FloatPoint struct.
- Returns:
- A const reference to the internal PP_FloatPoint struct.
PP_FloatPoint& pp::FloatPoint::pp_float_point | ( | ) | [inline] |
Getter function for returning the internal PP_Point struct.
- Returns:
- A mutable reference to the PP_Point struct.
void pp::FloatPoint::set_x | ( | float | in_x | ) | [inline] |
Setter function for setting the value of x.
- Parameters:
[in] in_x A new x value.
void pp::FloatPoint::set_y | ( | float | in_y | ) | [inline] |
Setter function for setting the value of y.
- Parameters:
[in] in_y A new y value.
void pp::FloatPoint::swap | ( | FloatPoint & | other | ) | [inline] |
Swaps the coordinates of two Points.
- Parameters:
[in] other A Point.
float pp::FloatPoint::x | ( | ) | const [inline] |
Getter function for returning the value of x.
- Returns:
- The value of x for this Point.
float pp::FloatPoint::y | ( | ) | const [inline] |
Getter function for returning the value of y.
- Returns:
- The value of y for this Point.
The documentation for this class was generated from the following file: