qgsrubberband3d.cpp

Go to the documentation of this file.

/***************************************************************************
  qgsrubberband3d.cpp
  --------------------------------------
  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.                                   *
 *                                                                         *
 ***************************************************************************/
 
#include "qgsrubberband3d.h"
 
#include "qgs3d.h"
#include "qgs3dmapscene.h"
#include "qgs3dmapsettings.h"
#include "qgs3dutils.h"
#include "qgsabstract3dengine.h"
#include "qgsbillboardgeometry.h"
#include "qgsframegraph.h"
#include "qgsgeotransform.h"
#include "qgslinematerial_p.h"
#include "qgslinestring.h"
#include "qgslinevertexdata_p.h"
#include "qgsmarkersymbol.h"
#include "qgsmaterial3dhandler.h"
#include "qgsmessagelog.h"
#include "qgspoint3dbillboardmaterial.h"
#include "qgspolygon.h"
#include "qgsrubberbandrenderview.h"
#include "qgssymbollayer.h"
#include "qgssymbollayerutils.h"
#include "qgstessellatedpolygongeometry.h"
#include "qgstessellator.h"
#include "qgsunlitmaterial.h"
#include "qgsvertexid.h"
 
#include <QColor>
#include <QString>
#include <Qt3DCore/QAttribute>
#include <Qt3DCore/QBuffer>
#include <Qt3DCore/QEntity>
#include <Qt3DCore/QGeometry>
#include <Qt3DRender/QGeometryRenderer>
 
using namespace Qt::StringLiterals;

 
 
QgsRubberBand3D::QgsRubberBand3D( Qgs3DMapScene *scene, const Qgis::GeometryType geometryType )
  : mMapSettings( scene->mapSettings() )
  , mEngine( scene->engine() )
  , mGeometryType( geometryType )
{
  Qt3DCore::QEntity *parentEntity = mEngine->frameGraph()->rubberBandRenderView().rubberBandEntity();
 
  switch ( mGeometryType )
  {
    case Qgis::GeometryType::Point:
      setupMarker( parentEntity );
      break;
    case Qgis::GeometryType::Line:
      setupLine( parentEntity );
      setupMarker( parentEntity );
      break;
    case Qgis::GeometryType::Polygon:
      setupMarker( parentEntity );
      setupLine( parentEntity );
      setupPolygon( parentEntity );
      break;
    case Qgis::GeometryType::Null:
    case Qgis::GeometryType::Unknown:
      QgsDebugError( "Unknown GeometryType used in QgsRubberband3D" );
      break;
  }
}
 
void QgsRubberBand3D::setupMarker( Qt3DCore::QEntity *parentEntity )
{
  mMarkerEntity = make_qobject_unique<Qt3DCore::QEntity>( parentEntity );
  mMarkerGeometry = new QgsBillboardGeometry();
  mMarkerGeometryRenderer = new Qt3DRender::QGeometryRenderer;
  mMarkerGeometryRenderer->setPrimitiveType( Qt3DRender::QGeometryRenderer::TriangleStrip );
  mMarkerGeometryRenderer->setGeometry( mMarkerGeometry );
  mMarkerGeometryRenderer->setVertexCount( 4 );
  mMarkerGeometryRenderer->setInstanceCount( 0 );
 
  setMarkerType( mMarkerType );
  mMarkerEntity->addComponent( mMarkerGeometryRenderer );
 
  mMarkerTransform = new QgsGeoTransform;
  mMarkerTransform->setOrigin( mMapSettings->origin() );
  mMarkerEntity->addComponent( mMarkerTransform );
}
 
