Skip to content

dev_docs.md

Latest commit

 

History

History
88 lines (54 loc) · 3.37 KB

dev_docs.md

File metadata and controls

88 lines (54 loc) · 3.37 KB

Developer Documentation

Summary

Members Descriptions
class APIWebsockets Manages websocket connections with Potree mdInfinity API.
class MainWidget Implements the graphical interface of the demonstrator.

class APIWebsockets

class APIWebsockets
  : public QObject

Manages websocket connections with Potree mdInfinity API.

Summary

Members Descriptions
public explicit APIWebsockets(quint16 port,MainWidget * container,QObject * parent) Construct a new APIWebsockets object.
public virtual ~APIWebsockets() Destroy the APIWebsockets object.

Members

public explicit APIWebsockets(quint16 port,MainWidget * container,QObject * parent)

Construct a new APIWebsockets object.

Runs a websocket server to listen for Potree mdInfinityAPI

Parameters

  • port port on which websocket server will run

  • container MainWidget instance containing this websocket server

  • parent the parent widget

public virtual ~APIWebsockets()

Destroy the APIWebsockets object.

class MainWidget

class MainWidget
  : public QWidget

Implements the graphical interface of the demonstrator.

The main components of the graphical interface are described in this class. It inherits from QWidget and contains a button, a plain text field, and a web view.

Summary

Members Descriptions
public explicit MainWidget(QWidget * parent) Construct a new Main Widget object.
public ~MainWidget() Destroy the Main Widget object.
public void log(QString text) Appends log to demonstrator text field.

Members

public explicit MainWidget(QWidget * parent)

Construct a new Main Widget object.

Initiates all the GUI elements (button, web view and text field). Defines a layout to arrange these elements. Initiate the Websocket server to listen for Potree. Connects the proper signal and slots.

Parameters

  • parent parent Widget, optional

public ~MainWidget()

Destroy the Main Widget object.

public void log(QString text)

Appends log to demonstrator text field.

Provided string is appended to demonstrator text field.

Parameters

  • text text data to log

Generated by Moxygen