Privacy
An open-source, flexible 3D physical simulation framework
mars::interfaces::GraphicsWindowInterface Class Referenceabstract

#include <GraphicsWindowInterface.h>

Public Member Functions

virtual ~GraphicsWindowInterface ()
 
virtual const std::string getName () const =0
 
virtual GraphicsCameraInterfacegetCameraInterface () const =0
 
virtual void grabFocus ()=0
 
virtual void setClearColor (mars::utils::Color color)=0
 
virtual const mars::utils::ColorgetClearColor () const =0
 
virtual void switchHudElemtVis (int num_element)=0
 
virtual void setFullscreen (bool val, int display=1)=0
 
virtual void setGrabFrames (bool grab)=0
 
virtual void setSaveFrames (bool grab)=0
 
virtual void getImageData (char *buffer, int &width, int &height)=0
 This function copies the image data in the given buffer. More...
 
virtual void getImageData (void **data, int &width, int &height)=0
 
virtual void getRTTDepthData (float *buffer, int &width, int &height)=0
 This function copies the depth image in the given buffer. More...
 
virtual void getRTTDepthData (float **data, int &width, int &height)=0
 
virtual osg::Group * getScene ()=0
 
virtual void setScene (osg::Group *scene)=0
 
virtual void addGraphicsEventHandler (GraphicsEventInterface *graphicsEventHandler)=0
 
virtual void setHUDViewOffsets (double x1, double y1, double x2, double y2)=0
 
virtual void setupDistortion (double factor)=0
 

Detailed Description

Definition at line 46 of file GraphicsWindowInterface.h.

Constructor & Destructor Documentation

◆ ~GraphicsWindowInterface()

virtual mars::interfaces::GraphicsWindowInterface::~GraphicsWindowInterface ( )
inlinevirtual

Definition at line 50 of file GraphicsWindowInterface.h.

Member Function Documentation

◆ addGraphicsEventHandler()

virtual void mars::interfaces::GraphicsWindowInterface::addGraphicsEventHandler ( GraphicsEventInterface graphicsEventHandler)
pure virtual

◆ getCameraInterface()

virtual GraphicsCameraInterface* mars::interfaces::GraphicsWindowInterface::getCameraInterface ( ) const
pure virtual

◆ getClearColor()

virtual const mars::utils::Color& mars::interfaces::GraphicsWindowInterface::getClearColor ( ) const
pure virtual

◆ getImageData() [1/2]

virtual void mars::interfaces::GraphicsWindowInterface::getImageData ( char *  buffer,
int &  width,
int &  height 
)
pure virtual

This function copies the image data in the given buffer.

It assumes that the buffer ist correctly initalized with a char array of the size width * height * 4

Parameters
bufferbuffer in which the image gets copied
widthreturns the width of the image
heightreturns the height of the image

Implemented in mars::graphics::GraphicsWidget.

◆ getImageData() [2/2]

virtual void mars::interfaces::GraphicsWindowInterface::getImageData ( void **  data,
int &  width,
int &  height 
)
pure virtual

◆ getName()

virtual const std::string mars::interfaces::GraphicsWindowInterface::getName ( ) const
pure virtual

◆ getRTTDepthData() [1/2]

virtual void mars::interfaces::GraphicsWindowInterface::getRTTDepthData ( float *  buffer,
int &  width,
int &  height 
)
pure virtual

This function copies the depth image in the given buffer.

It assumes that the buffer ist correctly initalized with a double array of the size width * height

Parameters
bufferbuffer in which the image gets copied
widthreturns the width of the image
heightreturns the height of the image

Implemented in mars::graphics::GraphicsWidget.

◆ getRTTDepthData() [2/2]

virtual void mars::interfaces::GraphicsWindowInterface::getRTTDepthData ( float **  data,
int &  width,
int &  height 
)
pure virtual

◆ getScene()

virtual osg::Group* mars::interfaces::GraphicsWindowInterface::getScene ( )
pure virtual

◆ grabFocus()

virtual void mars::interfaces::GraphicsWindowInterface::grabFocus ( )
pure virtual

◆ setClearColor()

virtual void mars::interfaces::GraphicsWindowInterface::setClearColor ( mars::utils::Color  color)
pure virtual

◆ setFullscreen()

virtual void mars::interfaces::GraphicsWindowInterface::setFullscreen ( bool  val,
int  display = 1 
)
pure virtual

◆ setGrabFrames()

virtual void mars::interfaces::GraphicsWindowInterface::setGrabFrames ( bool  grab)
pure virtual

◆ setHUDViewOffsets()

virtual void mars::interfaces::GraphicsWindowInterface::setHUDViewOffsets ( double  x1,
double  y1,
double  x2,
double  y2 
)
pure virtual

◆ setSaveFrames()

virtual void mars::interfaces::GraphicsWindowInterface::setSaveFrames ( bool  grab)
pure virtual

◆ setScene()

virtual void mars::interfaces::GraphicsWindowInterface::setScene ( osg::Group *  scene)
pure virtual

◆ setupDistortion()

virtual void mars::interfaces::GraphicsWindowInterface::setupDistortion ( double  factor)
pure virtual

◆ switchHudElemtVis()

virtual void mars::interfaces::GraphicsWindowInterface::switchHudElemtVis ( int  num_element)
pure virtual

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