Skip to content

Latest commit

 

History

History
106 lines (75 loc) · 4.21 KB

CONTRIBUTING.md

File metadata and controls

106 lines (75 loc) · 4.21 KB
Raw

Contributing to Livekeys

This guide will serve as a quick start for anyone interested in contributing with Livekeys. It offers a quick view over:

  1. The Structure of Livekeys
  2. Qml Components From C++
  3. Repository organization

Structure

Livekeys is split into 3 sections:

  • the application containing the visual elements and the runtime types
  • the editor containing components for projects and editing
  • the plugins containing the plugins you can import, some of which can also be linked to as libraries in ordeer to provide common transferable types.

QML Components From c++

This section is just quick overview on how to create a qml component from c++. For a more detailed description on qml language and its bindings, you can check out the following links:

In terms of c++, qml components are basically classes of a QObject subtype registered to the qml meta object system. A component is registered using the qmlRegisterType function:

int qmlRegisterType(const QUrl &url, const char *uri, int versionMajor, int versionMinor, const char *qmlName)

For example, in lcvimgproc plugin, at plugins/lcvimgproc/src/lcvimgproc_plugin.cpp you can see how each component is registered:

void LcvimgprocPlugin::registerTypes(const char *uri){ 
  // @uri modules.lcvimgproc 
  qmlRegisterType<QBlur>(uri, 1, 0, "Blur"); 
  qmlRegisterType<QCanny>(uri, 1, 0, "Canny"); 
  qmlRegisterType<QGaussianBlur>(uri, 1, 0, "GaussianBlur"); 
  qmlRegisterType<QHoughLines>(uri, 1, 0, "HoughLines"); 
  // ...
}

Whenever the plugin gets imported, the function gets called and the components become available. Components can have a set of properties accessible through qml. A property is declared through the Q_PROPERTY macro:

Q_PROPERTY(Type value READ getValue WRITE setValue NOTIFY valueChanged)

The READ, WRITE and NOTIFY declare the getter setter and property changed handler. So, to declare a simple qml component that has a int property defaulted to 42:

#include <QObject>

class MySample : public QObject{

  Q_OBJECT
  Q_PROPERTY(int value READ value WRITE setValue NOTIFY valueChanged)
  
public:
  MySample(QObject* parent) : QObject(parent), m_value(42){}
  
  int value() const {return m_value;}
  
  void setValue(int value){
    if ( m_value != value ){
      m_value = value;
      emit valueChanged();
    }
  }
  
signals:
  void valueChanged();
  
private:
  int m_value;
};

The component can then be used in qml:

MySample{
  Component.onCompleted : {
    console.log(value);
  }
}

Repository

Livekeys's repository contains the master and development branch. The master branch is considered the stable branch, with all integrated components tested and functional. The dev branch is used for the development of Livekeys. The branch contains the latest added components, which are not yet fully stable.

The coding style used for Livekeys is compatible with Qt's standards, described here, with the addition of exceptions in some cases, for example coming from Open CV.

Issues have associated labels, some of them handling specific cases:

  • deployment : dealing with Livekeys project files, build and deployment scripts
  • quickstart : used for people who want to start contributing to Livekeys
  • easy : entry level or issues that don't require a lot of time
  • editor : related to Livekeys's code editor
  • has-sample : requires a use case sample within Livekeys's sample directory
  • opencv : is related to open cv or an open cv wrapper

If issues are part of a module, the module is usually speciifed at the begining of the issue, e.g. [lcvvideo] Add BackgroundSubtractor{}