QGIS API Documentation 3.37.0-Master (614ebf5f6b2)
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
QgsPointCloudCategory Class Reference

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

#include <qgspointcloudclassifiedrenderer.h>

Public Member Functions

 QgsPointCloudCategory ()=default
 Constructor for QgsPointCloudCategory.
 
 QgsPointCloudCategory (int value, const QColor &color, const QString &label, bool render=true, double pointSize=0)
 Constructor for a new QgsPointCloudCategory, with the specified value and color.
 
QColor color () const
 Returns the color which will be used to render this category.
 
QString label () const
 Returns the label for this category, which is used to represent the category within legends and the layer tree.
 
bool operator== (const QgsPointCloudCategory &other) const
 Equality operator.
 
double pointSize () const
 Returns the point size for this category.
 
bool renderState () const
 Returns true if the category is currently enabled and should be rendered.
 
void setColor (const QColor &color)
 Sets the color which will be used to render this category.
 
void setLabel (const QString &label)
 Sets the label for this category, which is used to represent the category within legends and the layer tree.
 
void setPointSize (double size)
 Sets the point size for this category.
 
void setRenderState (bool render)
 Sets whether the category is currently enabled and should be rendered.
 
void setValue (int value)
 Sets the value corresponding to this category.
 
int value () const
 Returns the value corresponding to this category.
 

Protected Attributes

QColor mColor
 
QString mLabel
 
double mPointSize = 0
 
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,
double  pointSize = 0 
)

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.

A positive pointSize argument overrides the layer's point size setting for this category (added in QGIS 3.36).

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 69 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 83 of file qgspointcloudclassifiedrenderer.h.

◆ operator==()

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

Equality operator.

Since
QGIS 3.26

Definition at line 35 of file qgspointcloudclassifiedrenderer.cpp.

◆ pointSize()

double QgsPointCloudCategory::pointSize ( ) const
inline

Returns the point size for this category.

See also
setPointSize()
Since
QGIS 3.36

Definition at line 76 of file qgspointcloudclassifiedrenderer.h.

◆ renderState()

bool QgsPointCloudCategory::renderState ( ) const
inline

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

See also
setRenderState()

Definition at line 118 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 97 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 112 of file qgspointcloudclassifiedrenderer.h.

◆ setPointSize()

void QgsPointCloudCategory::setPointSize ( double  size)
inline

Sets the point size for this category.

See also
pointSize()
Since
QGIS 3.36

Definition at line 105 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 124 of file qgspointcloudclassifiedrenderer.h.

◆ setValue()

void QgsPointCloudCategory::setValue ( int  value)
inline

Sets the value corresponding to this category.

See also
value()

Definition at line 90 of file qgspointcloudclassifiedrenderer.h.

◆ value()

int QgsPointCloudCategory::value ( ) const
inline

Returns the value corresponding to this category.

See also
setValue()

Definition at line 63 of file qgspointcloudclassifiedrenderer.h.

Member Data Documentation

◆ mColor

QColor QgsPointCloudCategory::mColor
protected

Definition at line 128 of file qgspointcloudclassifiedrenderer.h.

◆ mLabel

QString QgsPointCloudCategory::mLabel
protected

Definition at line 130 of file qgspointcloudclassifiedrenderer.h.

◆ mPointSize

double QgsPointCloudCategory::mPointSize = 0
protected

Definition at line 129 of file qgspointcloudclassifiedrenderer.h.

◆ mRender

bool QgsPointCloudCategory::mRender = true
protected

Definition at line 131 of file qgspointcloudclassifiedrenderer.h.

◆ mValue

int QgsPointCloudCategory::mValue = 0
protected

Definition at line 127 of file qgspointcloudclassifiedrenderer.h.


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