FSUSBJoyStickInputElement.h

Go to the documentation of this file.

/**************************************************************************
Created by Alan Uthoff on 11/12/2013
Copyright (C) 2013

This Code is free software; you can redistribute it and/or
modify it under the terms of the zlib/libpng License as published
by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This software is provided 'as-is', without any express or implied warranty.

In no event will the authors be held liable for any damages arising from the use of this software.

Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute
it freely, subject to the following restrictions:

1. The origin of this software must not be misrepresented;
you must not claim that you wrote the original software.
If you use this software in a product, an acknowledgment
in the product documentation would be appreciated but is not required.

2. Altered source versions must be plainly marked as such,
and must not be misrepresented as being the original software.

3. This notice may not be removed or altered from any source distribution.
**************************************************************************/

#pragma once
#include "FSUSBDevice.h"
#include <map>
#include "FSUSBDeviceManager.h"
#include <stack>
#include <queue>
namespace freestick
{


    class FSUSBJoyStickInputElement : public FSUSBDevice
    {
    private:
        minMaxNumber _elementMin;
        minMaxNumber _elementMax;
        minMaxNumber _oldValue;
        minMaxNumber _value;
        minMaxNumber _deadZoneMin;
        minMaxNumber _deadZoneMax;
        bool _needsDeadZone;
        bool _calibrated;
        bool _intialized;
        FSUSBDeviceManager * _usbDeviceManager;
        time_t firstTime;
        std::queue<minMaxNumber> _lastValueStack;
        bool _useLastValueStack;
        unsigned int _parentID;
        minMaxNumber _buttonNumber;
        float _calibrationOffsetPrecent = 0.05f; //Offset used to calibrate deadzones
    protected:
        void calibrate(physicalValueNumber currentValue, minMaxNumber elementMin, minMaxNumber elementMax );
        void EmptyQue(std::stack<FSUSBElementInfoMap> & infoMapsToReturn,unsigned int sizeToleft);
    public:
        //FSUSBJoyStickInputElement(const & FSUSBJoyStickInputElement copy){}
        FSUSBJoyStickInputElement();
        FSUSBJoyStickInputElement(unsigned int id, unsigned int parentID, minMaxNumber elementMin, minMaxNumber elementMax, vendorIDType vendorID,productIDType productID,FSUSBDeviceManager & _manager,physicalValueNumber currentValue,minMaxNumber buttonNumber);
        FSUSBJoyStickInputElement(unsigned int id, unsigned int parentID, minMaxNumber elementMin, minMaxNumber elementMax, vendorIDType vendorID,productIDType productID,FSUSBDeviceManager * _manager,physicalValueNumber currentValue,minMaxNumber buttonNumber);
        void getMapping(int inputValue,std::stack<FSUSBElementInfoMap> & infoMapsToReturn) ;
        inline minMaxNumber getValue() const {return _value;}
        void setValue(minMaxNumber newValue);
        minMaxNumber getOldValue() const {return _oldValue;};
        bool isValueInDeadZone(minMaxNumber value);
        bool isIntialized();
        inline minMaxNumber getMaxValue() const {return _elementMax;}
        inline minMaxNumber getMinValue() const {return _elementMin;}
        inline minMaxNumber getDeadZoneMin() const {return _deadZoneMin;}
        inline minMaxNumber getDeadZoneMax() const {return _deadZoneMax;}
        inline minMaxNumber getButtonNumber() const {return _buttonNumber;}
        void recalibrate(physicalValueNumber currentValue, minMaxNumber elementMin, minMaxNumber elementMax );
        uint16_t getHIDUsage();
        uint16_t getHIDUsagePage();
        //used to pad out the dead zone when calibrating
        void setCalibrationOffsetPrecent(float offset ) ;
    };
}