TrinityCore
Loading...
Searching...
No Matches
Public Member Functions | Private Member Functions | Private Attributes | List of all members
PathGenerator Class Reference

#include <PathGenerator.h>

Public Member Functions

 PathGenerator (WorldObject const *owner)
 
 ~PathGenerator ()
 
 PathGenerator (PathGenerator const &right)=delete
 
 PathGenerator (PathGenerator &&right)=delete
 
PathGenerator & operator= (PathGenerator const &right)=delete
 
PathGenerator & operator= (PathGenerator &&right)=delete
 
bool CalculatePath (float srcX, float srcY, float srcZ, float destX, float destY, float destZ, bool forceDest=false)
 
bool CalculatePath (float destX, float destY, float destZ, bool forceDest=false)
 
bool IsInvalidDestinationZ (WorldObject const *target) const
 
void SetUseStraightPath (bool useStraightPath)
 
void SetPathLengthLimit (float distance)
 
void SetUseRaycast (bool useRaycast)
 
G3D::Vector3 const & GetStartPosition () const
 
G3D::Vector3 const & GetEndPosition () const
 
G3D::Vector3 const & GetActualEndPosition () const
 
Movement::PointsArray const & GetPath () const
 
float GetPathLength () const
 
PathType GetPathType () const
 
void ShortenPathUntilDist (G3D::Vector3 const &target, float dist)
 

Private Member Functions

void SetStartPosition (G3D::Vector3 const &point)
 
void SetEndPosition (G3D::Vector3 const &point)
 
void SetActualEndPosition (G3D::Vector3 const &point)
 
void NormalizePath ()
 
void Clear ()
 
bool InRange (G3D::Vector3 const &p1, G3D::Vector3 const &p2, float r, float h) const
 
float Dist3DSqr (G3D::Vector3 const &p1, G3D::Vector3 const &p2) const
 
bool InRangeYZX (float const *v1, float const *v2, float r, float h) const
 
dtPolyRef GetPathPolyByPosition (dtPolyRef const *polyPath, uint32 polyPathSize, float const *Point, float *Distance=nullptr) const
 
dtPolyRef GetPolyByLocation (float const *Point, float *Distance) const
 
bool HaveTile (G3D::Vector3 const &p) const
 
void BuildPolyPath (G3D::Vector3 const &startPos, G3D::Vector3 const &endPos)
 
void BuildPointPath (float const *startPoint, float const *endPoint)
 
void BuildShortcut ()
 
NavTerrainFlag GetNavTerrain (float x, float y, float z) const
 
void CreateFilter ()
 
void UpdateFilter ()
 
uint32 FixupCorridor (dtPolyRef *path, uint32 npath, uint32 maxPath, dtPolyRef const *visited, uint32 nvisited)
 
bool GetSteerTarget (float const *startPos, float const *endPos, float minTargetDist, dtPolyRef const *path, uint32 pathSize, float *steerPos, unsigned char &steerPosFlag, dtPolyRef &steerPosRef)
 
dtStatus FindSmoothPath (float const *startPos, float const *endPos, dtPolyRef const *polyPath, uint32 polyPathSize, float *smoothPath, int *smoothPathSize, uint32 maxSmoothPathSize)
 
void AddFarFromPolyFlags (bool startFarFromPoly, bool endFarFromPoly)
 

Private Attributes

dtPolyRef _pathPolyRefs [MAX_PATH_LENGTH]
 
uint32 _polyLength
 
Movement::PointsArray _pathPoints
 
PathType _type
 
bool _useStraightPath
 
bool _forceDestination
 
uint32 _pointPathLimit
 
bool _useRaycast
 
G3D::Vector3 _startPosition
 
G3D::Vector3 _endPosition
 
G3D::Vector3 _actualEndPosition
 
WorldObject const *const _source
 
dtNavMesh const * _navMesh
 
dtNavMeshQuery const * _navMeshQuery
 
dtQueryFilter _filter
 

Detailed Description

Definition at line 55 of file PathGenerator.h.

Constructor & Destructor Documentation

◆ PathGenerator() [1/3]

PathGenerator::PathGenerator ( WorldObject const *  owner)
explicit

Definition at line 31 of file PathGenerator.cpp.

