carla::client::DebugHelper Class Reference

#include <DebugHelper.h>

Public Types
using	Color = sensor::data::Color

Public Member Functions
void	ClearDebugShape ()
	Clear every persistent debug shape (lines, points, boxes, arrows) previously drawn from this world.
void	ClearDebugString ()
	Clear every persistent debug string currently shown in the HUD.
	DebugHelper (detail::EpisodeProxy episode)
void	DrawArrow (const geom::Location &begin, const geom::Location &end, float thickness=0.1f, float arrow_size=0.1f, Color color=Color{255u, 0u, 0u}, float life_time=-1.0f, bool persistent_lines=true)
void	DrawBox (const geom::BoundingBox &box, const geom::Rotation &rotation, float thickness=0.1f, Color color=Color{255u, 0u, 0u}, float life_time=-1.0f, bool persistent_lines=true)
void	DrawLine (const geom::Location &begin, const geom::Location &end, float thickness=0.1f, Color color=Color{255u, 0u, 0u}, float life_time=-1.0f, bool persistent_lines=true)
void	DrawPoint (const geom::Location &location, float size=0.1f, Color color=Color{255u, 0u, 0u}, float life_time=-1.0f, bool persistent_lines=true)
void	DrawString (const geom::Location &location, const std::string &text, bool draw_shadow=false, Color color=Color{255u, 0u, 0u}, float life_time=-1.0f, bool persistent_lines=true)

Private Attributes
detail::EpisodeProxy	_episode

Detailed Description

Definition at line 18 of file DebugHelper.h.

Member Typedef Documentation

Color

using carla::client::DebugHelper::Color = sensor::data::Color

Definition at line 21 of file DebugHelper.h.

Constructor & Destructor Documentation

DebugHelper()

carla::client::DebugHelper::DebugHelper ( detail::EpisodeProxy  episode )

inlineexplicit

Definition at line 23 of file DebugHelper.h.

Member Function Documentation

ClearDebugShape()

void carla::client::DebugHelper::ClearDebugShape

(

)

Clear every persistent debug shape (lines, points, boxes, arrows) previously drawn from this world.

Definition at line 84 of file DebugHelper.cpp.

References _episode, and carla::client::detail::EpisodeProxyImpl< PointerT >::Lock().

ClearDebugString()

void carla::client::DebugHelper::ClearDebugString

(

)

Clear every persistent debug string currently shown in the HUD.

Definition at line 88 of file DebugHelper.cpp.

References _episode, and carla::client::detail::EpisodeProxyImpl< PointerT >::Lock().

DrawArrow()

void carla::client::DebugHelper::DrawArrow	(	const geom::Location &	begin,
		const geom::Location &	end,
		float	thickness = 0.1f,
		float	arrow_size = 0.1f,
		Color	color = Color{255u, 0u, 0u},
		float	life_time = -1.0f,
		bool	persistent_lines = true
	)

Definition at line 49 of file DebugHelper.cpp.

References _episode, and carla::client::DrawShape().

DrawBox()

void carla::client::DebugHelper::DrawBox	(	const geom::BoundingBox &	box,
		const geom::Rotation &	rotation,
		float	thickness = 0.1f,
		Color	color = Color{255u, 0u, 0u},
		float	life_time = -1.0f,
		bool	persistent_lines = true
	)

Definition at line 62 of file DebugHelper.cpp.

References _episode, and carla::client::DrawShape().

DrawLine()

void carla::client::DebugHelper::DrawLine	(	const geom::Location &	begin,
		const geom::Location &	end,
		float	thickness = 0.1f,
		Color	color = Color{255u, 0u, 0u},
		float	life_time = -1.0f,
		bool	persistent_lines = true
	)

Definition at line 38 of file DebugHelper.cpp.

References _episode, and carla::client::DrawShape().

DrawPoint()

void carla::client::DebugHelper::DrawPoint	(	const geom::Location &	location,
		float	size = 0.1f,
		Color	color = Color{255u, 0u, 0u},
		float	life_time = -1.0f,
		bool	persistent_lines = true
	)

Definition at line 28 of file DebugHelper.cpp.

References _episode, carla::client::DrawShape(), and point.

DrawString()

void carla::client::DebugHelper::DrawString	(	const geom::Location &	location,
		const std::string &	text,
		bool	draw_shadow = false,
		Color	color = Color{255u, 0u, 0u},
		float	life_time = -1.0f,
		bool	persistent_lines = true
	)

Definition at line 73 of file DebugHelper.cpp.

References _episode, and carla::client::DrawShape().

Member Data Documentation

_episode

detail::EpisodeProxy carla::client::DebugHelper::_episode

private

Definition at line 75 of file DebugHelper.h.

Referenced by ClearDebugShape(), ClearDebugString(), DrawArrow(), DrawBox(), DrawLine(), DrawPoint(), and DrawString().

---

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

• DebugHelper.h
• DebugHelper.cpp