#include <WsfWaypointMover.hpp>

Inheritance diagram for WsfWaypointMover:

[legend]

Collaboration diagram for WsfWaypointMover:

[legend]

Classes
class	BaseEvent
class	HitPointEvent

Public Member Functions
	WsfWaypointMover ()=delete
	WsfWaypointMover (const WsfScenario &aScenario)
	WsfWaypointMover (const WsfWaypointMover &aSrc)
WsfWaypointMover &	operator= (const WsfWaypointMover &)=delete
	~WsfWaypointMover () override
WsfMover *	Clone () const override
bool	Initialize (double aSimTime) override
bool	ProcessInput (UtInput &aInput) override
void	SetPlatform (WsfPlatform *aPlatformPtr) override
bool	GoToAltitude (double aSimTime, double aAltitude, double aClimbDiveRate, bool aKeepRoute) override
bool	GoToSpeed (double aSimTime, double aSpeed, double aLinearAccel, bool aKeepRoute) override
bool	TurnToRelativeHeading (double aSimTime, double aHeadingChange, double aRadialAccel, WsfPath::TurnDirection aTurnDirection) override
bool	TurnToHeading (double aSimTime, double aHeading, double aRadialAccel, WsfPath::TurnDirection aTurnDirection) override
bool	GetFutureLocationWCS (double aSimTime, double aLocationWCS[3]) override
WsfPathConstraints &	GetConstraints ()
bool	IsOnGround () const
void	SetIsOnRoad (bool aIsOnRoad)
bool	IsOnRoad () const
const WsfPathConstraints *	GetMoverConstraints () const override
const WsfPathConstraints &	GetCurrentConstraints () const
const WsfPathTarget &	GetTarget () const
WsfPathComputer &	GetPathComputer ()
const WsfAngleOfAttack *	GetAngleOfAttackTable ()
bool	GetPropertyDouble (const std::string &aPropertyName, double &aProperty) override
virtual double	MaximumRadialAcceleration ()
double	TurnRadius ()
double	TurnRadius (double atSpeed) override
virtual double	MaximumTurnRate ()
virtual double	CornerVelocity (WsfGeoPoint *aTarget)
void	Pause (double aSimTime, double aUnpauseTime) override
	Stop the movement of the platform until aUnpauseTime.
bool	Unpause (double aSimTime, bool aInterrupt) override
void	ResetPosition (double aSimTime) override
	Informs the mover to use the current platform state.
bool	IsExtrapolating () const override
Public Member Functions inherited from WsfRouteMover
	WsfRouteMover ()=delete
	WsfRouteMover (const WsfScenario &aScenario)
	WsfRouteMover (const WsfRouteMover &aSrc)
WsfRouteMover &	operator= (const WsfRouteMover &)=delete
	~WsfRouteMover () override
bool	Initialize2 (double aSimTime) override
void	Update (double aSimTime) override
void	TurnOff (double aSimTime) override
void	TurnOn (double aSimTime) override
const WsfRoute *	GetRoute () const override
const WsfRoute *	GetDefaultRoute () const override
int	RoutePointIndex () const override
bool	SetRoute (double aSimTime, const WsfRoute &aRoute) override
bool	GoToLabel (double aSimTime, WsfStringId aLabelId) override
bool	GoToWaypoint (double aSimTime, unsigned int aDestination) override
bool	GoToClosestPoint (double aSimTime) override
bool	FindAndSetPath (double aSimTime, WsfGeoPoint aStartPtr, WsfGeoPoint aEndPtr) override
bool	GoToLocation (double aSimTime, double aLatitude, double aLongitude, double aAltitude) override
bool	UpdateRoute (double aSimTime, const WsfRoute &aRoute) override
bool	UpdateDefaultRoute () override
virtual bool	SetRoutePoint (double aSimTime, const WsfRoute &aRoute, int aTargetPoint)
bool	ReturnToRoute (double aSimTime) override
bool	IsPaused () const override
	Returns true if the mover is paused.
WsfRouteComputer *	GetRouteComputer () const
void	SetRouteComputer (WsfRouteComputer *aRouteComputerPtr)
void	SetEndOfPath (WsfPath::EndPath aEndOfPathOption)
	Sets the default end-of-path option for the mover.
int	GetTargetIndex () const
	Return next waypoint index.
void	SetTargetIndex (int aIndex)
int	GetCurrentIndex () const
	Return current waypoint index.
MissTurnOption	GetTurnFailOption () const
double	GetTurnFailThreshold () const
WsfPath::Switch	GetSwitch () const
Public Member Functions inherited from WsfMover
	WsfMover ()=delete
	WsfMover (const WsfScenario &aScenario)
	WsfMover (const WsfMover &aSrc)
WsfMover &	operator= (const WsfMover &)=delete
	~WsfMover () override
WsfModeList *	GetModeList () const
virtual void	TriggerExtrapolation ()
virtual KinematicModel *	CreateKinematicModel (double aSimTime, WsfStringId aPlatformTypeId, const double aLocationWCS[3], const double aVelocityWCS[3], WsfMover aMoverPtr, WsfDraw aDrawPtr) const
WsfComponent *	CloneComponent () const override
int	GetComponentInitializationOrder () const override
const int *	GetComponentRoles () const override
void *	QueryInterface (int aRole) override
const char *	GetScriptClassName () const override
virtual void	SwapMoverInitiated (double aSimTime, WsfMover *aOldMoverPtr)
void	SetNonOperational (double aSimTime) override
void	SetOperational (double aSimTime) override
void	PartBroken (double aSimTime) override
void	Restore (double aSimTime) override
virtual WsfSpatialDomain	GetSpatialDomain () const
virtual bool	IsStopped () const
	Return whether the mover (and its attached platform) is stopped.
virtual void	SetHeading (double aHeading)
virtual void	SetPitch (double aPitch)
virtual void	SetRoll (double aRoll)
virtual void	SetOrientationNED (double aHeading, double aPitch, double aRoll)
double	GetLastUpdateTime () const
double	GetUpdateInterval () const override
double	GetUpdateTimeTolerance () const
void	SetUpdateInterval (double aUpdateInterval) override
void	SetLastUpdateTime (double aLastUpdateTime)
virtual bool	UpdateAllowed () const
bool	UpdateWhenBroken () const
void	SetUpdateWhenBroken ()
void	SetNoUpdateWhenBroken ()
virtual bool	FlyRates (const UtVec3d &aAngularRates, const UtVec3d &aLongitudinalAccel)
virtual bool	FlyHeadingSpeedAltitude (double aHeading, double aSpeed, double aAltitude, double aMaxGees, double aMaxClimb)
virtual bool	TurnInPlaneWithSpeed (const UtVec3d &aPlane, double aGees, double aSpeed)
virtual bool	TurnInPlaneWithThrottle (const UtVec3d &aPlane, double aGees, double aThrottle)
virtual bool	FlyVectorWithSpeed (const UtVec3d &aVelocityVector, double aMaxGees, double aSpeed)
virtual bool	FlyVectorWithThrottle (const UtVec3d &aVelocityVector, double aMaxGees, double aThrottle)
WsfStringId	GetModeId () const
virtual void	SetMode (WsfStringId aModeName)
bool	ThreadSafe () const
	Returns true if the mover update is thread safe.
