Path Class Reference

Class representing a path and its information (vector of positions, total distance, etc.). More...

#include <A-StarPathfinding.h>

Public Member Functions
	Path (vector< BWAPI::Position > positions, int distance)
void	flip ()
	Reverses the vector of positions in the path. Used when we want to flip a path from A to B into a path from B to A.
bool	operator== (const Path &other) const
Path	operator+ (const Path &other)

Public Attributes
vector< BWAPI::Position >	positions = vector<BWAPI::Position>()
	A vector of BWAPI::Positions representing the waypoints along the path to follow ///<.
int	distance = 0
	The total distance of the path, calculated as the sum of the distances between each waypoint ///<.

Detailed Description

Class representing a path and its information (vector of positions, total distance, etc.).

Definition at line 66 of file A-StarPathfinding.h.

Constructor & Destructor Documentation

Path() [1/2]

Path::Path ( vector< BWAPI::Position > positions, int distance )

inline

Definition at line 71 of file A-StarPathfinding.h.

                                                            {
            this->positions = positions;
            this->distance = distance;
        };

Path() [2/2]

Path::Path ( )

inlinenoexcept

Definition at line 76 of file A-StarPathfinding.h.

                        {
            this->positions = vector<BWAPI::Position>();
            this->distance = 0;
        };

Member Function Documentation

flip()

void Path::flip ( )

inline

Reverses the vector of positions in the path. Used when we want to flip a path from A to B into a path from B to A.

Definition at line 84 of file A-StarPathfinding.h.

                    {
            vector<BWAPI::Position> vec = this->positions;
            reverse(vec.begin(), vec.end());
            this->positions = vec;
        }

operator+()

Path Path::operator+ ( const Path & other )

inline

Definition at line 94 of file A-StarPathfinding.h.

                                         {
            vector<BWAPI::Position> finalPositions;
            const int finalDist = this->distance + other.distance;
            finalPositions.insert(finalPositions.end(), this->positions.begin(), this->positions.end());
            finalPositions.insert(finalPositions.end(), other.positions.begin(), other.positions.end());
            return Path(finalPositions, finalDist);
        }

operator==()

bool Path::operator== ( const Path & other ) const

inline

Definition at line 90 of file A-StarPathfinding.h.

                                               {
            return this->positions == other.positions;
        }

Member Data Documentation

distance

int Path::distance = 0

The total distance of the path, calculated as the sum of the distances between each waypoint ///<.

Definition at line 69 of file A-StarPathfinding.h.

positions

vector<BWAPI::Position> Path::positions = vector<BWAPI::Position>()

A vector of BWAPI::Positions representing the waypoints along the path to follow ///<.

Definition at line 68 of file A-StarPathfinding.h.

---

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

• src/protobot/A-StarPathfinding.h