void QgsRubberBand3D::setupLine( Qt3DCore::QEntity *parentEntity )
{
  mLineEntity = make_qobject_unique<Qt3DCore::QEntity>( parentEntity );
 
  QgsLineVertexData dummyLineData;
  mLineGeometry = dummyLineData.createGeometry( mLineEntity );
 
  Q_ASSERT( mLineGeometry->attributes().count() == 5 );
  mPointAAttribute = mLineGeometry->attributes().at( 1 );
  mPointBAttribute = mLineGeometry->attributes().at( 2 );
  mPointPrevAttribute = mLineGeometry->attributes().at( 3 );
  mPointNextAttribute = mLineGeometry->attributes().at( 4 );
 
  mLineGeometryRenderer = new Qt3DRender::QGeometryRenderer;
  mLineGeometryRenderer->setPrimitiveType( Qt3DRender::QGeometryRenderer::Triangles );
  mLineGeometryRenderer->setGeometry( mLineGeometry );
  mLineGeometryRenderer->setVertexCount( 6 );
  mLineGeometryRenderer->setInstanceCount( 0 );
 
  mLineEntity->addComponent( mLineGeometryRenderer );
 
  mLineMaterial = new QgsLineMaterial;
  mLineMaterial->setLineWidth( mWidth );
  mLineMaterial->setLineColor( mColor );
 
  QObject::connect( mEngine, &QgsAbstract3DEngine::sizeChanged, mLineMaterial, [this] { mLineMaterial->setViewportSize( mEngine->size() ); } );
  mLineMaterial->setViewportSize( mEngine->size() );
 
  mLineEntity->addComponent( mLineMaterial );
 
  mLineTransform = new QgsGeoTransform;
  mLineTransform->setOrigin( mMapSettings->origin() );
  mLineEntity->addComponent( mLineTransform );
 
  mJoinEntity = make_qobject_unique<Qt3DCore::QEntity>( parentEntity );
 
  mJoinGeometry = dummyLineData.createJoinGeometry( mJoinEntity );
 
  mJoinPointAAttribute = mJoinGeometry->attributes().at( 1 );
  mJoinPointBAttribute = mJoinGeometry->attributes().at( 2 );
  mJoinPointCAttribute = mJoinGeometry->attributes().at( 3 );
 
  mJoinGeometryRenderer = new Qt3DRender::QGeometryRenderer;
  mJoinGeometryRenderer->setPrimitiveType( Qt3DRender::QGeometryRenderer::Triangles );
  mJoinGeometryRenderer->setGeometry( mJoinGeometry );
  mJoinGeometryRenderer->setVertexCount( 6 );
  mJoinGeometryRenderer->setInstanceCount( 0 );
 
  mJoinEntity->addComponent( mJoinGeometryRenderer );
 
  mJoinMaterial = new QgsLineMaterial( QgsLineMaterial::LinePart::Join );
  mJoinMaterial->setLineWidth( mWidth );
  mJoinMaterial->setLineColor( mColor );
 
  QObject::connect( mEngine, &QgsAbstract3DEngine::sizeChanged, mJoinMaterial, [this] { mJoinMaterial->setViewportSize( mEngine->size() ); } );
  mJoinMaterial->setViewportSize( mEngine->size() );
 
  mJoinEntity->addComponent( mJoinMaterial );
 
  mJoinTransform = new QgsGeoTransform;
  mJoinTransform->setOrigin( mMapSettings->origin() );
  mJoinEntity->addComponent( mJoinTransform );
}
 
void QgsRubberBand3D::setupPolygon( Qt3DCore::QEntity *parentEntity )
{
  mPolygonEntity = make_qobject_unique<Qt3DCore::QEntity>( parentEntity );
 
  mPolygonGeometry = new QgsTessellatedPolygonGeometry();
 
  Qt3DRender::QGeometryRenderer *polygonGeometryRenderer = new Qt3DRender::QGeometryRenderer;
  polygonGeometryRenderer->setPrimitiveType( Qt3DRender::QGeometryRenderer::Triangles );
  polygonGeometryRenderer->setGeometry( mPolygonGeometry );
  mPolygonEntity->addComponent( polygonGeometryRenderer );
 
  QColor color = mColor;
  color.setAlphaF( DEFAULT_POLYGON_OPACITY );
  mPolygonMaterial = new QgsUnlitMaterial();
  mPolygonMaterial->setColor( color );
 
  mPolygonEntity->addComponent( mPolygonMaterial );
 
  mPolygonTransform = new QgsGeoTransform;
  mPolygonTransform->setOrigin( mMapSettings->origin() );
  mPolygonEntity->addComponent( mPolygonTransform );
}
 
void QgsRubberBand3D::removePoint( int index )
{
  if ( QgsPolygon *polygon = qgsgeometry_cast<QgsPolygon *>( mGeometry.get() ) )
  {
    QgsLineString *lineString = qgsgeometry_cast<QgsLineString *>( polygon->exteriorRing() );
    const int vertexIndex = index < 0 ? lineString->numPoints() - 1 + index : index;
    lineString->deleteVertex( QgsVertexId( 0, 0, vertexIndex ) );
 
    if ( lineString->numPoints() < 3 )
    {
      mGeometry.set( new QgsLineString( *lineString ) );
    }
  }
  else if ( QgsLineString *lineString = qgsgeometry_cast<QgsLineString *>( mGeometry.get() ) )
  {
    const int vertexIndex = index < 0 ? lineString->numPoints() + index : index;
    lineString->deleteVertex( QgsVertexId( 0, 0, vertexIndex ) );
  }
  else
  {
    return;
  }
 
  updateGeometry();
}
 