void	SetThreadSafe ()
void	SetNotThreadSafe ()
virtual void	InitializeProperties ()
	Add any input properties and its default value common properties list.
virtual bool	PropertyExists (const std::string &aPropertyName)
	Return true if the given property exists in the set of properties.
virtual void	RegisterProperty (const std::string &aPropertyName, const int &aProperty)
	Add an integer property to the common set of properties.
virtual void	RegisterProperty (const std::string &aPropertyName, const double &aProperty)
	Add an floating point property to the common set of properties.
virtual void	RegisterProperty (const std::string &aPropertyName, const std::string &aProperty)
	Add an string property to the set of common properties.
virtual bool	GetPropertyInt (const std::string &aPropertyName, int &aProperty)
virtual bool	GetPropertyString (const std::string &aPropertyName, std::string &aProperty)
virtual double	GetThrottlePosition ()
Public Member Functions inherited from WsfPlatformPart
	WsfPlatformPart (const WsfScenario &aScenario, int aPartType)
WsfPlatformPart &	operator= (const WsfPlatformPart &aRhs)=delete
	~WsfPlatformPart () override
const int *	GetComponentRoles () const override
void *	QueryInterface (int aRole) override
bool	DebugEnabled () const
	Returns 'true' if debugging is enabled for this instance.
void	SetDebugEnabled (bool aDebugEnabled)
unsigned int	GetDebugMask ()
bool	IsExternallyControlled () const
virtual void	SetExternallyControlled (double aSimTime, bool aIsExternallyControlled)
int	GetPartType () const
const char *	GetScriptClassName () const override
WsfSimulation *	GetSimulation () const
const WsfScenario &	GetScenario () const
WsfStringId	GetComponentName () const override
void	ComponentParentChanged (WsfPlatform *aPlatformPtr) override
WsfPlatform *	GetPlatform () const
virtual void	PlatformAdded (double aSimTime, WsfPlatform *aPlatformPtr)
virtual void	PlatformDeleted (WsfPlatform *aPlatformPtr)
double	GetLastStatusChangeTime () const
void	SetLastStatusChangeTime (double aSimTime)
	Allows a system to set the time at which the device was initialized.
bool	CanBeMadeOperational () const
	Returns an indication that this system can be made operational.
bool	CanBeMadeNonOperational () const
	Returns an indication that this system can be made non-operational.
bool	CanBeTurnedOn () const
	Returns an indication that this system can be turned on.
bool	CanBeTurnedOff () const
	Returns an indication that this system can be turned off.
bool	IsTurnedOn () const
bool	InitiallyTurnedOn () const
	Is the system to be turned 'on' when added to the simulation?
void	SetInitiallyTurnedOn (bool aInitiallyTurnedOn)
	Sets if the system is turned on when added to the simulation.
bool	IsOperational () const
bool	SetOperational (double aSimTime, bool aMakeOperational)
double	GetDamageFactor () const
bool	SetDamageFactor (double aSimTime, double aDamageFactor)
bool	IsCritical () const
void	SetCritical (bool aValue)
virtual void	OnPlatformBrokenEvent (double aSimTime)
	Owning platform has issued a broken event.
bool	IsBroken () const
WsfInternalLinks &	GetInternalLinks ()
	Return the internal links for this part.
virtual bool	HasInternalLinks () const
	Does this platform part have a communication link to other platform parts?
virtual bool	ProcessMessage (double aSimTime, const WsfMessage &aMessage)
virtual bool	ReceiveMessage (double aSimTime, const WsfMessage &aMessage)
virtual void	SendMessage (double aSimTime, const WsfMessage &aMessage)
virtual void	SendMessageTo (double aSimTime, const WsfMessage &aMessage, WsfStringId aRecipientId)
void	SendMessageToProcessor (double aSimTime, const WsfMessage &aMessage, WsfStringId aRecipientId)
virtual void	SendQueuedMessages (double aSimTime)
const WsfCategoryList &	GetCategories () const
	Get the categories to which this part belongs.
void	AddCategory (WsfStringId aCategoryId)
	Adds the provided category to the platform part's category list.
bool	IsCategoryMember (WsfStringId aCategoryId) const
const WsfGroupList &	GetGroups () const
	Get the groups to which this platform part belongs.
void	JoinGroup (WsfGroup *aGroupPtr)
	Join the given group.
void	LeaveGroup (WsfGroup *aGroupPtr)
	Leave the given group.
bool	IsGroupMember (WsfStringId aGroupId)
unsigned int	GetUpdateEventEpoch () const
void	IncrementUpdateEventEpoch ()
bool	UpdateEventActive () const
	Is an 'Update' event active?
void	SetUpdateEventActive (bool aUpdateEventActive)
	Indicate if the 'Update' event is active.
Public Member Functions inherited from WsfObject
	WsfObject ()
	This is the constructor for the WsfObject class.
	~WsfObject () override
	This is the destructor for the WsfObject class.
const char *	GetScriptClassName () const override
const std::string &	GetType () const
WsfStringId	GetTypeId () const
	Get the string ID of the 'type' of the object.
void	SetType (WsfStringId aType)
const std::string &	GetBaseType () const
WsfStringId	GetBaseTypeId () const
const TypeList &	GetTypeList () const
bool	IsA_TypeOf (WsfStringId aType) const
WsfObject &	operator= (const WsfObject &aRhs)
	Assignment operator.
template<typename T>
void	Serialize (T &aBuff)
	For XIO (de)serialization.
const std::string &	GetName () const
WsfStringId	GetNameId () const
void	SetName (WsfStringId aName)
Public Member Functions inherited from WsfComponentT< WsfPlatform >
	WsfComponentT ()
	WsfComponentT (const WsfComponentT &) noexcept
WsfComponentT &	operator= (const WsfComponentT &) noexcept
	~WsfComponentT () override=default
ParentType *	GetComponentParent () const
void	SetComponentParent (ParentType *aParentPtr)
Public Member Functions inherited from WsfComponent
virtual	~WsfComponent ()=default
template<typename T>
bool	QueryInterfaceT (T *&aRolePtr)
bool	ComponentHasRole (int aRole)
	Returns true if the component has the specified role.
virtual bool	PreInitialize (double aSimTime)
virtual void	PreInput ()
Public Member Functions inherited from WsfUniqueId
	WsfUniqueId ()
	Construtor initializes the unique identifier to 0.
	WsfUniqueId (const WsfUniqueId &)
	Copy constructor initializes the unique identifier to 0.
WsfUniqueId &	operator= (const WsfUniqueId &)
unsigned int	GetUniqueId () const
	Get the unique identifier assigned to this object.
