GripTab Class Reference

This class is used as an interface for defining plugins The aim is to ensure that all methods declared in this class are defined in the plugins. More...

#include <GripTab.h>

Inheritance diagram for GripTab:

List of all members.

Public Member Functions
virtual void	Refresh ()=0
	called from the main window whenever a new scene is loaded
virtual void	Load (TreeViewReturn *ret, ViewerWidget *viewer, dart::simulation::World *world, std::vector< GripTimeslice > *timeline)
	called from the main window whenever the plugin is added to grip This is initalize the members of the class
virtual void	GRIPEventSceneLoaded ()
	called when a new scene file (urdf, sdf) is loaded into Grip. This signifies that there are skeletons in the world, the viewer is displaying the objects in the world and the TreeView is populated
virtual void	GRIPEventSimulationBeforeTimestep ()
	called from the main window whenever the simulation is executing This method is executed before every simulation time step
virtual void	GRIPEventSimulationAfterTimestep ()
	called from the main window whenever the simulation is executing This method is executed after every simulation time step
virtual void	GRIPEventSimulationStart ()
	called from the main window whenever the simulation is executing This method is executed at the start of the simulation
virtual void	GRIPEventSimulationStop ()
	called from the main window whenever the simulation is executing This method is executed at the end of the simulation
virtual void	GRIPEventPlaybackBeforeFrame ()
	called from the main window whenever the simulation history slider is being played This method is executed before every playback time step
virtual void	GRIPEventPlaybackAfterFrame ()
	called from the main window whenever the simulation history slider is being played This method is executed after every playback time step
virtual void	GRIPEventPlaybackStart ()
	called from the main window whenever the simulation history slider is being played This method is executed at the start of the playback
virtual void	GRIPEventPlaybackStop ()
	called from the main window whenever the simulation history slider is being played This method is executed at the end of the playback
virtual void	GRIPEventTreeViewSelectionChanged ()
	called from the main window when a new object is selected in the treeview
Protected Attributes
TreeViewReturn *	_activeNode
ViewerWidget *	_viewWidget
	pointer to the osg viewer
dart::simulation::World *	_world
	pointer to simulation world object that is being rendered and simulated
std::vector< GripTimeslice > *	_timeline

---

Detailed Description

This class is used as an interface for defining plugins The aim is to ensure that all methods declared in this class are defined in the plugins.

---

Member Function Documentation

virtual void GripTab::Load	(	TreeViewReturn *	ret,
		ViewerWidget *	viewer,
		dart::simulation::World *	world,
		std::vector< GripTimeslice > *	timeline
	)		[inline, virtual]

called from the main window whenever the plugin is added to grip This is initalize the members of the class

Parameters:

ret	Pointer to object returned by the TreeView
viewer	Pointer to composite viewer object where things are rendered
world	Pointer to the dart world simulation object
timeline	Array of GripTimesclie object for simulation and kinematic playback

---

Member Data Documentation

TreeViewReturn* GripTab::_activeNode [protected]

used to manipulate the objects in the main window pointer to the object selected in the Tree View

std::vector<GripTimeslice>* GripTab::_timeline [protected]

pointer to the timeline, which holds a GripTimeslice objects. These contain the state and time of the world. To use just call timeline->push_back(GripTimeslice(*world));

---

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

• /home/pete/myRepos/grip2/qtWidgets/GripTab.h