GLHelper.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2001-2024 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
/****************************************************************************/
// Some methods which help to draw certain geometrical objects in openGL
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <vector>
#include <utility>
#include <utils/common/RGBColor.h>
#include <utils/geom/PositionVector.h>
#include <utils/gui/settings/GUIVisualizationSettings.h>
 
 
// ===========================================================================
// class declarations
// ===========================================================================
struct GUIVisualizationTextSettings;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class GLHelper {
 
public:
    static const std::vector<std::pair<double, double> >& getCircleCoords();
 
    static int angleLookup(double angleDeg);
 
    static void pushMatrix();
 
    static void popMatrix();
 
    static void pushName(unsigned int name);
 
    static void popName();
 
    static int getMatrixCounter();
 
    static void resetMatrixCounter();
 
    static int getVertexCounter();
 
    static void resetVertexCounter();
 
    static void checkCounterMatrix();
 
    static void checkCounterName();
 
    static void drawFilledPoly(const PositionVector& v, bool close);
 
 
    static void drawFilledPolyTesselated(const PositionVector& v, bool close);
 
    static void drawRectangle(const Position& center, const double width, const double height);
 
    static void drawBoxLine(const Position& beg, double rot,
                            double visLength, double width, double offset = 0);
 
 
    static void drawBoxLine(const Position& beg1, const Position& beg2,
                            double rot, double visLength, double width);
 
 
    static void drawBoxLines(const PositionVector& geom,
                             const std::vector<double>& rots, const std::vector<double>& lengths,
                             double width, int cornerDetail = 0, double offset = 0);
 
    static void drawBoxLines(const PositionVector& geom,
                             const std::vector<double>& rots, const std::vector<double>& lengths,
                             const std::vector<RGBColor>& cols,
                             double width, int cornerDetail = 0, double offset = 0);
 
 
    static void drawBoxLines(const PositionVector& geom1,
                             const PositionVector& geom2,
                             const std::vector<double>& rots, const std::vector<double>& lengths,
                             double width);
 
 
    static void drawBoxLines(const PositionVector& geom, double width);
 
 
    static void drawLine(const Position& beg, double rot,
                         double visLength);
 
 
    static void drawLine(const Position& beg1, const Position& beg2,
                         double rot, double visLength);
 
 
    static void drawLine(const PositionVector& v);
 
 
    static void drawLine(const PositionVector& v, const std::vector<RGBColor>& cols);
 
 
    static void drawLine(const Position& beg, const Position& end);
 
    static void drawFilledCircleDetailled(const GUIVisualizationSettings::Detail d, const double radius);
 
    static void drawFilledCircleDetailled(const GUIVisualizationSettings::Detail d, const double radius,
                                          double beg, double end);
 
    static void drawFilledCircle(const double widradiusth, const int steps = 8);
 
    static void drawFilledCircle(double radius, int steps,
                                 double beg, double end);
 
 
    static void drawOutlineCircle(double radius, double iRadius,
                                  int steps = 8);
 
 
    static void drawOutlineCircle(double radius, double iRadius,
                                  int steps, double beg, double end);
 
 
    static void drawTriangleAtEnd(const Position& p1, const Position& p2, double tLength,
                                  double tWidth, const double extraOffset = 0);
 
    static void setColor(const RGBColor& c);
 
    static RGBColor getColor();
 
    static double getTextWidth(const std::string& text, double size);
 
    /* @brief draw Text with given parameters
     * when width is not given (negative) the font is scaled proportionally in
     * height and width according to size.
     *
     * align: see foreign/fontstash/fontstash.h for flags
    */
    static void drawText(const std::string& text, const Position& pos,
                         const double layer, const double size,
                         const RGBColor& col = RGBColor::BLACK,
                         const double angle = 0,
                         const int align = 0,
                         double width = -1);
 
    static void drawTextSettings(
        const GUIVisualizationTextSettings& settings,
        const std::string& text, const Position& pos,
        const double scale,
        const double angle = 0,
        const double layer = 2048, // GLO_MAX
        const int align = 0); // centered
 
    static void drawTextBox(const std::string& text, const Position& pos,
                            const double layer, const double size,
                            const RGBColor& txtColor = RGBColor::BLACK,
                            const RGBColor& bgColor = RGBColor::WHITE,
                            const RGBColor& borderColor = RGBColor::BLACK,
                            const double angle = 0,
                            const double relBorder = 0.05,
                            const double relMargin = 0.5,
                            const int align = 0);
 
    static void drawTextAtEnd(const std::string& text, const PositionVector& shape, double x,
                              const GUIVisualizationTextSettings& settings, const double scale);
 
    static void drawCrossTies(const PositionVector& geom,
                              const std::vector<double>& rots,
                              const std::vector<double>& lengths,
                              double length, double spacing, double halfWidth,
                              double offset, bool lessDetail);
 
    static void drawInverseMarkings(const PositionVector& geom,
                                    const std::vector<double>& rots,
                                    const std::vector<double>& lengths,
                                    double maxLength, double spacing,
                                    double halfWidth, bool cl, bool cr, bool lefthand, double scale);
 
    static void debugVertices(const PositionVector& shape, const GUIVisualizationTextSettings& settings, double scale, double layer = 1024);
 
    static void drawBoundary(const GUIVisualizationSettings& s, const Boundary& b);
 
    static void resetFont();
 
    static void setGL2PS(bool active = true);
 
    static void drawSpaceOccupancies(const double exaggeration, const Position& pos, const double rotation,
                                     const double width, const double length, const bool vehicle);
 
private:
    static bool rightTurn(double angle1, double angle2);
 
    static bool initFont();
 
    static const std::vector<RGBColor>& getDottedcontourColors(const int size);
 
    static int myMatrixCounter;
 
    static int myVertexCounter;
 
    static int myMatrixCounterDebug;
 
    static int myNameCounter;
 
    static std::vector<std::pair<double, double> > myCircleCoords;
 
    static struct FONScontext* myFont;
    static double myFontSize;
 
    static bool myGL2PSActive;
 
    static std::vector<RGBColor> myDottedcontourColors;
};