#include <BaseGUI.h>
Static Protected Attributes | |
static std::string | mGuiName = "" |
static std::string | configDirectoryPath = "." |
static std::string | screenshotDirectoryPath = "." |
static const char * | mProgramName = nullptr |
static ArgumentParser * | mArgumentParser = nullptr |
Public Member Functions | |
virtual void | configureGUI (sofa::simulation::NodeSPtr groot) |
Use a component setting to configure our GUI. More... | |
void | exportGnuplot (sofa::simulation::Node *node, std::string gnuplot_directory="") |
virtual bool | canBeDefaultGUI () const |
methods each GUI must implement | |
Start the GUI loop | |
virtual int | mainLoop ()=0 |
virtual void | redraw ()=0 |
Update the GUI. More... | |
virtual int | closeGUI ()=0 |
Close the GUI. More... | |
virtual void | setScene (sofa::simulation::NodeSPtr groot, const char *filename=nullptr, bool temporaryFile=false)=0 |
Register the scene in our GUI. More... | |
virtual sofa::simulation::Node * | currentSimulation ()=0 |
Get the rootNode of the sofa scene. More... | |
methods to configure the GUI | |
virtual void | setDumpState (bool) |
virtual void | setLogTime (bool) |
virtual void | setExportState (bool) |
virtual void | setGnuplotPath (const std::string &) |
virtual void | initViewer (BaseViewer *) |
virtual void | setViewerConfiguration (sofa::component::setting::ViewerSetting *) |
virtual void | setViewerResolution (int, int) |
virtual void | setFullScreen () |
virtual void | centerWindow () |
virtual void | setBackgroundColor (const sofa::type::RGBAColor &) |
virtual void | setBackgroundImage (const std::string &) |
virtual BaseViewer * | getViewer () |
virtual void | registerViewer (BaseViewer *) |
virtual bool | saveScreenshot (const std::string &filename, int compression_level=-1) |
virtual void | setMouseButtonConfiguration (sofa::component::setting::MouseButtonSetting *) |
methods to communicate with the GUI | |
Do one step of the GUI loop | |
virtual void | stepMainLoop () |
virtual void | sendMessage (const std::string &, const std::string &) |
Send a (script) message. More... | |
virtual void | showFPS (double) |
Force the displayed FPS value (if any) More... | |
Static Public Member Functions | |
static std::string & | GetGUIName () |
static const char * | GetProgramName () |
static void | SetProgramName (const char *argv0) |
static void | SetArgumentParser (ArgumentParser *parser) |
static const std::string & | getConfigDirectoryPath () |
static const std::string & | getScreenshotDirectoryPath () |
static void | setConfigDirectoryPath (const std::string &path, bool createIfNecessary=false) |
static void | setScreenshotDirectoryPath (const std::string &path, bool createIfNecessary=false) |
Protected Member Functions | |
BaseGUI () | |
virtual | ~BaseGUI () |
The destructor should not be called directly. Use the closeGUI() method instead. More... | |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
protected |
|
protectedvirtual |
The destructor should not be called directly. Use the closeGUI() method instead.
|
inlinevirtual |
If the function returns true: when the GUI is created, its name will be saved so that it will be created when no GUI is specified. If the function returns false, the GUI name is not saved, and the last one will be used when no GUI is specified.
Reimplemented in sofa::gui::batch::BatchGUI.
|
inlinevirtual |
|
pure virtual |
Close the GUI.
Implemented in sofa::gui::batch::BatchGUI.
|
virtual |
Use a component setting to configure our GUI.
|
pure virtual |
Get the rootNode of the sofa scene.
Implemented in sofa::gui::batch::BatchGUI.
void sofa::gui::common::BaseGUI::exportGnuplot | ( | sofa::simulation::Node * | node, |
std::string | gnuplot_directory = "" |
||
) |
|
static |
|
inlinestatic |
|
inlinestatic |
|
static |
|
inlinevirtual |
|
inlinevirtual |
|
pure virtual |
Implemented in sofa::gui::batch::BatchGUI.
|
pure virtual |
Update the GUI.
Implemented in sofa::gui::batch::BatchGUI.
|
inlinevirtual |
|
virtual |
|
inlinevirtual |
Send a (script) message.
|
inlinestatic |
|
inlinevirtual |
|
inlinevirtual |
|
static |
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
inlinestatic |
|
pure virtual |
Register the scene in our GUI.
Implemented in sofa::gui::batch::BatchGUI.
|
static |
|
inlinevirtual |
|
inlinevirtual |
Force the displayed FPS value (if any)
|
inlinevirtual |