LookAtDemoPlugin Class Reference

A GUI plugin that demos the ignition::math::Matrix4<T>::LookAt function. More...

#include <LookAtDemoPlugin.hh>

Inherits GUIPlugin.

Public Types

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

Public Member Functions

 LookAtDemoPlugin ()
 Constructor. More...
 
virtual ~LookAtDemoPlugin ()
 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...
 
void Load (sdf::ElementPtr)
 Load function. More...
 

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 demos the ignition::math::Matrix4<T>::LookAt function.

The plugin offers 3 input fields (XYZ) for each of 3 vectors: the position of the eye, the position of the target and the desired up direction. See more documentation on ignition math.

It works with the lookat_demo.world, and expects that world to have 3 models:

  1. "frame": A model representing the resulting frame, the one which "looks at"
  2. "target": A yellow sphere representing the target which is being "looked at"
  3. "desired_z": A single axis, representing the desired Z axis.

Member Typedef Documentation

typedef boost::shared_ptr<GUIPlugin > TPtr
inherited

plugin pointer type definition

Constructor & Destructor Documentation

Constructor.

virtual ~LookAtDemoPlugin ( )
virtual

Destructor.

Member Function Documentation

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

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

It locates the shared library and loads it dynamically.

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

Get the name of the handler.

std::string GetHandle ( ) const
inlineinherited

Get the short name of the handler.

PluginType GetType ( ) const
inlineinherited

Returns the type of the plugin.

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

Load function.

Called when a plugin is first created. This function should not be blocking. This function is only called when a GUI plugin is loaded from an SDF file. This function is not called when a GUI plugin is loaded via a gui.ini file.

Parameters
[in]_sdfPointer the the SDF element of the plugin. This is the plugin SDF, <plugin ...>, and its children.

Reimplemented from GUIPlugin.

Member Data Documentation

std::string filename
protectedinherited

Path to the shared library file.

std::string handleName
protectedinherited

Short name.

PluginType type
protectedinherited

Type of plugin.

Referenced by GUIPlugin::GUIPlugin().


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