OgreHapticsForceEffectAlgorithm.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 _OgreHapticsForceEffectAlgorithm_H__
#define _OgreHapticsForceEffectAlgorithm_H__

#include "OgreHapticsPrerequisites.h"
#include "OgreHapticsForceOutput.h"

namespace OgreHaptics {

    class _OgreHapticsExport ForceEffectAlgorithm : public StringInterface
    {
    public:
        ForceEffectAlgorithm(const String& type);
        virtual ~ForceEffectAlgorithm() {}

        virtual const String& getType(void) const { return mType; }

        virtual void reset(void) {}

        virtual const ForceOutput& calculateForces(const Vector3& position,
            const Quaternion& orientation, const Vector3& linearVelocity,
            const Vector3& angularVelocity, double timeElapsed) = 0;
    protected:
        String mType;
        ForceOutput mOutput;
    };

    typedef std::vector<ForceEffectAlgorithm*> ForceEffectAlgorithmList;

    class _OgreHapticsExport ForceEffectAlgorithmFactory
    {
    public:
        ForceEffectAlgorithmFactory() {}
        virtual ~ForceEffectAlgorithmFactory();

        virtual String getName(void) const = 0;

        virtual ForceEffectAlgorithm* createAlgorithm(void) = 0;
        virtual void destroyAlgorithm(ForceEffectAlgorithm* algorithm);
    protected:
        ForceEffectAlgorithmList mAlgorithms;
    };

}

#endif

---

Last modified Tue Jan 6 22:31:25 2009