References _navMesh, _navMeshQuery, _pathPolyRefs, _source, _startPosition, CreateFilter(), BaseEntity::GetGUID(), WorldObject::GetInstanceId(), WorldObject::GetMap(), WorldLocation::GetMapId(), MMAP::MMapManager::GetNavMesh(), MMAP::MMapManager::GetNavMeshQuery(), WorldObject::GetPhaseShift(), Map::GetTerrain(), PhasingHandler::GetTerrainMapId(), MMAP::MMapManager::instance(), DisableMgr::IsPathfindingEnabled(), TC_LOG_DEBUG, and ObjectGuid::ToString().

◆ ~PathGenerator()

PathGenerator::~PathGenerator ( )

Definition at line 52 of file PathGenerator.cpp.

References _source, BaseEntity::GetGUID(), TC_LOG_DEBUG, and ObjectGuid::ToString().

◆ PathGenerator() [2/3]

PathGenerator::PathGenerator ( PathGenerator const &  right)
delete

◆ PathGenerator() [3/3]

PathGenerator::PathGenerator ( PathGenerator &&  right)
delete

Member Function Documentation

◆ AddFarFromPolyFlags()

void PathGenerator::AddFarFromPolyFlags ( bool  startFarFromPoly,
bool  endFarFromPoly 
)
private

Definition at line 1043 of file PathGenerator.cpp.

References _type, PATHFIND_FARFROMPOLY_END, and PATHFIND_FARFROMPOLY_START.

Referenced by BuildPolyPath().

◆ BuildPointPath()

void PathGenerator::BuildPointPath ( float const *  startPoint,
float const *  endPoint 
)
private
Todo:
check the exact cases

Definition at line 534 of file PathGenerator.cpp.

References _forceDestination, _navMeshQuery, _pathPoints, _pathPolyRefs, _pointPathLimit, _polyLength, _source, _type, _useRaycast, _useStraightPath, BuildShortcut(), Dist3DSqr(), FindSmoothPath(), GetActualEndPosition(), GetEndPosition(), BaseEntity::GetGUID(), GetStartPosition(), InRange(), MAX_POINT_PATH_LENGTH, NormalizePath(), PATHFIND_NOPATH, PATHFIND_NORMAL, PATHFIND_NOT_USING_PATH, PATHFIND_SHORT, SetActualEndPosition(), TC_LOG_DEBUG, TC_LOG_ERROR, ObjectGuid::ToString(), and VERTEX_SIZE.

Referenced by BuildPolyPath().

◆ BuildPolyPath()

void PathGenerator::BuildPolyPath ( G3D::Vector3 const &  startPos,
G3D::Vector3 const &  endPos 
)
private
Todo:
we can merge it with getPathPolyByPosition() loop
Todo:
play with the values here

Definition at line 164 of file PathGenerator.cpp.

References _filter, _navMeshQuery, _pathPoints, _pathPolyRefs, _polyLength, _source, _type, _useRaycast, AddFarFromPolyFlags(), BuildPointPath(), BuildShortcut(), Creature::CanEnterWater(), Creature::CanFly(), Clear(), WorldObject::GetCollisionHeight(), WorldObject::GetDebugInfo(), BaseEntity::GetGUID(), Map::GetLiquidStatus(), WorldObject::GetMap(), WorldLocation::GetMapId(), WorldObject::GetPhaseShift(), GetPolyByLocation(), GetStartPosition(), BaseEntity::GetTypeId(), INVALID_POLYREF, Map::IsUnderWater(), LIQUID_MAP_NO_WATER, MAX_PATH_LENGTH, NormalizePath(), PATHFIND_INCOMPLETE, PATHFIND_NOPATH, PATHFIND_NORMAL, PATHFIND_NOT_USING_PATH, SetActualEndPosition(), TC_LOG_DEBUG, TC_LOG_ERROR, Object::ToCreature(), ObjectGuid::ToString(), Object::ToUnit(), TYPEID_UNIT, and VERTEX_SIZE.

Referenced by CalculatePath().

◆ BuildShortcut()

void PathGenerator::BuildShortcut ( )
private

Definition at line 634 of file PathGenerator.cpp.

