qgsabstractmaterialsettings.h

Go to the documentation of this file.

/***************************************************************************
  qgsabstractmaterialsettings.h
  --------------------------------------
  Date                 : July 2020
  Copyright            : (C) 2020 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 QGSABSTRACTMATERIALSETTINGS_H
#define QGSABSTRACTMATERIALSETTINGS_H
 
#include "qgis_3d.h"
#include "qgis_sip.h"
#include "qgsmaterial.h"
#include "qgspropertycollection.h"
 
#include <QColor>
#include <QString>
 
using namespace Qt::StringLiterals;
 
class QDomElement;
class QgsReadWriteContext;
class QgsLineMaterial;
class QgsExpressionContext;
 
#ifndef SIP_RUN
namespace Qt3DCore
{
  class QGeometry;
}
#endif //SIP_RUN

enum class QgsMaterialSettingsRenderingTechnique SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsAbstractMaterialSettings, RenderingTechnique ) : int
{
  Triangles,                 
  Lines,                     
  InstancedPoints,           
  Points,                    
  TrianglesWithFixedTexture, 
  TrianglesFromModel,        
  TrianglesDataDefined,      
};
 

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 QgsAbstractMaterialSettings SIP_ABSTRACT
{
#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    if ( sipCpp->type() == "gooch"_L1 )
    {
      sipType = sipType_QgsGoochMaterialSettings;
    }
    else if ( sipCpp->type() == "phong"_L1 )
    {
      sipType = sipType_QgsPhongMaterialSettings;
    }
    else if ( sipCpp->type() == "phongtextured" )
    {
      sipType = sipType_QgsPhongTexturedMaterialSettings;
    }
    else if ( sipCpp->type() == "simpleline" )
    {
      sipType = sipType_QgsSimpleLineMaterialSettings;
    }
    else if ( sipCpp->type() == "null" )
    {
      sipType = sipType_QgsNullMaterialSettings;
    }
    else
    {
      sipType = 0;
    }
    SIP_END
#endif
 
  public:
    virtual ~QgsAbstractMaterialSettings() = default;

    virtual QString type() const = 0;

    virtual QgsAbstractMaterialSettings *clone() const = 0 SIP_FACTORY;

    virtual void readXml( const QDomElement &element, const QgsReadWriteContext & );

    virtual void writeXml( QDomElement &element, const QgsReadWriteContext & ) const;

    virtual bool equals( const QgsAbstractMaterialSettings *other ) const = 0;
 
#ifndef SIP_RUN

    virtual QgsMaterial *toMaterial( QgsMaterialSettingsRenderingTechnique technique, const QgsMaterialContext &context ) const = 0 SIP_FACTORY;

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

    virtual void addParametersToEffect( Qt3DRender::QEffect *effect, const QgsMaterialContext &materialContext ) const = 0;
 
    // *INDENT-OFF*
    enum class Property SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsAbstractMaterialSettings, Property ) : int
    {
      Diffuse, 
      Ambient, 
      Warm,    
      Cool,    
      Specular 
    };
    // *INDENT-ON*

    void setDataDefinedProperties( const QgsPropertyCollection &collection );

    QgsPropertyCollection dataDefinedProperties() const;

    const QgsPropertiesDefinition &propertyDefinitions() const;

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

    virtual QByteArray dataDefinedVertexColorsAsByte( const QgsExpressionContext &expressionContext ) const;

    virtual int dataDefinedByteStride() const { return 0; }
#endif
 
  private:
    QgsPropertyCollection mDataDefinedProperties;
    static QgsPropertiesDefinition sPropertyDefinitions;
    void initPropertyDefinitions() const;
};
 
 
#endif // QGSABSTRACTMATERIALSETTINGS_H