Mouse3DHandlerMac.mm File Reference

#include "Mouse3DController.hpp"
#include <stdint.h>
#include <dlfcn.h>
#include <array>
#include <boost/log/trivial.hpp>
#include <cstdio>

Include dependency graph for Mouse3DHandlerMac.mm:

Go to the source code of this file.

Classes
struct	ConnexionDeviceState

Namespaces
namespace	Slic3r
	|/ Copyright (c) Prusa Research 2020 - 2023 Enrico Turri @enricoturri1966 |/ |/ PrusaSlicer is released under the terms of the AGPLv3 or higher |/
namespace	Slic3r::GUI

Macros
#define	kConnexionClientModeTakeOver   1
#define	kConnexionMaskAxis   0x3f00
#define	kConnexionMaskAll   0x3fff
#define	kConnexionMaskAllButtons   0xffffffff
#define	kConnexionCmdHandleButtons   2
#define	kConnexionCmdHandleAxis   3
#define	kConnexionCmdAppSpecific   10
#define	kConnexionMsgDeviceState   '3dSR'
#define	kConnexionCtlGetDeviceID   '3did'
#define	DECLARE_FUNC(name)
#define	LOAD_FUNC(name)

Typedefs
typedef void(*	AddedHandler) (uint32_t)
typedef void(*	RemovedHandler) (uint32_t)
typedef void(*	MessageHandler) (uint32_t, uint32_t msg_type, void *msg_arg)
typedef int16_t(*	SetConnexionHandlers_ptr) (MessageHandler, AddedHandler, RemovedHandler, bool)
typedef int16_t(*	InstallConnexionHandlers_ptr) (MessageHandler, AddedHandler, RemovedHandler)
typedef void(*	CleanupConnexionHandlers_ptr) ()
typedef uint16_t(*	RegisterConnexionClient_ptr) (uint32_t signature, const char *name, uint16_t mode, uint32_t mask)
typedef void(*	SetConnexionClientButtonMask_ptr) (uint16_t clientID, uint32_t buttonMask)
typedef void(*	UnregisterConnexionClient_ptr) (uint16_t clientID)
typedef int16_t(*	ConnexionClientControl_ptr) (uint16_t clientID, uint32_t message, int32_t param, int32_t *result)

Functions
	DECLARE_FUNC (SetConnexionHandlers)
	DECLARE_FUNC (InstallConnexionHandlers)
	DECLARE_FUNC (CleanupConnexionHandlers)
	DECLARE_FUNC (RegisterConnexionClient)
	DECLARE_FUNC (SetConnexionClientButtonMask)
	DECLARE_FUNC (UnregisterConnexionClient)
	DECLARE_FUNC (ConnexionClientControl)
static void *	load_func (void *module, const char *func_name)
static bool	load_driver_functions ()
static void	unload_driver ()
static void	DeviceAdded (uint32_t unused)
static void	DeviceRemoved (uint32_t unused)
static void	DeviceEvent (uint32_t unused, uint32_t msg_type, void *msg_arg)

Variables
static Slic3r::GUI::Mouse3DController *	mouse_3d_controller = nullptr
static uint16_t	clientID = 0
static bool	driver_loaded = false
static bool	has_new_driver = false
static void *	module

---

Class Documentation

ConnexionDeviceState

struct ConnexionDeviceState

Class Members
uint16_t	address
int16_t	axis[6]
uint32_t	buttons
uint16_t	buttons8
uint16_t	client
uint16_t	command
int16_t	param
uint8_t	report[8]
uint64_t	time
int32_t	value
uint16_t	version

Macro Definition Documentation

DECLARE_FUNC

#define DECLARE_FUNC

(

name

)

Value:

name##_ptr name = nullptr

kConnexionClientModeTakeOver

#define kConnexionClientModeTakeOver   1

kConnexionCmdAppSpecific

#define kConnexionCmdAppSpecific   10

Referenced by DeviceEvent().

kConnexionCmdHandleAxis

#define kConnexionCmdHandleAxis   3

Referenced by DeviceEvent().

kConnexionCmdHandleButtons

