Encapsulates the render context for a 2D point cloud rendering operation. More...

#include <qgspointcloudrenderer.h>

Public Member Functions
	QgsPointCloudRenderContext (const QgsPointCloudRenderContext &rh)=delete
	QgsPointCloudRenderContext cannot be copied. More...

	QgsPointCloudRenderContext (QgsRenderContext &context, const QgsVector3D &scale, const QgsVector3D &offset, double zValueScale, double zValueFixedOffset, QgsFeedback *feedback=nullptr)
	Constructor for QgsPointCloudRenderContext. More...

QgsPointCloudAttributeCollection	attributes () const
	Returns the attributes associated with the rendered block. More...

QgsElevationMap *	elevationMap ()
	Returns elevation map. More...

QgsFeedback *	feedback () const
	Returns the feedback object used to cancel rendering. More...

void	incrementPointsRendered (long count)
	Increments the count of points rendered by the specified amount. More...

QgsVector3D	offset () const
	Returns the offset of the layer's int32 coordinates compared to CRS coords. More...

QgsPointCloudRenderContext &	operator= (const QgsPointCloudRenderContext &)=delete
	QgsPointCloudRenderContext cannot be copied. More...

int	pointRecordSize () const
	Returns the size of a single point record. More...

long	pointsRendered () const
	Returns the total number of points rendered. More...

QgsRenderContext &	renderContext ()
	Returns a reference to the context's render context. More...

const QgsRenderContext &	renderContext () const
	Returns a reference to the context's render context. More...

QgsVector3D	scale () const
	Returns the scale of the layer's int32 coordinates compared to CRS coords. More...

void	setAttributes (const QgsPointCloudAttributeCollection &attributes)
	Sets the attributes associated with the rendered block. More...

void	setElevationMap (QgsElevationMap *elevationMap)
	Sets elevation map that will be used to record elevation of rendered points. More...

void	setOffset (const QgsVector3D &offset)
	Sets the offset of the layer's int32 coordinates compared to CRS coords. More...

void	setScale (const QgsVector3D &scale)
	Sets the scale of the layer's int32 coordinates compared to CRS coords. More...

int	xOffset () const
	Returns the offset for the x value in a point record. More...

int	yOffset () const
	Returns the offset for the y value in a point record. More...

int	zOffset () const
	Returns the offset for the y value in a point record. More...

double	zValueFixedOffset () const
	Returns any constant offset which must be applied to z values taken from the point cloud index. More...

double	zValueScale () const
	Returns any constant scaling factor which must be applied to z values taken from the point cloud index. More...

Static Public Member Functions
template<typename T >
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 data type for the attribute. More...

Detailed Description

Encapsulates the render context for a 2D point cloud rendering operation.

Since: QGIS 3.18

Definition at line 43 of file qgspointcloudrenderer.h.

Constructor & Destructor Documentation

◆ QgsPointCloudRenderContext() [1/2]

QgsPointCloudRenderContext::QgsPointCloudRenderContext	(	QgsRenderContext &	context,
		const QgsVector3D &	scale,
		const QgsVector3D &	offset,
		double	zValueScale,
		double	zValueFixedOffset,
		QgsFeedback *	feedback = `nullptr`
	)

Constructor for QgsPointCloudRenderContext.

The scale and offset arguments specify the scale and offset of the layer's int32 coordinates compared to CRS coordinates respectively.

The zValueScale argument specifies any constant scaling factor which must be applied to z values taken from the point cloud index.

The zValueFixedOffset argument specifies any constant offset value which must be added to z values taken from the point cloud index.

Definition at line 31 of file qgspointcloudrenderer.cpp.

◆ QgsPointCloudRenderContext() [2/2]

QgsPointCloudRenderContext::QgsPointCloudRenderContext ( const QgsPointCloudRenderContext & rh )

delete

QgsPointCloudRenderContext cannot be copied.

Member Function Documentation

◆ attributes()

QgsPointCloudAttributeCollection QgsPointCloudRenderContext::attributes ( ) const

inline

Returns the attributes associated with the rendered block.

See also: setAttributes()

Definition at line 119 of file qgspointcloudrenderer.h.

◆ elevationMap()

QgsElevationMap * QgsPointCloudRenderContext::elevationMap ( )

inline

Returns elevation map.

It may be a null pointer if elevation map is not needed in rendering.

Since: QGIS 3.28

Definition at line 193 of file qgspointcloudrenderer.h.

◆ feedback()

QgsFeedback * QgsPointCloudRenderContext::feedback ( ) const

inline

Returns the feedback object used to cancel rendering.

Since: QGIS 3.20

Definition at line 176 of file qgspointcloudrenderer.h.

◆ getAttribute()

template<typename T >

static void QgsPointCloudRenderContext::getAttribute	(	const char *	data,
		std::size_t	offset,
		QgsPointCloudAttribute::DataType	type,
		T &	value
	)

inlinestatic

Retrieves the attribute value from data at the specified offset, where type indicates the original data type for the attribute.

Definition at line 203 of file qgspointcloudrenderer.h.

◆ incrementPointsRendered()

void QgsPointCloudRenderContext::incrementPointsRendered ( long count )

