Point Class Reference

#include <Point.hxx>

Collaboration diagram for Point:

Public Member Functions
constexpr	Point ()
constexpr	Point (int x, int y)
constexpr	Point (int x, int y, int z)
constexpr	Point (int x, int y, int z, int height)
constexpr	Point (int x, int y, int z, int height, double rawHeight)
bool	operator== (const Point &p) const
bool	operator!= (const Point &p) const
bool	isWithinMapBoundaries () const
bool	isNeighborOf (Point coordinate) const
	Checks if a given point is a neighbor of this point. More...
bool	isDirectNeighborOf (Point coordinate) const
	Check if a given point is a direct neighbor (cardinal direction) of this point. More...
int	manhattanDistanceTo (Point target) const
	Calculate the manhattan distance between this point and a given point. More...
int	distanceTo (Point target) const
	Calculate the direct distance between this point and a given point. More...
int	toIndex () const
	calculates the index (stride) that can be used to access in Map to access mapNodes vector. More...

Static Public Member Functions
static constexpr Point	INVALID ()

Public Attributes
int	x
	The x coordinate. More...
int	y
	The y coordinate. More...
int	z
	The z coordinate. More...
int	height
	The height level. More...
double	rawHeight
	The raw height. More...

Detailed Description

Definition at line 7 of file Point.hxx.

Constructor & Destructor Documentation

Point() [1/5]

constexpr Point::Point ( )

inlineconstexpr

Definition at line 10 of file Point.hxx.

: x(0), y(0), z(0), height(0), rawHeight(0){};

Point() [2/5]

constexpr Point::Point ( int  x, int  y  )

inlineconstexpr

Definition at line 11 of file Point.hxx.

: x(x), y(y), z(0), height(0), rawHeight(0){};

Point() [3/5]

constexpr Point::Point ( int  x, int  y, int  z  )

inlineconstexpr

Definition at line 12 of file Point.hxx.

: x(x), y(y), z(z), height(0), rawHeight(0){};

Point() [4/5]

constexpr Point::Point ( int  x, int  y, int  z, int  height  )

inlineconstexpr

Definition at line 13 of file Point.hxx.

: x(x), y(y), z(z), height(height), rawHeight(0){};

Point() [5/5]

constexpr Point::Point ( int  x, int  y, int  z, int  height, double  rawHeight  )

inlineconstexpr

Definition at line 14 of file Point.hxx.

: x(x), y(y), z(z), height(height), rawHeight(rawHeight){};

Member Function Documentation

distanceTo()

int Point::distanceTo ( Point  target ) const

inline

Calculate the direct distance between this point and a given point.

Parameters

target

the point to calculate the direct distance to

Returns

number of nodes between this point and the target

Definition at line 75 of file Point.hxx.

{ return sqrt((x - target.x) * (x - target.x) + (y - target.y) * (y - target.y)); }

INVALID()

static constexpr Point Point::INVALID ( )

inlinestaticconstexpr

Definition at line 35 of file Point.hxx.

{ return {-1, -1, -1, -1}; }

Here is the caller graph for this function:

isDirectNeighborOf()

bool Point::isDirectNeighborOf ( Point  coordinate ) const

inline

Check if a given point is a direct neighbor (cardinal direction) of this point.

Parameters

coordinate

Point to check if it is a direct neighbor

Returns

if point is a direct neighbor in a cardinal direction (top, bottom, left, right)

Definition at line 57 of file Point.hxx.

  {
    return ((x == coordinate.x) && (std::abs(y - coordinate.y) <= 1)) ||
           ((y == coordinate.y) && (std::abs(x - coordinate.x) <= 1));
  }

isNeighborOf()

bool Point::isNeighborOf ( Point  coordinate ) const

inline

Checks if a given point is a neighbor of this point.

Parameters

coordinate

Point to check if it's adjacent

Returns

if the two points are neighbors

Definition at line 47 of file Point.hxx.

  {
    return isWithinMapBoundaries() && std::max(std::abs(coordinate.x - x), std::abs(coordinate.y - y)) <= 1;
  }

Here is the call graph for this function:

isWithinMapBoundaries()

bool Point::isWithinMapBoundaries ( ) const

inline

Definition at line 37 of file Point.hxx.

  {
    return (x >= 0 && x < Settings::instance().mapSize) && (y >= 0 && y < Settings::instance().mapSize);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

manhattanDistanceTo()

int Point::manhattanDistanceTo ( Point  target ) const

inline

Calculate the manhattan distance between this point and a given point.

Parameters

target

the point to calculate the manhattan distance to

Returns

number of nodes between this point and the target

Definition at line 68 of file Point.hxx.

{ return abs(x - target.x) + abs(y - target.y); }

operator!=()

bool Point::operator!= ( const Point &  p ) const

inline

Definition at line 33 of file Point.hxx.

{ return !(*this == p); }

operator==()

bool Point::operator== ( const Point &  p ) const

inline

Definition at line 32 of file Point.hxx.

{ return x == p.x && y == p.y /*&& z == p.z*/; }

toIndex()

int Point::toIndex ( ) const

inline

calculates the index (stride) that can be used to access in Map to access mapNodes vector.

Definition at line 80 of file Point.hxx.

{ return x * Settings::instance().mapSize + y; };

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

height

int Point::height

The height level.

Definition at line 26 of file Point.hxx.

rawHeight

double Point::rawHeight

The raw height.

Definition at line 29 of file Point.hxx.

x

int Point::x

The x coordinate.

Definition at line 14 of file Point.hxx.

y

int Point::y

The y coordinate.

Definition at line 20 of file Point.hxx.

z

int Point::z

The z coordinate.

Definition at line 23 of file Point.hxx.

---

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

• src/engine/basics/Point.hxx