Point Class Reference

Point class is used for point creations and manipulations. More...

#include <Point.hpp>

Inheritance diagram for Point:

Public Member Functions
	Point (float x, float y, Point *decorated=nullptr)
	Construct a new Point object. More...
	~Point (void)
	Destroy the Point object. More...
float	getX (void)
	Get the Point's x coordinate value. More...
float	getY (void)
	Get the Point's y coordinate value. More...
const Point *	getDecorated (void)
	Get the pointer to Point used to check if that's a "decorated" Point. More...

Protected Member Functions
void	setX (float x)
	Set the Point's x coordinate value. More...
void	setY (float y)
	Set the Point's y coordinate value. More...

Private Attributes
float	x
	Point's x coordinate. More...
float	y
	Point's y coordinate. More...
const Point *	decorated
	A pointer to Point. More...

Detailed Description

Point class is used for point creations and manipulations.

Point class is a class that represents a 2D Point with its own x coordinate and y coordinate. Furthermore, the Decorator pattern it's implemented with a raw pointer to a Point.

Definition at line 21 of file Point.hpp.

Constructor & Destructor Documentation

Point()

Point::Point ( float  x, float  y, Point *  decorated = nullptr  )

inline

Construct a new Point object.

Parameters

x	Point's x coordinate value.
y	Point's y coordinate value.
decorated	A pointer to Point.

Definition at line 53 of file Point.hpp.

                                                          : decorated(decorated) {
        setX(x);
        setY(y);
    }

References setX(), setY(), x, and y.

~Point()

Point::~Point

(

void

)

Destroy the Point object.

Definition at line 23 of file Point.cpp.

                   {
    if (getDecorated() != nullptr) delete getDecorated();
}

References getDecorated().

Member Function Documentation

getDecorated()

const Point * Point::getDecorated

(

void

)

Get the pointer to Point used to check if that's a "decorated" Point.

Returns

const Point *

Definition at line 37 of file Point.cpp.

                                       {
    return this->decorated;
}

References decorated.

Referenced by ~Point().

getX()

float Point::getX

(

void

)

Get the Point's x coordinate value.

Returns

float

Definition at line 29 of file Point.cpp.

                       {
    return this->x;
}

References x.

getY()

float Point::getY

(

void

)

Get the Point's y coordinate value.

Returns

float

Definition at line 33 of file Point.cpp.

                       {
    return this->y;
}

References y.

setX()

void Point::setX ( float  x )

protected

Set the Point's x coordinate value.

Parameters

x	Point's x coordinate value.

Definition at line 15 of file Point.cpp.

                         {
    this->x = x;
}

References x.

Referenced by Point().

setY()

void Point::setY ( float  y )

protected

Set the Point's y coordinate value.

Parameters

y	Point's y coordinate value.

Definition at line 19 of file Point.cpp.

                         {
    this->y = y;
}

References y.

Referenced by Point().

Member Data Documentation

decorated

const Point* Point::decorated

private

A pointer to Point.

Definition at line 34 of file Point.hpp.

Referenced by getDecorated().

x

float Point::x

private

Point's x coordinate.

Definition at line 26 of file Point.hpp.

Referenced by getX(), Point(), and setX().

y

float Point::y

private

Point's y coordinate.

Definition at line 30 of file Point.hpp.

Referenced by getY(), Point(), and setY().

---

The documentation for this class was generated from the following files:

• Points/Point.hpp
• Points/Point.cpp