OgreHapticsForceEffect.h

Go to the documentation of this file.

/*
This source file is part of OgreHaptics
 (a library for wrapping haptics devices for use with the open-source
 graphics engine OGRE, http://www.ogre3d.org)

Copyright (c) 2006 - 2008 Jorrit de Vries
Also see acknowledgements in Readme.html

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public License
as published by the Free Software Foundation; either version 2.1
of the License, or (at your option) any later version.

This library 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 Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the
Free Software Foundation, Inc.,
59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 
*/
#ifndef _OgreHapticsForceEffect_H__
#define _OgreHapticsForceEffect_H__

#include "OgreHapticsPrerequisites.h"
#include "OgreHapticsAtomic.h"
#include "OgreHapticsForceEffectAlgorithm.h"
#include "OgreHapticsForceOutput.h"

namespace OgreHaptics {

    enum ForceEffectState
    {
        FES_INACTIVE,
        FES_STARTING,
        FES_FADING_IN,
        FES_SUSTAINING,
        FES_FADING_OUT
    };

    enum ForceEffectSustainMode
    {
        FESM_TEMPORAL,
        FESM_PERSISTANT
    };

    enum ForceEffectTimeType
    {
        FETT_TOTAL,
        FETT_CURRENT_STATE
    };

    class _OgreHapticsExport ForceEffect : public StringInterface
    {
        // Allow manager full access
        friend class ForceEffectManager;
    public:
        class _OgreHapticsPrivate CmdSustainMode : public ParamCommand
        {
        public:
            String doGet(const void* target) const;
            void doSet(void* target, const String& value);
        };
        class _OgreHapticsPrivate CmdSustainDuration : public ParamCommand
        {
        public:
            String doGet(const void* target) const;
            void doSet(void* target, const String& value);
        };
        class _OgreHapticsPrivate CmdFadeInDuration : public ParamCommand
        {
        public:
            String doGet(const void* target) const;
            void doSet(void* target, const String& value);
        };
        class _OgreHapticsPrivate CmdFadeOutDuration : public ParamCommand
        {
        public:
            String doGet(const void* target) const;
            void doSet(void* target, const String& value);
        };

        class Listener
        {
        public:
            virtual ~Listener() {}
            virtual void effectStarted(ForceEffect*) {}
        };

        ForceEffect(const String& name);
        virtual ~ForceEffect();
        ForceEffect& operator = (const ForceEffect& rhs);

        const String& getName(void) const { return mName; }

        const String& getOrigin(void) const { return mOrigin; }
        void _notifyOrigin(const String& origin) { mOrigin = origin; }

        void start(Device* device);
        void restart(void);
        void stop(bool immediate = false);
        bool isActive(void) const;
        ForceEffectState getState(void) const;
        void _notifyDeviceDisabled(void);

        void setSustainMode(ForceEffectSustainMode mode);
        ForceEffectSustainMode getSustainMode(void) const { return mSustainMode; };

        void setSustainDuration(long duration);
        long getSustainDuration(void) const;
        void setFadeInDuration(long duration);
        long getFadeInDuration(void) const;
        void setFadeOutDuration(long duration);
        long getFadeOutDuration(void) const;
        long getRemainingTime(ForceEffectTimeType type = FETT_TOTAL) const;

        void setListener(Listener* listener) { mListener = listener; }
        Listener* getListener(void) const { return mListener; }

        void setAlgorithmParameter(unsigned short index, const String& name,
            const String& value);
        void setAlgorithmParameterList(unsigned short index,
            const NameValuePairList& paramList);
        void setAllAlgorithmsParameter(const String& name, const String& value);
        void setAllAlgorithmsParameterList(const NameValuePairList& paramList);

        ForceEffectAlgorithm* addAlgorithm(const String& algorithmType);
        ForceEffectAlgorithm* getAlgorithm(unsigned short index) const;
        void removeAlgorithm(unsigned short index);
        void removeAllAlgorithms(void);
        unsigned short getNumAlgorithms(void) const;
        typedef VectorIterator<ForceEffectAlgorithmList> AlgorithmIterator;
        AlgorithmIterator getAlgorithmIterator(void);

        void _applyAlgorithmParameters(void);
        void _setState(ForceEffectState state, double currentTime);
        void _resetAlgorithms(void);
        const ForceOutput& _calculateForces(const Vector3& position,
            const Quaternion& orientation, const Vector3& linearVelocity,
            const Vector3& angularVelocity, double timeElapsed);
        Real _getLerpFraction(double currentTime, bool fadingIn);
    protected:
        // Command objects
        static CmdSustainMode msSustainModeCmd;
        static CmdSustainDuration msSustainDurationCmd;
        static CmdFadeInDuration msFadeInDurationCmd;
        static CmdFadeOutDuration msFadeOutDurationCmd;

        Device* mDevice;
        Listener* mListener;
        bool mhtIsMaxLerpFractionSet;
        long mhtCurrentStateDuration;
        double mhtCurrentStateStartTime;
        Real mhtMaxLerpFraction;
        ForceEffectSustainMode mSustainMode;
        String mName;
        String mOrigin;
        AtomicScalar<ForceEffectState> mState;
        AtomicScalar<long> mSustainDuration;
        AtomicScalar<long> mFadeInDuration;
        AtomicScalar<long> mFadeOutDuration;
        AtomicScalar<int> mDurationChanged;
        AtomicScalar<long> mCurrentStateRemainingTime;
        AtomicScalar<long> mTotalRemainingTime;
        ForceOutput mOutput;
        ForceEffectAlgorithmList mAlgorithms;
        typedef std::map<unsigned short, NameValuePairList> AlgorithmsParameterMap;
        AlgorithmsParameterMap mAlgorithmsParameterMap;

        void updateRemainingTime(double timeElapsed);
    };

}

#endif

---

Last modified Tue Jan 6 22:31:25 2009