References _pathPoints, _type, Clear(), GetActualEndPosition(), GetStartPosition(), NormalizePath(), PATHFIND_SHORTCUT, and TC_LOG_DEBUG.

Referenced by BuildPointPath(), BuildPolyPath(), and CalculatePath().

◆ CalculatePath() [1/2]

bool PathGenerator::CalculatePath ( float  destX,
float  destY,
float  destZ,
bool  forceDest = false 
)

Definition at line 91 of file PathGenerator.cpp.

References _source, CalculatePath(), and Position::GetPosition().

◆ CalculatePath() [2/2]

bool PathGenerator::CalculatePath ( float  srcX,
float  srcY,
float  srcZ,
float  destX,
float  destY,
float  destZ,
bool  forceDest = false 
)

Definition at line 57 of file PathGenerator.cpp.

References _forceDestination, _navMesh, _navMeshQuery, _source, _type, BuildPolyPath(), BuildShortcut(), BaseEntity::GetGUID(), Unit::HasUnitState(), HaveTile(), Trinity::IsValidMapCoord(), PATHFIND_NORMAL, PATHFIND_NOT_USING_PATH, SetEndPosition(), SetStartPosition(), TC_LOG_DEBUG, TC_METRIC_DETAILED_EVENT, ObjectGuid::ToString(), Object::ToUnit(), UNIT_STATE_IGNORE_PATHFINDING, and UpdateFilter().

Referenced by CalculatePath(), spell_warr_heroic_leap::CheckElevation(), Spell::EffectChargeDest(), mmaps_commandscript::HandleMmapPathCommand(), mmaps_commandscript::HandleMmapTestArea(), PointMovementGenerator::Initialize(), WorldObject::MovePositionToFirstCollision(), Movement::MoveSplineInit::MoveTo(), at_fel_lord_caza_throw_axe_knockback::OnInitialize(), at_tunk_seismic_slam::OnInitialize(), at_orator_krix_vizk_doubt::OnInitialize(), at_dh_inner_demon::OnInitialize(), at_gen_spatial_rift::OnInitialize(), at_monk_song_of_chi_ji::OnInitialize(), areatrigger_pri_divine_star::OnInitialize(), at_void_orb_harbinger::OnInitialize(), at_sporecaller_zancha_volatile_pod::OnInitialize(), and areatrigger_pri_entropic_rift::UpdateMovement().

◆ Clear()

void PathGenerator::Clear ( )
inlineprivate

Definition at line 118 of file PathGenerator.h.

Referenced by BuildPolyPath(), and BuildShortcut().

◆ CreateFilter()

void PathGenerator::CreateFilter ( )
private

Definition at line 652 of file PathGenerator.cpp.

References _filter, _source, Creature::CanEnterWater(), BaseEntity::GetTypeId(), Creature::IsAquatic(), NAV_GROUND, NAV_MAGMA_SLIME, NAV_WATER, TYPEID_UNIT, and UpdateFilter().

Referenced by PathGenerator().

◆ Dist3DSqr()

float PathGenerator::Dist3DSqr ( G3D::Vector3 const &  p1,
G3D::Vector3 const &  p2 
) const
private

Definition at line 968 of file PathGenerator.cpp.

Referenced by BuildPointPath().

◆ FindSmoothPath()

dtStatus PathGenerator::FindSmoothPath ( float const *  startPos,
float const *  endPos,
dtPolyRef const *  polyPath,
uint32  polyPathSize,
float *  smoothPath,
int *  smoothPathSize,
uint32  maxSmoothPathSize 
)
private

Definition at line 818 of file PathGenerator.cpp.

References _filter, _navMesh, _navMeshQuery, _source, FixupCorridor(), WorldObject::GetDebugInfo(), GetSteerTarget(), InRangeYZX(), INVALID_POLYREF, MAX_PATH_LENGTH, MAX_POINT_PATH_LENGTH, SMOOTH_PATH_SLOP, SMOOTH_PATH_STEP_SIZE, TC_LOG_DEBUG, and VERTEX_SIZE.

Referenced by BuildPointPath().

◆ FixupCorridor()

uint32 PathGenerator::FixupCorridor ( dtPolyRef *  path,
uint32  npath,
uint32  maxPath,
dtPolyRef const *  visited,
uint32  nvisited 
)
private