template<typename T>
void	Serialize (T &aBuff)
	For XIO (de)serialization.
Public Member Functions inherited from WsfAuxDataEnabled
	WsfAuxDataEnabled ()=default
	WsfAuxDataEnabled (const WsfAuxDataEnabled &aSrc)=default
WsfAuxDataEnabled &	operator= (const WsfAuxDataEnabled &aRhs)
	WsfAuxDataEnabled (WsfAuxDataEnabled &&)=default
WsfAuxDataEnabled &	operator= (WsfAuxDataEnabled &&)=default
virtual	~WsfAuxDataEnabled () noexcept
void	SetAuxData (const WsfAttributeContainer &aAuxData)
void	DeleteAuxData ()
	Delete the aux data container from the object.
void	MergeAuxData (const WsfAuxDataEnabled &aSrc)
	Merge the object's aux data with aux data from an existing object.
void	UpdateAuxData (const WsfAuxDataEnabled &aSrc)
	Update the object's aux data with aux data from an existing object.
bool	HasAuxData () const
	Returns true if this object has aux data.
bool	ProcessInput (UtInput &aInput)
template<typename T>
void	Serialize (T &aBuff)
	(De)serialization for XIO
WsfAttributeContainer &	GetAuxData ()
const WsfAttributeContainer &	GetAuxData () const noexcept
const WsfAttributeContainer &	GetAuxDataConst () const noexcept

Protected Member Functions
void	SetGuidanceFrom (const WsfWaypoint &aPreviousWaypoint) override
void	SetGuidanceTo (const WsfWaypoint &aNextWaypoint) override
void	AdvanceToNextWaypoint (double aSimTime, const WsfWaypoint &aTarget, const WsfWaypoint *aNextPointPtr) override
double	GetHeightOfTerrain () const
void	UpdateHeightOfTerrain ()
void	SetIsOnGround (bool aIsOnGround)
virtual void	PostMoveUpdate (double aSimTime)
void	EnableTerrain (bool aUseTerrain)
void	ExecutePath (double aSimTime)
void	UpdatePosition (double aSimTime) override
void	HitWaypoint (double aSimTime)
	Called when a waypoint is reached. Triggers processing of next waypoint.
void	ResetPath (double aSimTime)
void	SetCompleteTime (double aSimTime)
	Schedules the HitPointEvent to execute at aSimTime.
void	SetComplete ()
	Disables any pending HitPointEvent.
void	UpdateConstraints (const WsfWaypoint &aWaypoint)
void	CreatePath (const WsfWaypoint &aTargetPoint, const WsfWaypoint *aNextPointPtr=nullptr)
void	CreatePath (bool aResetDefaults=true)
void	Extrapolate (double aSimTime)
void	MoveToGround ()
void	SetGroundAttitude (double aLatitude, double aLongitude)
Protected Member Functions inherited from WsfRouteMover
void	TriggerUnpause (double aSimTime)
	Called when the pause time has expired to resume movement.
void	SetAltRef (WsfPath::AltRef aAltRef)
WsfPath::AltRef	GetAltRef () const
virtual void	WaypointReached (double aSimTime)
	Called when waypoint is reached.
void	RouteChanged ()
	Called when the route is changed to reset processing of current point.
bool	IsSwitchingPoints ()
void	AddUnpauseEventFor (WsfRouteMover *aMoverPtr, double aUnpauseTime)
void	DisableAndClearUnpause ()
void	SetModeList (WsfModeList *aModeListPtr)
void	SetUpdateTimeTolerance (double aDt)
	Revise the internal time tolerance allowed for Update() sequencing logic.
	WsfPlatformPart (const WsfPlatformPart &aSrc)
	Copy constructor (for Clone()).
	WsfObject (const WsfObject &aSrc)
	Copy constructor (for Clone()).
Protected Member Functions inherited from WsfUniqueId
void	AssignUniqueId (WsfSimulation *aSimulationPtr)

Protected Attributes
WsfPathComputer	mPathComputer
	Computes the mover's path.
double	mPathStartTime
	The sim-time at which mPath was begun.
WsfPathList	mPath
	The current path being traversed by the platform.
WsfPathList	mTotalPath
	If mDebugKeepPath is set, this contains entire path traversed by platform.
WsfPathTarget	mTarget
	Current 'goal' parameters.
HitPointEvent *	mHitEventPtr
	Event triggered when mover reaches waypoint.
WsfPathConstraints	mMoverConstraints
	Constraints of the mover.
WsfPathConstraints	mCurrentConstraints
	Currently used constraints.
double	mDefaultRadialAcceleration
double	mDefaultLinearAcceleration
double	mDefaultClimbRate
double	mPrePauseVelocity [3]
	}
double	mHeightOfTerrain
unsigned int	mTargetTypeFlags
bool	mIsOnGround
	Is the platform moving along the ground.
bool	mIsOnRoad
	Is the platform moving along roads.
bool	mPitchEnable
bool	mDebugKeepPath
bool	mDebugPathComputation
bool	mUseTerrain
double	mPathComputeTimestep
	Mover will optionally recompute path on a regular interval if this is non-zero.
WsfAngleOfAttack *	mAngleOfAttackPtr
Protected Attributes inherited from WsfRouteMover
wsf::Terrain *	mTerrainPtr
bool	mForceUpdates
MissTurnOption	mTurnFailOption
	If true, the mover will ensure it passes each point.
double	mTurnFailureThreshold
	Threshold of turn failure as percentage of turn radius.
double	mUnpauseTime
	Simulation time at which the mover will unpause.
double	mAltitudeOffset
	Altitude offset of the parent platform's center of gravity / mass (CG).
double	mLastUpdateTime
	The simulation time when Update was last called.
WsfVariable< double >	mUpdateTimeTolerance
bool	mThreadSafe
std::vector< WsfMoverMode * >	mMoverModeList
	The generic list of modes (not valid until Initialize is called).
WsfStringId	mModeId

Friends
class	HitPointEvent

Additional Inherited Members
Public Types inherited from WsfRouteMover
enum	MissTurnOption { cCLOSEST_POINT = 0 , cREVERSE_TURN = 1 , cSKIP_POINT = 2 }
Public Types inherited from WsfPlatformPart
enum	{ cLEVEL_ONE_DEBUG = 0x00000001 , cLEVEL_TWO_DEBUG = 0x00000002 }
using	InternalMessageQueue = std::queue<WsfMessage*>
using	RecipientMessageQueue = std::queue<std::pair<WsfPlatformPart, WsfMessage>>
Public Types inherited from WsfObject
typedef std::vector< WsfStringId >	TypeList
	The list of types returned by GetTypeList.
Public Types inherited from WsfComponentT< WsfPlatform >
typedef WsfPlatform	ParentType
	This is needed to support the WsfComponentList template.
