qgscategorized3drenderer.h

Go to the documentation of this file.

/***************************************************************************
  qgscategorized3drenderer.h
  --------------------------------------
  Date                 : November 2025
  Copyright            : (C) 2025 by Jean Felder
  Email                : jean dot felder at oslandia dot com
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSCATEGORIZED3DRENDERER_H
#define QGSCATEGORIZED3DRENDERER_H
 
#include <memory>
 
#include "qgis_3d.h"
#include "qgis_sip.h"
#include "qgs3drendererregistry.h"
#include "qgsabstract3dsymbol.h"
#include "qgsabstractvectorlayer3drenderer.h"
#include "qgscolorramp.h"
 
class Qgs3DRenderContext;
class QgsFeature3DHandler;
class QgsExpression;
 

class _3D_EXPORT QgsCategorized3DRendererMetadata : public Qgs3DRendererAbstractMetadata
{
  public:
    QgsCategorized3DRendererMetadata();

    QgsAbstract3DRenderer *createRenderer( QDomElement &elem, const QgsReadWriteContext &context ) override SIP_FACTORY;
};
 

class _3D_EXPORT Qgs3DRendererCategory
{
  public:
    Qgs3DRendererCategory() = default;

    Qgs3DRendererCategory( const QVariant &value, QgsAbstract3DSymbol *symbol SIP_TRANSFER, bool render = true );
 
    Qgs3DRendererCategory( const Qgs3DRendererCategory &other );
    Qgs3DRendererCategory &operator=( const Qgs3DRendererCategory &other );

    const QVariant value() const { return mValue; }

    QgsAbstract3DSymbol *symbol() const { return mSymbol.get(); }

    bool renderState() const { return mRender; }

    void setValue( const QVariant &value );

    void setSymbol( QgsAbstract3DSymbol *symbol SIP_TRANSFER );

    void setRenderState( bool render );
 
  private:
    QVariant mValue;
    std::unique_ptr<QgsAbstract3DSymbol> mSymbol;
    bool mRender = true;
};
 
using Qgs3DCategoryList = QList<Qgs3DRendererCategory>;
 

class _3D_EXPORT QgsCategorized3DRenderer : public QgsAbstractVectorLayer3DRenderer
{
  public:
    using Category = Qgs3DRendererCategory;
    using Categories = Qgs3DCategoryList;

    QgsCategorized3DRenderer( const QString &attributeName = QString(), const Qgs3DCategoryList &categories = Qgs3DCategoryList() );
 
    QString type() const override { return "categorized"; }
    QgsCategorized3DRenderer *clone() const override SIP_FACTORY;
    Qt3DCore::QEntity *createEntity( Qgs3DMapSettings *mapSettings ) const override SIP_SKIP;

    void updateSymbols( QgsAbstract3DSymbol *symbol );

    const Qgs3DCategoryList &categories() const { return mCategories; }

    QString classAttribute() const { return mAttributeName; }

    void setClassAttribute( QString attributeName );

    QgsAbstract3DSymbol *sourceSymbol();

    const QgsAbstract3DSymbol *sourceSymbol() const SIP_SKIP;

    void setSourceSymbol( QgsAbstract3DSymbol *symbol SIP_TRANSFER );

    QgsColorRamp *sourceColorRamp();

    const QgsColorRamp *sourceColorRamp() const SIP_SKIP;

    void setSourceColorRamp( QgsColorRamp *ramp SIP_TRANSFER );

    void updateColorRamp( QgsColorRamp *ramp SIP_TRANSFER );

    bool updateCategoryValue( int catIndex, const QVariant &value );

    bool updateCategorySymbol( int catIndex, QgsAbstract3DSymbol *symbol SIP_TRANSFER );

    bool updateCategoryRenderState( int catIndex, bool render );

    void addCategory( const Qgs3DRendererCategory &category );

    bool deleteCategory( int catIndex );

    void deleteAllCategories();

    bool moveCategory( int from, int to );

    static Qgs3DCategoryList createCategories( const QVariantList &values, const QgsAbstract3DSymbol *symbol, QgsVectorLayer *layer = nullptr, const QString &attributeName = QString() );

    void sortByValue( Qt::SortOrder order = Qt::AscendingOrder );
 
    void writeXml( QDomElement &elem, const QgsReadWriteContext &context ) const override;
    void readXml( const QDomElement &elem, const QgsReadWriteContext &context ) override;
 
  private:
    QString mAttributeName;
    Qgs3DCategoryList mCategories;
    std::unique_ptr<QgsColorRamp> mSourceColorRamp;
    std::unique_ptr<QgsAbstract3DSymbol> mSourceSymbol;
};
 
#endif // QGSCATEGORIZED3DRENDERER_H