WsfPath Namespace Reference

Enumerations
enum	AltRef { cALT_REF_MOVER_DEFAULT , cALT_REF_MSL , cALT_REF_AGL }
	Altitude reference option. More...
enum	HdgRef { cHDG_REF_NORTH , cHDG_REF_RELATIVE }
	Heading reference option. More...
enum	EndPath { cEP_MOVER_DEFAULT , cEP_EXTRAPOLATE , cEP_STOP , cEP_REMOVE }
	End of-path option. More...
enum	Switch {   cSWITCH_MOVER_DEFAULT , cSWITCH_ON_TIME , cSWITCH_ON_DISTANCE , cSWITCH_ON_APPROACH ,   cSWITCH_ON_PASSING , cSWITCH_EXTERNAL }
	Option setting when to react as a WsfWaypoint is approached. More...
enum	TurnDirection { cTURN_DIR_LEFT = -1 , cTURN_DIR_SHORTEST = 0 , cTURN_DIR_RIGHT = 1 }
	Turn direction for TurnToHeading and TurnToRelativeHeading. More...

Functions
WSF_EXPORT AltRef	GetAltRef (AltRef aMoverDefault, AltRef aWaypointValue)
	Obtain the altitude reference, allowing for the WsfWaypoint value to override the WsfMover default.

Variables
constexpr double	cDOUBLE_NOT_SET = -1.0E-12
	Unique value, tested internally to see if a floating point value is set or defaulted.
constexpr double	cUSE_PREVIOUS = WsfPath::cDOUBLE_NOT_SET
	A waypoint parameter with this value is a request to use the previously used value. (i.e.: the current speed).
constexpr double	cUSE_DEFAULT = -1.0E-13
	A waypoint parameter with this value is a request to use the mover's default value. (i.e.: maximum_radial_acceleration).
constexpr double	cUSE_COMPUTED = -1.0E-14
constexpr double	cNEGLIGIBLE_SPEED = 5280.0 / 3600.0 * UtMath::cM_PER_FT
	Speed below which an object is not considered to be moving:
constexpr double	cHEADING_FUZZ = 5.0 * UtMath::cRAD_PER_DEG
	Heading error, below which we are considered to be on course (not turning).
constexpr double	cGROUND_PROXIMITY_FUZZ = 4.0
	Height delta, above which we are considered airborne.

Detailed Description

A base namespace used by almost all WsfMover classes. This namespace contains a collection of enumerations used to set the path of a WsfMover guided by WsfWayPoints. The enumerations were placed in a namespace, as a base for other classes which will use them.

Enumeration Type Documentation

AltRef

enum WsfPath::AltRef

Altitude reference option.

Enumerator
cALT_REF_MOVER_DEFAULT	Use the WsfMover altitude reference.
cALT_REF_MSL	Altitude is referenced to MSL.
cALT_REF_AGL	Altitude is referenced to the terrain height.

EndPath

enum WsfPath::EndPath

End of-path option.

Enumerator
cEP_MOVER_DEFAULT	Use the WsfMover end-of-path option.
cEP_EXTRAPOLATE	Extrapolate at end-of-path.
cEP_STOP	Stop at end-of-path.
cEP_REMOVE	Remove the platform at end-of-path.

HdgRef

enum WsfPath::HdgRef

Heading reference option.

Enumerator
cHDG_REF_NORTH	North-relative.
cHDG_REF_RELATIVE	Implementation-defined (usually body-relative).

Switch

enum WsfPath::Switch

Option setting when to react as a WsfWaypoint is approached.

Enumerator
cSWITCH_MOVER_DEFAULT	Use the WsfMover switch setting.
cSWITCH_ON_TIME	Switch when a specified time since the last WsfWaypoint has elapsed.
cSWITCH_ON_DISTANCE	Switch when a specified distance since last WsfWaypoint has passed.
cSWITCH_ON_APPROACH	Switch when approaching within one turn radius of the WsfWaypoint.
cSWITCH_ON_PASSING	Switch only when abreast of the WsfWaypoint (DEFAULT).
cSWITCH_EXTERNAL	via software commands, or in script, or the path is being extrapolated. Ignore switching internally, as it is done externally

TurnDirection

enum WsfPath::TurnDirection

Turn direction for TurnToHeading and TurnToRelativeHeading.

Enumerator
cTURN_DIR_LEFT	Turn to the left, even if right is closer.
cTURN_DIR_SHORTEST	Turn in the direction that results in the shortest turn (DEFAULT).
cTURN_DIR_RIGHT	Turn to the right, even if left is closer.

Function Documentation

GetAltRef()

