mirror of
https://github.com/RetroDECK/Supermodel.git
synced 2024-11-22 22:05:38 +00:00
111 lines
3 KiB
C++
111 lines
3 KiB
C++
/**
|
|
** Supermodel
|
|
** A Sega Model 3 Arcade Emulator.
|
|
** Copyright 2011 Bart Trzynadlowski, Nik Henson
|
|
**
|
|
** This file is part of Supermodel.
|
|
**
|
|
** Supermodel 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 3 of the License, or (at your option)
|
|
** any later version.
|
|
**
|
|
** Supermodel 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 Supermodel. If not, see <http://www.gnu.org/licenses/>.
|
|
**/
|
|
|
|
/*
|
|
* InputSource.h
|
|
*
|
|
* Header file for CInputSource.
|
|
*/
|
|
|
|
#ifndef INCLUDED_INPUTSOURCE_H
|
|
#define INCLUDED_INPUTSOURCE_H
|
|
|
|
#include <string>
|
|
|
|
class CInputSystem;
|
|
struct ForceFeedbackCmd;
|
|
|
|
/*
|
|
* Enumeration to represent different types of sources.
|
|
*/
|
|
enum ESourceType
|
|
{
|
|
SourceInvalid = -1,
|
|
SourceEmpty = 0,
|
|
SourceSwitch = 1,
|
|
SourceHalfAxis = 2,
|
|
SourceFullAxis = 3
|
|
};
|
|
|
|
/*
|
|
* Provides values to inputs, either in the form of a bool for switch inputs or an int value within a given range for analog/axis inputs.
|
|
*/
|
|
class CInputSource
|
|
{
|
|
protected:
|
|
unsigned m_acquired;
|
|
|
|
CInputSource(ESourceType sourceType);
|
|
|
|
public:
|
|
/*
|
|
* The type of this source.
|
|
*/
|
|
const ESourceType type;
|
|
|
|
virtual void Acquire();
|
|
|
|
virtual void Release();
|
|
|
|
//
|
|
// Static helper methods
|
|
//
|
|
|
|
/*
|
|
* Clamps the given value to between the min and max values.
|
|
*/
|
|
static int Clamp(int val, int minVal, int maxVal);
|
|
|
|
/*
|
|
* Scales the given value, that falls within the stated 'from' range, to be between the given 'to' range.
|
|
*/
|
|
static int Scale(int val, int fromMinVal, int fromMaxVal, int toMinVal, int toMaxVal);
|
|
|
|
/*
|
|
* Scales the given value, that falls within the stated 'from' range, to be between the given 'to' range.
|
|
* The off values are supplied to avoid rounding errors and ensure that the scaled value has the correct off value when required.
|
|
*/
|
|
static int Scale(int val, int fromMinVal, int fromOffVal, int fromMaxVal, int toMinVal, int toOffVal, int toMaxVal);
|
|
|
|
/*
|
|
* Returns true if the source is active (taken from GetValueAsSwitch).
|
|
*/
|
|
bool IsActive();
|
|
|
|
/*
|
|
* Reads a boolean value for a switch input.
|
|
* Returns true if the value was set.
|
|
*/
|
|
virtual bool GetValueAsSwitch(bool &val) = 0;
|
|
|
|
/*
|
|
* Reads an int value for an analog/axis input, guaranteeing that the value falls within the given range and has the correct off value when required.
|
|
* Returns true if the value was set.
|
|
*/
|
|
virtual bool GetValueAsAnalog(int &val, int minVal, int offVal, int maxVal) = 0;
|
|
|
|
/*
|
|
* Sends a force feedback command to the input source.
|
|
*/
|
|
virtual bool SendForceFeedbackCmd(ForceFeedbackCmd ffCmd);
|
|
};
|
|
|
|
#endif // INCLUDED_INPUTSOURCE_H
|