QGIS API Documentation: QgsPointCloudCategory Class Reference

QGIS API Documentation 3.28.0-Firenze (ed3ad0430f)

Represents an individual category (class) from a QgsPointCloudClassifiedRenderer. More...

#include <qgspointcloudclassifiedrenderer.h>

Public Member Functions
	QgsPointCloudCategory ()=default
	Constructor for QgsPointCloudCategory. More...

	QgsPointCloudCategory (int value, const QColor &color, const QString &label, bool render=true)
	Constructor for a new QgsPointCloudCategory, with the specified value and color. More...

QColor	color () const
	Returns the color which will be used to render this category. More...

QString	label () const
	Returns the label for this category, which is used to represent the category within legends and the layer tree. More...

bool	operator== (const QgsPointCloudCategory &other) const
	Equality operator. More...

bool	renderState () const
	Returns `true` if the category is currently enabled and should be rendered. More...

void	setColor (const QColor &color)
	Sets the color which will be used to render this category. More...

void	setLabel (const QString &label)
	Sets the label for this category, which is used to represent the category within legends and the layer tree. More...

void	setRenderState (bool render)
	Sets whether the category is currently enabled and should be rendered. More...

void	setValue (int value)
	Sets the value corresponding to this category. More...

int	value () const
	Returns the value corresponding to this category. More...

Protected Attributes
QColor	mColor

QString	mLabel

bool	mRender = true

int	mValue = 0

Detailed Description

Represents an individual category (class) from a QgsPointCloudClassifiedRenderer.

Since: QGIS 3.18

Definition at line 32 of file qgspointcloudclassifiedrenderer.h.

Constructor & Destructor Documentation

◆ QgsPointCloudCategory() [1/2]

QgsPointCloudCategory::QgsPointCloudCategory ( )

default

Constructor for QgsPointCloudCategory.

◆ QgsPointCloudCategory() [2/2]

QgsPointCloudCategory::QgsPointCloudCategory	(	int	value,
		const QColor &	color,
		const QString &	label,
		bool	render = `true`
	)

Constructor for a new QgsPointCloudCategory, with the specified value and color.

The label argument specifies the label used for this category in legends and the layer tree.

The render argument indicates whether the category should initially be rendered and appear checked in the layer tree.

Definition at line 26 of file qgspointcloudclassifiedrenderer.cpp.

Member Function Documentation

◆ color()

QColor QgsPointCloudCategory::color ( ) const

inline

Returns the color which will be used to render this category.

See also: setColor()

Definition at line 67 of file qgspointcloudclassifiedrenderer.h.

◆ label()

QString QgsPointCloudCategory::label ( ) const

inline

Returns the label for this category, which is used to represent the category within legends and the layer tree.

See also: setLabel()

Definition at line 74 of file qgspointcloudclassifiedrenderer.h.

◆ operator==()

bool QgsPointCloudCategory::operator== ( const QgsPointCloudCategory & other ) const

Equality operator.

Since: QGIS 3.26

Definition at line 34 of file qgspointcloudclassifiedrenderer.cpp.

◆ renderState()

bool QgsPointCloudCategory::renderState ( ) const

inline

Returns true if the category is currently enabled and should be rendered.

See also: setRenderState()

Definition at line 101 of file qgspointcloudclassifiedrenderer.h.

◆ setColor()

void QgsPointCloudCategory::setColor ( const QColor & color )

inline

Sets the color which will be used to render this category.

See also: color()

Definition at line 88 of file qgspointcloudclassifiedrenderer.h.

◆ setLabel()

void QgsPointCloudCategory::setLabel ( const QString & label )

inline

Sets the label for this category, which is used to represent the category within legends and the layer tree.

See also: label()

Definition at line 95 of file qgspointcloudclassifiedrenderer.h.

◆ setRenderState()

void QgsPointCloudCategory::setRenderState ( bool render )

inline

Sets whether the category is currently enabled and should be rendered.

See also: renderState()

Definition at line 107 of file qgspointcloudclassifiedrenderer.h.

◆ setValue()

void QgsPointCloudCategory::setValue ( int value )

inline

Sets the value corresponding to this category.

See also: value()

Definition at line 81 of file qgspointcloudclassifiedrenderer.h.

◆ value()

int QgsPointCloudCategory::value ( ) const

inline

Returns the value corresponding to this category.

See also: setValue()

Definition at line 61 of file qgspointcloudclassifiedrenderer.h.

Member Data Documentation

◆ mColor

QColor QgsPointCloudCategory::mColor

protected

Definition at line 111 of file qgspointcloudclassifiedrenderer.h.

◆ mLabel

QString QgsPointCloudCategory::mLabel

protected

Definition at line 112 of file qgspointcloudclassifiedrenderer.h.

◆ mRender

bool QgsPointCloudCategory::mRender = true

protected

Definition at line 113 of file qgspointcloudclassifiedrenderer.h.

◆ mValue

int QgsPointCloudCategory::mValue = 0

protected

Definition at line 110 of file qgspointcloudclassifiedrenderer.h.

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

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