Increments the count of points rendered by the specified amount.

It is a point cloud renderer's responsibility to correctly call this after rendering a block of points.

Definition at line 52 of file qgspointcloudrenderer.cpp.

◆ offset()

QgsVector3D QgsPointCloudRenderContext::offset ( ) const

inline

Returns the offset of the layer's int32 coordinates compared to CRS coords.

Definition at line 93 of file qgspointcloudrenderer.h.

◆ operator=()

QgsPointCloudRenderContext & QgsPointCloudRenderContext::operator= ( const QgsPointCloudRenderContext & )

delete

QgsPointCloudRenderContext cannot be copied.

◆ pointRecordSize()

int QgsPointCloudRenderContext::pointRecordSize ( ) const

inline

Returns the size of a single point record.

Definition at line 131 of file qgspointcloudrenderer.h.

◆ pointsRendered()

long QgsPointCloudRenderContext::pointsRendered ( ) const

Returns the total number of points rendered.

Definition at line 47 of file qgspointcloudrenderer.cpp.

◆ renderContext() [1/2]

QgsRenderContext & QgsPointCloudRenderContext::renderContext ( )

inline

Returns a reference to the context's render context.

Definition at line 71 of file qgspointcloudrenderer.h.

◆ renderContext() [2/2]

const QgsRenderContext & QgsPointCloudRenderContext::renderContext ( ) const

inline

Returns a reference to the context's render context.

Note: Not available in Python bindings.

Definition at line 77 of file qgspointcloudrenderer.h.

◆ scale()

QgsVector3D QgsPointCloudRenderContext::scale ( ) const

inline

Returns the scale of the layer's int32 coordinates compared to CRS coords.

Definition at line 82 of file qgspointcloudrenderer.h.

◆ setAttributes()

void QgsPointCloudRenderContext::setAttributes ( const QgsPointCloudAttributeCollection & attributes )

Sets the attributes associated with the rendered block.

See also: attributes()

Definition at line 57 of file qgspointcloudrenderer.cpp.

◆ setElevationMap()

void QgsPointCloudRenderContext::setElevationMap ( QgsElevationMap * elevationMap )

Sets elevation map that will be used to record elevation of rendered points.

Note: Takes ownership of the passed object

Since: QGIS 3.28

Definition at line 42 of file qgspointcloudrenderer.cpp.

◆ setOffset()

void QgsPointCloudRenderContext::setOffset ( const QgsVector3D & offset )

inline

Sets the offset of the layer's int32 coordinates compared to CRS coords.

Since: QGIS 3.20

Definition at line 99 of file qgspointcloudrenderer.h.

◆ setScale()

void QgsPointCloudRenderContext::setScale ( const QgsVector3D & scale )

inline

Sets the scale of the layer's int32 coordinates compared to CRS coords.

Since: QGIS 3.20

Definition at line 88 of file qgspointcloudrenderer.h.

◆ xOffset()

int QgsPointCloudRenderContext::xOffset ( ) const

inline

Returns the offset for the x value in a point record.

See also: yOffset(); zOffset()

Definition at line 139 of file qgspointcloudrenderer.h.

◆ yOffset()

int QgsPointCloudRenderContext::yOffset ( ) const

inline

Returns the offset for the y value in a point record.

See also: xOffset(); zOffset()

Definition at line 147 of file qgspointcloudrenderer.h.

◆ zOffset()

int QgsPointCloudRenderContext::zOffset ( ) const

inline

Returns the offset for the y value in a point record.

See also: xOffset(); yOffset()

Definition at line 155 of file qgspointcloudrenderer.h.

◆ zValueFixedOffset()

double QgsPointCloudRenderContext::zValueFixedOffset ( ) const

inline

Returns any constant offset which must be applied to z values taken from the point cloud index.

Note: Scaling of z values via zValueScale() should be applied before the zValueFixedOffset().

Definition at line 169 of file qgspointcloudrenderer.h.

◆ zValueScale()

double QgsPointCloudRenderContext::zValueScale ( ) const

inline

Returns any constant scaling factor which must be applied to z values taken from the point cloud index.

Note: Scaling of z values should be applied before the zValueFixedOffset().

Definition at line 162 of file qgspointcloudrenderer.h.

The documentation for this class was generated from the following files:

/build/qgis-3.28.0+99sid/src/core/pointcloud/qgspointcloudrenderer.h
/build/qgis-3.28.0+99sid/src/core/pointcloud/qgspointcloudrenderer.cpp

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ QgsPointCloudRenderContext() [1/2]

◆ QgsPointCloudRenderContext() [2/2]

Member Function Documentation

◆ attributes()

◆ elevationMap()

◆ feedback()

◆ getAttribute()

◆ incrementPointsRendered()

◆ offset()

◆ operator=()

◆ pointRecordSize()

◆ pointsRendered()

◆ renderContext() [1/2]

◆ renderContext() [2/2]

◆ scale()

◆ setAttributes()

◆ setElevationMap()

◆ setOffset()

◆ setScale()

◆ xOffset()

◆ yOffset()

◆ zOffset()

◆ zValueFixedOffset()

◆ zValueScale()