QgsRubberBand3D::~QgsRubberBand3D()
{
  if ( mPolygonEntity )
  {
    mPolygonEntity.reset();
  }
  if ( mLineEntity )
  {
    mLineEntity.reset();
  }
  if ( mJoinEntity )
  {
    mJoinEntity.reset();
  }
  if ( mMarkerEntity )
  {
    mMarkerEntity.reset();
  }
}
 
 
float QgsRubberBand3D::width() const
{
  return mWidth;
}
 
void QgsRubberBand3D::setWidth( float width )
{
  const bool isLineOrPolygon = mGeometryType == Qgis::GeometryType::Line || mGeometryType == Qgis::GeometryType::Polygon;
  mWidth = width;
 
  if ( isLineOrPolygon && mEdgesEnabled )
  {
    // when highlighting lines, the vertex markers should be wider
    mLineMaterial->setLineWidth( width );
    mJoinMaterial->setLineWidth( width );
    width *= 3;
  }
 
  mMarkerSymbol->setSize( width );
  updateMarkerMaterial();
}
 
QColor QgsRubberBand3D::color() const
{
  return mColor;
}
 
void QgsRubberBand3D::setColor( const QColor color )
{
  const bool isLineOrPolygon = mGeometryType == Qgis::GeometryType::Line || mGeometryType == Qgis::GeometryType::Polygon;
  mColor = color;
 
  if ( mEdgesEnabled && isLineOrPolygon )
  {
    mLineMaterial->setLineColor( color );
    mJoinMaterial->setLineColor( color );
  }
 
  if ( isLineOrPolygon )
  {
    mMarkerSymbol->setColor( color.lighter( 130 ) );
  }
  else
  {
    mMarkerSymbol->setColor( color );
  }
 
  if ( mMarkerSymbol->symbolLayerCount() > 0 && mMarkerSymbol->symbolLayer( 0 )->layerType() == "SimpleMarker"_L1 && !mOutlineColor.value() )
  {
    mMarkerSymbol->symbolLayer( 0 )->setStrokeColor( color );
  }
  updateMarkerMaterial();
 
  if ( mGeometryType == Qgis::GeometryType::Polygon )
  {
    if ( mPolygonMaterial )
      mPolygonEntity->removeComponent( mPolygonMaterial );
 
    if ( mPolygonFillEnabled )
    {
      QColor color = mColor;
      color.setAlphaF( DEFAULT_POLYGON_OPACITY );
      mPolygonMaterial = new QgsUnlitMaterial();
      mPolygonMaterial->setColor( color );
      mPolygonEntity->addComponent( mPolygonMaterial );
    }
  }
}
 
QColor QgsRubberBand3D::outlineColor() const
{
  return mOutlineColor;
}
 
void QgsRubberBand3D::setOutlineColor( const QColor color )
{
  mOutlineColor = color;
 
  if ( mMarkerSymbol->symbolLayerCount() > 0 && mMarkerSymbol->symbolLayer( 0 )->layerType() == "SimpleMarker"_L1 )
  {
    mMarkerSymbol->symbolLayer( 0 )->setStrokeColor( color );
  }
  updateMarkerMaterial();
}
 
void QgsRubberBand3D::setMarkerType( const MarkerType marker )
{
  mMarkerType = marker;
 
  const bool lineOrPolygon = mGeometryType == Qgis::GeometryType::Line || mGeometryType == Qgis::GeometryType::Polygon;
 
  const QVariantMap props {
    { u"color"_s, lineOrPolygon ? mColor.lighter( 130 ).name() : mColor.name() },
    { u"size_unit"_s, u"pixel"_s },
    { u"size"_s, QString::number( lineOrPolygon ? mWidth * 3.f : mWidth ) },
    { u"outline_color"_s, mOutlineColor.value() ? mOutlineColor.name() : mColor.name() },
    { u"outline_style"_s, QgsSymbolLayerUtils::encodePenStyle( mMarkerOutlineStyle ) },
    { u"outline_width"_s, QString::number( lineOrPolygon ? 0.5 : 1 ) },
    { u"name"_s, mMarkerType == Square ? u"square"_s : u"circle"_s }
  };
 
  mMarkerSymbol = QgsMarkerSymbol::createSimple( props );
  updateMarkerMaterial();
}
 
QgsRubberBand3D::MarkerType QgsRubberBand3D::markerType() const
{
  return mMarkerType;
}
 
void QgsRubberBand3D::setMarkerOutlineStyle( const Qt::PenStyle style )
{
  mMarkerOutlineStyle = style;
  setMarkerType( markerType() );
}
 
