coGRMsg.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+ */

//-*-Mode: C++;-*-
// +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
// ++                                                  (C)2006 VISENSO    ++
// ++ coGRMsg - Covise GUI to Renderer Messages                           ++
// ++           Base class for all messages                               ++
// +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

#ifndef COGRMSG_H
#define COGRMSG_H

#include <string>
#include <vector>
#include <util/coExport.h>
using namespace std;

#ifdef WIN32
#define strdup _strdup
#endif //WIN32
#ifndef COGRMSG_SAFEFREE
#define COGRMSG_SAFEFREE(x) \
    if (x)                  \
    {                       \
        free(x);            \
        x = NULL;           \
    }
#endif //COGRMSG_SAFEFREE

namespace grmsg
{

class GRMSGEXPORT coGRMsg
{
public:
    typedef enum
    {
        NO_TYPE = 0,
        REGISTER,
        GEO_VISIBLE,
        INTERACTOR_VISIBLE,
        SMOKE_VISIBLE,
        MOVE_INTERACTOR,
        INTERACTOR_USED,
        CREATE_VIEWPOINT,
        CREATE_DEFAULT_VIEWPOINT,
        SHOW_VIEWPOINT, //9
        SHOW_PRESENTATIONPOINT,
        CHANGE_VIEWPOINT_ID,
        CHANGE_VIEWPOINT_NAME,
        DELETE_VIEWPOINT,
        FLYMODE_TOGGLE,
        SET_CASE,
        SET_NAME,
        MOVE_OBJECT,
        ADD_DOCUMENT,
        SET_DOCUMENT_PAGE, //19
        SET_DOCUMENT_SCALE,
        SET_DOCUMENT_POSITION,
        SET_DOCUMENT_PAGESIZE,
        SEND_DOCUMENT_NUMBERS,
        DOC_VISIBLE,
        BOUNDARIES_OBJECT,
        COLOR_OBJECT,
        SHADER_OBJECT, // 27
        MATERIAL_OBJECT,
        SET_TRANSPARENCY,
        KEYWORD,
        TRANSFORM_OBJECT,
        TRANSFORM_CASE,
        RESTRICT_AXIS,
        GRAPHIC_RESSOURCE,
        SET_MOVE,
        SET_MOVE_SELECTED,
        SENSOR,
        SENSOR_EVENT,
        ATTACHED_CLIPPLANE,
        ANIMATION_ON,
        ANIMATION_SPEED,
        ANIMATION_TIMESTEP,
        ACTIVATED_VIEWPOINT,
        VPCLIPPLANEMODE_TOGGLE,
        SNAPSHOT,
        SEND_CURRENT_DOCUMENT,
        SET_TRACKING_PARAMS,
        CHANGE_VIEWPOINT,
        VIEWPOINT_CHANGED,
        OBJECT_TRANSFORMED,
        SET_CONNECTIONPOINT,
        GENERIC_PARAM_REGISTER,
        GENERIC_PARAM_CHANGED,
        TRANSFORM_SGITEM,
        SELECT_OBJECT,
        DELETE_OBJECT,
        GEOMETRY_OBJECT, // KLSM
        ADD_CHILD_OBJECT, // KLSM
        TURNTABLE_ANIMATION,
        SET_VARIANT, // KLSM
        SET_APPEARANCE, // KLSM
        KINEMATICS_STATE // KLSM
    } Mtype; //, PLANEINT, BBINT, COLOR, MATERIAL, SELECT, VIEWPOINT, CLIPLANE } Mtype;

    coGRMsg(const char *msg);

    virtual ~coGRMsg()
    {
        if (str_)
            delete[] str_;
    };

    int isValid()
    {
        return (is_valid_ == 1);
    };

    virtual void print_stdout();

    Mtype getType()
    {
        return type_;
    };
    const char *c_str();
    string getString()
    {
        return content_;
    };

protected:
    coGRMsg(Mtype type);

    void addToken(const char *token);

    string getFirstToken();

    string extractFirstToken();

    vector<string> getAllTokens();

    int is_valid_;

private:
    const char SplitToken;

    const string MsgID;

    Mtype type_;
    string content_;
    char *str_;
};
}
#endif