Kaim::PathEvent Class Reference

#include <patheventlist.h>

Class Description

A PathEvent is a particular PositionOnPath which feature is specified by a PathEventType.

Examples:

Functions
	PathEvent ()
void	SetCheckPointStatus (CheckPointStatus checkPointStatus)
	Allows to change the user checkpoint status of the PathEvent. More...
void	SetCheckPointWithDirection (Vec2f direction)
	Set CheckPointStatus_EventIsACheckPoint and assigned it a direction (Currently only used with TrajectoryMode_Spline as a spline end constraint) More...
bool	IsACheckPoint () const
	returns true if it is a check point with or without direction More...
bool	IsACheckPointWithDirection () const
	returns true only if is a checkpoint with direction, i.e. it returns false if it is a checkpoint but direction wasn't specified More...
const Vec2f &	GetCheckPointDirection () const
	relevant only if IsACheckPointWithDirection() returns true More...
bool	IsOnUpperBound () const
bool	IsOnLowerBound () const
bool	IsAtLastNodeOfPath () const
bool	IsAtLastNodeOfAChannel () const
Path *	GetPath () const

Public Data Members
PositionOnPath	m_positionOnPath
PathEventType	m_eventType
PathEventStatusInList	m_eventStatusInList
CheckPointStatus	m_checkPointStatus
Vec2f	m_checkPointDirection
KyUInt32	m_userSpecific

Member Function Documentation

const Vec2f & Kaim::PathEvent::GetCheckPointDirection ( ) const

inline

relevant only if IsACheckPointWithDirection() returns true

bool Kaim::PathEvent::IsACheckPoint ( ) const

inline

returns true if it is a check point with or without direction

bool Kaim::PathEvent::IsACheckPointWithDirection ( ) const

inline

returns true only if is a checkpoint with direction, i.e. it returns false if it is a checkpoint but direction wasn't specified

void Kaim::PathEvent::SetCheckPointStatus ( CheckPointStatus  checkPointStatus )

inline

Allows to change the user checkpoint status of the PathEvent.

Examples:

void Kaim::PathEvent::SetCheckPointWithDirection ( Vec2f  direction )

inline

Set CheckPointStatus_EventIsACheckPoint and assigned it a direction (Currently only used with TrajectoryMode_Spline as a spline end constraint)

Examples:

---

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

• gwnavruntime/path/patheventlist.h