Static Public Attributes inherited from WsfMover
static const char *	cTYPE_KIND = "mover"
Static Public Attributes inherited from WsfAuxDataEnabled
static UtCallbackListN< void(const WsfAuxDataEnabled *)>	AuxDataAccessed
static UtCallbackListN< void(const WsfAuxDataEnabled *)>	AuxDataDestroyed

Detailed Description

A specialized mover that will move along a path defined by WsfRoute, using a parametric, linearized, non-physics-based approach to motion. This class contains the ability to move on the ground or in the air and to change at any time (like an airplane that taxis and then takes-off). WsfAirMover and WsfGroundMover are specific examples of classes that derive from this class. They differ only in the fact that they declare the default state (ground or air).

Constructor & Destructor Documentation

◆ WsfWaypointMover() [1/3]

WsfWaypointMover::WsfWaypointMover ( )

delete

References WsfWaypointMover().

Referenced by WsfWaypointMover::BaseEvent::BaseEvent(), Clone(), WsfWaypointMover::HitPointEvent::HitPointEvent(), operator=(), WsfAirMover::WsfAirMover(), WsfGroundMover::WsfGroundMover(), WsfGroundMover::WsfGroundMover(), WsfSubsurfaceMover::WsfSubsurfaceMover(), WsfSurfaceMover::WsfSurfaceMover(), WsfSurfaceMover::WsfSurfaceMover(), WsfWaypointMover(), and WsfWaypointMover().

◆ WsfWaypointMover() [2/3]

WsfWaypointMover::WsfWaypointMover ( const WsfScenario & aScenario )

◆ WsfWaypointMover() [3/3]

WsfWaypointMover::WsfWaypointMover ( const WsfWaypointMover & aSrc )

◆ ~WsfWaypointMover()

WsfWaypointMover::~WsfWaypointMover ( )

override

References WsfObject::GetName(), WsfPlatformPart::GetPlatform(), WsfPlatformPart::GetSimulation(), mAngleOfAttackPtr, mDebugKeepPath, mPath, mPathStartTime, mTotalPath, and SetComplete().

Member Function Documentation

◆ AdvanceToNextWaypoint()

void WsfWaypointMover::AdvanceToNextWaypoint	(	double	aSimTime,
		const WsfWaypoint &	aTarget,
		const WsfWaypoint *	aNextPointPtr )

overrideprotectedvirtual

Mover implementing this method should begin movement toward aTarget. WaypointReached() should be called when target waypoint is reached.

Parameters

aSimTime	The current simulation time.
aTarget	The new target waypoint
aNextPointPtr	The waypoint in the route after aTarget. May be null.

Implements WsfRouteMover.

References WsfWaypoint::cHEADING_MASK, CreatePath(), ExecutePath(), WsfWaypoint::GetPointType(), ResetPath(), WsfRouteMover::Update(), and UpdateConstraints().

◆ Clone()

WsfMover * WsfWaypointMover::Clone ( ) const

overridevirtual

Clone this object.

Returns: a pointer to the new object.

Implements WsfMover.

References WsfMover::WsfMover(), and WsfWaypointMover().

◆ CornerVelocity()

double WsfWaypointMover::CornerVelocity ( WsfGeoPoint * aTarget )

virtual

References WsfGeoPoint::GetLocationWCS(), WsfPlatformPart::GetPlatform(), MaximumRadialAcceleration(), MaximumTurnRate(), and platformPtr.

◆ CreatePath() [1/2]

void WsfWaypointMover::CreatePath ( bool aResetDefaults = true )

protected

References WsfPathTarget::cRELATIVE_TURN, WsfPathTarget::cTURN_ON_APPROACH, WsfObject::GetName(), WsfPlatformPart::GetPlatform(), WsfPathState::mAltitude, mCurrentConstraints, mDebugPathComputation, WsfPathState::mLatitude, WsfPathState::mLongitude, WsfPathState::mOrientationNED, mPath, mPathComputer, mTarget, mTargetTypeFlags, WsfPathState::mVelocityNED, and vel.

◆ CreatePath() [2/2]

void WsfWaypointMover::CreatePath	(	const WsfWaypoint &	aTargetPoint,
		const WsfWaypoint *	aNextPointPtr = nullptr )

protected

References CreatePath(), WsfWaypoint::cTIME_TO_POINT, WsfWaypoint::GetDistanceOrTime(), WsfPlatformPart::GetPlatform(), WsfWaypoint::GetPointType(), mCurrentConstraints, mIsOnGround, mMoverConstraints, mPath, mPathComputer, and mTarget.

Referenced by AdvanceToNextWaypoint(), CreatePath(), GoToAltitude(), GoToSpeed(), HitPointEvent, ResetPosition(), TurnToHeading(), and TurnToRelativeHeading().

◆ EnableTerrain()

void WsfWaypointMover::EnableTerrain ( bool aUseTerrain )

protected

References WsfPlatformPart::GetSimulation(), WsfRouteMover::mTerrainPtr, and mUseTerrain.

Referenced by Initialize(), and WsfGroundMover::WsfGroundMover().

◆ ExecutePath()

void WsfWaypointMover::ExecutePath ( double aSimTime )

protected

References mPath, mPathStartTime, WsfRouteMover::RouteChanged(), SetComplete(), SetCompleteTime(), and Unpause().

Referenced by AdvanceToNextWaypoint(), Extrapolate(), GoToAltitude(), GoToSpeed(), ResetPosition(), TurnToHeading(), and TurnToRelativeHeading().

◆ Extrapolate()

void WsfWaypointMover::Extrapolate ( double aSimTime )

protected

References WsfPathTarget::cALTITUDE, WsfPathTarget::cEXTRAPOLATE, WsfPathTarget::cHEADING, WsfPathTarget::cLOCATION, WsfPathTarget::cSPEED, WsfPathTarget::cTIME_TO_POINT, ExecutePath(), WsfPlatformPart::GetPlatform(), mPath, mPathComputer, mTarget, mTargetTypeFlags, and WsfRouteMover::Update().

Referenced by HitPointEvent.

◆ GetAngleOfAttackTable()

const WsfAngleOfAttack * WsfWaypointMover::GetAngleOfAttackTable ( )

inline

References mAngleOfAttackPtr.

◆ GetConstraints()

WsfPathConstraints & WsfWaypointMover::GetConstraints ( )

inline

References mMoverConstraints.

Referenced by WsfWMAIEngagementMod::Beam::Perform(), and WsfWMAIEngagementMod::TakeAction::Perform().

◆ GetCurrentConstraints()

const WsfPathConstraints & WsfWaypointMover::GetCurrentConstraints ( ) const

inline

References mCurrentConstraints.

◆ GetFutureLocationWCS()

bool WsfWaypointMover::GetFutureLocationWCS	(	double	aSimTime,
		double	aLocationWCS[3] )

overridevirtual

Get the anticipated location at some future time

Parameters

aSimTime	A time in the future for which the location is to be determined.
aLocationWCS	The location at the time specified by aSimTime.

Returns: false if the future location cannot be determined.

Note: Not all movers support this method.

