coVRPluginList.h

Go to the documentation of this file.

/* This file is part of COVISE.

   You can use it under the terms of the GNU Lesser General Public License
   version 2.1 or later, see lgpl-2.1.txt.

 * License: LGPL 2+ */

#ifndef COVR_PLUGIN_LIST_H
#define COVR_PLUGIN_LIST_H

#include "coVRDynLib.h"
#include "coVRPlugin.h"
#include <osg/Drawable>
#include <map>

namespace covise
{
class Message;
};

namespace osg
{
class Node;
class Group;
};

namespace opencover
{
class RenderObject;
class coInteractor;

class COVEREXPORT coVRPluginList
{
    friend class coVRPluginSupport;
    friend class OpenCOVER;

public:
    enum PluginDomain
    {
        Default,
        Window,
        Input,
        NumPluginDomains // keep last
    };

    // plugin management functions
    static coVRPluginList *instance();
    void loadDefault();

    coVRPlugin *getPlugin(const char *name) const;

    coVRPlugin *addPlugin(const char *name, PluginDomain domain=Default);

    void unload(coVRPlugin *m);

    //
    // methods forwarded to plugins

    void notify(int level, const char *text) const;

    void addNode(osg::Node *, const RenderObject *o = NULL, coVRPlugin *addingPlugin = NULL) const;

    void addObject(const RenderObject *container, osg::Group *root,
            const RenderObject *geometry, const RenderObject *normals, const RenderObject *colors, const RenderObject *texture) const;

    void newInteractor(const RenderObject *container, coInteractor *it) const;

    bool requestInteraction(coInteractor *inter, osg::Node *triggerNode, bool isMouse);

    void coviseError(const char *error) const;

    void guiToRenderMsg(const char *msg) const;

    void removeObject(const char *objName, bool replaceFlag) const;
    void removeNode(osg::Node *node, bool isGroup = false, osg::Node *realNode = NULL) const;
    bool update() const;
    void preFrame();
    void postFrame() const;
    void preDraw(osg::RenderInfo &renderInfo) const;
    void preSwapBuffers(int windowNumber) const;
    void clusterSyncDraw() const;
    void postSwapBuffers(int windowNumber) const;
    void param(const char *paramName, bool inMapLoading) const;
    bool key(int type, int keySym, int mod) const;
    bool userEvent(int mod) const;
    void requestTimestep(int timestep);
    void setTimestep(int timestep);
    void message(int toWhom, int t, int l, const void *b) const;
    void forwardMessage(int len, const void *buf) const;
    void requestQuit(bool killSession) const;
    bool sendVisMessage(const covise::Message *msg) const;
    bool becomeCollaborativeMaster() const;
    covise::Message *waitForVisMessage(int messageType) const;
    bool executeAll() const;
    void expandBoundingSphere(osg::BoundingSphere &bs) const;

    void commitTimestep(int t, coVRPlugin *caller);

    void unloadAllPlugins(PluginDomain domain=Default);

private:
    coVRPluginList();
    ~coVRPluginList();
    void init();
    void init2();
    void unloadQueued();
    void manage(coVRPlugin *plug, PluginDomain domain);
    void unmanage(coVRPlugin *plug);

    coVRPlugin *loadPlugin(const char *name, bool showErrors = true);

    void grabKeyboard(coVRPlugin *);
    coVRPlugin *keyboardGrabber() const
    {
        return keyboardPlugin;
    }
    int pointerGrabbed;
    coVRPlugin *keyboardPlugin;

    void grabViewer(coVRPlugin *);
    coVRPlugin *viewerGrabber() const;
    coVRPlugin *viewerPlugin = nullptr;

    static coVRPluginList *singleton;
    void updateState();

    typedef std::map<std::string, coVRPlugin *> PluginMap;
    PluginMap m_plugins;
    std::vector<coVRPlugin *> m_loadedPlugins[NumPluginDomains];

    typedef std::vector<CO_SHLIB_HANDLE> HandleList;
    HandleList m_unloadNext, m_unloadQueue;
    int m_numOutstandingTimestepPlugins = 0;
    int m_requestedTimestep = -1;
    int m_currentTimestep = 0;
};
}
#endif