Definition at line 736 of file PathGenerator.cpp.

Referenced by FindSmoothPath().

◆ GetActualEndPosition()

G3D::Vector3 const & PathGenerator::GetActualEndPosition ( ) const
inline

Definition at line 80 of file PathGenerator.h.

Referenced by BuildPointPath(), BuildShortcut(), mmaps_commandscript::HandleMmapPathCommand(), IsInvalidDestinationZ(), and MotionMaster::MoveCharge().

◆ GetEndPosition()

G3D::Vector3 const & PathGenerator::GetEndPosition ( ) const
inline

Definition at line 79 of file PathGenerator.h.

Referenced by BuildPointPath(), and mmaps_commandscript::HandleMmapPathCommand().

◆ GetNavTerrain()

NavTerrainFlag PathGenerator::GetNavTerrain ( float  x,
float  y,
float  z 
) const
private

Definition at line 704 of file PathGenerator.cpp.

References _source, WorldObject::GetCollisionHeight(), Map::GetLiquidStatus(), WorldObject::GetMap(), WorldObject::GetPhaseShift(), EnumFlag< T >::HasFlag(), LIQUID_MAP_NO_WATER, Magma, NAV_GROUND, NAV_MAGMA_SLIME, NAV_WATER, Ocean, Slime, LiquidData::type_flags, and Water.

Referenced by UpdateFilter().

◆ GetPath()

Movement::PointsArray const & PathGenerator::GetPath ( ) const
inline

Definition at line 82 of file PathGenerator.h.

Referenced by mmaps_commandscript::HandleMmapPathCommand(), PointMovementGenerator::Initialize(), MotionMaster::MoveCharge(), WorldObject::MovePositionToFirstCollision(), Movement::MoveSplineInit::MoveTo(), at_fel_lord_caza_throw_axe_knockback::OnInitialize(), at_tunk_seismic_slam::OnInitialize(), at_orator_krix_vizk_doubt::OnInitialize(), at_dh_inner_demon::OnInitialize(), at_gen_spatial_rift::OnInitialize(), at_monk_song_of_chi_ji::OnInitialize(), areatrigger_pri_divine_star::OnInitialize(), at_void_orb_harbinger::OnInitialize(), at_sporecaller_zancha_volatile_pod::OnInitialize(), and areatrigger_pri_entropic_rift::UpdateMovement().

◆ GetPathLength()

float PathGenerator::GetPathLength ( ) const

Definition at line 973 of file PathGenerator.cpp.

References _pathPoints.

Referenced by Spell::EffectChargeDest().

◆ GetPathPolyByPosition()

dtPolyRef PathGenerator::GetPathPolyByPosition ( dtPolyRef const *  polyPath,
uint32  polyPathSize,
float const *  Point,
float *  Distance = nullptr 
) const
private

Definition at line 98 of file PathGenerator.cpp.

References _navMeshQuery, INVALID_POLYREF, and VERTEX_SIZE.

Referenced by GetPolyByLocation().

◆ GetPathType()

PathType PathGenerator::GetPathType ( ) const
inline

Definition at line 85 of file PathGenerator.h.

Referenced by spell_warr_heroic_leap::CheckElevation(), mmaps_commandscript::HandleMmapPathCommand(), PointMovementGenerator::Initialize(), WorldObject::MovePositionToFirstCollision(), Movement::MoveSplineInit::MoveTo(), and ShortenPathUntilDist().

◆ GetPolyByLocation()

dtPolyRef PathGenerator::GetPolyByLocation ( float const *  Point,
float *  Distance 
) const
private

Definition at line 129 of file PathGenerator.cpp.

References _filter, _navMeshQuery, _pathPolyRefs, _polyLength, GetPathPolyByPosition(), INVALID_POLYREF, and VERTEX_SIZE.

Referenced by BuildPolyPath().

◆ GetStartPosition()

G3D::Vector3 const & PathGenerator::GetStartPosition ( ) const
inline

Definition at line 78 of file PathGenerator.h.

Referenced by BuildPointPath(), BuildPolyPath(), BuildShortcut(), and mmaps_commandscript::HandleMmapPathCommand().

