Warning: include(php/utility.php): Failed to open stream: No such file or directory in /home/argos/argos3/doc/api/embedded/a03714.php on line 2

Warning: include(): Failed opening 'php/utility.php' for inclusion (include_path='.:/usr/lib64/php') in /home/argos/argos3/doc/api/embedded/a03714.php on line 2
The ARGoS Website

Public Slots | Signals | Public Member Functions | List of all members
argos::CQTOpenGLMainWindow Class Reference

#include <qtopengl_main_window.h>

Inheritance diagram for argos::CQTOpenGLMainWindow:
Inheritance graph
[legend]
Collaboration diagram for argos::CQTOpenGLMainWindow:
Collaboration graph
[legend]

Public Slots

void PlayExperiment ()
 Plays the experiment. More...
 
void FastForwardExperiment ()
 Fast forwards the experiment. More...
 
void StepExperiment ()
 Executes one experiment time step. More...
 
void PauseExperiment ()
 Pauses the experiment. More...
 
void TerminateExperiment ()
 Terminates the execution of the experiment. More...
 
void ResetExperiment ()
 Resets the state of the experiment to its state right after initialization. More...
 
void SuspendExperiment ()
 Suspends an experiment due to an error. More...
 
void ResumeExperiment ()
 Resumes a suspended experiment. More...
 
void CameraXMLPopUp ()
 
QString GetCameraXMLData ()
 
void SwitchCamera (QAction *)
 

Signals

void CameraSwitched (int n_camera)
 Emitted whenever the user presses a camera button to switch camera. More...
 
void ExperimentStarted ()
 Emitted when the experiment has just been started. More...
 
void ExperimentPlaying ()
 Emitted when the experiment has (re)started playing. More...
 
void ExperimentFastForwarding ()
 Emitted when the experiment has (re)started fast-forwarding. More...
 
void ExperimentPaused ()
 Emitted when the experiment has been paused. More...
 
void ExperimentSuspended ()
 Emitted when the experiment has been suspended. More...
 
void ExperimentResumed ()
 Emitted when the experiment has just been resumed. More...
 
void ExperimentDone ()
 Emitted when the experiment is finished. More...
 
void ExperimentReset ()
 Emitted when the experiment has been reset. More...
 

Public Member Functions

 CQTOpenGLMainWindow (TConfigurationNode &t_tree)
 
virtual ~CQTOpenGLMainWindow ()
 
CQTOpenGLWidget & GetOpenGLWidget ()
 
const CQTOpenGLWidget & GetOpenGLWidget () const
 
CQTOpenGLUserFunctions & GetUserFunctions ()
 
const CQTOpenGLUserFunctions & GetUserFunctions () const
 
const QString & GetIconDir () const
 
const QString & GetTextureDir () const
 
const QString & GetModelDir () const
 

Detailed Description

Definition at line 36 of file qtopengl_main_window.h.

Constructor & Destructor Documentation

◆ CQTOpenGLMainWindow()

argos::CQTOpenGLMainWindow::CQTOpenGLMainWindow ( TConfigurationNode &  t_tree)

Definition at line 127 of file qtopengl_main_window.cpp.

◆ ~CQTOpenGLMainWindow()

argos::CQTOpenGLMainWindow::~CQTOpenGLMainWindow ( )
virtual

Definition at line 174 of file qtopengl_main_window.cpp.

Member Function Documentation

◆ CameraSwitched

void argos::CQTOpenGLMainWindow::CameraSwitched ( int  n_camera)
signal

Emitted whenever the user presses a camera button to switch camera.

Parameters
n_cameraThe index of the desired camera

◆ CameraXMLPopUp

void argos::CQTOpenGLMainWindow::CameraXMLPopUp ( )
slot

Definition at line 891 of file qtopengl_main_window.cpp.

◆ ExperimentDone

void argos::CQTOpenGLMainWindow::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.

◆ ExperimentFastForwarding

void argos::CQTOpenGLMainWindow::ExperimentFastForwarding ( )
signal

Emitted when the experiment has (re)started fast-forwarding.

◆ ExperimentPaused

void argos::CQTOpenGLMainWindow::ExperimentPaused ( )
signal

Emitted when the experiment has been paused.

The difference between pausing and suspending an experiment is that pausing results from an action of the user; suspending is caused by an error condition. To resume execution, call PlayExperiment() or FastForwardExperiment().

