/***************************************************************************
    qgsvertexmarker.h  - canvas item which shows a simple vertex marker
    ---------------------
    begin                : February 2006
    copyright            : (C) 2006 by Martin Dobias
    email                : wonder.sk at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef QGSVERTEXMARKER_H
#define QGSVERTEXMARKER_H

#include "qgsmapcanvasitem.h"
#include "qgspointxy.h"
#include "qgis_gui.h"

class QPainter;

#ifdef SIP_RUN
% ModuleHeaderCode
// For ConvertToSubClassCode.
#include <qgsvertexmarker.h>
% End
#endif

/**
 * \ingroup gui
 * \brief A class for marking vertices of features using e.g. circles or 'x'.
 */
class GUI_EXPORT QgsVertexMarker : public QgsMapCanvasItem
{

#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    if ( dynamic_cast<QgsVertexMarker *>( sipCpp ) )
      sipType = sipType_QgsVertexMarker;
    else
      sipType = nullptr;
    SIP_END
#endif
  public:

    //! Icons
    enum IconType
    {
      ICON_NONE,
      ICON_CROSS,
      ICON_X,
      ICON_BOX,
      ICON_CIRCLE,
      ICON_DOUBLE_TRIANGLE,    //!< Added in QGIS 3.0
      ICON_TRIANGLE,  //!< Added in QGIS 3.12
      ICON_RHOMBUS,  //!< Added in QGIS 3.12
    };

    QgsVertexMarker( QgsMapCanvas *mapCanvas SIP_TRANSFERTHIS );

    /**
     * Sets the center \a point of the marker, in map coordinates.
     *
     * \see center()
     */
    void setCenter( const QgsPointXY &point );

    /**
     * Returns the center point of the marker, in map coordinates.
     *
     * \see setCenter()
     * \since QGIS 3.18
     */
    QgsPointXY center() const { return mCenter; }

    void setIconType( int iconType );

    void setIconSize( int iconSize );

    /**
     * Sets the stroke \a color for the marker.
     * \see color()
     * \see setFillColor()
     */
    void setColor( const QColor &color );

    /**
     * Returns the stroke color for the marker.
     * \see setColor()
     * \see fillColor()
     * \since QGIS 3.0
     */
    QColor color() const { return mColor; }

    /**
     * Sets the fill \a color for the marker. This setting only
     * applies to some icon types.
     * \see fillColor()
     * \see setColor()
     * \since QGIS 3.0
     */
    void setFillColor( const QColor &color );

    /**
     * Returns the fill \a color for the marker. This setting only
     * applies to some icon types.
     * \see setFillColor()
     * \see color()
     * \since QGIS 3.0
     */
    QColor fillColor() const { return mFillColor; }

    void setPenWidth( int width );

    void paint( QPainter *p ) override;

    QRectF boundingRect() const override;

    void updatePosition() override;

  private:

    //! icon to be shown
    int mIconType = ICON_X;

    //! size
    int mIconSize = 10;

    //! coordinates of the point in the center
    QgsPointXY mCenter;

    //! color of the marker
    QColor mColor = QColor( 255, 0, 0 );

    //! pen width
    int mPenWidth = 1;

    //! Fill color
    QColor mFillColor = QColor( 0, 0, 0, 0 );

};

#endif