◆ GetSteerTarget()

bool PathGenerator::GetSteerTarget ( float const *  startPos,
float const *  endPos,
float  minTargetDist,
dtPolyRef const *  path,
uint32  pathSize,
float *  steerPos,
unsigned char &  steerPosFlag,
dtPolyRef &  steerPosRef 
)
private

Definition at line 781 of file PathGenerator.cpp.

References _navMeshQuery, InRangeYZX(), and VERTEX_SIZE.

Referenced by FindSmoothPath().

◆ HaveTile()

bool PathGenerator::HaveTile ( G3D::Vector3 const &  p) const
private

Workaround For some reason, often the tx and ty variables wont get a valid value Use this check to prevent getting negative tile coords and crashing on getTileAt

Definition at line 720 of file PathGenerator.cpp.

References _navMesh, and VERTEX_SIZE.

Referenced by CalculatePath().

◆ InRange()

bool PathGenerator::InRange ( G3D::Vector3 const &  p1,
G3D::Vector3 const &  p2,
float  r,
float  h 
) const
private

Definition at line 962 of file PathGenerator.cpp.

Referenced by BuildPointPath().

◆ InRangeYZX()

bool PathGenerator::InRangeYZX ( float const *  v1,
float const *  v2,
float  r,
float  h 
) const
private

Definition at line 954 of file PathGenerator.cpp.

References v1, and v2.

Referenced by FindSmoothPath(), and GetSteerTarget().

◆ IsInvalidDestinationZ()

bool PathGenerator::IsInvalidDestinationZ ( WorldObject const *  target) const

Definition at line 1038 of file PathGenerator.cpp.

References GetActualEndPosition(), and Position::GetPositionZ().

◆ NormalizePath()

void PathGenerator::NormalizePath ( )
private

Definition at line 628 of file PathGenerator.cpp.

References _pathPoints, _source, and WorldObject::UpdateAllowedPositionZ().

Referenced by BuildPointPath(), BuildPolyPath(), and BuildShortcut().

◆ operator=() [1/2]

PathGenerator & PathGenerator::operator= ( PathGenerator &&  right)
delete

◆ operator=() [2/2]

PathGenerator & PathGenerator::operator= ( PathGenerator const &  right)
delete

◆ SetActualEndPosition()

void PathGenerator::SetActualEndPosition ( G3D::Vector3 const &  point)
inlineprivate

Definition at line 115 of file PathGenerator.h.

Referenced by BuildPointPath(), and BuildPolyPath().

◆ SetEndPosition()

void PathGenerator::SetEndPosition ( G3D::Vector3 const &  point)
inlineprivate

Definition at line 114 of file PathGenerator.h.

Referenced by CalculatePath().

◆ SetPathLengthLimit()

void PathGenerator::SetPathLengthLimit ( float  distance)
inline

Definition at line 74 of file PathGenerator.h.

References MAX_POINT_PATH_LENGTH, and SMOOTH_PATH_STEP_SIZE.

Referenced by spell_warr_heroic_leap::CheckElevation().

◆ SetStartPosition()

void PathGenerator::SetStartPosition ( G3D::Vector3 const &  point)
inlineprivate

Definition at line 113 of file PathGenerator.h.

Referenced by CalculatePath().

◆ SetUseRaycast()

void PathGenerator::SetUseRaycast ( bool  useRaycast)
inline

Definition at line 75 of file PathGenerator.h.

Referenced by mmaps_commandscript::HandleMmapPathCommand(), and WorldObject::MovePositionToFirstCollision().

◆ SetUseStraightPath()

void PathGenerator::SetUseStraightPath ( bool  useStraightPath)
inline

Definition at line 73 of file PathGenerator.h.

Referenced by mmaps_commandscript::HandleMmapPathCommand().

◆ ShortenPathUntilDist()

void PathGenerator::ShortenPathUntilDist ( G3D::Vector3 const &  target,
float  dist 
)

Definition at line 982 of file PathGenerator.cpp.

References _pathPoints, _source, WorldObject::GetCollisionHeight(), WorldObject::GetHitSpherePointFor(), WorldObject::GetMap(), GetPathType(), WorldObject::GetPhaseShift(), Map::isInLineOfSight(), LINEOFSIGHT_ALL_CHECKS, VMAP::Nothing, PATHFIND_BLANK, and TC_LOG_ERROR.

