PointOfInterest.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2005-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
/****************************************************************************/
// A point-of-interest (2D)
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <utils/common/FileHelpers.h>
#include <utils/common/Parameterised.h>
#include <utils/common/StringBijection.h>
#include <utils/common/StringUtils.h>
#include <utils/geom/GeoConvHelper.h>
#include <utils/geom/Position.h>
#include <utils/iodevices/OutputDevice.h>
 
#include "Shape.h"
 
// ===========================================================================
// class definitions
// ===========================================================================
class PointOfInterest : public Shape, public Position, public Parameterised {
 
public:
    PointOfInterest(const std::string& id, const std::string& type,
                    const RGBColor& color, const Position& pos, bool geo,
                    const std::string& lane, double posOverLane,
                    bool friendlyPos, double posLat,
                    const std::string& icon,
                    double layer = DEFAULT_LAYER,
                    double angle = DEFAULT_ANGLE,
                    const std::string& imgFile = DEFAULT_IMG_FILE,
                    bool relativePath = DEFAULT_RELATIVEPATH,
                    double width = DEFAULT_IMG_WIDTH,
                    double height = DEFAULT_IMG_HEIGHT,
                    const std::string& name = DEFAULT_NAME,
                    const Parameterised::Map& parameters = DEFAULT_PARAMETERS);
 
    ~PointOfInterest();
 
 
    POIIcon getIcon() const;
 
    const std::string& getIconStr() const;
 
    double getWidth() const;
 
    double getHeight() const;
 
    Position getCenter() const;
 
    bool getFriendlyPos() const;
 
 
 
 
    void setIcon(const std::string& icon);
 
    void setWidth(double width);
 
    void setHeight(double height);
 
    void setFriendlyPos(const bool friendlyPos);
 
 
    /* @brief POI definition to the given device
     * @param[in] geo  Whether to write the output in geo-coordinates
     */
    void writeXML(OutputDevice& out, const bool geo = false, const double zOffset = 0., const std::string laneID = "", const double pos = 0., const bool friendlyPos = false, const double posLat = 0.) const;
 
protected:
    bool myGeo;
 
    std::string myLane;
 
    double myPosOverLane;
 
    bool myFriendlyPos;
 
    double myPosLat;
 
    POIIcon myIcon;
 
    double myHalfImgWidth;
 
    double myHalfImgHeight;
};