QGIS API Documentation  3.27.0-Master (0e23467727)
qgspointcloudrenderer.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgspointcloudrenderer.h
3  --------------------
4  begin : October 2020
5  copyright : (C) 2020 by Peter Petrik
6  email : zilolv at gmail dot com
7  ***************************************************************************/
8 
9 /***************************************************************************
10  * *
11  * This program is free software; you can redistribute it and/or modify *
12  * it under the terms of the GNU General Public License as published by *
13  * the Free Software Foundation; either version 2 of the License, or *
14  * (at your option) any later version. *
15  * *
16  ***************************************************************************/
17 
18 #ifndef QGSPOINTCLOUDRENDERER_H
19 #define QGSPOINTCLOUDRENDERER_H
20 
21 #include "qgsrendercontext.h"
22 
23 #include "qgis_core.h"
24 #include "qgis_sip.h"
25 #include "qgsvector3d.h"
26 #include "qgspointcloudattribute.h"
27 
28 class QgsPointCloudBlock;
29 class QgsLayerTreeLayer;
31 class QgsPointCloudLayer;
32 
41 class CORE_EXPORT QgsPointCloudRenderContext
42 {
43  public:
44 
57  QgsPointCloudRenderContext( QgsRenderContext &context, const QgsVector3D &scale, const QgsVector3D &offset,
58  double zValueScale, double zValueFixedOffset, QgsFeedback *feedback = nullptr );
59 
62 
65 
69  QgsRenderContext &renderContext() { return mRenderContext; }
70 
75  const QgsRenderContext &renderContext() const { return mRenderContext; } SIP_SKIP
76 
80  QgsVector3D scale() const { return mScale; }
81 
86  void setScale( const QgsVector3D &scale ) { mScale = scale; }
87 
91  QgsVector3D offset() const { return mOffset; }
92 
97  void setOffset( const QgsVector3D &offset ) { mOffset = offset; }
98 
102  long pointsRendered() const;
103 
110  void incrementPointsRendered( long count );
111 
117  QgsPointCloudAttributeCollection attributes() const { return mAttributes; }
118 
124  void setAttributes( const QgsPointCloudAttributeCollection &attributes );
125 
129  int pointRecordSize() const { return mPointRecordSize; }
130 
137  int xOffset() const { return mXOffset; }
138 
145  int yOffset() const { return mYOffset; }
146 
153  int zOffset() const { return mZOffset; }
154 
160  double zValueScale() const { return mZValueScale; }
161 
167  double zValueFixedOffset() const { return mZValueFixedOffset; }
168 
174  QgsFeedback *feedback() const { return mFeedback; }
175 
176 #ifndef SIP_RUN
177 
182  template <typename T>
183  static void getAttribute( const char *data, std::size_t offset, QgsPointCloudAttribute::DataType type, T &value )
184  {
185  switch ( type )
186  {
188  value = *reinterpret_cast< const unsigned char * >( data + offset );
189  return;
191  value = *( data + offset );
192  return;
193 
195  value = *reinterpret_cast< const quint32 * >( data + offset );
196  return;
198  value = *reinterpret_cast< const qint32 * >( data + offset );
199  return;
200 
202  value = *reinterpret_cast< const quint64 * >( data + offset );
203  return;
205  value = *reinterpret_cast< const qint64 * >( data + offset );
206  return;
207 
209  value = *reinterpret_cast< const short * >( data + offset );
210  return;
211 
213  value = *reinterpret_cast< const unsigned short * >( data + offset );
214  return;
215 
217  value = *reinterpret_cast< const float * >( data + offset );
218  return;
219 
221  value = *reinterpret_cast< const double * >( data + offset );
222  return;
223  }
224  }
225 #endif
226 
227  private:
228 #ifdef SIP_RUN
230 #endif
231 
232  QgsRenderContext &mRenderContext;
233  QgsVector3D mScale;
234  QgsVector3D mOffset;
235  long mPointsRendered = 0;
237  int mPointRecordSize = 0;
238  int mXOffset = 0;
239  int mYOffset = 0;
240  int mZOffset = 0;
241  double mZValueScale = 1.0;
242  double mZValueFixedOffset = 0;
243 
244  QgsFeedback *mFeedback = nullptr;
245 };
246 
247 #ifndef SIP_RUN
248 
259 {
260  public:
261 
263 
267  virtual QSet< QString > usedAttributes() const = 0;
268 
274  virtual bool prepareBlock( const QgsPointCloudBlock *block ) = 0;
275 
283  virtual QColor pointColor( const QgsPointCloudBlock *block, int i, double z ) = 0;
284 
285 };
286 
287 #endif
288 
289 
298 class CORE_EXPORT QgsPointCloudRenderer
299 {
300 
301 #ifdef SIP_RUN
303 
304  const QString type = sipCpp->type();
305 
306  if ( type == QLatin1String( "rgb" ) )
307  sipType = sipType_QgsPointCloudRgbRenderer;
308  else if ( type == QLatin1String( "ramp" ) )
309  sipType = sipType_QgsPointCloudAttributeByRampRenderer;
310  else if ( type == QLatin1String( "classified" ) )
311  sipType = sipType_QgsPointCloudClassifiedRenderer;
312  else if ( type == QLatin1String( "extent" ) )
313  sipType = sipType_QgsPointCloudExtentRenderer;
314  else
315  sipType = 0;
316  SIP_END
317 #endif
318 
319  public:
320 
325 
326  virtual ~QgsPointCloudRenderer() = default;
327 
331  virtual QString type() const = 0;
332 
338 
341 
344 
348  virtual void renderBlock( const QgsPointCloudBlock *block, QgsPointCloudRenderContext &context ) = 0;
349 
359  QVector<QVariantMap> identify( QgsPointCloudLayer *layer, const QgsRenderContext &context, const QgsGeometry &geometry, double toleranceForPointIdentification = 0 ) SIP_SKIP;
360 
366  virtual bool willRenderPoint( const QMap<QString, QVariant> &pointAttributes )
367  {
368  Q_UNUSED( pointAttributes );
369  return true;
370  }
371 
379  static QgsPointCloudRenderer *load( QDomElement &element, const QgsReadWriteContext &context ) SIP_FACTORY;
380 
385  virtual QDomElement save( QDomDocument &doc, const QgsReadWriteContext &context ) const = 0;
386 
394  virtual QSet< QString > usedAttributes( const QgsPointCloudRenderContext &context ) const;
395 
402  virtual std::unique_ptr< QgsPreparedPointCloudRendererData > prepare() SIP_SKIP;
403 
413  virtual void startRender( QgsPointCloudRenderContext &context );
414 
425  virtual void stopRender( QgsPointCloudRenderContext &context );
426 
432  virtual bool legendItemChecked( const QString &key );
433 
439  virtual void checkLegendItem( const QString &key, bool state = true );
440 
447  void setPointSize( double size ) { mPointSize = size; }
448 
458  double pointSize() const { return mPointSize; }
459 
467  void setPointSizeUnit( const QgsUnitTypes::RenderUnit units ) { mPointSizeUnit = units; }
468 
475  QgsUnitTypes::RenderUnit pointSizeUnit() const { return mPointSizeUnit; }
476 
483  void setPointSizeMapUnitScale( const QgsMapUnitScale &scale ) { mPointSizeMapUnitScale = scale; }
484 
491  const QgsMapUnitScale &pointSizeMapUnitScale() const { return mPointSizeMapUnitScale; }
492 
499  Qgis::PointCloudDrawOrder drawOrder2d() const;
500 
507  void setDrawOrder2d( Qgis::PointCloudDrawOrder order );
508 
514  Qgis::PointCloudSymbol pointSymbol() const;
515 
521  void setPointSymbol( Qgis::PointCloudSymbol symbol );
522 
533  double maximumScreenError() const;
534 
545  void setMaximumScreenError( double error );
546 
553  QgsUnitTypes::RenderUnit maximumScreenErrorUnit() const;
554 
561  void setMaximumScreenErrorUnit( QgsUnitTypes::RenderUnit unit );
562 
566  virtual QList<QgsLayerTreeModelLegendNode *> createLegendNodes( QgsLayerTreeLayer *nodeLayer ) SIP_FACTORY;
567 
571  virtual QStringList legendRuleKeys() const;
572 
573  protected:
574 
578  static void pointXY( QgsPointCloudRenderContext &context, const char *ptr, int i, double &x, double &y )
579  {
580  // be wary when copying this code!! In the renderer we explicitly request x/y/z as qint32 values, but in other
581  // situations these may be floats or doubles!
582  const qint32 ix = *reinterpret_cast< const qint32 * >( ptr + i * context.pointRecordSize() + context.xOffset() );
583  const qint32 iy = *reinterpret_cast< const qint32 * >( ptr + i * context.pointRecordSize() + context.yOffset() );
584  x = context.offset().x() + context.scale().x() * ix;
585  y = context.offset().y() + context.scale().y() * iy;
586  }
587 
591  static double pointZ( QgsPointCloudRenderContext &context, const char *ptr, int i )
592  {
593  // be wary when copying this code!! In the renderer we explicitly request x/y/z as qint32 values, but in other
594  // situations these may be floats or doubles!
595  const qint32 iz = *reinterpret_cast<const qint32 * >( ptr + i * context.pointRecordSize() + context.zOffset() );
596  return ( context.offset().z() + context.scale().z() * iz ) * context.zValueScale() + context.zValueFixedOffset();
597  }
598 
602  void drawPoint( double x, double y, const QColor &color, QgsPointCloudRenderContext &context ) const
603  {
604  const QPointF originalXY( x, y );
605  context.renderContext().mapToPixel().transformInPlace( x, y );
606  QPainter *painter = context.renderContext().painter();
607  switch ( mPointSymbol )
608  {
610  painter->fillRect( QRectF( x - mPainterPenWidth * 0.5,
611  y - mPainterPenWidth * 0.5,
612  mPainterPenWidth, mPainterPenWidth ), color );
613  break;
614 
616  painter->setBrush( QBrush( color ) );
617  painter->setPen( Qt::NoPen );
618  painter->drawEllipse( QRectF( x - mPainterPenWidth * 0.5,
619  y - mPainterPenWidth * 0.5,
620  mPainterPenWidth, mPainterPenWidth ) );
621  break;
622  };
623  }
624 
628  void copyCommonProperties( QgsPointCloudRenderer *destination ) const;
629 
636  void restoreCommonProperties( const QDomElement &element, const QgsReadWriteContext &context );
637 
644  void saveCommonProperties( QDomElement &element, const QgsReadWriteContext &context ) const;
645 
646  private:
647 #ifdef SIP_RUN
649 #endif
650 
651 #ifdef QGISDEBUG
653  QThread *mThread = nullptr;
654 #endif
655 
656  double mMaximumScreenError = 0.3;
658 
659  double mPointSize = 1;
661  QgsMapUnitScale mPointSizeMapUnitScale;
662 
664  int mPainterPenWidth = 1;
666 };
667 
668 #endif // QGSPOINTCLOUDRENDERER_H
PointCloudSymbol
Rendering symbols for point cloud points.
Definition: qgis.h:1907
@ Circle
Renders points as circles.
@ Square
Renders points as squares.
PointCloudDrawOrder
Pointcloud rendering order for 2d views.
Definition: qgis.h:1919
@ Default
Draw points in the order they are stored.
Base class for feedback objects to be used for cancellation of something running in a worker thread.
Definition: qgsfeedback.h:45
A geometry is the spatial representation of a feature.
Definition: qgsgeometry.h:125
Layer tree node points to a map layer.
The QgsLegendRendererItem class is abstract interface for legend items returned from QgsMapLayerLegen...
void transformInPlace(double &x, double &y) const
Transforms device coordinates to map coordinates.
Struct for storing maximum and minimum scales for measurements in map units.
Collection of point cloud attributes.
DataType
Systems of unit measurement.
@ UShort
Unsigned short int 2 bytes.
@ UChar
Unsigned char 1 byte.
@ UInt32
Unsigned int32 4 bytes.
@ UInt64
Unsigned int64 8 bytes.
Base class for storing raw data from point cloud nodes.
Represents a map layer supporting display of point clouds.
Encapsulates the render context for a 2D point cloud rendering operation.
const QgsRenderContext & renderContext() const
Returns a reference to the context's render context.
int yOffset() const
Returns the offset for the y value in a point record.
double zValueFixedOffset() const
Returns any constant offset which must be applied to z values taken from the point cloud index.
QgsVector3D offset() const
Returns the offset of the layer's int32 coordinates compared to CRS coords.
static void getAttribute(const char *data, std::size_t offset, QgsPointCloudAttribute::DataType type, T &value)
Retrieves the attribute value from data at the specified offset, where type indicates the original da...
void setOffset(const QgsVector3D &offset)
Sets the offset of the layer's int32 coordinates compared to CRS coords.
void setScale(const QgsVector3D &scale)
Sets the scale of the layer's int32 coordinates compared to CRS coords.
int pointRecordSize() const
Returns the size of a single point record.
int xOffset() const
Returns the offset for the x value in a point record.
QgsPointCloudRenderContext(const QgsPointCloudRenderContext &rh)=delete
QgsPointCloudRenderContext cannot be copied.
QgsFeedback * feedback() const
Returns the feedback object used to cancel rendering.
double zValueScale() const
Returns any constant scaling factor which must be applied to z values taken from the point cloud inde...
QgsVector3D scale() const
Returns the scale of the layer's int32 coordinates compared to CRS coords.
QgsPointCloudAttributeCollection attributes() const
Returns the attributes associated with the rendered block.
int zOffset() const
Returns the offset for the y value in a point record.
QgsPointCloudRenderContext & operator=(const QgsPointCloudRenderContext &)=delete
QgsPointCloudRenderContext cannot be copied.
QgsRenderContext & renderContext()
Returns a reference to the context's render context.
Abstract base class for 2d point cloud renderers.
virtual QDomElement save(QDomDocument &doc, const QgsReadWriteContext &context) const =0
Saves the renderer configuration to an XML element.
const QgsMapUnitScale & pointSizeMapUnitScale() const
Returns the map unit scale used for the point size.
virtual void renderBlock(const QgsPointCloudBlock *block, QgsPointCloudRenderContext &context)=0
Renders a block of point cloud data using the specified render context.
QgsPointCloudRenderer & operator=(const QgsPointCloudRenderer &other)=delete
QgsPointCloudRenderer cannot be copied – use clone() instead.
void setPointSizeUnit(const QgsUnitTypes::RenderUnit units)
Sets the units used for the point size.
void setPointSizeMapUnitScale(const QgsMapUnitScale &scale)
Sets the map unit scale used for the point size.
QgsPointCloudRenderer()=default
Constructor for QgsPointCloudRenderer.
virtual QgsPointCloudRenderer * clone() const =0
Create a deep copy of this renderer.
virtual QString type() const =0
Returns the identifier of the renderer type.
QgsPointCloudRenderer(const QgsPointCloudRenderer &other)=delete
QgsPointCloudRenderer cannot be copied – use clone() instead.
QgsUnitTypes::RenderUnit pointSizeUnit() const
Returns the units used for the point size.
virtual ~QgsPointCloudRenderer()=default
void drawPoint(double x, double y, const QColor &color, QgsPointCloudRenderContext &context) const
Draws a point using a color at the specified x and y (in map coordinates).
double pointSize() const
Returns the point size.
static double pointZ(QgsPointCloudRenderContext &context, const char *ptr, int i)
Retrieves the z value for the point at index i.
static void pointXY(QgsPointCloudRenderContext &context, const char *ptr, int i, double &x, double &y)
Retrieves the x and y coordinate for the point at index i.
Base class for 2d point cloud renderer prepared data containers.
virtual QColor pointColor(const QgsPointCloudBlock *block, int i, double z)=0
An optimised method of retrieving the color of a point from a point cloud block.
virtual bool prepareBlock(const QgsPointCloudBlock *block)=0
Prepares the renderer for using the specified block.
virtual QSet< QString > usedAttributes() const =0
Returns the set of attributes used by the prepared point cloud renderer.
The class is used as a container of context for various read/write operations on other objects.
Contains information about the context of a rendering operation.
QPainter * painter()
Returns the destination QPainter for the render operation.
const QgsMapToPixel & mapToPixel() const
Returns the context's map to pixel transform, which transforms between map coordinates and device coo...
RenderUnit
Rendering size units.
Definition: qgsunittypes.h:168
@ RenderMillimeters
Millimeters.
Definition: qgsunittypes.h:169
double y() const
Returns Y coordinate.
Definition: qgsvector3d.h:51
double z() const
Returns Z coordinate.
Definition: qgsvector3d.h:53
double x() const
Returns X coordinate.
Definition: qgsvector3d.h:49
#define SIP_CONVERT_TO_SUBCLASS_CODE(code)
Definition: qgis_sip.h:186
#define SIP_SKIP
Definition: qgis_sip.h:126
#define SIP_FACTORY
Definition: qgis_sip.h:76
#define SIP_END
Definition: qgis_sip.h:203