#include <qtopengl_widget.h>

Inheritance diagram for argos::CQTOpenGLWidget:

Classes
struct	SFrameGrabData
	Data regarding frame grabbing. More...

struct	SSelectionInfo
	Data arelated to robot selection. More...

Public Slots
void	PlayExperiment ()
	Plays the experiment.

void	FastForwardExperiment ()
	Fast forwards the experiment.

void	PauseExperiment ()
	Pauses the experiment.

void	StepExperiment ()
	Executes one experiment time step.

void	ResetExperiment ()
	Resets the state of the experiment to its state right after initialization.

void	SetDrawFrameEvery (int n_every)
	When fast-forwarding, sets every how many steps a frame must be drawn.

void	SetGrabFrame (bool b_grab_on)
	Toggles frame grabbing.

void	SetCamera (int n_camera)
	Sets the current camera in use.

void	SetCameraFocalLength (double f_length)
	Sets the focal length of the current camera.

void	KeyPressed (QKeyEvent *pc_event)
	Handles key press events.

void	KeyReleased (QKeyEvent *pc_event)
	Handles key release events.

Signals
void	StepDone (int n_step)
	Emitted whenever a time step has been executed.

void	ExperimentDone ()
	Emitted when the experiment is finished.

void	EntitySelected (CEntity *pc_entity)
	Emitted when an entity is selected.

void	EntityDeselected (CEntity *pc_entity)
	Emitted when an entity is deselected.

Public Member Functions
	CQTOpenGLWidget (QWidget *pc_parent, CQTOpenGLMainWindow &c_main_window, CQTOpenGLUserFunctions &c_user_functions)
	Class constructor.

virtual	~CQTOpenGLWidget ()
	Class destructor.

virtual void	initializeGL ()
	Called when the GL context must be initialized.

virtual void	paintGL ()
	Logic for scene drawing.

CRay3	RayFromWindowCoord (int n_x, int n_y)
	Casts a ray from the given window coordinate.

CVector3	GetWindowCoordInWorld (int n_x, int n_y)
	Returns the position in the world corresponding to the given window coordinate.

CEntity *	GetSelectedEntity ()
	Returns the currently selected entity, or NULL if none is selected.

void	SelectEntity (CEntity &c_entity)
	Selects the passed entity.

void	DeselectEntity ()
	Deselects the currently selected entity.

void	SelectInScene (UInt32 un_x, UInt32 un_y)
	Selects the entity closest to the camera at the given screen coordinates.

void	DrawEntity (CPositionalEntity &c_entity)
	Draws a positional entity.

void	DrawEntity (CEmbodiedEntity &c_entity)
	Draws an embodied entity.

void	DrawRays (CControllableEntity &c_entity)
	Draws a ray.

void	DrawBoundingBox (CEmbodiedEntity &c_entity)
	Draws the bounding box of an embodied entity.

virtual int	heightForWidth (int w) const
	Called internally by Qt to set the aspect ratio.

virtual QSize	sizeHint () const
	Called internally by Qt to know the preferred widget size.

virtual QSize	minimumSize () const
	Called internally by Qt to know the minimum widget size.

CQTOpenGLUserFunctions &	GetUserFunctions ()
	Returns a reference to the user functions.

CQTOpenGLCamera &	GetCamera ()
	Returns a reference to the camera.

SFrameGrabData &	GetFrameGrabData ()
	Returns the current frame grabbing data.

void	SetInvertMouse (bool b_invert_mouse)
	Sets whether the mouse should be inverted when moving.

void	SetShowBoundary (bool b_show_boundary)
	Sets whether the boundary walls should be rendered.

Protected Member Functions
void	DrawScene ()

void	DrawArena ()

void	DrawAxes ()

virtual void	timerEvent (QTimerEvent *pc_event)

virtual void	mousePressEvent (QMouseEvent *pc_event)

virtual void	mouseReleaseEvent (QMouseEvent *pc_event)

virtual void	mouseMoveEvent (QMouseEvent *pc_event)

virtual void	wheelEvent (QWheelEvent *pc_event)

virtual void	keyPressEvent (QKeyEvent *pc_event)

virtual void	keyReleaseEvent (QKeyEvent *pc_event)

virtual void	resizeEvent (QResizeEvent *pc_event)

void	reactToKeyEvent ()

Detailed Description

Definition at line 56 of file qtopengl_widget.h.