#define kConnexionCmdHandleButtons   2

Referenced by DeviceEvent().

kConnexionCtlGetDeviceID

#define kConnexionCtlGetDeviceID   '3did'

Referenced by DeviceAdded().

kConnexionMaskAll

#define kConnexionMaskAll   0x3fff

kConnexionMaskAllButtons

#define kConnexionMaskAllButtons   0xffffffff

kConnexionMaskAxis

#define kConnexionMaskAxis   0x3f00

kConnexionMsgDeviceState

#define kConnexionMsgDeviceState   '3dSR'

Referenced by DeviceEvent().

LOAD_FUNC

#define LOAD_FUNC

(

name

)

Value:

name = (name##_ptr)load_func(module, #name)

Referenced by load_driver_functions().

Typedef Documentation

AddedHandler

typedef void(* AddedHandler) (uint32_t)

CleanupConnexionHandlers_ptr

typedef void(* CleanupConnexionHandlers_ptr) ()

ConnexionClientControl_ptr

typedef int16_t(* ConnexionClientControl_ptr) (uint16_t clientID, uint32_t message, int32_t param, int32_t *result)

InstallConnexionHandlers_ptr

typedef int16_t(* InstallConnexionHandlers_ptr) (MessageHandler, AddedHandler, RemovedHandler)

MessageHandler

typedef void(* MessageHandler) (uint32_t, uint32_t msg_type, void *msg_arg)

RegisterConnexionClient_ptr

typedef uint16_t(* RegisterConnexionClient_ptr) (uint32_t signature, const char *name, uint16_t mode, uint32_t mask)

RemovedHandler

typedef void(* RemovedHandler) (uint32_t)

SetConnexionClientButtonMask_ptr

typedef void(* SetConnexionClientButtonMask_ptr) (uint16_t clientID, uint32_t buttonMask)

SetConnexionHandlers_ptr

typedef int16_t(* SetConnexionHandlers_ptr) (MessageHandler, AddedHandler, RemovedHandler, bool)

UnregisterConnexionClient_ptr

typedef void(* UnregisterConnexionClient_ptr) (uint16_t clientID)

Function Documentation

DECLARE_FUNC() [1/7]

DECLARE_FUNC

(

CleanupConnexionHandlers

)

DECLARE_FUNC() [2/7]

DECLARE_FUNC

(

ConnexionClientControl

)

DECLARE_FUNC() [3/7]

DECLARE_FUNC

(

InstallConnexionHandlers

)

DECLARE_FUNC() [4/7]

DECLARE_FUNC

(

RegisterConnexionClient

)

DECLARE_FUNC() [5/7]

DECLARE_FUNC

(

SetConnexionClientButtonMask

)

DECLARE_FUNC() [6/7]

DECLARE_FUNC

(

SetConnexionHandlers

)

DECLARE_FUNC() [7/7]

DECLARE_FUNC

(

UnregisterConnexionClient

)

DeviceAdded()

void DeviceAdded ( uint32_t unused )

static

{
  BOOST_LOG_TRIVIAL(info)<<"3dx device added";
  // determine exactly which device is plugged in
  int32_t result;
  ConnexionClientControl(clientID, kConnexionCtlGetDeviceID, 0, &result);
  int vendorID  = result >> 16;
  int productID = result & 0xffff;
  //TODO: verify device
  char buf[64];
  sprintf(buf, "VID%04X,PID%04X", vendorID, productID);
  mouse_3d_controller->connected(buf);
}

References clientID, kConnexionCtlGetDeviceID, and mouse_3d_controller.

DeviceEvent()

void DeviceEvent ( uint32_t unused, uint32_t msg_type, void * msg_arg )

static

{
  if (msg_type == kConnexionMsgDeviceState) {
    ConnexionDeviceState *s = (ConnexionDeviceState *)msg_arg;
    if (s->client == clientID) {
      switch (s->command) {
        case kConnexionCmdHandleAxis: {
          // The axis field is an array of 6 signed 16-bit integers corresponding to the 6 device axes. Data is ordered as Tx, Tz, Ty, Rx, Rz, Ry. The values reported are scaled by the driver according to the speed slider settings on the 3Dconnexion preference panel. At maximum speed, the range is - 1024 to 1024. Typical range that you should optimize your application for should be -500 to 500.
          // Actually we are getting values way over 1024. Max is probably 2048 now.
          Slic3r::GUI::Mouse3DController::DataPacketAxis packet;
          for (int i = 0; i < 6; ++ i)
              packet[i] = (double)s->axis[i]/350.0;//wanted to divide by 500 but 350 is used at raw input so i used same value.
          mouse_3d_controller->handle_input(packet);
          break;
        }
        case kConnexionCmdHandleButtons:
          break;
        case kConnexionCmdAppSpecific:
          break;
        default:
        break;
      }
    }
  }
}

References ConnexionDeviceState::axis, ConnexionDeviceState::client, clientID, ConnexionDeviceState::command, kConnexionCmdAppSpecific, kConnexionCmdHandleAxis, kConnexionCmdHandleButtons, kConnexionMsgDeviceState, and mouse_3d_controller.

DeviceRemoved()

void DeviceRemoved ( uint32_t unused )

static

{
  BOOST_LOG_TRIVIAL(info) << "3dx device removed\n";
// not accessible in a free function
//  assert(m_connected);
//  assert(! m_device_str.empty());
  mouse_3d_controller->disconnected();
}

References mouse_3d_controller.

load_driver_functions()

bool load_driver_functions ( )

static

{
  if (driver_loaded)
    return true;
 
  module = dlopen("/Library/Frameworks/3DconnexionClient.framework/3DconnexionClient",
                  RTLD_LAZY | RTLD_LOCAL);
 
  if (module) {
    BOOST_LOG_TRIVIAL(info) << "loading 3dx drivers";
    LOAD_FUNC(SetConnexionHandlers);
 
    if (SetConnexionHandlers != nullptr) {
      driver_loaded = true;
      has_new_driver = true;
    }
    else {
      BOOST_LOG_TRIVIAL(info) << "installing 3dx drivers";
      LOAD_FUNC(InstallConnexionHandlers);
      driver_loaded = (InstallConnexionHandlers != nullptr);
    }
 
    if (driver_loaded) {
      LOAD_FUNC(CleanupConnexionHandlers);
      LOAD_FUNC(RegisterConnexionClient);
      LOAD_FUNC(SetConnexionClientButtonMask);
      LOAD_FUNC(UnregisterConnexionClient);
      LOAD_FUNC(ConnexionClientControl);
    }
  }
  else {
    BOOST_LOG_TRIVIAL(error) << "3dx drivers module loading error: "<< dlerror() ;
  }
 
  BOOST_LOG_TRIVIAL(info) << "3dx drivers loaded: " << (driver_loaded ? (has_new_driver ? "YES, new" : "YES, old") : "NO");
  return driver_loaded;
}

References driver_loaded, has_new_driver, LOAD_FUNC, and module.

load_func()

void * load_func ( void * module, const char * func_name )

static

{
  void *func = dlsym(module, func_name);
 
  if (func) {
      BOOST_LOG_TRIVIAL(info) << func_name <<" loaded";
  }
  else {
    BOOST_LOG_TRIVIAL(error) <<"loading 3dx drivers dlsym error: "<< dlerror();
  }
 
  return func;
}

References module.

unload_driver()

void unload_driver ( )

static

{
  dlclose(module);
}

References module.

Variable Documentation

clientID

uint16_t clientID = 0

static

Referenced by DeviceAdded(), and DeviceEvent().

driver_loaded

bool driver_loaded = false

static

Referenced by load_driver_functions().

has_new_driver

bool has_new_driver = false

static

Referenced by load_driver_functions().

module

void* module

static

Referenced by StaticBambuLib::get(), get_function(), load_driver_functions(), load_func(), and unload_driver().

mouse_3d_controller

Slic3r::GUI::Mouse3DController* mouse_3d_controller = nullptr

static

Referenced by DeviceAdded(), DeviceEvent(), and DeviceRemoved().