QGIS API Documentation  3.18.1-Zürich (202f1bf7e5)
qgspoint3dbillboardmaterial.cpp
Go to the documentation of this file.
1 /***************************************************************************
2  qgspoint3dbillboardmaterial.h
3  --------------------------------------
4  Date : Jul 2019
5  Copyright : (C) 2019 by Ismail Sunni
6  Email : imajimatika at gmail dot com
7  ***************************************************************************
8  * *
9  * This program is free software; you can redistribute it and/or modify *
10  * it under the terms of the GNU General Public License as published by *
11  * the Free Software Foundation; either version 2 of the License, or *
12  * (at your option) any later version. *
13  * *
14  ***************************************************************************/
15 #include <Qt3DRender/QParameter>
16 #include <Qt3DRender/QShaderProgram>
17 #include <Qt3DRender/QRenderPass>
18 #include <Qt3DRender/QTechnique>
19 #include <Qt3DRender/QGraphicsApiFilter>
20 #include <Qt3DRender/QEffect>
21 #include <Qt3DRender/QBlendEquationArguments>
22 #include <Qt3DRender/QBlendEquation>
23 #include <Qt3DRender/QNoDepthMask>
24 #include <QUrl>
25 
26 #include "qgslogger.h"
29 #include "qgsmarkersymbollayer.h"
30 #include "qgssymbollayerutils.h"
31 #include "qgssettings.h"
32 #include "qgs3dmapsettings.h"
33 
35  : mSize( new Qt3DRender::QParameter( "BB_SIZE", QSizeF( 100, 100 ), this ) )
36  , mViewportSize( new Qt3DRender::QParameter( "WIN_SCALE", QSizeF( 800, 600 ), this ) )
37 {
38  addParameter( mSize );
39  addParameter( mViewportSize );
40 
41  // Initialize with empty parameter.
42  mTexture2D = new Qt3DRender::QParameter( "tex0", QVariant(), this );
43  addParameter( mTexture2D );
44 
45  // Blending for handling transparency
46  Qt3DRender::QBlendEquationArguments *blendState = new Qt3DRender::QBlendEquationArguments;
47  blendState->setSourceRgb( Qt3DRender::QBlendEquationArguments::SourceAlpha );
48  blendState->setDestinationRgb( Qt3DRender::QBlendEquationArguments::OneMinusSourceAlpha );
49 
50  Qt3DRender::QBlendEquation *blendEquation = new Qt3DRender::QBlendEquation;
51  blendEquation->setBlendFunction( Qt3DRender::QBlendEquation::Add );
52 
53  // Shader program
54  Qt3DRender::QShaderProgram *shaderProgram = new Qt3DRender::QShaderProgram( this );
55  shaderProgram->setVertexShaderCode( Qt3DRender::QShaderProgram::loadSource( QUrl( QStringLiteral( "qrc:/shaders/billboards.vert" ) ) ) );
56  shaderProgram->setFragmentShaderCode( Qt3DRender::QShaderProgram::loadSource( QUrl( QStringLiteral( "qrc:/shaders/billboards.frag" ) ) ) );
57  shaderProgram->setGeometryShaderCode( Qt3DRender::QShaderProgram::loadSource( QUrl( QStringLiteral( "qrc:/shaders/billboards.geom" ) ) ) );
58 
59  // Render Pass
60  Qt3DRender::QRenderPass *renderPass = new Qt3DRender::QRenderPass( this );
61  renderPass->setShaderProgram( shaderProgram );
62  renderPass->addRenderState( blendState );
63  renderPass->addRenderState( blendEquation );
64 
65  // without this filter the default forward renderer would not render this
66  Qt3DRender::QFilterKey *filterKey = new Qt3DRender::QFilterKey;
67  filterKey->setName( QStringLiteral( "renderingStyle" ) );
68  filterKey->setValue( "forward" );
69 
70  // Technique
71  Qt3DRender::QTechnique *technique = new Qt3DRender::QTechnique;
72  technique->addRenderPass( renderPass );
73  technique->addFilterKey( filterKey );
74  technique->graphicsApiFilter()->setApi( Qt3DRender::QGraphicsApiFilter::OpenGL );
75  technique->graphicsApiFilter()->setProfile( Qt3DRender::QGraphicsApiFilter::CoreProfile );
76  technique->graphicsApiFilter()->setMajorVersion( 3 );
77  technique->graphicsApiFilter()->setMinorVersion( 1 );
78 
79  // Effect
80  Qt3DRender::QEffect *effect = new Qt3DRender::QEffect( this );
81  effect->addTechnique( technique );
82 
83  setEffect( effect );
84 }
85 
86 void QgsPoint3DBillboardMaterial::setSize( const QSizeF size )
87 {
88  mSize->setValue( size );
89 }
90 
92 {
93  return mSize->value().value<QSizeF>();
94 }
95 
97 {
98  mViewportSize->setValue( size );
99 }
100 
102 {
103  return mViewportSize->value().value<QSizeF>();
104 }
105 
106 void QgsPoint3DBillboardMaterial::setTexture2DFromImage( QImage image, double size )
107 {
108  // Create texture image
109  QgsRectangle randomExtent = QgsRectangle( rand(), rand(), rand(), rand() );
110  QgsTerrainTextureImage *billboardTextureImage = new QgsTerrainTextureImage( image, randomExtent, QStringLiteral( "billboard material." ) );
111 
112  setTexture2DFromTextureImage( billboardTextureImage );
113  setSize( QSizeF( size + size, size + size ) );
114 }
115 
117 {
118  // Default texture
119  std::unique_ptr< QgsMarkerSymbol> defaultSymbol( static_cast<QgsMarkerSymbol *>( QgsSymbol::defaultSymbol( QgsWkbTypes::PointGeometry ) ) );
120  setTexture2DFromSymbol( defaultSymbol.get(), map, selected );
121 }
122 
124 {
125  QgsRenderContext context;
126  context.setSelectionColor( map.selectionColor() );
127  context.setScaleFactor( map.outputDpi() / 25.4 );
128  double pixelSize = context.convertToPainterUnits( markerSymbol->size( context ), markerSymbol->sizeUnit() );
129 
130  // This number is an max estimation ratio between stroke width and symbol size.
131  double strokeRatio = 0.5;
132  // Minimum extra width, just in case the size is small, but the stroke is quite big.
133  // 10 mm is quite big based on Raymond's experiece.
134  // 10 mm has around 37 pixel in 96 dpi, round up become 40.
135  double minimumExtraSize = 40;
136  double extraPixel = minimumExtraSize > pixelSize * strokeRatio ? minimumExtraSize : pixelSize * strokeRatio;
137  int pixelWithExtra = std::ceil( pixelSize + extraPixel );
138  QPixmap symbolPixmap = QgsSymbolLayerUtils::symbolPreviewPixmap( markerSymbol, QSize( pixelWithExtra, pixelWithExtra ), 0, &context, selected );
139  QImage symbolImage = symbolPixmap.toImage();
140  QImage flippedSymbolImage = symbolImage.mirrored();
141  setTexture2DFromImage( flippedSymbolImage, pixelWithExtra );
142 }
143 
144 void QgsPoint3DBillboardMaterial::setTexture2DFromTextureImage( Qt3DRender::QAbstractTextureImage *textureImage )
145 {
146  // Texture2D
147  Qt3DRender::QTexture2D *texture2D = new Qt3DRender::QTexture2D( this );
148  texture2D->setGenerateMipMaps( false );
149  texture2D->setMagnificationFilter( Qt3DRender::QTexture2D::Linear );
150  texture2D->setMinificationFilter( Qt3DRender::QTexture2D::Linear );
151 
152  // The textureImage gets parented to texture2D here
153  texture2D->addTextureImage( textureImage );
154 
155  mTexture2D->setValue( QVariant::fromValue( texture2D ) );
156 }
double outputDpi() const
Returns DPI used for conversion between real world units (e.g.
QColor selectionColor() const
Returns color used for selected features.
A marker symbol type, for rendering Point and MultiPoint geometries.
Definition: qgssymbol.h:1004
QgsUnitTypes::RenderUnit sizeUnit() const
Returns the size units for the whole symbol (including all symbol layers).
Definition: qgssymbol.cpp:1780
double size() const
Returns the estimated size for the whole symbol, which is the maximum size of all marker symbol layer...
Definition: qgssymbol.cpp:1735
QSizeF windowSize() const
Returns the size of the view port.
QSizeF size() const
Returns the billboard size.
void useDefaultSymbol(const Qgs3DMapSettings &map, bool selected=false)
Set default symbol for the texture with map and selected parameter for rendering.
void setViewportSize(const QSizeF size)
Set the size of the view port.
void setSize(const QSizeF size)
Set the billboard size.
void setTexture2DFromSymbol(QgsMarkerSymbol *markerSymbol, const Qgs3DMapSettings &map, bool selected=false)
Set markerSymbol for the texture with map and selected parameter for rendering.
A rectangle specified with double values.
Definition: qgsrectangle.h:42
Contains information about the context of a rendering operation.
void setScaleFactor(double factor)
Sets the scaling factor for the render to convert painter units to physical sizes.
double convertToPainterUnits(double size, QgsUnitTypes::RenderUnit unit, const QgsMapUnitScale &scale=QgsMapUnitScale()) const
Converts a size from the specified units to painter units (pixels).
void setSelectionColor(const QColor &color)
Sets the color to use when rendering selected features.
static QPixmap symbolPreviewPixmap(const QgsSymbol *symbol, QSize size, int padding=0, QgsRenderContext *customContext=nullptr, bool selected=false, const QgsExpressionContext *expressionContext=nullptr, const QgsLegendPatchShape *shape=nullptr)
Returns a pixmap preview for a color ramp.
static QgsSymbol * defaultSymbol(QgsWkbTypes::GeometryType geomType)
Returns a new default symbol for the specified geometry type.
Definition: qgssymbol.cpp:346