Reimplemented from WsfMover.

References WsfPathComputer::ComputePath(), WsfPathComputer::CreateTarget(), WsfWaypoint::cTIME_TO_POINT, WsfWaypoint::GetDistanceOrTime(), WsfPathList::GetDuration(), WsfPathList::GetEndState(), WsfWaypoint::GetGotoId(), WsfWaypoint::GetPointType(), WsfRouteMover::GetRoute(), WsfRoute::GetSize(), WsfPathList::GetState(), WsfRouteMover::GetTargetIndex(), WsfRoute::GetWaypointAt(), WsfRoute::GetWaypointIndexAt(), WsfPathState::mAltitude, WsfRouteMover::mAltitudeOffset, mCurrentConstraints, WsfPathConstraints::mIsOnGround, mIsOnGround, WsfPathState::mLatitude, WsfPathState::mLongitude, mMoverConstraints, mPath, mPathComputer, mPathStartTime, mTarget, WsfPathTarget::mTargetType, mTargetTypeFlags, WsfRouteMover::mTerrainPtr, WsfPathComputer::RevisePathHitPointAtTime(), and targetIndex().

◆ GetHeightOfTerrain()

double WsfWaypointMover::GetHeightOfTerrain ( ) const

inlineprotected

References mHeightOfTerrain.

Referenced by WsfAirMover::DestIsInAir(), and WsfAirMover::PostMoveUpdate().

◆ GetMoverConstraints()

const WsfPathConstraints * WsfWaypointMover::GetMoverConstraints ( ) const

overridevirtual

Reimplemented from WsfRouteMover.

References mMoverConstraints.

◆ GetPathComputer()

WsfPathComputer & WsfWaypointMover::GetPathComputer ( )

inline

References mPathComputer.

Referenced by TurnRadius(), and TurnRadius().

◆ GetPropertyDouble()

bool WsfWaypointMover::GetPropertyDouble	(	const std::string &	aPropertyName,
		double &	aProperty )

overridevirtual

Get the value of a floating point property from either a derived-class set of properties or the common set of properties.

Reimplemented from WsfMover.

References WsfMover::GetPropertyDouble(), mDefaultClimbRate, mDefaultLinearAcceleration, mDefaultRadialAcceleration, mPathComputer, and TurnRadius().

◆ GetTarget()

const WsfPathTarget & WsfWaypointMover::GetTarget ( ) const

inline

References mTarget.

Referenced by WsfRoadMover::CreateRoute().

◆ GoToAltitude()

bool WsfWaypointMover::GoToAltitude	(	double	aSimTime,
		double	aAltitude,
		double	aClimbDiveRate,
		bool	aKeepRoute )

overridevirtual

Command the mover change its altitude.

Parameters

aSimTime	The current simulated time (seconds).
aAltitude	The desired altitude to attempt to achieve (in meters).
aClimbDiveRate	The desired climb/dive rate (meters/second). If zero then use the mover default.
aKeepRoute	'true' if the mover should maintain current route. 'false' to extrapolate.

Returns: true if successful.

Reimplemented from WsfMover.

References WsfPathTarget::cALTITUDE, WsfPathTarget::cEXTRAPOLATE, CreatePath(), ExecutePath(), WsfPlatformPart::GetPlatform(), WsfRouteMover::IsSwitchingPoints(), mMoverConstraints, mPathComputer, mTarget, ResetPath(), Unpause(), and WsfRouteMover::Update().

◆ GoToSpeed()

bool WsfWaypointMover::GoToSpeed	(	double	aSimTime,
		double	aSpeed,
		double	aLinearAccel,
		bool	aKeepRoute )

overridevirtual

Command the mover to change its speed.

Parameters

aSimTime	The current simulated clock time (seconds).
aSpeed	The desired speed (in meters/second).
aLinearAccel	The desired acceleration (meters/second^2). If zero then use the mover default.
aKeepRoute	'true' if the mover should maintain current route. 'false' to extrapolate.

Returns: true if successful.

Reimplemented from WsfRouteMover.

References WsfPathTarget::cEXTRAPOLATE, CreatePath(), WsfPathTarget::cSPEED, ExecutePath(), WsfRouteMover::GoToSpeed(), WsfRouteMover::IsSwitchingPoints(), mMoverConstraints, mPathComputer, mTarget, ResetPath(), Unpause(), and WsfRouteMover::Update().

Referenced by WsfWMAIEngagementMod::Drag::Perform().

◆ HitWaypoint()

void WsfWaypointMover::HitWaypoint ( double aSimTime )

protected

Called when a waypoint is reached. Triggers processing of next waypoint.

References WsfPathTarget::cALTITUDE, WsfPathTarget::cHEADING, WsfPathTarget::cLOCATION, WsfPathTarget::cSPEED, WsfPlatformPart::DebugEnabled(), WsfRouteMover::GetCurrentIndex(), WsfObject::GetName(), WsfPlatformPart::GetPlatform(), WsfRouteMover::GetTargetIndex(), WsfRouteMover::mForceUpdates, mHitEventPtr, mPathStartTime, mTarget, Pause(), ResetPath(), WsfRouteMover::Update(), and WsfRouteMover::WaypointReached().

◆ Initialize()

bool WsfWaypointMover::Initialize ( double aSimTime )

overridevirtual

Initialize the kinematic state of the associated platform. Fix the initial location, orientation, speed and acceleration of the attached platform to what it should be at the beginning of its existence.

Parameters

aSimTime The current simulation time.

Returns: True if successful.

Reimplemented from WsfRouteMover.

References WsfPath::cDOUBLE_NOT_SET, WsfPathTarget::cOPTIONAL_POINT, WsfPathTarget::cREQUIRED_POINT, WsfRouteMover::cREVERSE_TURN, WsfRouteMover::cSKIP_POINT, EnableTerrain(), WsfPlatformPart::GetPlatform(), WsfPlatformPart::GetSimulation(), WsfRouteMover::GetSwitch(), WsfMover::GetUpdateInterval(), WsfRouteMover::Initialize(), WsfRouteMover::IsPaused(), mCurrentConstraints, mDefaultClimbRate, mDefaultLinearAcceleration, mDefaultRadialAcceleration, mMoverConstraints, mPath, mPathComputer, mPathComputeTimestep, mTarget, mTargetTypeFlags, WsfRouteMover::mTerrainPtr, WsfRouteMover::mTurnFailOption, WsfRouteMover::mTurnFailureThreshold, mUseTerrain, ok, WsfMover::SetUpdateInterval(), and Unpause().

Referenced by WsfAirMover::Initialize(), and WsfSubsurfaceMover::Initialize().

◆ IsExtrapolating()

bool WsfWaypointMover::IsExtrapolating ( ) const

overridevirtual

Return true if the mover is extrapolating after the end of a route or after a GoTo/TurnTo command.

Reimplemented from WsfMover.

References WsfPathTarget::cEXTRAPOLATE, and mTarget.