Constructor & Destructor Documentation

◆ CQTOpenGLWidget()

argos::CQTOpenGLWidget::CQTOpenGLWidget	(	QWidget *	pc_parent,
		CQTOpenGLMainWindow &	c_main_window,
		CQTOpenGLUserFunctions &	c_user_functions )

Class constructor.

Parameters

pc_parent	The containing widget.
pc_main_window	A pointer to the main window.
c_user_functions	A reference to the main window.

Definition at line 39 of file qtopengl_widget.cpp.

◆ ~CQTOpenGLWidget()

argos::CQTOpenGLWidget::~CQTOpenGLWidget ( )

virtual

Class destructor.

Definition at line 78 of file qtopengl_widget.cpp.

Member Function Documentation

◆ DeselectEntity()

void argos::CQTOpenGLWidget::DeselectEntity ( )

Deselects the currently selected entity.

If no entity is selected, nothing is done.

Definition at line 331 of file qtopengl_widget.cpp.

◆ DrawArena()

void argos::CQTOpenGLWidget::DrawArena ( )

protected

Definition at line 673 of file qtopengl_widget.cpp.

◆ DrawAxes()

void argos::CQTOpenGLWidget::DrawAxes ( )

protected

Definition at line 777 of file qtopengl_widget.cpp.

◆ DrawBoundingBox()

void argos::CQTOpenGLWidget::DrawBoundingBox ( CEmbodiedEntity & c_entity )

Draws the bounding box of an embodied entity.

Definition at line 428 of file qtopengl_widget.cpp.

◆ DrawEntity() [1/2]

void argos::CQTOpenGLWidget::DrawEntity ( CEmbodiedEntity & c_entity )

Draws an embodied entity.

Definition at line 376 of file qtopengl_widget.cpp.

◆ DrawEntity() [2/2]

void argos::CQTOpenGLWidget::DrawEntity ( CPositionalEntity & c_entity )

Draws a positional entity.

Definition at line 358 of file qtopengl_widget.cpp.

◆ DrawRays()

void argos::CQTOpenGLWidget::DrawRays ( CControllableEntity & c_entity )

Draws a ray.

Definition at line 394 of file qtopengl_widget.cpp.

◆ DrawScene()

void argos::CQTOpenGLWidget::DrawScene ( )

protected

◆ EntityDeselected

void argos::CQTOpenGLWidget::EntityDeselected ( CEntity * pc_entity )

signal

Emitted when an entity is deselected.

Parameters

The	deselected entity

◆ EntitySelected

void argos::CQTOpenGLWidget::EntitySelected ( CEntity * pc_entity )

signal

Emitted when an entity is selected.

Parameters

The	selected entity

◆ ExperimentDone

void argos::CQTOpenGLWidget::ExperimentDone ( )

signal

Emitted when the experiment is finished.

An experiment can finish "naturally", when CSimulator::IsExperimentFinished() returns true; or "forcedly", when the user pressed the terminate button.

◆ FastForwardExperiment

void argos::CQTOpenGLWidget::FastForwardExperiment ( )

slot

Fast forwards the experiment.

Internally sets a timer whose period is 1ms.

Definition at line 493 of file qtopengl_widget.cpp.

◆ GetCamera()

CQTOpenGLCamera & argos::CQTOpenGLWidget::GetCamera ( )

inline

Returns a reference to the camera.

Definition at line 218 of file qtopengl_widget.h.

◆ GetFrameGrabData()

SFrameGrabData & argos::CQTOpenGLWidget::GetFrameGrabData ( )

inline

Returns the current frame grabbing data.

Definition at line 225 of file qtopengl_widget.h.

◆ GetSelectedEntity()

CEntity * argos::CQTOpenGLWidget::GetSelectedEntity ( )

Returns the currently selected entity, or NULL if none is selected.

Returns: The currently selected entity.

Definition at line 297 of file qtopengl_widget.cpp.

◆ GetUserFunctions()

CQTOpenGLUserFunctions & argos::CQTOpenGLWidget::GetUserFunctions ( )

inline

Returns a reference to the user functions.

Definition at line 211 of file qtopengl_widget.h.

◆ GetWindowCoordInWorld()

CVector3 argos::CQTOpenGLWidget::GetWindowCoordInWorld	(	int	n_x,
		int	n_y )

Returns the position in the world corresponding to the given window coordinate.

