SOFA API  7352f41a
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 () override
 
int mainLoop () override
 
void step ()
 
void redraw () override
 Update the GUI. More...
 
void resetView ()
 
void initializeGL ()
 
void paintGL ()
 
void setScene (sofa::simulation::NodeSPtr scene, const char *filename=nullptr, 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
 
virtual void setBackgroundColor (const sofa::type::RGBAColor &color) override
 
- Public Member Functions inherited from sofa::gui::common::BaseGUI
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
 
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 setFullScreen ()
 
virtual void centerWindow ()
 
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::setting::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 common::BaseGUICreateGUI (const char *name, sofa::simulation::NodeSPtr groot=nullptr, const char *filename=nullptr)
 
static int RegisterGUIParameters (common::ArgumentParser *argumentParser)
 
static void parseRecordingModeOption ()
 
- Static Public Member Functions inherited from sofa::gui::common::BaseGUI
static std::string & GetGUIName ()
 
static const charGetProgramName ()
 
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::common::BaseGUI
static std::string mGuiName = ""
 
static std::string configDirectoryPath = "."
 
static std::string screenshotDirectoryPath = "."
 
static const charmProgramName = nullptr
 
static ArgumentParsermArgumentParser = nullptr
 
- Protected Member Functions inherited from sofa::gui::common::BaseGUI
 BaseGUI ()
 
virtual ~BaseGUI ()
 The destructor should not be called directly. Use the closeGUI() method instead. More...
 

Attribute details

◆ recordTimeInSeconds

int sofa::gui::hrecorder::HeadlessRecorder::recordTimeInSeconds = 5
static

◆ recordUntilStopAnimate

bool sofa::gui::hrecorder::HeadlessRecorder::recordUntilStopAnimate = false
static

Constructor details

◆ HeadlessRecorder()

sofa::gui::hrecorder::HeadlessRecorder::HeadlessRecorder ( )

◆ ~HeadlessRecorder()

sofa::gui::hrecorder::HeadlessRecorder::~HeadlessRecorder ( )
override

Function details

◆ closeGUI()

int sofa::gui::hrecorder::HeadlessRecorder::closeGUI ( )
overridevirtual

Close the GUI.

Implements sofa::gui::common::BaseGUI.

◆ CreateGUI()

common::BaseGUI * sofa::gui::hrecorder::HeadlessRecorder::CreateGUI ( const char name,
sofa::simulation::NodeSPtr  groot = nullptr,
const char filename = nullptr 
)
static

◆ currentSimulation()

sofa::simulation::Node * sofa::gui::hrecorder::HeadlessRecorder::currentSimulation ( )
overridevirtual

Get the rootNode of the sofa scene.

Implements sofa::gui::common::BaseGUI.

◆ initializeGL()

void sofa::gui::hrecorder::HeadlessRecorder::initializeGL ( void  )

◆ mainLoop()

int sofa::gui::hrecorder::HeadlessRecorder::mainLoop ( )
overridevirtual

◆ newView()

void sofa::gui::hrecorder::HeadlessRecorder::newView ( )

◆ paintGL()

void sofa::gui::hrecorder::HeadlessRecorder::paintGL ( )

◆ parseRecordingModeOption()

void sofa::gui::hrecorder::HeadlessRecorder::parseRecordingModeOption ( )
static

◆ redraw()

void sofa::gui::hrecorder::HeadlessRecorder::redraw ( )
overridevirtual

Update the GUI.

Implements sofa::gui::common::BaseGUI.

◆ RegisterGUIParameters()

int sofa::gui::hrecorder::HeadlessRecorder::RegisterGUIParameters ( common::ArgumentParser argumentParser)
static

◆ resetView()

void sofa::gui::hrecorder::HeadlessRecorder::resetView ( )

◆ setBackgroundColor()

void sofa::gui::hrecorder::HeadlessRecorder::setBackgroundColor ( const sofa::type::RGBAColor color)
overridevirtual

Reimplemented from sofa::gui::common::BaseGUI.

◆ setScene()

void sofa::gui::hrecorder::HeadlessRecorder::setScene ( sofa::simulation::NodeSPtr  groot,
const char filename = nullptr,
bool  temporaryFile = false 
)
overridevirtual

Register the scene in our GUI.

Implements sofa::gui::common::BaseGUI.

◆ setViewerResolution()

void sofa::gui::hrecorder::HeadlessRecorder::setViewerResolution ( int  width,
int  height 
)
overridevirtual

Reimplemented from sofa::gui::common::BaseGUI.

◆ step()

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