SOFA API  014b24ea
Open source framework for multi-physics simuation
sofa::gui::qt::viewer::SofaViewer Class Referenceabstract

#include <SofaViewer.h>

Inheritance diagram for sofa::gui::qt::viewer::SofaViewer:

Protected Attributes

std::unique_ptr< EngineBackendm_backend
 
QTimer captureTimer
 
bool m_isControlPressed
 
ColourPickingRenderCallBack colourPickingRenderCallBack
 
- Protected Attributes inherited from sofa::gui::BaseViewer
sofa::simulation::Node::SPtr groot
 the sofa root note of the current scene More...
 
sofa::component::visualmodel::BaseCamera::SPtr currentCamera
 
std::string sceneFileName
 
bool _video
 
bool m_isVideoButtonPressed
 
bool m_bShowAxis
 
bool _fullScreen
 
int _background
 
bool initTexturesDone
 
sofa::defaulttype::Vector3 backgroundColour
 
std::string backgroundImageFile
 
sofa::defaulttype::Vector3 ambientColour
 
PickHandlerpick
 
int _navigationMode
 
bool _mouseInteractorMoving
 
int _mouseInteractorSavedPosX
 
int _mouseInteractorSavedPosY
 
std::string _screenshotDirectory
 

Public Member Functions

 SofaViewer ()
 
 ~SofaViewer () override
 
virtual void removeViewerTab (QTabWidget *)
 Optional QTabWidget GUI for a concreate viewer. More...
 
virtual void configureViewerTab (QTabWidget *)
 Optional QTabWidget GUI for a concreate viewer. More...
 
virtual QWidgetgetQWidget ()=0
 
virtual QString helpString () const =0
 
void captureEvent () override
 
virtual void keyPressEvent (QKeyEvent *e)
 
virtual void keyReleaseEvent (QKeyEvent *e)
 
bool isControlPressed () const
 
virtual void wheelEvent (QWheelEvent *e)
 
virtual void mouseMoveEvent (QMouseEvent *e)
 
virtual void mousePressEvent (QMouseEvent *e)
 
virtual void mouseReleaseEvent (QMouseEvent *e)
 
virtual bool mouseEvent (QMouseEvent *e)
 
virtual void configure (sofa::component::configurationsetting::ViewerSetting *viewerConf) override
 
const std::string screenshotName () override
 
void setPrefix (const std::string &prefix, bool prependDirectory=true) override
 
virtual void screenshot (const std::string &filename, int compression_level=-1) override
 
virtual void setBackgroundImage (std::string imageFileName=std::string("textures/SOFA_logo.bmp")) override
 
- Public Member Functions inherited from sofa::gui::BaseViewer
 BaseViewer ()
 
virtual ~BaseViewer ()
 
virtual void drawColourPicking (ColourPickingVisitor::ColourCode)
 
virtual sofa::simulation::NodegetScene ()
 
virtual const std::string & getSceneFileName ()
 
virtual void setSceneFileName (const std::string &f)
 
virtual void setScene (sofa::simulation::Node::SPtr scene, const char *filename=nullptr, bool=false)
 
virtual void setCameraMode (core::visual::VisualParams::CameraType)
 
virtual bool ready ()
 
virtual void wait ()
 ask the viewer to resume its activity More...
 
virtual bool load (void)
 Load the viewer. It's the initialisation. More...
 
virtual bool unload (void)
 unload the viewer without delete More...
 
virtual void viewAll (void)=0
 Recompute viewer's home position so it encompass the whole scene and apply it. More...
 
virtual void getView (sofa::defaulttype::Vector3 &pos, sofa::defaulttype::Quat &ori) const
 
virtual void setView (const sofa::defaulttype::Vector3 &pos, const sofa::defaulttype::Quat &ori)
 
virtual void moveView (const sofa::defaulttype::Vector3 &pos, const sofa::defaulttype::Quat &ori)
 
virtual void newView ()
 
virtual void resetView ()
 
virtual void setBackgroundColour (float r, float g, float b)
 
std::string getBackgroundImage ()
 
virtual void saveView ()=0
 
virtual void setSizeW (int)=0
 
virtual void setSizeH (int)=0
 
virtual int getWidth ()=0
 
virtual int getHeight ()=0
 
virtual void fitObjectBBox (sofa::core::objectmodel::BaseObject *)
 
virtual void fitNodeBBox (sofa::core::objectmodel::BaseNode *)
 
