QGIS API Documentation 4.1.0-Master (9af12b5a203)
Loading...
Searching...
No Matches
Qgs3DRendererCategory Class Reference

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

#include <qgscategorized3drenderer.h>

Public Member Functions

 Qgs3DRendererCategory ()=default
 Qgs3DRendererCategory (const Qgs3DRendererCategory &other)
 Qgs3DRendererCategory (const QVariant &value, QgsAbstract3DSymbol *symbol, bool render=true)
 Constructor for a new QgsRendererCategory, with the specified value and symbol.
Qgs3DRendererCategoryoperator= (const Qgs3DRendererCategory &other)
bool renderState () const
 Returns true if the category is currently enabled and should be rendered.
void setRenderState (bool render)
 Sets whether the category is currently enabled and should be rendered.
void setSymbol (QgsAbstract3DSymbol *symbol)
 Sets the symbol which will be used to render this category.
void setValue (const QVariant &value)
 Sets the value corresponding to this category.
QgsAbstract3DSymbolsymbol () const
 Returns the symbol which will be used to render this category.
const QVariant value () const
 Returns the value corresponding to this category.

Detailed Description

Represents an individual category (class) from a QgsCategorized3DRenderer.

Warning
This is not considered stable API, and may change in future QGIS releases. It is exposed to the Python bindings as a tech preview only.
Since
QGIS 4.2

Definition at line 61 of file qgscategorized3drenderer.h.

Constructor & Destructor Documentation

◆ Qgs3DRendererCategory() [1/3]

Qgs3DRendererCategory::Qgs3DRendererCategory ( )
default

◆ Qgs3DRendererCategory() [2/3]

Qgs3DRendererCategory::Qgs3DRendererCategory ( const QVariant & value,
QgsAbstract3DSymbol * symbol,
bool render = true )

Constructor for a new QgsRendererCategory, with the specified value and symbol.

If value is a list, then the category will match any of the values from this list.

The ownership of symbol is transferred to the category.

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

Definition at line 54 of file qgscategorized3drenderer.cpp.

◆ Qgs3DRendererCategory() [3/3]

Qgs3DRendererCategory::Qgs3DRendererCategory ( const Qgs3DRendererCategory & other)

Definition at line 60 of file qgscategorized3drenderer.cpp.

Member Function Documentation

◆ operator=()

Qgs3DRendererCategory & Qgs3DRendererCategory::operator= ( const Qgs3DRendererCategory & other)

Definition at line 64 of file qgscategorized3drenderer.cpp.

◆ renderState()

bool Qgs3DRendererCategory::renderState ( ) const
inline

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

See also
setRenderState()

Definition at line 99 of file qgscategorized3drenderer.h.

◆ setRenderState()

void Qgs3DRendererCategory::setRenderState ( bool render)

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

See also
renderState()

Definition at line 76 of file qgscategorized3drenderer.cpp.

◆ setSymbol()

void Qgs3DRendererCategory::setSymbol ( QgsAbstract3DSymbol * symbol)

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

Ownership of the symbol is transferred to the category.

See also
symbol()

Definition at line 86 of file qgscategorized3drenderer.cpp.

◆ setValue()

void Qgs3DRendererCategory::setValue ( const QVariant & value)

Sets the value corresponding to this category.

If value is a list, then the category will match any of the values from this list.

See also
value()

Definition at line 81 of file qgscategorized3drenderer.cpp.

◆ symbol()

QgsAbstract3DSymbol * Qgs3DRendererCategory::symbol ( ) const
inline

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

See also
setSymbol()

Definition at line 93 of file qgscategorized3drenderer.h.

◆ value()

const QVariant Qgs3DRendererCategory::value ( ) const
inline

Returns the value corresponding to this category.

If the returned value is a list, then the category will match any of the values from this list.

See also
setValue()

Definition at line 87 of file qgscategorized3drenderer.h.


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