qgsmaterial3dhandler.h

Go to the documentation of this file.

/***************************************************************************
  qgsmaterial3dhandler.h
  --------------------------------------
  Date                 : March 2026
  Copyright            : (C) 2026 by Nyall Dawson
  Email                : nyall dot dawson at gmail 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 QGSMATERIAL3DHANDLER_H
#define QGSMATERIAL3DHANDLER_H
 
#include "qgis_3d.h"
#include "qgis_sip.h"
#include "qgsmaterial.h"
#include "qgspropertycollection.h"
 
#include <QColor>
#include <QString>
 
#define SIP_NO_FILE
 
using namespace Qt::StringLiterals;
 
class QDomElement;
class QgsReadWriteContext;
class QgsLineMaterial;
class QgsExpressionContext;
class QgsAbstractMaterialSettings;
 
namespace Qt3DCore
{
  class QGeometry;
}
namespace Qt3DExtras
{
  class Qt3DWindow;
}

class _3D_EXPORT QgsMaterialContext
{
  public:
    bool isSelected() const { return mIsSelected; }

    void setIsSelected( bool isSelected ) { mIsSelected = isSelected; }

    QColor selectionColor() const { return mSelectedColor; }

    void setSelectionColor( const QColor &color ) { mSelectedColor = color; }

    bool isHighlighted() const { return mIsHighlighted; }

    void setIsHighlighted( bool isHighlighted ) { mIsHighlighted = isHighlighted; }
 
  private:
    bool mIsSelected = false;
    bool mIsHighlighted = false;
 
    QColor mSelectedColor;
};
 

class _3D_EXPORT QgsAbstractMaterial3DHandler SIP_ABSTRACT
{
  public:
    virtual ~QgsAbstractMaterial3DHandler() = default;

    virtual QgsMaterial *toMaterial( const QgsAbstractMaterialSettings *settings, Qgis::MaterialRenderingTechnique technique, const QgsMaterialContext &context ) const = 0 SIP_FACTORY;

    virtual QMap<QString, QString> toExportParameters( const QgsAbstractMaterialSettings *settings ) const = 0;

    virtual void addParametersToEffect( Qt3DRender::QEffect *effect, const QgsAbstractMaterialSettings *settings, const QgsMaterialContext &materialContext ) const = 0;

    virtual void applyDataDefinedToGeometry( const QgsAbstractMaterialSettings *settings, Qt3DCore::QGeometry *geometry, int vertexCount, const QByteArray &dataDefinedBytes ) const;

    virtual QByteArray dataDefinedVertexColorsAsByte( const QgsAbstractMaterialSettings *settings, const QgsExpressionContext &expressionContext ) const;

    virtual int dataDefinedByteStride( const QgsAbstractMaterialSettings *settings ) const;

    struct PreviewMeshType
    {
        QString type;
        QString displayName;
    };

    virtual QList< PreviewMeshType > previewMeshTypes() const;

    virtual Qt3DCore::QEntity *createPreviewMesh( const QString &type, Qt3DCore::QEntity *parent ) const;

    virtual Qt3DCore::QEntity *createPreviewScene(
      const QgsAbstractMaterialSettings *settings, const QString &type, const QgsMaterialContext &context, Qt3DExtras::Qt3DWindow *window, Qt3DCore::QEntity *parent
    ) const;

    virtual bool updatePreviewScene( Qt3DCore::QEntity *sceneRoot, const QgsAbstractMaterialSettings *settings, const QgsMaterialContext &context ) const = 0;
 
  protected:
    static Qt3DRender::QParameter *findParameter( Qt3DRender::QEffect *effect, const QString &name );
};
 
 
#endif // QGSMATERIAL3DHANDLER_H