Point.h and Point.cpp

Section 17.15 Point.h and Point.cpp

This is the Point class implemented as a .h/.cpp file pair. Note that the .h file only includes what is necessary to define the names used in the class definition (<string>). We avoid using using namespace std so that files that include this .h do not have to deal with possible name conflicts that might cause.

🔗

Listing 17.15.1. Point.h for final Point class implemented as .h/.cpp pair.

🔗

#ifndef POINT_H
#define POINT_H

#include <string>

/**
 * @brief Represents a point in a 2D Cartesian coordinate system.
 */
class Point {
public:
    /**
     * @brief Constructs a Point with the specified coordinates.
     * @param x The x-coordinate of the point.
     * @param y The y-coordinate of the point.
     */
    Point(double x, double y);

    /**
     * @brief Constructs a Point at the origin (0, 0).
     */
    Point();

    /**
     * @brief Gets the x-coordinate of the point.
     * @return The x-coordinate.
     */
    double getX() const;

    /**
     * @brief Gets the y-coordinate of the point.
     * @return The y-coordinate.
     */
    double getY() const;

    /**
     * @brief Sets the x-coordinate of the point.
     * @param x The new x-coordinate.
     */
    void setX(double x);

    /**
     * @brief Sets the y-coordinate of the point.
     * @param y The new y-coordinate.
     */
    void setY(double y);

    /**
     * @brief Shifts the point by the specified offsets.
     * @param dx The offset to add to the x-coordinate.
     * @param dy The offset to add to the y-coordinate.
     */
    void shift(double dx, double dy);

    /**
     * @brief Converts the point to a string representation.
     * @return A string representing the point in the format "(x, y)".
     */
    std::string toString() const;

    /**
     * @brief Calculates the distance to another point.
     * @param other The other point.
     * @return The Euclidean distance to the other point.
     */
    double distanceTo(const Point& other) const;

private:
    double m_x;
    double m_y;
};

#endif // POINT_H

In the .cpp file, we include the .h file (and thus get <string> indirectly). We also include any other files required to define items we are going to use in the function bodies (<format> and <cmath>).

🔗

Listing 17.15.2. Point.cpp for final Point class implemented as .h/.cpp pair.

🔗

// Includes needed for logic inside functions
#include <cmath> // for sqrt
#include <format>

// Point.h will include string already
#include "Point.h"

using namespace std;

Point::Point(double x, double y) {
    m_x = x;
    m_y = y;
}

Point::Point() {
    m_x = 0;
    m_y = 0;
}

double Point::getX() const {
    return m_x;
}

double Point::getY() const {
    return m_y;
}

void Point::setX(double x) {
    m_x = x;
}

void Point::setY(double y) {
    m_y = y;
}

void Point::shift(double dx, double dy) {
    setX(getX() + dx);
    setY(getY() + dy);
}

string Point::toString() const {
    return format("({}, {})", getX(), getY());
}

double Point::distanceTo(const Point& other) const {
    double xdiff = other.m_x - m_x;
    double ydiff = other.m_y - m_y;
    double distance = sqrt(xdiff * xdiff + ydiff * ydiff);
    return distance;
}

You have attempted of activities on this page.

🔗

Prev Top Next