Shape.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2012-2026 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 2D- or 3D-Shape
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <string>
#include <map>
#include <utils/common/Named.h>
#include <utils/common/RGBColor.h>
#include <utils/common/Parameterised.h>
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class Shape : public Named {
public:
    static const std::string DEFAULT_TYPE;
    static const double DEFAULT_LAYER;
    static const double DEFAULT_LINEWIDTH;
    static const double DEFAULT_LAYER_POI;
    static const double DEFAULT_ANGLE;
    static const std::string DEFAULT_IMG_FILE;
    static const double DEFAULT_IMG_WIDTH;
    static const double DEFAULT_IMG_HEIGHT;
    static const double DEFAULT_HEIGHT;
    static const std::string DEFAULT_NAME;
    static const Parameterised::Map DEFAULT_PARAMETERS;
 
    Shape(const std::string& id);
 
    Shape(const std::string& id, const std::string& type, const RGBColor& color, double layer,
          double angle, const std::string& imgFile, const std::string& name);
 
    virtual ~Shape();
 
    void writeShapeAttributes(OutputDevice& device, const RGBColor& defaultColor, const double defaultLayer) const;
 
 
    const std::string& getShapeType() const;
 
    const RGBColor& getShapeColor() const;
 
    double getShapeLayer() const;
 
    double getShapeNaviDegree() const;
 
    const std::string& getShapeImgFile() const;
 
    const std::string& getShapeName() const;
 
 
 
    void setShapeType(const std::string& type);
 
    void setShapeColor(const RGBColor& col);
 
    void setShapeAlpha(unsigned char alpha);
 
    void setShapeLayer(const double layer);
 
    virtual void setShapeNaviDegree(const double angle);
 
    void setShapeImgFile(const std::string& imgFile);
 
    void setShapeName(const std::string& name);
 
 
private:
    std::string myType = DEFAULT_TYPE;
 
    RGBColor myColor = RGBColor::BLACK;
 
    double myLayer = DEFAULT_LAYER;
 
    double myNaviDegreeAngle = DEFAULT_ANGLE;
 
    std::string myImgFile = DEFAULT_IMG_FILE;
 
    std::string myName = DEFAULT_NAME;
};