◆ IsOnGround()

bool WsfWaypointMover::IsOnGround ( ) const

inline

References mIsOnGround.

Referenced by WsfAirMover::PostMoveUpdate(), and WsfSubsurfaceMover::PostMoveUpdate().

◆ IsOnRoad()

bool WsfWaypointMover::IsOnRoad ( ) const

inline

References mIsOnRoad.

◆ MaximumRadialAcceleration()

double WsfWaypointMover::MaximumRadialAcceleration ( )

virtual

References mMoverConstraints.

Referenced by CornerVelocity().

◆ MaximumTurnRate()

double WsfWaypointMover::MaximumTurnRate ( )

virtual

References WsfPathConstraints::mMaxTurnRate, mMoverConstraints, and WsfPathConstraints::mTurnRateLimit.

Referenced by CornerVelocity().

◆ MoveToGround()

void WsfWaypointMover::MoveToGround ( )

protected

References WsfPlatformPart::GetPlatform(), WsfRouteMover::mAltitudeOffset, mHeightOfTerrain, mIsOnGround, WsfRouteMover::mTerrainPtr, and SetGroundAttitude().

Referenced by HitPointEvent, and UpdatePosition().

◆ operator=()

WsfWaypointMover & WsfWaypointMover::operator= ( const WsfWaypointMover & )

delete

References WsfMover::WsfMover(), and WsfWaypointMover().

◆ Pause()

void WsfWaypointMover::Pause	(	double	aSimTime,
		double	aUnpauseTime )

overridevirtual

Stop the movement of the platform until aUnpauseTime.

Implements WsfRouteMover.

References WsfRouteMover::AddUnpauseEventFor(), WsfPlatformPart::GetPlatform(), mPrePauseVelocity, WsfRouteMover::mUnpauseTime, and SetComplete().

Referenced by HitWaypoint().

◆ PostMoveUpdate()

virtual void WsfWaypointMover::PostMoveUpdate ( double aSimTime )

inlineprotectedvirtual

Reimplemented in WsfAirMover, and WsfSubsurfaceMover.

Referenced by WsfSubsurfaceMover::PostMoveUpdate(), and UpdatePosition().

◆ ProcessInput()

bool WsfWaypointMover::ProcessInput ( UtInput & aInput )

overridevirtual

Process input from a generic source.

Examine the current input command. If it is NOT one of the commands recognized by this class then it simply returns 'false'. If it is one of the commands recognized by this class then it processes the command and returns 'true'.

Parameters

aInput a reference to a UtInput object.

Returns: 'true' if the command was one recognized by the class or 'false' if not.

Exceptions

UtInput::ExceptionBase (or an object derived from it) if the command was recognized but contains some sort of error.

Note: If a derived class does not recognize the command (i.e.: the return value is false) then it should call the base class ProcessInput method. This chain should continue until either the command is recognized or the top-level base class is encountered.

Reimplemented from WsfRouteMover.

References mAngleOfAttackPtr, mDebugKeepPath, mDebugPathComputation, mDefaultClimbRate, mDefaultLinearAcceleration, mDefaultRadialAcceleration, mIsOnGround, mIsOnRoad, mMoverConstraints, mPathComputer, mPathComputeTimestep, mPitchEnable, and WsfRouteMover::ProcessInput().

Referenced by WsfAirMover::ProcessInput(), WsfGroundMover::ProcessInput(), and WsfSurfaceMover::ProcessInput().

◆ ResetPath()

void WsfWaypointMover::ResetPath ( double aSimTime )

protected

References mDebugKeepPath, mPath, mPathStartTime, and mTotalPath.

Referenced by AdvanceToNextWaypoint(), GoToAltitude(), GoToSpeed(), HitPointEvent, HitWaypoint(), ResetPosition(), TurnToHeading(), and TurnToRelativeHeading().

◆ ResetPosition()

void WsfWaypointMover::ResetPosition ( double aSimTime )

overridevirtual

Informs the mover to use the current platform state.

Reimplemented from WsfMover.

References CreatePath(), ExecutePath(), and ResetPath().

Referenced by UpdatePosition().

◆ SetComplete()

void WsfWaypointMover::SetComplete ( )

protected

Disables any pending HitPointEvent.

References mHitEventPtr.

Referenced by ExecutePath(), HitPointEvent, Pause(), SetCompleteTime(), SetPlatform(), and ~WsfWaypointMover().

◆ SetCompleteTime()

void WsfWaypointMover::SetCompleteTime ( double aSimTime )

protected

Schedules the HitPointEvent to execute at aSimTime.

References WsfSimulation::AddEvent(), WsfPlatformPart::GetSimulation(), mHitEventPtr, and SetComplete().

Referenced by ExecutePath(), and HitPointEvent.

◆ SetGroundAttitude()

void WsfWaypointMover::SetGroundAttitude	(	double	aLatitude,
		double	aLongitude )

protected

Update the orientation of the platform to conform to local ground slope. It is assumed this method will not be called unless already on ground.

References WsfPlatformPart::GetPlatform(), mIsOnRoad, mPitchEnable, and WsfRouteMover::mTerrainPtr.

Referenced by HitPointEvent, and MoveToGround().

◆ SetGuidanceFrom()

void WsfWaypointMover::SetGuidanceFrom ( const WsfWaypoint & aPreviousWaypoint )

overrideprotectedvirtual

Mover implementing this method should adjust current constraints to comply with those in aPreviousWaypoint.

Implements WsfRouteMover.

References UpdateConstraints().

◆ SetGuidanceTo()

void WsfWaypointMover::SetGuidanceTo ( const WsfWaypoint & aNextWaypoint )

overrideprotectedvirtual

Mover implementing this method should adjust current constraints to comply with those in aNextWaypoint.

Implements WsfRouteMover.

References WsfPathTarget::cALTITUDE, WsfPath::cDOUBLE_NOT_SET, WsfPathTarget::cSPEED, WsfWaypoint::GetAlt(), WsfWaypoint::GetSpeed(), and mTarget.

◆ SetIsOnGround()

void WsfWaypointMover::SetIsOnGround ( bool aIsOnGround )

inlineprotected

References mIsOnGround.

Referenced by WsfAirMover::Land(), WsfAirMover::TakeOff(), and WsfGroundMover::WsfGroundMover().

◆ SetIsOnRoad()

void WsfWaypointMover::SetIsOnRoad ( bool aIsOnRoad )

inline

References mIsOnRoad.

◆ SetPlatform()

void WsfWaypointMover::SetPlatform ( WsfPlatform * aPlatformPtr )

overridevirtual

Set the platform to which this part is associated.

Parameters

aPlatformPtr Pointer to the containing platform.

Note: A part can be associated with only one platform. It is an error to associate a part with more than one platform!

Reimplemented from WsfPlatformPart.

References WsfRouteMover::DisableAndClearUnpause(), WsfPlatformPart::GetPlatform(), SetComplete(), and WsfPlatformPart::SetPlatform().

