GLHelper.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
// Copyright (C) 2001-2018 German Aerospace Center (DLR) and others.
// This program and the accompanying materials
// are made available under the terms of the Eclipse Public License v2.0
// which accompanies this distribution, and is available at
// http://www.eclipse.org/legal/epl-v20.html
// SPDX-License-Identifier: EPL-2.0
/****************************************************************************/
// Some methods which help to draw certain geometrical objects in openGL
/****************************************************************************/
#ifndef GLHelper_h
#define GLHelper_h


// ===========================================================================
// included modules
// ===========================================================================
#include <config.h>

#include <vector>
#include <utility>
#include <utils/common/RGBColor.h>
#include <utils/geom/PositionVector.h>


// ===========================================================================
// class definitions
// ===========================================================================
class GLHelper {
public:
    static void drawFilledPoly(const PositionVector& v, bool close);


    static void drawFilledPolyTesselated(const PositionVector& v, bool close);


    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 drawFilledCircle(double width, int steps = 8);

    static std::vector<Position> drawFilledCircleReturnVertices(double width, int steps = 8);

    static void drawFilledCircle(double width, int steps,
                                 double beg, double end);


    static void drawOutlineCircle(double width, double iwidth,
                                  int steps = 8);


    static void drawOutlineCircle(double width, double iwidth,
                                  int steps, double beg, double end);


    static void drawTriangleAtEnd(const Position& p1, const Position& p2,
                                  double tLength, double tWidth);

    static const std::vector<RGBColor>& getDottedcontourColors(const int size);

    static void drawShapeDottedContour(const int type, const PositionVector& shape, const double width);

    static void drawShapeDottedContour(const int type, const PositionVector& shape);

    static void drawShapeDottedContour(const int type, const PositionVector& frontShape, const double offsetFrontShape, const PositionVector& backShape, const double offsetBackShape);

    static void drawShapeDottedContour(const int type, const Position& center, const double width, const double height, const double rotation = 0, const double offsetX = 0, const double offsetY = 0);

    static void setColor(const RGBColor& c);

    static RGBColor getColor();

    /* @brief draw Text with given parameters
     * when width is not given (negative) the font is scaled proportionally in
     * height and with according to size.
    */
    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,
                         int align = 0,
                         double width = -1);

    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);

    static void drawTextAtEnd(const std::string& text, const PositionVector& shape, double x, double size, RGBColor color);

    static void drawCrossTies(const PositionVector& geom,
                              const std::vector<double>& rots,
                              const std::vector<double>& lengths,
                              double length, double spacing, double halfWidth, bool drawForSelecting);

    static void debugVertices(const PositionVector& shape, double size, double layer = 256);

    static void resetFont();

private:
    static int angleLookup(double angleDeg);

    static bool rightTurn(double angle1, double angle2);

    static bool initFont();

private:
    static std::vector<std::pair<double, double> > myCircleCoords;

    static struct FONScontext* myFont;
    static double myFontSize;

    static std::vector<RGBColor> myDottedcontourColors;
};


#endif

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