MRSpaceMouseDevice.h

Go to the documentation of this file.

#pragma once
#include "MRMesh/MRVector3.h"
#include <bitset>
#include <array>
#include <vector>
#include <unordered_map>
#include <string>
 
namespace MR::SpaceMouse
{
 
using VendorId = short unsigned int;
using ProductId = short unsigned int;
using DataPacketRaw = std::array<unsigned char, 13>;
 
enum class Buttons : int
{
    SMB_NO = -1,
    SMB_MENU,
 
    SMB_ESC,
    SMB_ENTER,
    SMB_TAB,
    SMB_SHIFT,
    SMB_CTRL,
    SMB_ALT,
    SMB_SPACE,
    SMB_DELETE,
 
    SMB_CUSTOM_1,
    SMB_CUSTOM_2,
    SMB_CUSTOM_3,
    SMB_CUSTOM_4,
    SMB_CUSTOM_5,
    SMB_CUSTOM_6,
    SMB_CUSTOM_7,
    SMB_CUSTOM_8,
    SMB_CUSTOM_9,
    SMB_CUSTOM_10,
    SMB_CUSTOM_11,
    SMB_CUSTOM_12,
 
    SMB_FIT,
    SMB_TOP,
    SMB_RIGHT,
    SMB_FRONT,
    SMB_ROLL_CW, // roll clockwise
    SMB_LOCK_ROT,
 
    SMB_BTN_V1,
    SMB_BTN_V2,
    SMB_BTN_V3,
    SMB_ISO1,
 
    SMB_BUTTON_COUNT
};
 
const std::unordered_map<VendorId, std::vector<ProductId>> cVendor2Device = {
        { VendorId( 0x046d ), {  // Logitech (3Dconnexion was a subsidiary)
                    0xc603,    // SpaceMouse plus XT
                    0xc605,    // cadman
                    0xc606,    // SpaceMouse classic
                    0xc621,    // spaceball 5000
                    0xc623,    // space traveller
                    0xc625,    // space pilot
                    0xc626,    // Full-size SpaceNavigator
                    0xc627,    // space explorer
                    0xc628,    // SpaceNavigator for notebooks
                    0xc629,    // space pilot pro
                    0xc62b,    // space mouse pro
                    0xc640     // nulooq
        }},
        { VendorId( 0x256f ), {  // 3Dconnexion
                    0xc62e,    // SpaceMouse wireless (USB cable)
                    0xc62f,    // SpaceMouse wireless receiver
                    0xc631,    // SpaceMouse pro wireless (USB cable)
                    0xc632,    // SpaceMouse pro wireless receiver
                    0xc633,    // SpaceMouse enterprise
                    0xc635,    // SpaceMouse compact
                    0xc638,    // SpaceMouse Pro Wireless Bluetooth Edition (USB cable)
                    0xc63a,    // SpaceMouse Wireless BT
                    0xc652,    // Universal receiver
                    0xc658     // Wireless (3DConnexion Universal Wireless Receiver in WIN32)
        }}
};
 
 
struct Action {
    bool btnStateChanged = false;
    std::bitset<size_t( Buttons::SMB_BUTTON_COUNT )> buttons = 0;
    Vector3f translate = { 0.0f, 0.0f, 0.0f };
    Vector3f rotate = { 0.0f, 0.0f, 0.0f };
};
 
class Device
{
public:
    void updateDevice( VendorId vId, ProductId pId );
    
    void resetDevice();
 
    bool valid() const;
 
    void parseRawEvent( const DataPacketRaw& raw, int numBytes, Action& action ) const;
 
    void processAction( const Action& action );
private:
    VendorId vId_{ 0 };
    ProductId pId_{ 0 };
    std::bitset<size_t( Buttons::SMB_BUTTON_COUNT )> buttonsState_;
 
    const std::vector<std::vector<Buttons>>* buttonsMapPtr_ = nullptr;
 
    /*         |   <--- packet values --->
     *   #byte |   1          2
     *   ------+--------------------------
     *       0 |   -          -
     *       1 |   custom_1   custom_2
     */
    std::vector<std::vector<Buttons>> buttonMapCompact = {
        {  }, // 0th byte (unused)
        { Buttons::SMB_CUSTOM_1, Buttons::SMB_CUSTOM_2} // 1st byte
    };
 
    /*         |  <--- packet values --->
     *   #byte |    1      2       4       8     16      32      64      126
     *   ------+------------------------------------------------------------------
     *       1 |  menu   fit     T               R       F
     *       2 |  rot                            1       2       3        4
     *       3 |                                                 esc      alt
     *       4 |  shift  ctrl    lock
     *
     */
    std::vector<std::vector<Buttons>> buttonMapPro = {
        {  }, // 0th byte (unused)
        //1                      2                      4                      8                      16                     32                     64                     128
        { Buttons::SMB_MENU,     Buttons::SMB_FIT,      Buttons::SMB_TOP,      Buttons::SMB_NO,       Buttons::SMB_RIGHT,    Buttons::SMB_FRONT,    Buttons::SMB_NO,       Buttons::SMB_NO },      // 1st byte
        { Buttons::SMB_ROLL_CW,  Buttons::SMB_NO,       Buttons::SMB_NO,       Buttons::SMB_NO,       Buttons::SMB_CUSTOM_1, Buttons::SMB_CUSTOM_2, Buttons::SMB_CUSTOM_3, Buttons::SMB_CUSTOM_4}, // 2nd byte
        { Buttons::SMB_NO,       Buttons::SMB_NO,       Buttons::SMB_NO,       Buttons::SMB_NO,       Buttons::SMB_NO,       Buttons::SMB_NO,       Buttons::SMB_ESC,      Buttons::SMB_ALT},      // 3rd byte
        { Buttons::SMB_SHIFT,    Buttons::SMB_CTRL,     Buttons::SMB_LOCK_ROT, Buttons::SMB_NO,       Buttons::SMB_NO,       Buttons::SMB_NO,       Buttons::SMB_NO,       Buttons::SMB_NO,},      // 4th byte
    };
 
    // @TODO !!! NOT TESTED !!!
    std::vector<std::vector<Buttons>> buttonMapEnterprise = {
        {  }, // 0th byte (unused)
        { Buttons::SMB_CUSTOM_1,     Buttons::SMB_CUSTOM_2}
    };
    /* @TODO !!! NOT TESTED !!!
    static constexpr int mapButtonsEnterprise[31] = {
        SMB_MENU, SMB_FIT,
        SMB_TOP, SMB_RIGHT, SMB_FRONT, SMB_ROLL_CW, SMB_LOCK_ROT,
        SMB_ISO1, SMB_BTN_V1, SMB_BTN_V2, SMB_BTN_V3,
        SMB_CUSTOM_1, SMB_CUSTOM_2, SMB_CUSTOM_3, SMB_CUSTOM_4, SMB_CUSTOM_5, SMB_CUSTOM_6,
        SMB_CUSTOM_7, SMB_CUSTOM_8, SMB_CUSTOM_9, SMB_CUSTOM_10, SMB_CUSTOM_11, SMB_CUSTOM_12,
        SMB_ESC, SMB_ENTER, SMB_ALT, SMB_SHIFT, SMB_CTRL, SMB_TAB, SMB_SPACE, SMB_DELETE
    };
    */
};
}