GUIGlObject.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2001-2025 German Aerospace Center (DLR) and others.
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0/
// This Source Code may also be made available under the following Secondary
// Licenses when the conditions for such availability set forth in the Eclipse
// Public License 2.0 are satisfied: GNU General Public License, version 2
// or later which is available at
// https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
/****************************************************************************/
// Base class for all objects that may be displayed within the openGL-gui
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <string>
#include <set>
 
#include <utils/geom/Boundary.h>
#include <utils/common/StdDefs.h>
#include <utils/common/StringUtils.h>
#include <utils/common/StringBijection.h>
#include <utils/common/RGBColor.h>
#include <utils/foxtools/fxheader.h>
#include <utils/xml/SUMOXMLDefinitions.h>
 
#include "GUIGlObjectTypes.h"
 
 
// ===========================================================================
// definitions
// ===========================================================================
 
typedef unsigned int GUIGlID;
 
// ===========================================================================
// class declarations
// ===========================================================================
 
class GUIGlObjectStorage;
class GUIParameterTableWindow;
class GUIMainWindow;
class GUIGLObjectPopupMenu;
class GUISUMOAbstractView;
class GUIVisualizationSettings;
struct GUIVisualizationTextSettings;
 
#ifdef HAVE_OSG
namespace osg {
class Node;
}
#endif
 
// ===========================================================================
// class definitions
// ===========================================================================
 
class GUIGlObject {
 
public:
    static StringBijection<GUIGlObjectType> TypeNames;
    static const GUIGlID INVALID_ID;
    static const double INVALID_PRIORITY;
 
    GUIGlObject(GUIGlObjectType type, const std::string& microsimID, FXIcon* icon);
 
    virtual ~GUIGlObject();
 
    inline const std::string& getFullName() const {
        return myFullName;
    }
 
    virtual std::string getParentName() const;
 
    inline GUIGlID getGlID() const {
        return myGlID;
    }
 
    FXIcon* getGLIcon() const;
 
 
 
    virtual GUIGLObjectPopupMenu* getPopUpMenu(GUIMainWindow& app, GUISUMOAbstractView& parent) = 0;
 
    virtual void removedPopupMenu() {}
 
    virtual GUIParameterTableWindow* getParameterWindow(GUIMainWindow& app, GUISUMOAbstractView& parent) = 0;
 
    virtual GUIParameterTableWindow* getTypeParameterWindow(GUIMainWindow& app, GUISUMOAbstractView& parent);
 
    inline const std::string& getMicrosimID() const {
        return myMicrosimID;
    }
 
    virtual const std::string getOptionalName() const;
 
    virtual void setMicrosimID(const std::string& newID);
 
    inline GUIGlObjectType getType() const {
        return myGLObjectType;
    }
 
    virtual double getClickPriority() const {
        return (double)myGLObjectType;
    }
 
    inline bool isBlocked() const {
        return myAmBlocked;
    }
 
    inline void setBlocked(const bool state = true) {
        myAmBlocked = state;
    }
 
    virtual double getExaggeration(const GUIVisualizationSettings& s) const {
        UNUSED_PARAMETER(s);
        return 1.;
    }
 
    virtual Boundary getCenteringBoundary() const = 0;
 
    virtual Position getCenter() const {
        return getCenteringBoundary().getCenter();
    }
 
    virtual double getScaleVisual() const {
        return 1;
    }
 
    virtual void drawGL(const GUIVisualizationSettings& s) const = 0;
 
    virtual bool isGLObjectLocked() const;
 
    virtual void markAsFrontElement();
 
    virtual void deleteGLObject();
 
    virtual void selectGLObject();
 
    virtual void updateGLObject();
 
    virtual double getColorValue(const GUIVisualizationSettings& /*s*/, int /*activeScheme*/) const {
        return 0;
    }
 
    virtual void drawGLAdditional(GUISUMOAbstractView* const parent, const GUIVisualizationSettings& s) const;
 
    virtual void removeActiveAddVisualisation(GUISUMOAbstractView* const /*parent*/, int /*which*/) {}
 
    virtual void onLeftBtnPress(void* /*data*/) {}
 
#ifdef HAVE_OSG
    osg::Node* getNode() const;
 
    void setNode(osg::Node* node);
#endif
 
    void addParameterTable(GUIParameterTableWindow* w);
 
    void removeParameterTable(GUIParameterTableWindow* w);
 
    void drawName(const Position& pos, const double scale, const GUIVisualizationTextSettings& settings, const double angle = 0, bool forceShow = false) const;
 
protected:
    void buildPopUpMenuCommonOptions(GUIGLObjectPopupMenu* ret, GUIMainWindow& app, GUISUMOAbstractView* parent, const SumoXMLTag tag,
                                     const bool selected, bool addSeparator = true);
 
    void buildPopupHeader(GUIGLObjectPopupMenu* ret, GUIMainWindow& app, bool addSeparator = true);
 
    void buildCenterPopupEntry(GUIGLObjectPopupMenu* ret, bool addSeparator = true);
 
    void buildNameCopyPopupEntry(GUIGLObjectPopupMenu* ret, bool addSeparator = true);
 
    void buildSelectionPopupEntry(GUIGLObjectPopupMenu* ret, bool addSeparator = true);
 
    void buildShowParamsPopupEntry(GUIGLObjectPopupMenu* ret, bool addSeparator = true);
 
    void buildShowTypeParamsPopupEntry(GUIGLObjectPopupMenu* ret, bool addSeparator = true);
 
    void buildPositionCopyEntry(GUIGLObjectPopupMenu* ret, const GUIMainWindow& app, bool addSeparator = true) const;
 
    void buildShowManipulatorPopupEntry(GUIGLObjectPopupMenu* ret, bool addSeparator = true);
 
 
    void buildShapePopupOptions(GUIMainWindow& app, GUIGLObjectPopupMenu* ret, const std::string& type);
 
    void buildAdditionalsPopupOptions(GUIMainWindow& app, GUIGLObjectPopupMenu* ret, const std::string& type);
 
private:
    const GUIGlID myGlID;
 
    const GUIGlObjectType myGLObjectType;
 
    std::string myMicrosimID;
 
    std::string myFullName;
 
    FXIcon* myIcon;
 
    bool myAmBlocked = false;
 
    std::set<GUIParameterTableWindow*> myParamWindows;
 
#ifdef HAVE_OSG
    osg::Node* myOSGNode = nullptr;
#endif
 
    std::string createFullName() const;
 
    static StringBijection<GUIGlObjectType>::Entry GUIGlObjectTypeNamesInitializer[];
 
    GUIGlObject(const GUIGlObject&) = delete;
 
    GUIGlObject& operator=(const GUIGlObject&) = delete;
};