CessnaGUIPlugin Class Reference

A GUI plugin that controls the Cessna model using the keyboard. More...

#include <CessnaGUIPlugin.hh>

Inherits GUIPlugin.

Public Types

typedef boost::shared_ptr
< GUIPlugin
 plugin pointer type definition More...

Public Member Functions

 CessnaGUIPlugin ()
 Constructor. More...
virtual ~CessnaGUIPlugin ()
 Destructor. More...
std::string GetFilename () const
 Get the name of the handler. More...
std::string GetHandle () const
 Get the short name of the handler. More...
PluginType GetType () const
 Returns the type of the plugin. More...
virtual void Load (sdf::ElementPtr)
 Load function. More...
virtual void paintEvent (QPaintEvent *)

Static Public Member Functions

static TPtr Create (const std::string &_filename, const std::string &_name)
 a class method that creates a plugin from a file name. More...

Protected Attributes

std::string filename
 Path to the shared library file. More...
std::string handleName
 Short name. More...
PluginType type
 Type of plugin. More...

Detailed Description

A GUI plugin that controls the Cessna model using the keyboard.

If you are reading this, feel free to improve this plugin by adding graphical widgets to make the demo more interesting and fun.

Keyboard controls: w Increase thrust (+10 %) s Decrease thrust (-10 %) d Increase rudder angle (+1 degree) a Decrease rudder angle (-1 degree) Left-Key Left roll (+1 degree) Right-Key Right roll (+1 degree) Up-Key Pitch down (+1 degree) Down-Key Pitch up (+1 degree) 1 Preset for take-off 2 Preset for cruise 3 Preset for landing

Member Typedef Documentation

typedef boost::shared_ptr<GUIPlugin > TPtr

plugin pointer type definition

Constructor & Destructor Documentation


virtual ~CessnaGUIPlugin ( )


Member Function Documentation

static TPtr Create ( const std::string &  _filename,
const std::string &  _name 

a class method that creates a plugin from a file name.

It locates the shared library and loads it dynamically.

[in]_filenamethe path to the shared library.
[in]_nameshort name of the plugin
Shared Pointer to this class type
std::string GetFilename ( ) const

Get the name of the handler.

std::string GetHandle ( ) const

Get the short name of the handler.

PluginType GetType ( ) const

Returns the type of the plugin.

type of the plugin
virtual void Load ( sdf::ElementPtr  )

Load function.

Called when a plugin is first created. This function should not be blocking. This function will be called with an empty sdf element when a GUI plugin is loaded via a gui.ini file or via a command line argument.

[in]_sdfPointer the the SDF element of the plugin. This is the plugin SDF, <plugin ...>, and its children. It will be an empty element when loaded from INI file or command line argument.

Reimplemented in TimerGUIPlugin, and LookAtDemoPlugin.

virtual void paintEvent ( QPaintEvent *  )

Member Data Documentation

std::string filename

Path to the shared library file.

std::string handleName

Short name.

PluginType type

Type of plugin.

Referenced by GUIPlugin::GUIPlugin().

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