◆ TurnRadius() [1/2]

double WsfWaypointMover::TurnRadius ( )

References GetPathComputer(), WsfPlatformPart::GetPlatform(), and WsfPathComputer::GetTurnRadius().

Referenced by GetPropertyDouble().

◆ TurnRadius() [2/2]

double WsfWaypointMover::TurnRadius ( double atSpeed )

overridevirtual

Reimplemented from WsfMover.

References GetPathComputer(), and WsfPathComputer::GetTurnRadius().

◆ TurnToHeading()

bool WsfWaypointMover::TurnToHeading	(	double	aSimTime,
		double	aHeading,
		double	aRadialAccel,
		WsfPath::TurnDirection	aTurnDirection )

overridevirtual

Command the mover to change its heading.

Parameters

aSimTime	The current simulated clock time (seconds).
aHeading	The desired heading (in radians).
aRadialAccel	The desired radial acceleration (meters/second^2). If zero then use the mover default.
aTurnDirection	The direction in which to turn.

Returns: true if successful.

Reimplemented from WsfMover.

References WsfPathTarget::cEXTRAPOLATE, WsfPathTarget::cHEADING, WsfPathTarget::cLOCATION, CreatePath(), WsfPathTarget::cRELATIVE_TURN, ExecutePath(), mMoverConstraints, mPathComputer, mTarget, ResetPath(), Unpause(), and WsfRouteMover::Update().

◆ TurnToRelativeHeading()

bool WsfWaypointMover::TurnToRelativeHeading	(	double	aSimTime,
		double	aHeadingChange,
		double	aRadialAccel,
		WsfPath::TurnDirection	aTurnDirection )

overridevirtual

Command the mover to change its relative heading.

Parameters

aSimTime	The current simulated clock time (seconds).
aHeadingChange	The desired heading change with positive clockwise, negative counter-clockwise. (in radians).
aRadialAccel	The desired radial acceleration (meters/second^2). If zero then use the mover default.
aTurnDirection	The direction in which to turn.

Returns: true if successful.

Reimplemented from WsfMover.

References WsfPathTarget::cEXTRAPOLATE, WsfPathTarget::cHEADING, CreatePath(), ExecutePath(), WsfPlatformPart::GetPlatform(), mMoverConstraints, mPathComputer, mTarget, ResetPath(), Unpause(), and WsfRouteMover::Update().

◆ Unpause()

bool WsfWaypointMover::Unpause	(	double	aSimTime,
		bool	aInterrupt )

overridevirtual

Resume movement

Parameters

aSimTime	The current simulation time
aInterrupt	'true' if the unpause was not scheduled

Reimplemented from WsfRouteMover.

References WsfPlatformPart::GetPlatform(), WsfRouteMover::IsPaused(), mPrePauseVelocity, and WsfRouteMover::Unpause().

Referenced by ExecutePath(), GoToAltitude(), GoToSpeed(), Initialize(), TurnToHeading(), and TurnToRelativeHeading().

◆ UpdateConstraints()

void WsfWaypointMover::UpdateConstraints ( const WsfWaypoint & aWaypoint )

protected

References WsfPath::cUSE_DEFAULT, WsfWaypoint::GetClimbRate(), WsfWaypoint::GetLinearAccel(), WsfWaypoint::GetMaximumFlightPathAngle(), WsfWaypoint::GetRadialAccel(), mCurrentConstraints, mDefaultClimbRate, mDefaultLinearAcceleration, mDefaultRadialAcceleration, mMoverConstraints, and mPathComputer.

Referenced by AdvanceToNextWaypoint(), HitPointEvent, and SetGuidanceFrom().

◆ UpdateHeightOfTerrain()

void WsfWaypointMover::UpdateHeightOfTerrain ( )

protected

References WsfPlatformPart::GetPlatform(), mHeightOfTerrain, and WsfRouteMover::mTerrainPtr.

Referenced by WsfAirMover::PostMoveUpdate().

◆ UpdatePosition()

void WsfWaypointMover::UpdatePosition ( double aSimTime )

overrideprotectedvirtual

◆ HitPointEvent

friend class HitPointEvent

friend

References CreatePath(), Extrapolate(), MoveToGround(), ResetPath(), SetComplete(), SetCompleteTime(), SetGroundAttitude(), and UpdateConstraints().

Member Data Documentation

◆ mAngleOfAttackPtr

WsfAngleOfAttack* WsfWaypointMover::mAngleOfAttackPtr

protected

Referenced by GetAngleOfAttackTable(), ProcessInput(), UpdatePosition(), WsfWaypointMover(), WsfWaypointMover(), and ~WsfWaypointMover().

◆ mCurrentConstraints

WsfPathConstraints WsfWaypointMover::mCurrentConstraints

protected

Currently used constraints.

Referenced by CreatePath(), CreatePath(), GetCurrentConstraints(), GetFutureLocationWCS(), Initialize(), UpdateConstraints(), and WsfWaypointMover().

◆ mDebugKeepPath

bool WsfWaypointMover::mDebugKeepPath

protected

Referenced by ProcessInput(), ResetPath(), WsfWaypointMover(), WsfWaypointMover(), and ~WsfWaypointMover().

◆ mDebugPathComputation

bool WsfWaypointMover::mDebugPathComputation

protected

Referenced by CreatePath(), ProcessInput(), WsfWaypointMover(), and WsfWaypointMover().

◆ mDefaultClimbRate

double WsfWaypointMover::mDefaultClimbRate

protected

Referenced by GetPropertyDouble(), Initialize(), ProcessInput(), UpdateConstraints(), WsfWaypointMover(), and WsfWaypointMover().

◆ mDefaultLinearAcceleration

double WsfWaypointMover::mDefaultLinearAcceleration

protected

Referenced by GetPropertyDouble(), Initialize(), ProcessInput(), UpdateConstraints(), WsfWaypointMover(), and WsfWaypointMover().

◆ mDefaultRadialAcceleration

double WsfWaypointMover::mDefaultRadialAcceleration

protected

