Pathfinder goal. More...
#include <PathGoal.h>
Public Types | |
| enum | Type { POINT , CIRCLE , INVERTED_CIRCLE , SQUARE , INVERTED_SQUARE } |
Public Member Functions | |
| bool | NavcellContainsGoal (int i, int j) const |
| Returns true if the given navcell contains a part of the goal area. More... | |
| bool | NavcellRectContainsGoal (int i0, int j0, int i1, int j1, int *i, int *j) const |
| Returns true if any navcell (i, j) where min(i0,i1) <= i <= max(i0,i1) min(j0,j1) <= j <= max(j0,j1), contains a part of the goal area. More... | |
| bool | RectContainsGoal (entity_pos_t x0, entity_pos_t z0, entity_pos_t x1, entity_pos_t z1) const |
| Returns true if the rectangle defined by (x0,z0)-(x1,z1) (inclusive) contains a part of the goal area. More... | |
| fixed | DistanceToPoint (CFixedVector2D pos) const |
| Returns the minimum distance from the point pos to any point on the goal shape. More... | |
| CFixedVector2D | NearestPointOnGoal (CFixedVector2D pos) const |
| Returns the coordinates of the point on the goal that is closest to the point pos. More... | |
Public Attributes | |
| enum PathGoal::Type | type |
| entity_pos_t | x |
| entity_pos_t | z |
| entity_pos_t | hw |
| entity_pos_t | hh |
| CFixedVector2D | u |
| CFixedVector2D | v |
| entity_pos_t | maxdist |
Detailed Description
Pathfinder goal.
The goal can be either a point, a circle, or a square (rectangle). For circles/squares, any point inside the shape is considered to be part of the goal. Also, it can be an 'inverted' circle/square, where any point outside the shape is part of the goal.
Member Enumeration Documentation
◆ Type
| enum PathGoal::Type |
Member Function Documentation
◆ DistanceToPoint()
| fixed PathGoal::DistanceToPoint | ( | CFixedVector2D | pos | ) | const |
Returns the minimum distance from the point pos to any point on the goal shape.
◆ NavcellContainsGoal()
| bool PathGoal::NavcellContainsGoal | ( | int | i, |
| int | j | ||
| ) | const |
Returns true if the given navcell contains a part of the goal area.
◆ NavcellRectContainsGoal()
| bool PathGoal::NavcellRectContainsGoal | ( | int | i0, |
| int | j0, | ||
| int | i1, | ||
| int | j1, | ||
| int * | i, | ||
| int * | j | ||
| ) | const |
Returns true if any navcell (i, j) where min(i0,i1) <= i <= max(i0,i1) min(j0,j1) <= j <= max(j0,j1), contains a part of the goal area.
If so, arguments i and j (if not NULL) are set to the goal navcell nearest to (i0, j0), assuming the rect has either width or height = 1.
◆ NearestPointOnGoal()
| CFixedVector2D PathGoal::NearestPointOnGoal | ( | CFixedVector2D | pos | ) | const |
Returns the coordinates of the point on the goal that is closest to the point pos.
◆ RectContainsGoal()
| bool PathGoal::RectContainsGoal | ( | entity_pos_t | x0, |
| entity_pos_t | z0, | ||
| entity_pos_t | x1, | ||
| entity_pos_t | z1 | ||
| ) | const |
Returns true if the rectangle defined by (x0,z0)-(x1,z1) (inclusive) contains a part of the goal area.
Member Data Documentation
◆ hh
| entity_pos_t PathGoal::hh |
◆ hw
| entity_pos_t PathGoal::hw |
◆ maxdist
| entity_pos_t PathGoal::maxdist |
◆ type
| enum PathGoal::Type PathGoal::type |
◆ u
| CFixedVector2D PathGoal::u |
◆ v
| CFixedVector2D PathGoal::v |
◆ x
| entity_pos_t PathGoal::x |
◆ z
| entity_pos_t PathGoal::z |
The documentation for this class was generated from the following files:
- /home/docker/jenkins/workspace/technical-docs/source/simulation2/helpers/PathGoal.h
- /home/docker/jenkins/workspace/technical-docs/source/simulation2/helpers/PathGoal.cpp
