qgsrubberband3d.h

Go to the documentation of this file.

/***************************************************************************
  qgsrubberband3d.h
  --------------------------------------
  Date                 : June 2021
  Copyright            : (C) 2021 by Martin Dobias
  Email                : wonder dot 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 QGSRUBBERBAND3D_H
#define QGSRUBBERBAND3D_H
 
#define SIP_NO_FILE

 
//
//  W A R N I N G
//  -------------
//
// This file is not part of the QGIS API.  It exists purely as an
// implementation detail.  This header file may change from version to
// version without notice, or even be removed.
//
 
#include "qgis_3d.h"
#include "qgsgeometry.h"
#include "qgspolygon.h"
#include "qgstessellator.h"
 
#include <QColor>
 
class QgsGeometry;
class QgsAbstract3DEngine;
class QgsPoint;
class QgsPhongMaterialSettings;
class QgsMaterial;
class QgsTessellatedPolygonGeometry;
class QgsLineMaterial;
class Qgs3DMapSettings;
class QgsBillboardGeometry;
class QgsMarkerSymbol;
class QgsPoint3DBillboardMaterial;
class QgsGeoTransform;
 
namespace Qt3DCore
{
  class QEntity;
#if QT_VERSION >= QT_VERSION_CHECK( 6, 0, 0 )
  class QBuffer;
  class QGeometry;
  class QAttribute;
#endif
} // namespace Qt3DCore
 
namespace Qt3DRender
{
#if QT_VERSION < QT_VERSION_CHECK( 6, 0, 0 )
  class QBuffer;
  class QGeometry;
  class QAttribute;
#endif
  class QGeometryRenderer;
} // namespace Qt3DRender

class _3D_EXPORT QgsRubberBand3D
{
  public:
    enum MarkerType
    {

      Square,

      Circle
    };
 
    QgsRubberBand3D( Qgs3DMapSettings &map, QgsAbstract3DEngine *engine, Qt3DCore::QEntity *parentEntity, Qgis::GeometryType geometryType = Qgis::GeometryType::Line );
    ~QgsRubberBand3D();

    float width() const;

    void setWidth( float width );

    QColor color() const;

    void setColor( QColor color );

    QColor outlineColor() const;

    void setOutlineColor( QColor color );

    void setMarkerType( MarkerType marker );

    MarkerType markerType() const;

    void setMarkerOutlineStyle( Qt::PenStyle style );

    Qt::PenStyle markerOutlineStyle() const;

    void setMarkersEnabled( bool enable );

    bool hasMarkersEnabled() const;

    void setEdgesEnabled( bool enable );

    bool hasEdgesEnabled() const;

    void setFillEnabled( bool enable );

    bool hasFillEnabled() const;
 
    void reset();
 
    void addPoint( const QgsPoint &pt );

    void setGeometry( const QgsGeometry &geometry );

    void removeLastPoint();

    void removePenultimatePoint();

    void moveLastPoint( const QgsPoint &pt );

    void setHideLastMarker( const bool hide ) { mHideLastMarker = hide; }
 
    bool isEmpty() const { return mGeometry.isEmpty(); }
 
  private:
    void updateGeometry();
    void updateMarkerMaterial();
    void setupMarker( Qt3DCore::QEntity *parentEntity );
    void setupLine( Qt3DCore::QEntity *parentEntity, QgsAbstract3DEngine *engine );
    void setupPolygon( Qt3DCore::QEntity *parentEntity );
    void removePoint( int index );
 
    const float DEFAULT_POLYGON_OPACITY = 0.25;
 
    QgsGeometry mGeometry;
    bool mHideLastMarker = false;
 
    Qgs3DMapSettings *mMapSettings = nullptr; // not owned
    QgsAbstract3DEngine *mEngine = nullptr;
    Qgis::GeometryType mGeometryType = Qgis::GeometryType::Line;

    MarkerType mMarkerType = Circle;
    float mWidth = 3.f;
    QColor mColor = Qt::red;
    QColor mOutlineColor;
    Qt::PenStyle mMarkerOutlineStyle = Qt::PenStyle::SolidLine;
 
    bool mMarkerEnabled = true;
    bool mEdgesEnabled = true;
    bool mPolygonFillEnabled = true;
 
    Qt3DCore::QEntity *mLineEntity = nullptr;    // owned by parentEntity (from constructor)
    Qt3DCore::QEntity *mPolygonEntity = nullptr; // owned by parentEntity (from constructor)
    Qt3DCore::QEntity *mMarkerEntity = nullptr;  // owned by parentEntity (from constructor)
 
    QgsGeoTransform *mLineTransform = nullptr;
    QgsGeoTransform *mPolygonTransform = nullptr;
    QgsGeoTransform *mMarkerTransform = nullptr;
 
    // all these are owned by mPolygonEntity
    QgsTessellatedPolygonGeometry *mPolygonGeometry = nullptr;
    QgsMaterial *mPolygonMaterial = nullptr;
 
    // all these are owned by mLineEntity
    Qt3DRender::QGeometryRenderer *mLineGeometryRenderer = nullptr;
#if QT_VERSION < QT_VERSION_CHECK( 6, 0, 0 )
    Qt3DRender::QGeometry *mLineGeometry = nullptr;
    Qt3DRender::QAttribute *mPositionAttribute = nullptr;
    Qt3DRender::QAttribute *mIndexAttribute = nullptr;
#else
    Qt3DCore::QGeometry *mLineGeometry = nullptr;
    Qt3DCore::QAttribute *mPositionAttribute = nullptr;
    Qt3DCore::QAttribute *mIndexAttribute = nullptr;
#endif
    QgsLineMaterial *mLineMaterial = nullptr;
 
    // and these are owned by mMarkerEntity
    Qt3DRender::QGeometryRenderer *mMarkerGeometryRenderer = nullptr;
    QgsBillboardGeometry *mMarkerGeometry = nullptr;
    QgsPoint3DBillboardMaterial *mMarkerMaterial = nullptr;
 
    std::unique_ptr<QgsMarkerSymbol> mMarkerSymbol;
 
    // Disable copying as we have pointer members.
    QgsRubberBand3D( const QgsRubberBand3D & ) = delete;
    QgsRubberBand3D &operator=( const QgsRubberBand3D & ) = delete;
};

 
#endif // QGSRUBBERBAND3D_H