Detailed Description

The struct for requesting navigation requests for a sequence of waypoints.

Used in CWaypointsNavigator::navigateWaypoints(). Users can directly fill in the list of waypoints manipulating the public field waypoints.

Definition at line 78 of file TWaypoint.h.

#include <mrpt/nav/reactive/TWaypoint.h>

Public Member Functions
void	clear ()

	TWaypointSequence ()
	Ctor with default values. More...

std::string	getAsText () const
	Gets navigation params as a human-readable format. More...

void	getAsOpenglVisualization (mrpt::opengl::CSetOfObjects &obj, const mrpt::nav::TWaypointsRenderingParams &params=mrpt::nav::TWaypointsRenderingParams()) const
	Renders the sequence of waypoints (previous contents of `obj` are cleared) More...

void	save (mrpt::utils::CConfigFileBase &c, const std::string &s) const
	Saves waypoints to a config file section. More...

void	load (const mrpt::utils::CConfigFileBase &c, const std::string &s)
	Loads waypoints to a config file section. More...

Public Attributes
std::vector< TWaypoint >	waypoints

Constructor & Destructor Documentation

◆ TWaypointSequence()

TWaypointSequence::TWaypointSequence ( )

Ctor with default values.

Definition at line 74 of file TWaypoint.cpp.

Member Function Documentation

◆ clear()

void mrpt::nav::TWaypointSequence::clear ( )

inline

Definition at line 82 of file TWaypoint.h.

Referenced by load().

◆ getAsOpenglVisualization()

void TWaypointSequence::getAsOpenglVisualization	(	mrpt::opengl::CSetOfObjects &	obj,
		const mrpt::nav::TWaypointsRenderingParams &	params = `mrpt::nav::TWaypointsRenderingParams()`
	)		const

Renders the sequence of waypoints (previous contents of obj are cleared)

Definition at line 149 of file TWaypoint.cpp.

References mrpt::opengl::CDisk::Create(), mrpt::opengl::CArrow::Create(), mrpt::mrpt::format(), mrpt::nav::TWaypoint::INVALID_NUM, and waypoints.

◆ getAsText()

std::string TWaypointSequence::getAsText ( ) const

Gets navigation params as a human-readable format.

Definition at line 79 of file TWaypoint.cpp.

References mrpt::mrpt::format(), and waypoints.

◆ load()

void TWaypointSequence::load	(	const mrpt::utils::CConfigFileBase &	c,
		const std::string &	s
	)

Loads waypoints to a config file section.

Definition at line 233 of file TWaypoint.cpp.

References clear(), mrpt::mrpt::format(), mrpt::nav::TWaypoint::INVALID_NUM, and waypoints.

◆ save()

void TWaypointSequence::save	(	mrpt::utils::CConfigFileBase &	c,
		const std::string &	s
	)		const

Saves waypoints to a config file section.

Definition at line 212 of file TWaypoint.cpp.

References mrpt::mrpt::format(), and waypoints.

Member Data Documentation

◆ waypoints

std::vector<TWaypoint> mrpt::nav::TWaypointSequence::waypoints

Definition at line 80 of file TWaypoint.h.

Referenced by getAsOpenglVisualization(), getAsText(), load(), mrpt::nav::CWaypointsNavigator::navigateWaypoints(), and save().