OgreHapticsSystem.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 
*/
// -- Plugin management and configuration based on, and uses, Ogre::Root,
//    original copyright follows --
// 
// This source file is part of OGRE
//    (Object-oriented Graphics Rendering Engine)
// For the latest info, see http://www.ogre3d.org/
//
// Copyright (c) 2000-2006 Torus Knot Software Ltd
// Also see acknowledgements in Readme.html
//
// This program 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 of the License, or (at your option) any later
// version.
//
// This program 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 program; if not, write to the Free Software Foundation, Inc., 59 Temple
// Place - Suite 330, Boston, MA 02111-1307, USA, or go to
// http://www.gnu.org/copyleft/lesser.txt.
//
// You may alternatively use this source under the terms of a specific version of
// the OGRE Unrestricted License provided you have obtained such a license from
// Torus Knot Software Ltd.
#ifndef _OgreHapticsSystem_H__
#define _OgreHapticsSystem_H__

#include "OgreHapticsPrerequisites.h"
#include "OgreHapticsCommon.h"

namespace OgreHaptics {

    typedef std::vector<RenderSystem*> RenderSystemList;

    class _OgreHapticsExport System : public Singleton<System>
    {
    public:
        System(const String& pluginsFileName = "HapticsPlugins.cfg",
            const String& configFileName = "OgreHaptics.cfg",
            const String& logFileName = "OgreHaptics.log");
        virtual ~System();

        static System& getSingleton(void);
        static System* getSingletonPtr(void);

        Device* initialise(bool autoCreateDevice);
        void shutdown(void);
        bool isInitialised(void) const { return mIsInitialised; }

        void saveConfig(void);
        bool restoreConfig(void);
        bool showConfigDialog(void);
        void setConfigSettings(const DeviceInitInfo& configSettings);
        const DeviceInitInfo& getConfigSettings(void) const { return mConfigSettings; }

        bool setOption(const String& key, const void* value);
        bool getOption(const String& key, void* value);

        Log* getLog(void) { return mLog; }
        void logMessage(const String& message, LogMessageLevel lml = LML_NORMAL,
            bool maskDebug = false);
        Log::Stream logStream(LogMessageLevel lml = LML_NORMAL, bool maskDebug = false);

        void loadPlugin(const String& pluginName);
        void unloadPlugin(const String& pluginName);
        void installPlugin(Plugin* plugin);
        void uninstallPlugin(Plugin* plugin);

        typedef std::vector<DynLib*> PluginLibList;
        typedef std::vector<Plugin*> PluginInstanceList;

        const PluginInstanceList& getInstalledPlugins() const { return mPlugins; }

        void addRenderSystem(RenderSystem* newRend);
        RenderSystem* getRenderSystemByName(const String& name);
        RenderSystemList* getAvailableRenderSystems(void);

        const DeviceInfoList& getAvailableNamedDevices(void) const;
        unsigned int getNumConnectedDevices(void);
        
        Device* createDevice(const String& name, const DeviceInitInfo& initInfo);
        Device* createDevice(const String& name, unsigned int index, DeviceInitInfo& initInfo);
        Device* getDevice(const String& name);
        void destroyDevice(const String& name);

        void destroyDevice(Device* device);
        void destroyAllDevices(void);
        ConstDeviceIterator getDeviceIterator(void) const;

        void startSchedulers(unsigned long rate = 1000, bool autoEnableDevices = true);
        void stopSchedulers(void);

        void update(void);

        void _oneTimePostDeviceCreate(void);
    protected:
        OGREHAPTICS_AUTO_MUTEX
        bool mIsInitialised;
        bool mFirstTimePostDeviceCreate;
        String mConfigFileName;
        DeviceInitInfo mConfigSettings;
        PluginLibList mPluginLibs;
        PluginInstanceList mPlugins;

        void loadPlugins(const String& pluginsFileName = "HapticsPlugins.cfg");
        void initialisePlugins(void);
        void shutdownPlugins(void);
        void unloadPlugins(void);
    private:
        // Pointer to automatically created device, if any.
        Device* mAutoDevice;
        // Singletons
        ForceEffectManager* mForceEffectManager;
        // List of available render systems.
        RenderSystemList mRenderSystems;
        // List of available devices through all registered render systems.
        // Used for iterator.
        mutable DeviceInfoList mAvailableDevices;
        // List of managed devices.
        DeviceMap mDevices;

        String mVersion;
        Log* mLog;

#if OGRE_PLATFORM == OGRE_PLATFORM_WIN32
        // The thread affinity mask used for all OgreHaptics threads.
        DWORD mThreadAffinityMask;
#endif
    };

}

#endif

---

Last modified Tue Jan 6 22:31:25 2009