GUIGlObject.h

Go to the documentation of this file.

/****************************************************************************/
// Base class for all objects that may be displayed within the openGL-gui
/****************************************************************************/
// SUMO, Simulation of Urban MObility; see http://sumo.sourceforge.net/
// Copyright 2001-2010 DLR (http://www.dlr.de/) and contributors
/****************************************************************************/
//
//   This program is free software; you can redistribute it and/or modify
//   it under the terms of the GNU General Public License as published by
//   the Free Software Foundation; either version 2 of the License, or
//   (at your option) any later version.
//
/****************************************************************************/
#ifndef GUIGlObject_h
#define GUIGlObject_h


// ===========================================================================
// included modules
// ===========================================================================
#ifdef _MSC_VER
#include <windows_config.h>
#else
#include <config.h>
#endif

#include <string>
#include "GUIGlObjectTypes.h"
#include <utils/geom/Boundary.h>

#ifdef _WIN32
#include <windows.h>
#endif

#include <GL/gl.h>


// ===========================================================================
// class declarations
// ===========================================================================
class GUIGlObjectStorage;
class GUIParameterTableWindow;
class GUIMainWindow;
class GUIGLObjectPopupMenu;
class GUISUMOAbstractView;
class GUIVisualizationSettings;


// ===========================================================================
// class definitions
// ===========================================================================
class GUIGlObject {
public:
    GUIGlObject(GUIGlObjectStorage &idStorage,
                std::string fullName) throw();


    GUIGlObject(std::string fullName, GLuint glID) throw();


    virtual ~GUIGlObject() throw();




    const std::string &getFullName() const throw() {
        return myFullName;
    }


    GLuint getGlID() const throw() {
        return myGlID;
    }



    friend class GUIGlObjectStorage;





    virtual GUIGLObjectPopupMenu *getPopUpMenu(
        GUIMainWindow &app, GUISUMOAbstractView &parent) throw() = 0;


    virtual GUIParameterTableWindow *getParameterWindow(
        GUIMainWindow &app, GUISUMOAbstractView &parent) throw() = 0;


    virtual const std::string &getMicrosimID() const throw() = 0;


    virtual GUIGlObjectType getType() const throw() = 0;


    virtual Boundary getCenteringBoundary() const throw() = 0;


    virtual void drawGL(const GUIVisualizationSettings &s) const throw() = 0;



    virtual bool active() const throw() {
        return true;
    }


protected:


    void buildPopupHeader(GUIGLObjectPopupMenu *ret,
                          GUIMainWindow &app, bool addSeparator=true) throw();


    void buildCenterPopupEntry(GUIGLObjectPopupMenu *ret, bool addSeparator=true) throw();


    void buildNameCopyPopupEntry(GUIGLObjectPopupMenu *ret,
                                 bool addSeparator=true) throw();


    void buildSelectionPopupEntry(GUIGLObjectPopupMenu *ret,
                                  bool addSeparator=true) throw();


    void buildShowParamsPopupEntry(GUIGLObjectPopupMenu *ret,
                                   bool addSeparator=true) throw();


    void buildPositionCopyEntry(GUIGLObjectPopupMenu *ret,
                                bool addSeparator=true) throw();


    void buildShowManipulatorPopupEntry(GUIGLObjectPopupMenu *ret,
                                        bool addSeparator=true) throw();

private:
    void setGlID(GLuint id) throw();


private:
    GLuint myGlID;

    std::string myFullName;

};


#endif

/****************************************************************************/