SOFA API  73d8bb95
Open source framework for multi-physics simuation
sofa::gui::hRecorder::HeadlessRecorder Class Reference

#include <HeadlessRecorder.h>

Inheritance diagram for sofa::gui::hRecorder::HeadlessRecorder:

Static Public Attributes

static int recordTimeInSeconds = 5
static bool recordUntilStopAnimate = false

Public Member Functions

 HeadlessRecorder ()
 ~HeadlessRecorder ()
int mainLoop () override
void step ()
void redraw () override
 Update the GUI. More...
void resetView ()
void saveView ()
void initializeGL ()
void paintGL ()
void setScene (sofa::simulation::Node::SPtr scene, const char *filename=NULL, bool temporaryFile=false) override
 Register the scene in our GUI. More...
void newView ()
virtual sofa::simulation::NodecurrentSimulation () override
 Get the rootNode of the sofa scene. More...
virtual int closeGUI () override
 Close the GUI. More...
virtual void setViewerResolution (int width, int height) override
- Public Member Functions inherited from sofa::gui::BaseGUI
virtual void configureGUI (sofa::simulation::Node::SPtr groot)
 Use a component setting to configure our GUI. More...
void exportGnuplot (sofa::simulation::Node *node, std::string gnuplot_directory="")
virtual void setDumpState (bool)
virtual void setLogTime (bool)
virtual void setExportState (bool)
virtual void setRecordPath (const std::string &)
virtual void setGnuplotPath (const std::string &)
virtual void initViewer (BaseViewer *)
virtual void setViewerConfiguration (sofa::component::configurationsetting::ViewerSetting *)
virtual void setFullScreen ()
virtual void setBackgroundColor (const sofa::helper::types::RGBAColor &)
virtual void setBackgroundImage (const std::string &)
virtual BaseViewergetViewer ()
virtual void registerViewer (BaseViewer *)
virtual bool saveScreenshot (const std::string &filename, int compression_level=-1)
virtual void setMouseButtonConfiguration (sofa::component::configurationsetting::MouseButtonSetting *)
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 BaseGUICreateGUI (const char *name, sofa::simulation::Node::SPtr groot=NULL, const char *filename=NULL)
static int RegisterGUIParameters (ArgumentParser *argumentParser)
static void parseRecordingModeOption ()
- Static Public Member Functions inherited from sofa::gui::BaseGUI
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)

Additional Inherited Members

- Static Protected Attributes inherited from sofa::gui::BaseGUI
static std::string mGuiName = ""
static std::string configDirectoryPath = "."
static std::string screenshotDirectoryPath = "."
static const char * mProgramName = nullptr
static ArgumentParsermArgumentParser = nullptr
- Protected Member Functions inherited from sofa::gui::BaseGUI
 BaseGUI ()
virtual ~BaseGUI ()
 The destructor should not be called directly. Use the closeGUI() method instead. More...

Attribute details

int sofa::gui::hRecorder::HeadlessRecorder::recordTimeInSeconds = 5
bool sofa::gui::hRecorder::HeadlessRecorder::recordUntilStopAnimate = false

Constructor details

sofa::gui::hRecorder::HeadlessRecorder::HeadlessRecorder ( )
sofa::gui::hRecorder::HeadlessRecorder::~HeadlessRecorder ( )

Function details

int sofa::gui::hRecorder::HeadlessRecorder::closeGUI ( )

Close the GUI.

Implements sofa::gui::BaseGUI.

BaseGUI * sofa::gui::hRecorder::HeadlessRecorder::CreateGUI ( const char *  name,
sofa::simulation::Node::SPtr  groot = NULL,
const char *  filename = NULL 
sofa::simulation::Node * sofa::gui::hRecorder::HeadlessRecorder::currentSimulation ( )

Get the rootNode of the sofa scene.

Implements sofa::gui::BaseGUI.

void sofa::gui::hRecorder::HeadlessRecorder::initializeGL ( void  )
int sofa::gui::hRecorder::HeadlessRecorder::mainLoop ( )

Implements sofa::gui::BaseGUI.

void sofa::gui::hRecorder::HeadlessRecorder::newView ( )
void sofa::gui::hRecorder::HeadlessRecorder::paintGL ( )
void sofa::gui::hRecorder::HeadlessRecorder::parseRecordingModeOption ( )
void sofa::gui::hRecorder::HeadlessRecorder::redraw ( )

Update the GUI.

Implements sofa::gui::BaseGUI.

int sofa::gui::hRecorder::HeadlessRecorder::RegisterGUIParameters ( ArgumentParser argumentParser)
void sofa::gui::hRecorder::HeadlessRecorder::resetView ( )
void sofa::gui::hRecorder::HeadlessRecorder::saveView ( )
void sofa::gui::hRecorder::HeadlessRecorder::setScene ( sofa::simulation::Node::SPtr  groot,
const char *  filename = NULL,
bool  temporaryFile = false 

Register the scene in our GUI.

Implements sofa::gui::BaseGUI.

void sofa::gui::hRecorder::HeadlessRecorder::setViewerResolution ( int  width,
int  height 

Reimplemented from sofa::gui::BaseGUI.

void sofa::gui::hRecorder::HeadlessRecorder::step ( )