Definition at line 255 of file qtopengl_widget.cpp.

◆ heightForWidth()

virtual int argos::CQTOpenGLWidget::heightForWidth ( int w ) const

inlinevirtual

Called internally by Qt to set the aspect ratio.

Definition at line 190 of file qtopengl_widget.h.

◆ initializeGL()

void argos::CQTOpenGLWidget::initializeGL ( )

virtual

Called when the GL context must be initialized.

This happens once per runtime, either before the first call to resizeGL() or to paintGL().

Definition at line 90 of file qtopengl_widget.cpp.

◆ KeyPressed

void argos::CQTOpenGLWidget::KeyPressed ( QKeyEvent * pc_event )

slot

Handles key press events.

Definition at line 581 of file qtopengl_widget.cpp.

◆ keyPressEvent()

void argos::CQTOpenGLWidget::keyPressEvent ( QKeyEvent * pc_event )

protectedvirtual

Definition at line 942 of file qtopengl_widget.cpp.

◆ KeyReleased

void argos::CQTOpenGLWidget::KeyReleased ( QKeyEvent * pc_event )

slot

Handles key release events.

Definition at line 627 of file qtopengl_widget.cpp.

◆ keyReleaseEvent()

void argos::CQTOpenGLWidget::keyReleaseEvent ( QKeyEvent * pc_event )

protectedvirtual

Definition at line 949 of file qtopengl_widget.cpp.

◆ minimumSize()

virtual QSize argos::CQTOpenGLWidget::minimumSize ( ) const

inlinevirtual

Called internally by Qt to know the minimum widget size.

Definition at line 204 of file qtopengl_widget.h.

◆ mouseMoveEvent()

void argos::CQTOpenGLWidget::mouseMoveEvent ( QMouseEvent * pc_event )

protectedvirtual

Definition at line 872 of file qtopengl_widget.cpp.

◆ mousePressEvent()

void argos::CQTOpenGLWidget::mousePressEvent ( QMouseEvent * pc_event )

protectedvirtual

Definition at line 790 of file qtopengl_widget.cpp.

◆ mouseReleaseEvent()

void argos::CQTOpenGLWidget::mouseReleaseEvent ( QMouseEvent * pc_event )

protectedvirtual

Definition at line 817 of file qtopengl_widget.cpp.

◆ paintGL()

void argos::CQTOpenGLWidget::paintGL ( )

virtual

Logic for scene drawing.

Definition at line 130 of file qtopengl_widget.cpp.

◆ PauseExperiment

void argos::CQTOpenGLWidget::PauseExperiment ( )

slot

Pauses the experiment.

The experiment can be resumed with PlayExperiment() or FastForwardExperiment().

Definition at line 503 of file qtopengl_widget.cpp.

◆ PlayExperiment

void argos::CQTOpenGLWidget::PlayExperiment ( )

slot

Plays the experiment.

Internally sets a timer whose period corresponds to the XML attribute 'ticks_per_second' in the .argos file.

Definition at line 484 of file qtopengl_widget.cpp.

◆ RayFromWindowCoord()

CRay3 argos::CQTOpenGLWidget::RayFromWindowCoord	(	int	n_x,
		int	n_y )

Casts a ray from the given window coordinate.

The ray goes from the near clipping plane to the far one.

Definition at line 209 of file qtopengl_widget.cpp.

◆ reactToKeyEvent()

void argos::CQTOpenGLWidget::reactToKeyEvent ( )

protected

Definition at line 956 of file qtopengl_widget.cpp.

◆ ResetExperiment

void argos::CQTOpenGLWidget::ResetExperiment ( )

slot

Resets the state of the experiment to its state right after initialization.

Definition at line 537 of file qtopengl_widget.cpp.

◆ resizeEvent()

void argos::CQTOpenGLWidget::resizeEvent ( QResizeEvent * pc_event )

protectedvirtual

Definition at line 981 of file qtopengl_widget.cpp.

◆ SelectEntity()

void argos::CQTOpenGLWidget::SelectEntity ( CEntity & c_entity )

Selects the passed entity.

Parameters

c_entity The entity to select.

Definition at line 306 of file qtopengl_widget.cpp.

◆ SelectInScene()

void argos::CQTOpenGLWidget::SelectInScene	(	UInt32	un_x,
		UInt32	un_y )