Qt::PenStyle QgsRubberBand3D::markerOutlineStyle() const
{
  return mMarkerOutlineStyle;
}
 
void QgsRubberBand3D::setMarkersEnabled( const bool enable )
{
  mMarkerEnabled = enable;
  updateMarkerMaterial();
}
 
bool QgsRubberBand3D::hasMarkersEnabled() const
{
  return mMarkerEnabled;
}
 
void QgsRubberBand3D::setEdgesEnabled( const bool enable )
{
  mEdgesEnabled = enable;
  setColor( mColor );
}
 
bool QgsRubberBand3D::hasEdgesEnabled() const
{
  return mEdgesEnabled;
}
 
void QgsRubberBand3D::setFillEnabled( const bool enable )
{
  mPolygonFillEnabled = enable;
  setColor( mColor );
}
 
bool QgsRubberBand3D::hasFillEnabled() const
{
  return mPolygonFillEnabled;
}
 
void QgsRubberBand3D::reset()
{
  mGeometry.set( nullptr );
  updateGeometry();
}
 
void QgsRubberBand3D::addPoint( const QgsPoint &pt )
{
  if ( QgsPolygon *polygon = qgsgeometry_cast<QgsPolygon *>( mGeometry.get() ) )
  {
    QgsLineString *exteriorRing = qgsgeometry_cast<QgsLineString *>( polygon->exteriorRing() );
    const int lastVertexIndex = exteriorRing->numPoints() - 1;
    exteriorRing->insertVertex( QgsVertexId( 0, 0, lastVertexIndex ), pt );
  }
  else if ( QgsLineString *lineString = qgsgeometry_cast<QgsLineString *>( mGeometry.get() ) )
  {
    lineString->addVertex( pt );
    // transform linestring to polygon if we have enough vertices
    if ( mGeometryType == Qgis::GeometryType::Polygon && lineString->numPoints() >= 3 )
    {
      mGeometry.set( new QgsPolygon( lineString->clone() ) );
    }
  }
  else if ( !mGeometry.constGet() )
  {
    mGeometry.set( new QgsLineString( QVector<QgsPoint> { pt } ) );
  }
 
  updateGeometry();
}
 
void QgsRubberBand3D::setGeometry( const QgsGeometry &geometry )
{
  mGeometry = geometry;
  mGeometryType = geometry.type();
 
  updateGeometry();
}
 
void QgsRubberBand3D::removeLastPoint()
{
  removePoint( -1 );
}
 
void QgsRubberBand3D::removePenultimatePoint()
{
  removePoint( -2 );
}
 
void QgsRubberBand3D::moveLastPoint( const QgsPoint &pt )
{
  if ( QgsPolygon *polygon = qgsgeometry_cast<QgsPolygon *>( mGeometry.get() ) )
  {
    QgsLineString *lineString = qgsgeometry_cast<QgsLineString *>( polygon->exteriorRing() );
    const int lastVertexIndex = lineString->numPoints() - 2;
    lineString->moveVertex( QgsVertexId( 0, 0, lastVertexIndex ), pt );
  }
  else if ( QgsLineString *lineString = qgsgeometry_cast<QgsLineString *>( mGeometry.get() ) )
  {
    const int lastVertexIndex = lineString->numPoints() - 1;
    lineString->moveVertex( QgsVertexId( 0, 0, lastVertexIndex ), pt );
  }
  else
  {
    return;
  }
 
  updateGeometry();
}
 
