coInteractor.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 CO_INTERACTOR_H
#define CO_INTERACTOR_H

#include <util/coExport.h>

#include <cstring>
#include <cstdio>
#include <string>
#include <osg/Referenced>

namespace opencover
{
class RenderObject;

class COVEREXPORT coInteractor
{
public:
    coInteractor();
    virtual ~coInteractor();

    int refCount() const;

    void incRefCount();

    void decRefCount();

    virtual void removedObject() = 0;

    virtual bool isSameModule(coInteractor *i) const = 0;

    virtual bool isSame(coInteractor *i) const = 0;

    virtual void executeModule() = 0;

    virtual void copyModule() = 0;

    virtual void copyModuleExec() = 0;

    virtual void deleteModule() = 0;

    // --- all getParameter Functions
    //       - return -1 on fail (illegal type requested), 0 if ok
    //       - only work for coFeedback created parameter messages
    //       - do not change the value fields if type incorrect

    virtual int getBooleanParam(const std::string &paraName, int &value) const = 0;
    virtual int getIntScalarParam(const std::string &paraName, int &value) const = 0;
    virtual int getFloatScalarParam(const std::string &paraName, float &value) const = 0;
    virtual int getIntSliderParam(const std::string &paraName, int &min, int &max, int &val) const = 0;
    virtual int getFloatSliderParam(const std::string &paraName, float &min, float &max, float &val) const = 0;
    virtual int getIntVectorParam(const std::string &paraName, int &numElem, int *&val) const = 0;
    virtual int getFloatVectorParam(const std::string &paraName, int &numElem, float *&val) const = 0;
    virtual int getStringParam(const std::string &paraName, const char *&val) const = 0;
    virtual int getChoiceParam(const std::string &paraName, int &num, char **&labels, int &active) const = 0;
    virtual int getFileBrowserParam(const std::string &paraName, char *&val) const = 0;

    // --- set-Functions:

    virtual void setBooleanParam(const char *name, int val) = 0;

    virtual void setScalarParam(const char *name, float val) = 0;

    virtual void setScalarParam(const char *name, int val) = 0;

    virtual void setSliderParam(const char *name, float min, float max, float value) = 0;

    virtual void setSliderParam(const char *name, int min, int max, int value) = 0;

    virtual void setVectorParam(const char *name, int numElem, float *field) = 0;
    virtual void setVectorParam(const char *name, float u, float v, float w) = 0;

    virtual void setVectorParam(const char *name, int numElem, int *field) = 0;
    virtual void setVectorParam(const char *name, int u, int v, int w) = 0;

    virtual void setStringParam(const char *name, const char *val) = 0;

    virtual void setChoiceParam(const char *name, int num, const char *const *list, int pos) = 0;

    virtual void setFileBrowserParam(const char *name, const char *val) = 0;

    // name of the covise data object which has feedback attributes
    virtual const char *getObjName() = 0;

    // the covise data object which has feedback attributes
    virtual RenderObject *getObject() = 0;

    // get the name of the module which created the data object
    virtual const char *getPluginName() = 0;

    // get the name of the module which created the data object
    virtual const char *getModuleName() = 0;

    // get the instance number of the module which created the data object
    virtual int getModuleInstance() = 0;

    // get the hostname of the module which created the data object
    virtual const char *getModuleHost() = 0;

    // -- The following functions only works for coFeedback attributes
    virtual int getNumParam() const = 0;

    virtual int getNumUser() const = 0;

    // get a User-supplied string
    virtual const char *getString(unsigned int i) const = 0;

private:
    int d_refCount;
};

class COVEREXPORT InteractorReference: public osg::Referenced
{
public:
    InteractorReference(opencover::coInteractor *inter)
    : m_interactor(inter)
    {
        if (m_interactor)
            m_interactor->incRefCount();
    }

    ~InteractorReference()
    {
        if (m_interactor)
            m_interactor->decRefCount();
    }

    opencover::coInteractor *interactor() const
    {
        return m_interactor;
    }

private:
    opencover::coInteractor *m_interactor = nullptr;
};

}
#endif