Default values are used when no other rate has yet been requested, or when a waypoint rate is set to 'default' {

Referenced by GetPropertyDouble(), Initialize(), ProcessInput(), UpdateConstraints(), WsfWaypointMover(), and WsfWaypointMover().

◆ mHeightOfTerrain

double WsfWaypointMover::mHeightOfTerrain

protected

Referenced by GetHeightOfTerrain(), MoveToGround(), UpdateHeightOfTerrain(), WsfWaypointMover(), and WsfWaypointMover().

◆ mHitEventPtr

HitPointEvent* WsfWaypointMover::mHitEventPtr

protected

Event triggered when mover reaches waypoint.

Referenced by HitWaypoint(), SetComplete(), SetCompleteTime(), WsfWaypointMover(), and WsfWaypointMover().

◆ mIsOnGround

bool WsfWaypointMover::mIsOnGround

protected

Is the platform moving along the ground.

Referenced by CreatePath(), WsfSubsurfaceMover::Dive(), GetFutureLocationWCS(), IsOnGround(), MoveToGround(), WsfAirMover::PostMoveUpdate(), ProcessInput(), SetIsOnGround(), WsfSubsurfaceMover::Surface(), UpdatePosition(), WsfSurfaceMover::WsfSurfaceMover(), WsfWaypointMover(), and WsfWaypointMover().

◆ mIsOnRoad

bool WsfWaypointMover::mIsOnRoad

protected

Is the platform moving along roads.

Referenced by IsOnRoad(), ProcessInput(), SetGroundAttitude(), SetIsOnRoad(), WsfSurfaceMover::WsfSurfaceMover(), WsfWaypointMover(), and WsfWaypointMover().

◆ mMoverConstraints

WsfPathConstraints WsfWaypointMover::mMoverConstraints

protected

Constraints of the mover.

Referenced by CreatePath(), GetConstraints(), GetFutureLocationWCS(), GetMoverConstraints(), GoToAltitude(), GoToSpeed(), Initialize(), MaximumRadialAcceleration(), MaximumTurnRate(), ProcessInput(), TurnToHeading(), TurnToRelativeHeading(), UpdateConstraints(), WsfAirMover::WsfAirMover(), WsfGroundMover::WsfGroundMover(), WsfWaypointMover(), and WsfWaypointMover().

◆ mPath

WsfPathList WsfWaypointMover::mPath

protected

The current path being traversed by the platform.

Referenced by CreatePath(), CreatePath(), ExecutePath(), Extrapolate(), GetFutureLocationWCS(), Initialize(), ResetPath(), UpdatePosition(), WsfWaypointMover(), WsfWaypointMover(), and ~WsfWaypointMover().

◆ mPathComputer

WsfPathComputer WsfWaypointMover::mPathComputer

protected

Computes the mover's path.

Referenced by CreatePath(), CreatePath(), Extrapolate(), GetFutureLocationWCS(), GetPathComputer(), GetPropertyDouble(), GoToAltitude(), GoToSpeed(), Initialize(), ProcessInput(), TurnToHeading(), TurnToRelativeHeading(), UpdateConstraints(), WsfWaypointMover(), and WsfWaypointMover().

◆ mPathComputeTimestep

double WsfWaypointMover::mPathComputeTimestep

protected

Mover will optionally recompute path on a regular interval if this is non-zero.

Referenced by Initialize(), ProcessInput(), UpdatePosition(), WsfWaypointMover(), and WsfWaypointMover().

◆ mPathStartTime

double WsfWaypointMover::mPathStartTime

protected

The sim-time at which mPath was begun.

Referenced by ExecutePath(), GetFutureLocationWCS(), HitWaypoint(), ResetPath(), UpdatePosition(), WsfWaypointMover(), WsfWaypointMover(), and ~WsfWaypointMover().

◆ mPitchEnable

bool WsfWaypointMover::mPitchEnable

protected

Referenced by ProcessInput(), SetGroundAttitude(), UpdatePosition(), WsfSurfaceMover::WsfSurfaceMover(), WsfWaypointMover(), and WsfWaypointMover().

◆ mPrePauseVelocity

double WsfWaypointMover::mPrePauseVelocity[3]

protected

}

Saves velocity prior to pause to be used after resume

Referenced by Pause(), Unpause(), WsfWaypointMover(), and WsfWaypointMover().

◆ mTarget

WsfPathTarget WsfWaypointMover::mTarget

protected

Current 'goal' parameters.

Referenced by CreatePath(), CreatePath(), WsfAirMover::DestIsInAir(), Extrapolate(), GetFutureLocationWCS(), GetTarget(), GoToAltitude(), GoToSpeed(), HitWaypoint(), Initialize(), IsExtrapolating(), SetGuidanceTo(), TurnToHeading(), TurnToRelativeHeading(), and WsfWaypointMover().

◆ mTargetTypeFlags

unsigned int WsfWaypointMover::mTargetTypeFlags

protected

Referenced by CreatePath(), Extrapolate(), GetFutureLocationWCS(), Initialize(), WsfWaypointMover(), and WsfWaypointMover().

◆ mTotalPath

WsfPathList WsfWaypointMover::mTotalPath

protected

If mDebugKeepPath is set, this contains entire path traversed by platform.

Referenced by ResetPath(), WsfWaypointMover(), WsfWaypointMover(), and ~WsfWaypointMover().

◆ mUseTerrain

bool WsfWaypointMover::mUseTerrain

protected

Referenced by EnableTerrain(), Initialize(), WsfWaypointMover(), and WsfWaypointMover().

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

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ WsfWaypointMover() [1/3]

◆ WsfWaypointMover() [2/3]

◆ WsfWaypointMover() [3/3]

◆ ~WsfWaypointMover()

Member Function Documentation

◆ AdvanceToNextWaypoint()

◆ Clone()

◆ CornerVelocity()

◆ CreatePath() [1/2]

◆ CreatePath() [2/2]

◆ EnableTerrain()

◆ ExecutePath()

◆ Extrapolate()

◆ GetAngleOfAttackTable()

◆ GetConstraints()

◆ GetCurrentConstraints()

◆ GetFutureLocationWCS()

◆ GetHeightOfTerrain()

◆ GetMoverConstraints()

◆ GetPathComputer()

◆ GetPropertyDouble()

◆ GetTarget()

◆ GoToAltitude()

◆ GoToSpeed()

◆ HitWaypoint()

◆ Initialize()

◆ IsExtrapolating()

◆ IsOnGround()

◆ IsOnRoad()

◆ MaximumRadialAcceleration()

◆ MaximumTurnRate()

◆ MoveToGround()

◆ operator=()

◆ Pause()

◆ PostMoveUpdate()

◆ ProcessInput()

◆ ResetPath()

◆ ResetPosition()

◆ SetComplete()

◆ SetCompleteTime()

◆ SetGroundAttitude()

◆ SetGuidanceFrom()

◆ SetGuidanceTo()

◆ SetIsOnGround()

◆ SetIsOnRoad()

◆ SetPlatform()

◆ TurnRadius() [1/2]

◆ TurnRadius() [2/2]

◆ TurnToHeading()

◆ TurnToRelativeHeading()

◆ Unpause()

◆ UpdateConstraints()

◆ UpdateHeightOfTerrain()

◆ UpdatePosition()

Friends And Related Symbol Documentation

◆ HitPointEvent

Member Data Documentation

◆ mAngleOfAttackPtr

◆ mCurrentConstraints

◆ mDebugKeepPath

◆ mDebugPathComputation

◆ mDefaultClimbRate

◆ mDefaultLinearAcceleration

◆ mDefaultRadialAcceleration

◆ mHeightOfTerrain

◆ mHitEventPtr

◆ mIsOnGround

◆ mIsOnRoad

◆ mMoverConstraints

◆ mPath

◆ mPathComputer

◆ mPathComputeTimestep