WsfPath::AltRef WsfPath::GetAltRef	(	AltRef	aMoverDefault,
		AltRef	aWaypointValue )

Obtain the altitude reference, allowing for the WsfWaypoint value to override the WsfMover default.

References cALT_REF_MOVER_DEFAULT.

Variable Documentation

cDOUBLE_NOT_SET

double WsfPath::cDOUBLE_NOT_SET = -1.0E-12

constexpr

Unique value, tested internally to see if a floating point value is set or defaulted.

Referenced by WsfIterativeRouteMover::AdvanceToNextWaypoint(), WsfMath3D_Mover::AdvanceToNextWaypoint(), WsfPathComputer::CreateTarget(), WsfNavigationMesh::FindPath(), WsfPathFinder::FindPath(), WsfPathGuidance::GetRadialAccelAtPoint(), WsfWaypointPathGuidance::GetRadialAccelAtPoint(), WsfRoute::GetTravelTime(), WsfRoute::GetTravelTimeToPosition(), WsfWaypointMover::Initialize(), WsfNavigationMesh::LineOfSightTest(), WsfRoadMover::MergeWaypoints(), WsfWaypoint::Print(), WsfWaypoint::ProcessInput(), WsfNavigationMesh::RefineFromCurrentPosition(), WsfIterativeRouteMover::SetGuidanceFrom(), WsfIterativeRouteMover::SetGuidanceTo(), WsfWaypointMover::SetGuidanceTo(), WsfRouteMover::SetRoutePoint(), WsfBrawlerMover::Update(), wsf::six_dof::GuidanceComputer::UpdateAimpoint(), WsfGuidanceComputer::UpdateAimpoint(), WsfP6DOF_GuidanceComputer::UpdateAimpoint(), UT_DEFINE_SCRIPT_METHOD(), UT_DEFINE_SCRIPT_METHOD(), and UT_DEFINE_SCRIPT_METHOD().

cGROUND_PROXIMITY_FUZZ

double WsfPath::cGROUND_PROXIMITY_FUZZ = 4.0

constexpr

Height delta, above which we are considered airborne.

Referenced by WsfAirMover::DestIsInAir().

cHEADING_FUZZ

double WsfPath::cHEADING_FUZZ = 5.0 * UtMath::cRAD_PER_DEG

constexpr

Heading error, below which we are considered to be on course (not turning).

Referenced by WsfPathGuidance::DetermineTheTurn(), and WsfWaypointPathGuidance::GetWPTargetInfo().

cNEGLIGIBLE_SPEED

double WsfPath::cNEGLIGIBLE_SPEED = 5280.0 / 3600.0 * UtMath::cM_PER_FT

constexpr

Speed below which an object is not considered to be moving:

Referenced by WsfWaypointPathGuidance::GetWPTargetInfo(), and WsfFollower::ImposeTurnLimits().

cUSE_COMPUTED

double WsfPath::cUSE_COMPUTED = -1.0E-14

constexpr

A waypoint parameter with this value is a request to use a computed value to reach the target with a constant rate (climb_rate, acceleration ...)

cUSE_DEFAULT

double WsfPath::cUSE_DEFAULT = -1.0E-13

constexpr

A waypoint parameter with this value is a request to use the mover's default value. (i.e.: maximum_radial_acceleration).

Referenced by WsfWaypointMover::UpdateConstraints().

cUSE_PREVIOUS

double WsfPath::cUSE_PREVIOUS = WsfPath::cDOUBLE_NOT_SET

constexpr

A waypoint parameter with this value is a request to use the previously used value. (i.e.: the current speed).

Referenced by WsfP6DOF_Mover::ConvertWsfRouteToP6DofRoute(), wsf::six_dof::Mover::ConvertWsfRouteToSixDOF_Route(), WsfPathComputer::CreateTarget(), WsfBrawlerMover::Initialize(), WsfWaypoint::Print(), WsfMath3D_Mover::SetGuidanceFrom(), WsfMath3D_Mover::SetGuidanceTo(), WsfBrawlerMover::UpdateRoute(), UT_DEFINE_SCRIPT_METHOD(), UT_DEFINE_SCRIPT_METHOD(), UT_DEFINE_SCRIPT_METHOD(), UT_DEFINE_SCRIPT_METHOD(), UT_DEFINE_SCRIPT_METHOD(), UT_DEFINE_SCRIPT_METHOD(), UT_DEFINE_SCRIPT_METHOD(), UT_DEFINE_SCRIPT_METHOD(), UT_DEFINE_SCRIPT_METHOD(), and WsfWaypoint::WsfWaypoint().