Selects the entity closest to the camera at the given screen coordinates.

Parameters

un_x	The screen X coordinate.
un_y	The screen Y coordinate.

Definition at line 345 of file qtopengl_widget.cpp.

◆ SetCamera

void argos::CQTOpenGLWidget::SetCamera ( int n_camera )

slot

Sets the current camera in use.

Parameters

n_camera The index of the wanted camera [0-11]

Definition at line 563 of file qtopengl_widget.cpp.

◆ SetCameraFocalLength

void argos::CQTOpenGLWidget::SetCameraFocalLength ( double f_length )

slot

Sets the focal length of the current camera.

Parameters

f_length The desired focal length

Definition at line 572 of file qtopengl_widget.cpp.

◆ SetDrawFrameEvery

void argos::CQTOpenGLWidget::SetDrawFrameEvery ( int n_every )

slot

When fast-forwarding, sets every how many steps a frame must be drawn.

Definition at line 549 of file qtopengl_widget.cpp.

◆ SetGrabFrame

void argos::CQTOpenGLWidget::SetGrabFrame ( bool b_grab_on )

slot

Toggles frame grabbing.

Definition at line 556 of file qtopengl_widget.cpp.

◆ SetInvertMouse()

void argos::CQTOpenGLWidget::SetInvertMouse ( bool b_invert_mouse )

inline

Sets whether the mouse should be inverted when moving.

Definition at line 232 of file qtopengl_widget.h.

◆ SetShowBoundary()

void argos::CQTOpenGLWidget::SetShowBoundary ( bool b_show_boundary )

inline

Sets whether the boundary walls should be rendered.

Definition at line 239 of file qtopengl_widget.h.

◆ sizeHint()

virtual QSize argos::CQTOpenGLWidget::sizeHint ( ) const

inlinevirtual

Called internally by Qt to know the preferred widget size.

Definition at line 197 of file qtopengl_widget.h.

◆ StepDone

void argos::CQTOpenGLWidget::StepDone ( int n_step )

signal

Emitted whenever a time step has been executed.

Parameters

n_step The time-step count

◆ StepExperiment

void argos::CQTOpenGLWidget::StepExperiment ( )

slot

Executes one experiment time step.

Definition at line 512 of file qtopengl_widget.cpp.

◆ timerEvent()

void argos::CQTOpenGLWidget::timerEvent ( QTimerEvent * pc_event )

protectedvirtual

Definition at line 783 of file qtopengl_widget.cpp.

◆ wheelEvent()

void argos::CQTOpenGLWidget::wheelEvent ( QWheelEvent * pc_event )

protectedvirtual

Definition at line 909 of file qtopengl_widget.cpp.

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

plugins/simulator/visualizations/qt-opengl/qtopengl_widget.h
plugins/simulator/visualizations/qt-opengl/qtopengl_widget.cpp

Classes

Public Slots

Signals

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ CQTOpenGLWidget()

◆ ~CQTOpenGLWidget()

Member Function Documentation

◆ DeselectEntity()

◆ DrawArena()

◆ DrawAxes()

◆ DrawBoundingBox()

◆ DrawEntity() [1/2]

◆ DrawEntity() [2/2]

◆ DrawRays()

◆ DrawScene()

◆ EntityDeselected

◆ EntitySelected

◆ ExperimentDone

◆ FastForwardExperiment

◆ GetCamera()

◆ GetFrameGrabData()

◆ GetSelectedEntity()

◆ GetUserFunctions()

◆ GetWindowCoordInWorld()

◆ heightForWidth()

◆ initializeGL()

◆ KeyPressed

◆ keyPressEvent()

◆ KeyReleased

◆ keyReleaseEvent()

◆ minimumSize()

◆ mouseMoveEvent()

◆ mousePressEvent()

◆ mouseReleaseEvent()

◆ paintGL()

◆ PauseExperiment

◆ PlayExperiment

◆ RayFromWindowCoord()

◆ reactToKeyEvent()

◆ ResetExperiment

◆ resizeEvent()

◆ SelectEntity()

◆ SelectInScene()

◆ SetCamera

◆ SetCameraFocalLength

◆ SetDrawFrameEvery

◆ SetGrabFrame

◆ SetInvertMouse()

◆ SetShowBoundary()

◆ sizeHint()

◆ StepDone

◆ StepExperiment

◆ timerEvent()

◆ wheelEvent()