void QgsRubberBand3D::updateGeometry()
{
  // figure out a reasonable origin for the coordinates to keep them as small as possible
  const QgsBox3D box = mGeometry.constGet() ? mGeometry.constGet()->boundingBox3D() : QgsBox3D();
  const QgsVector3D dataOrigin = box.isNull() ? mMapSettings->origin() : box.center();
 
  QgsLineVertexData lineData;
  lineData.geocentricCoordinates = mMapSettings->sceneMode() == Qgis::SceneMode::Globe;
  lineData.init( Qgis::AltitudeClamping::Absolute, Qgis::AltitudeBinding::Vertex, 0, Qgs3DRenderContext::fromMapSettings( mMapSettings ), dataOrigin );
  if ( const QgsPolygon *polygon = qgsgeometry_cast<const QgsPolygon *>( mGeometry.constGet() ) )
  {
    std::unique_ptr< QgsLineString > lineString( qgsgeometry_cast<QgsLineString *>( polygon->exteriorRing()->clone() ) );
    const int lastVertexIndex = lineString->numPoints() - 1;
    lineString->deleteVertex( QgsVertexId( 0, 0, lastVertexIndex ) );
    lineData.addLineString( *lineString, 0, true );
  }
  else if ( const QgsLineString *lineString = qgsgeometry_cast<const QgsLineString *>( mGeometry.constGet() ) )
  {
    lineData.addLineString( *lineString, 0, false );
  }
 
 
  if ( mEdgesEnabled && ( mGeometryType == Qgis::GeometryType::Line || mGeometryType == Qgis::GeometryType::Polygon ) )
  {
    mPointAAttribute->buffer()->setData( lineData.createPointABuffer() );
    mPointBAttribute->buffer()->setData( lineData.createPointBBuffer() );
    mPointPrevAttribute->buffer()->setData( lineData.createPointPrevBuffer() );
    mPointNextAttribute->buffer()->setData( lineData.createPointNextBuffer() );
    mLineGeometryRenderer->setInstanceCount( lineData.pointsA.size() );
    mLineTransform->setGeoTranslation( dataOrigin );
 
    mJoinPointAAttribute->buffer()->setData( lineData.createJoinPointABuffer() );
    mJoinPointBAttribute->buffer()->setData( lineData.createJoinPointBBuffer() );
    mJoinPointCAttribute->buffer()->setData( lineData.createJoinPointCBuffer() );
    mJoinGeometryRenderer->setInstanceCount( lineData.joinPointA.size() );
    mJoinTransform->setGeoTranslation( dataOrigin );
  }
 
  // we may not want a marker on the last point as it's tracked by the mouse cursor
  if ( mHideLastMarker && !lineData.vertices.isEmpty() )
    lineData.vertices.pop_back();
 
  mMarkerGeometry->setPositions( lineData.vertices );
  mMarkerGeometryRenderer->setVertexCount( 4 );
  mMarkerGeometryRenderer->setInstanceCount( lineData.vertices.count() );
  mMarkerTransform->setGeoTranslation( dataOrigin );
 
  if ( mGeometryType == Qgis::GeometryType::Polygon )
  {
    if ( const QgsPolygon *polygon = qgsgeometry_cast<const QgsPolygon *>( mGeometry.constGet() ) )
    {
      QgsTessellator tessellator;
      tessellator.setOrigin( mMapSettings->origin() );
      tessellator.setAddNormals( true );
      tessellator.addPolygon( *polygon, 0 );
      if ( !tessellator.error().isEmpty() )
      {
        QgsMessageLog::logMessage( tessellator.error(), QObject::tr( "3D" ) );
      }
      // extract vertex buffer data from tessellator
      const QByteArray vertexBuffer = tessellator.vertexBuffer();
      const QByteArray indexBuffer = tessellator.indexBuffer();
      const size_t vertexCount = tessellator.uniqueVertexCount();
      const size_t indexCount = tessellator.dataVerticesCount();
 
      mPolygonGeometry->setVertexBufferData( vertexBuffer, vertexCount, QVector<QgsFeatureId>(), QVector<uint>() );
      mPolygonGeometry->setIndexBufferData( indexBuffer, indexCount );
      mPolygonTransform->setGeoTranslation( mMapSettings->origin() );
    }
    else
    {
      mPolygonGeometry->setVertexBufferData( QByteArray(), 0, QVector<QgsFeatureId>(), QVector<uint>() );
      mPolygonGeometry->setIndexBufferData( QByteArray(), 0 );
    }
  }
}
 
void QgsRubberBand3D::updateMarkerMaterial()
{
  if ( mMarkerEnabled )
  {
    if ( !mMarkerMaterial )
    {
      mMarkerMaterial = new QgsPoint3DBillboardMaterial();
      mMarkerEntity->addComponent( mMarkerMaterial );
      //TODO: QgsAbstract3DEngine::sizeChanged should have const QSize &size param
      QObject::connect( mEngine, &QgsAbstract3DEngine::sizeChanged, mMarkerMaterial, [material = mMarkerMaterial, engine = mEngine] { material->setViewportSize( engine->size() ); } );
    }
 
    mMarkerMaterial->setTexture2DFromSymbol( mMarkerSymbol.get(), Qgs3DRenderContext::fromMapSettings( mMapSettings ) );
    mMarkerMaterial->setViewportSize( mEngine->size() );
  }
  else if ( !mMarkerEnabled && mMarkerMaterial )
  {
    mMarkerEntity->removeComponent( mMarkerMaterial );
    mMarkerMaterial->setParent( static_cast<Qt3DCore::QEntity *>( nullptr ) );
    mMarkerMaterial->deleteLater();
    mMarkerMaterial = nullptr;
  }
}