Referenced by PointMovementGenerator::Initialize().

◆ UpdateFilter()

void PathGenerator::UpdateFilter ( )
private

Definition at line 679 of file PathGenerator.cpp.

References _filter, _source, _startPosition, Map::GetForceDisabledNavMeshFilterFlags(), Map::GetForceEnabledNavMeshFilterFlags(), WorldObject::GetMap(), GetNavTerrain(), NAV_GROUND_STEEP, Object::ToCreature(), and Object::ToUnit().

Referenced by CalculatePath(), and CreateFilter().

Member Data Documentation

◆ _actualEndPosition

G3D::Vector3 PathGenerator::_actualEndPosition
private

Definition at line 105 of file PathGenerator.h.

◆ _endPosition

G3D::Vector3 PathGenerator::_endPosition
private

Definition at line 104 of file PathGenerator.h.

◆ _filter

dtQueryFilter PathGenerator::_filter
private

Definition at line 111 of file PathGenerator.h.

Referenced by BuildPolyPath(), CreateFilter(), FindSmoothPath(), GetPolyByLocation(), and UpdateFilter().

◆ _forceDestination

bool PathGenerator::_forceDestination
private

Definition at line 99 of file PathGenerator.h.

Referenced by BuildPointPath(), and CalculatePath().

◆ _navMesh

dtNavMesh const* PathGenerator::_navMesh
private

Definition at line 108 of file PathGenerator.h.

Referenced by CalculatePath(), FindSmoothPath(), HaveTile(), and PathGenerator().

◆ _navMeshQuery

dtNavMeshQuery const* PathGenerator::_navMeshQuery
private

Definition at line 109 of file PathGenerator.h.

Referenced by BuildPointPath(), BuildPolyPath(), CalculatePath(), FindSmoothPath(), GetPathPolyByPosition(), GetPolyByLocation(), GetSteerTarget(), and PathGenerator().

◆ _pathPoints

Movement::PointsArray PathGenerator::_pathPoints
private

Definition at line 95 of file PathGenerator.h.

Referenced by BuildPointPath(), BuildPolyPath(), BuildShortcut(), GetPathLength(), NormalizePath(), and ShortenPathUntilDist().

◆ _pathPolyRefs

dtPolyRef PathGenerator::_pathPolyRefs[MAX_PATH_LENGTH]
private

Definition at line 92 of file PathGenerator.h.

Referenced by BuildPointPath(), BuildPolyPath(), GetPolyByLocation(), and PathGenerator().

◆ _pointPathLimit

uint32 PathGenerator::_pointPathLimit
private

Definition at line 100 of file PathGenerator.h.

Referenced by BuildPointPath().

◆ _polyLength

uint32 PathGenerator::_polyLength
private

Definition at line 93 of file PathGenerator.h.

Referenced by BuildPointPath(), BuildPolyPath(), and GetPolyByLocation().

◆ _source

WorldObject const* const PathGenerator::_source
private

Definition at line 107 of file PathGenerator.h.

Referenced by BuildPointPath(), BuildPolyPath(), CalculatePath(), CalculatePath(), CreateFilter(), FindSmoothPath(), GetNavTerrain(), NormalizePath(), PathGenerator(), ShortenPathUntilDist(), UpdateFilter(), and ~PathGenerator().

◆ _startPosition

G3D::Vector3 PathGenerator::_startPosition
private

Definition at line 103 of file PathGenerator.h.

Referenced by PathGenerator(), and UpdateFilter().

◆ _type

PathType PathGenerator::_type
private

Definition at line 96 of file PathGenerator.h.

Referenced by AddFarFromPolyFlags(), BuildPointPath(), BuildPolyPath(), BuildShortcut(), and CalculatePath().

◆ _useRaycast

bool PathGenerator::_useRaycast
private

Definition at line 101 of file PathGenerator.h.

Referenced by BuildPointPath(), and BuildPolyPath().

◆ _useStraightPath

bool PathGenerator::_useStraightPath
private

Definition at line 98 of file PathGenerator.h.

Referenced by BuildPointPath().

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