virtual void setFullScreen (bool)
 
virtual void moveRayPickInteractor (int, int)
 RayCasting PickHandler. More...
 
PickHandlergetPickHandler ()
 
virtual void drawScene (void)=0
 the rendering pass is done here (have to be called in a loop) More...
 

Protected Member Functions

void redraw () override
 internally called while the actual viewer needs a redraw (ie the camera changed) More...
 

Signals

virtual void redrawn ()=0
 
virtual void resizeW (int)=0
 
virtual void resizeH (int)=0
 

Attribute details

QTimer sofa::gui::qt::viewer::SofaViewer::captureTimer
protected
ColourPickingRenderCallBack sofa::gui::qt::viewer::SofaViewer::colourPickingRenderCallBack
protected
std::unique_ptr<EngineBackend> sofa::gui::qt::viewer::SofaViewer::m_backend
protected
bool sofa::gui::qt::viewer::SofaViewer::m_isControlPressed
protected

Constructor details

sofa::gui::qt::viewer::SofaViewer::SofaViewer ( )
sofa::gui::qt::viewer::SofaViewer::~SofaViewer ( )
override

Function details

void sofa::gui::qt::viewer::SofaViewer::captureEvent ( )
overridevirtual

Reimplemented from sofa::gui::BaseViewer.

void sofa::gui::qt::viewer::SofaViewer::configure ( sofa::component::configurationsetting::ViewerSetting viewerConf)
overridevirtual

Reimplemented from sofa::gui::BaseViewer.

virtual void sofa::gui::qt::viewer::SofaViewer::configureViewerTab ( QTabWidget *  )
inlinevirtual

Optional QTabWidget GUI for a concreate viewer.

virtual QWidget* sofa::gui::qt::viewer::SofaViewer::getQWidget ( )
pure virtual
virtual QString sofa::gui::qt::viewer::SofaViewer::helpString ( ) const
pure virtual
bool sofa::gui::qt::viewer::SofaViewer::isControlPressed ( ) const
void sofa::gui::qt::viewer::SofaViewer::keyPressEvent ( QKeyEvent *  e)
virtual
void sofa::gui::qt::viewer::SofaViewer::keyReleaseEvent ( QKeyEvent *  e)
virtual
bool sofa::gui::qt::viewer::SofaViewer::mouseEvent ( QMouseEvent *  e)
virtual
void sofa::gui::qt::viewer::SofaViewer::mouseMoveEvent ( QMouseEvent *  e)
virtual
void sofa::gui::qt::viewer::SofaViewer::mousePressEvent ( QMouseEvent *  e)
virtual
void sofa::gui::qt::viewer::SofaViewer::mouseReleaseEvent ( QMouseEvent *  e)
virtual
void sofa::gui::qt::viewer::SofaViewer::redraw ( )
overrideprotectedvirtual

internally called while the actual viewer needs a redraw (ie the camera changed)

Implements sofa::gui::BaseViewer.

virtual void sofa::gui::qt::viewer::SofaViewer::redrawn ( )
pure virtualsignal
virtual void sofa::gui::qt::viewer::SofaViewer::removeViewerTab ( QTabWidget *  )
inlinevirtual

Optional QTabWidget GUI for a concreate viewer.

virtual void sofa::gui::qt::viewer::SofaViewer::resizeH ( int  )
pure virtualsignal
virtual void sofa::gui::qt::viewer::SofaViewer::resizeW ( int  )
pure virtualsignal
void sofa::gui::qt::viewer::SofaViewer::screenshot ( const std::string &  filename,
int  compression_level = -1 
)
overridevirtual

Reimplemented from sofa::gui::BaseViewer.

Reimplemented in sofa::gui::qt::viewer::qt::QtViewer.

const std::string sofa::gui::qt::viewer::SofaViewer::screenshotName ( )
overridevirtual

Reimplemented from sofa::gui::BaseViewer.

void sofa::gui::qt::viewer::SofaViewer::setBackgroundImage ( std::string  imageFileName = std::string("textures/SOFA_logo.bmp"))
overridevirtual

Reimplemented from sofa::gui::BaseViewer.

void sofa::gui::qt::viewer::SofaViewer::setPrefix ( const std::string &  prefix,
bool  prependDirectory = true 
)
overridevirtual

Reimplemented from sofa::gui::BaseViewer.

void sofa::gui::qt::viewer::SofaViewer::wheelEvent ( QWheelEvent *  e)
virtual