summaryrefslogtreecommitdiffhomepage
path: root/opentrack/plugin-api.hpp
blob: 714e69d98962e84f02b5735ee7e6cb638bbae733 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
#pragma once

#include "export.hpp"
#include <QString>
#include <QFrame>
#include <QIcon>

enum Axis {
    TX = 0, TY, TZ, Yaw, Pitch, Roll
};

#define OPENTRACK_DECLARE_PLUGIN_INTERNAL(ctor_class, ctor_ret_class, metadata_class, dialog_class, dialog_ret_class) \
    extern "C" OPENTRACK_EXPORT ctor_ret_class* GetConstructor() \
    { \
        return new ctor_class; \
    } \
    extern "C" OPENTRACK_EXPORT Metadata* GetMetadata() \
    { \
        return new metadata_class; \
    } \
    extern "C" OPENTRACK_EXPORT dialog_ret_class* GetDialog() \
    { \
        return new dialog_class; \
    }

// implement this in all plugins
struct Metadata
{
public:
    // plugin name to be displayed in the interface
    virtual QString name() = 0;
    // plugin icon, you can return an empty QIcon()
    virtual QIcon icon() = 0;
    // optional destructor
    virtual ~Metadata() {}
};

// implement this in filters
struct IFilter
{
public:
    // optional destructor
    virtual ~IFilter() {}
    // perform filtering step.
    // you have to take care of dt on your own, try "opentrack/timer.hpp"
    virtual void filter(const double *input, double *output) = 0;
};

struct IFilterDialog : public QWidget
{
    // optional destructor
    virtual ~IFilterDialog() {}
    // receive a pointer to the filter from ui thread
    virtual void register_filter(IFilter* filter) = 0;
    // received filter pointer is about to get deleted
    virtual void unregister_filter() = 0;
};

// call once with your chosen class names in the plugin
#define OPENTRACK_DECLARE_FILTER(filter_class, dialog_class, metadata_class) \
    OPENTRACK_DECLARE_PLUGIN_INTERNAL(filter_class, IFilter, metadata_class, dialog_class, IFilterDialog)

// implement this in protocols
struct IProtocol
{
public:
    // optional destructor
    virtual ~IProtocol() {}
    // return true if protocol was properly initialized
    virtual bool correct() = 0;
    // called 250 times a second with XYZ yaw pitch roll pose
    // try not to perform intense computation here. if you must, use a thread.
    virtual void pose(const double* headpose) = 0;
    // return game name or placeholder text
    virtual QString game_name() = 0;
};

struct IProtocolDialog : public QWidget
{
    // optional destructor
    virtual ~IProtocolDialog() {}
    // receive a pointer to the protocol from ui thread
    virtual void register_protocol(IProtocol *protocol) = 0;
    // received protocol pointer is about to get deleted
    virtual void unregister_protocol() = 0;
};

// call once with your chosen class names in the plugin
#define OPENTRACK_DECLARE_PROTOCOL(protocol_class, dialog_class, metadata_class) \
    OPENTRACK_DECLARE_PLUGIN_INTERNAL(protocol_class, IProtocol, metadata_class, dialog_class, IProtocolDialog)

// implement this in trackers
struct ITracker
{
public:
    // optional destructor
    virtual ~ITracker() {}
    // start tracking, and grab a frame to display webcam video in, optionally
    virtual void start_tracker(QFrame* frame) = 0;
    // return XYZ yaw pitch roll data. don't block here, use a separate thread for computation.
    virtual void data(double *data) = 0;
};

struct ITrackerDialog : public QWidget
{
    // optional destructor
    virtual ~ITrackerDialog() {}
    // receive a pointer to the tracker from ui thread
    virtual void register_tracker(ITracker *tracker) = 0;
    // received tracker pointer is about to get deleted
    virtual void unregister_tracker() = 0;
};

// call once with your chosen class names in the plugin
#define OPENTRACK_DECLARE_TRACKER(tracker_class, dialog_class, metadata_class) \
    OPENTRACK_DECLARE_PLUGIN_INTERNAL(tracker_class, ITracker, metadata_class, dialog_class, ITrackerDialog)