GHOST_NDOFManagerCocoa.mm

Go to the documentation of this file.

/*
 * $Id: GHOST_NDOFManagerCocoa.mm 39307 2011-08-11 15:59:19Z nazgul $
 *
 * ***** BEGIN GPL LICENSE BLOCK *****
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version. 
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * Contributor(s):
 *   Mike Erwin
 *
 * ***** END GPL LICENSE BLOCK *****
 */

#ifdef WITH_INPUT_NDOF

#include "GHOST_NDOFManagerCocoa.h"
#include "GHOST_SystemCocoa.h"

extern "C" {
        #include <3DconnexionClient/ConnexionClientAPI.h>
        #include <stdio.h>
        }

// static functions need to talk to these objects:
static GHOST_SystemCocoa* ghost_system = NULL;
static GHOST_NDOFManager* ndof_manager = NULL;

// 3Dconnexion drivers before 10.x are "old"
// not all buttons will work
static bool has_old_driver = true;

static void NDOF_DeviceAdded(io_connect_t connection)
{
        printf("ndof: device added\n"); // change these: printf --> informational reports

#if 0 // device preferences will be useful some day
        ConnexionDevicePrefs p;
        ConnexionGetCurrentDevicePrefs(kDevID_AnyDevice, &p);
#endif

        // determine exactly which device is plugged in
        SInt32 result = 0;
        ConnexionControl(kConnexionCtlGetDeviceID, 0, &result);
        unsigned short vendorID = result >> 16;
        unsigned short productID = result & 0xffff;

        ndof_manager->setDevice(vendorID, productID);
}

static void NDOF_DeviceRemoved(io_connect_t connection)
{
        printf("ndof: device removed\n");
}

static void NDOF_DeviceEvent(io_connect_t connection, natural_t messageType, void* messageArgument)
{
        switch (messageType)
        {
                case kConnexionMsgDeviceState:
                {
                        ConnexionDeviceState* s = (ConnexionDeviceState*)messageArgument;

                        GHOST_TUns64 now = ghost_system->getMilliSeconds();

                        switch (s->command)
                        {
                                case kConnexionCmdHandleAxis:
                                {
                                        // convert to blender view coordinates
                                        short t[3] = {s->axis[0], -(s->axis[2]), s->axis[1]};
                                        short r[3] = {-(s->axis[3]), s->axis[5], -(s->axis[4])};

                                        ndof_manager->updateTranslation(t, now);
                                        ndof_manager->updateRotation(r, now);

                                        ghost_system->notifyExternalEventProcessed();
                                        break;
                                }
                                case kConnexionCmdHandleButtons:
                                {
                                        int button_bits = has_old_driver ? s->buttons8 : s->buttons;
                                        ndof_manager->updateButtons(button_bits, now);
                                        ghost_system->notifyExternalEventProcessed();
                                        break;
                                }
                                case kConnexionCmdAppSpecific:
                                        printf("ndof: app-specific command, param = %hd, value = %d\n", s->param, s->value);
                                        break;

                                default:
                                        printf("ndof: mystery device command %d\n", s->command);
                        }
                        break;
                }
                case kConnexionMsgPrefsChanged:
                        // printf("ndof: prefs changed\n"); // this includes app switches
                        // TODO: look through updated prefs for things blender cares about
                        break;
                case kConnexionMsgCalibrateDevice:
                        printf("ndof: calibrate\n"); // but what should blender do?
                        break;
                case kConnexionMsgDoMapping:
                        // printf("ndof: driver did something\n");
                        // sent when the driver itself consumes an NDOF event
                        // and performs whatever action is set in user prefs
                        // 3Dx header file says to ignore these
                        break;
                default:
                        printf("ndof: mystery event %d\n", messageType);
        }
}

GHOST_NDOFManagerCocoa::GHOST_NDOFManagerCocoa(GHOST_System& sys)
    : GHOST_NDOFManager(sys)
{
        if (available())
        {
                // give static functions something to talk to:
                ghost_system = dynamic_cast<GHOST_SystemCocoa*>(&sys);
                ndof_manager = this;

                OSErr error = InstallConnexionHandlers(NDOF_DeviceEvent, NDOF_DeviceAdded, NDOF_DeviceRemoved);
                if (error) {
                        printf("ndof: error %d while installing handlers\n", error);
                        return;
                }

                // Pascal string *and* a four-letter constant. How old-skool.
                m_clientID = RegisterConnexionClient('blnd', (UInt8*) "\007blender",
                                                     kConnexionClientModeTakeOver, kConnexionMaskAll);

                // printf("ndof: client id = %d\n", m_clientID);

                if (SetConnexionClientButtonMask != NULL) {
                        has_old_driver = false;
                        SetConnexionClientButtonMask(m_clientID, kConnexionMaskAllButtons);
                }
                else {
                        printf("ndof: old 3Dx driver installed, some buttons may not work\n");
                }
        }
        else {
                printf("ndof: 3Dx driver not found\n");
                // This isn't a hard error, just means the user doesn't have a 3D mouse.
        }
}

GHOST_NDOFManagerCocoa::~GHOST_NDOFManagerCocoa()
{
        if (available())
        {
                UnregisterConnexionClient(m_clientID);
                CleanupConnexionHandlers();
                ghost_system = NULL;
                ndof_manager = NULL;
        }
}
extern "C" {
        bool GHOST_NDOFManagerCocoa::available()
        {
                extern OSErr InstallConnexionHandlers() __attribute__((weak_import));
                // Make the linker happy for the framework check (see link below for more info)
                // http://developer.apple.com/documentation/MacOSX/Conceptual/BPFrameworks/Concepts/WeakLinking.html
                return InstallConnexionHandlers != NULL;
                // this means that the driver is installed and dynamically linked to blender
        }
}
#endif // WITH_INPUT_NDOF