◆ ExperimentPlaying

void argos::CQTOpenGLMainWindow::ExperimentPlaying ( )
signal

Emitted when the experiment has (re)started playing.

◆ ExperimentReset

void argos::CQTOpenGLMainWindow::ExperimentReset ( )
signal

Emitted when the experiment has been reset.

◆ ExperimentResumed

void argos::CQTOpenGLMainWindow::ExperimentResumed ( )
signal

Emitted when the experiment has just been resumed.

This marks the fact that the error condition has been solved.

◆ ExperimentStarted

void argos::CQTOpenGLMainWindow::ExperimentStarted ( )
signal

Emitted when the experiment has just been started.

◆ ExperimentSuspended

void argos::CQTOpenGLMainWindow::ExperimentSuspended ( )
signal

Emitted when the experiment has been suspended.

The difference between pausing and suspending an experiment is that pausing results from an action of the user; suspending is caused by an error condition. To resume execution, call ResumeExperiment().

◆ FastForwardExperiment

void argos::CQTOpenGLMainWindow::FastForwardExperiment ( )
slot

Fast forwards the experiment.

Internally sets a timer whose period is 1ms.

Definition at line 683 of file qtopengl_main_window.cpp.

◆ GetCameraXMLData

QString argos::CQTOpenGLMainWindow::GetCameraXMLData ( )
slot

Definition at line 941 of file qtopengl_main_window.cpp.

◆ GetIconDir()

const QString& argos::CQTOpenGLMainWindow::GetIconDir ( ) const
inline

Definition at line 61 of file qtopengl_main_window.h.

◆ GetModelDir()

const QString& argos::CQTOpenGLMainWindow::GetModelDir ( ) const
inline

Definition at line 69 of file qtopengl_main_window.h.

◆ GetOpenGLWidget() [1/2]

CQTOpenGLWidget& argos::CQTOpenGLMainWindow::GetOpenGLWidget ( )
inline

Definition at line 45 of file qtopengl_main_window.h.

◆ GetOpenGLWidget() [2/2]

const CQTOpenGLWidget& argos::CQTOpenGLMainWindow::GetOpenGLWidget ( ) const
inline

Definition at line 49 of file qtopengl_main_window.h.

◆ GetTextureDir()

const QString& argos::CQTOpenGLMainWindow::GetTextureDir ( ) const
inline

Definition at line 65 of file qtopengl_main_window.h.

◆ GetUserFunctions() [1/2]

CQTOpenGLUserFunctions& argos::CQTOpenGLMainWindow::GetUserFunctions ( )
inline

Definition at line 53 of file qtopengl_main_window.h.

◆ GetUserFunctions() [2/2]

const CQTOpenGLUserFunctions& argos::CQTOpenGLMainWindow::GetUserFunctions ( ) const
inline

Definition at line 57 of file qtopengl_main_window.h.

◆ PauseExperiment

void argos::CQTOpenGLMainWindow::PauseExperiment ( )
slot

Pauses the experiment.

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

Definition at line 740 of file qtopengl_main_window.cpp.

◆ PlayExperiment

void argos::CQTOpenGLMainWindow::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 650 of file qtopengl_main_window.cpp.

◆ ResetExperiment

void argos::CQTOpenGLMainWindow::ResetExperiment ( )
slot

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

Definition at line 807 of file qtopengl_main_window.cpp.

◆ ResumeExperiment

void argos::CQTOpenGLMainWindow::ResumeExperiment ( )
slot

Resumes a suspended experiment.

Definition at line 865 of file qtopengl_main_window.cpp.

◆ StepExperiment

void argos::CQTOpenGLMainWindow::StepExperiment ( )
slot

Executes one experiment time step.

Definition at line 714 of file qtopengl_main_window.cpp.

◆ SuspendExperiment

void argos::CQTOpenGLMainWindow::SuspendExperiment ( )
slot

Suspends an experiment due to an error.

Definition at line 843 of file qtopengl_main_window.cpp.

◆ SwitchCamera

void argos::CQTOpenGLMainWindow::SwitchCamera ( QAction *  pc_action)
slot

Definition at line 1069 of file qtopengl_main_window.cpp.

◆ TerminateExperiment

void argos::CQTOpenGLMainWindow::TerminateExperiment ( )
slot

Terminates the execution of the experiment.

Definition at line 769 of file qtopengl_main_window.cpp.