OISForceFeedback.h

Go to the documentation of this file.

/*
The zlib/libpng License

Copyright (c) 2005-2007 Phillip Castaneda (pjcast -- www.wreckedgames.com)

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.
*/
#ifndef OIS_ForceFeedBack_H
#define OIS_ForceFeedBack_H

#include "OISPrereqs.h"
#include "OISInterface.h"
#include "OISEffect.h"

namespace OIS
{
    class _OISExport ForceFeedback : public Interface
    {
    public:
        ForceFeedback();
        virtual ~ForceFeedback() {}

        virtual void setMasterGain( float level ) = 0;
        
        virtual void setAutoCenterMode( bool auto_on ) = 0;

        virtual void upload( const Effect* effect ) = 0;

        virtual void modify( const Effect* effect ) = 0;

        virtual void remove( const Effect* effect ) = 0;

        virtual short getFFAxesNumber() = 0;

        virtual unsigned short getFFMemoryLoad() = 0;

        typedef std::multimap<Effect::EForce, Effect::EType> SupportedEffectList;
        const SupportedEffectList& getSupportedEffects() const;

        bool supportsEffect(Effect::EForce force, Effect::EType type) const;

        void _addEffectTypes( Effect::EForce force, Effect::EType type );
        void _setGainSupport( bool on );
        void _setAutoCenterSupport( bool on );

    protected:
        SupportedEffectList mSupportedEffects;
        bool mSetGainSupport;
        bool mSetAutoCenterSupport;
    };
}
#endif //OIS_ForceFeedBack_H