QGIS API Documentation 3.29.0-Master (8c80f25a4f)
Public Member Functions | Static Public Member Functions | List of all members
QgsNullMaterialSettings Class Reference

3 More...

#include <qgsnullmaterialsettings.h>

Inheritance diagram for QgsNullMaterialSettings:
Inheritance graph
[legend]

Public Member Functions

 QgsNullMaterialSettings ()=default
 Constructor for QgsNullMaterialSettings. More...
 
void addParametersToEffect (Qt3DRender::QEffect *effect) const override
 Adds parameters from the material to a destination effect. More...
 
QgsNullMaterialSettingsclone () const override
 Clones the material settings. More...
 
QMap< QString, QString > toExportParameters () const override
 Returns the parameters to be exported to .mtl file. More...
 
Qt3DRender::QMaterial * toMaterial (QgsMaterialSettingsRenderingTechnique technique, const QgsMaterialContext &context) const override
 Creates a new QMaterial object representing the material settings. More...
 
QString type () const override
 Returns the unique type name for the material. More...
 
- Public Member Functions inherited from QgsAbstractMaterialSettings
virtual ~QgsAbstractMaterialSettings ()=default
 
virtual void addParametersToEffect (Qt3DRender::QEffect *effect) const =0
 Adds parameters from the material to a destination effect. More...
 
virtual void applyDataDefinedToGeometry (Qt3DCore::QGeometry *geometry, int vertexCount, const QByteArray &dataDefinedBytes) const
 Applies the data defined bytes, dataDefinedBytes, on the geometry by filling a specific vertex buffer that will be used by the shader. More...
 
virtual QgsAbstractMaterialSettingsclone () const =0
 Clones the material settings. More...
 
virtual int dataDefinedByteStride () const
 Returns byte stride of the data defined colors,used to fill the vertex colors data defined buffer for rendering. More...
 
QgsPropertyCollection dataDefinedProperties () const
 Returns the symbol material property collection, used for data defined overrides. More...
 
virtual QByteArray dataDefinedVertexColorsAsByte (const QgsExpressionContext &expressionContext) const
 Returns byte array corresponding to the data defined colors depending of the expressionContext, used to fill the specific vertex buffer used for rendering the geometry. More...
 
const QgsPropertiesDefinitionpropertyDefinitions () const
 Returns a reference to the material properties definition, used for data defined overrides. More...
 
virtual void readXml (const QDomElement &element, const QgsReadWriteContext &)
 Reads settings from a DOM element. More...
 
void setDataDefinedProperties (const QgsPropertyCollection &collection)
 Sets the material property collection, used for data defined overrides. More...
 
virtual QMap< QString, QString > toExportParameters () const =0
 Returns the parameters to be exported to .mtl file. More...
 
virtual Qt3DRender::QMaterial * toMaterial (QgsMaterialSettingsRenderingTechnique technique, const QgsMaterialContext &context) const =0
 Creates a new QMaterial object representing the material settings. More...
 
virtual QString type () const =0
 Returns the unique type name for the material. More...
 
virtual void writeXml (QDomElement &element, const QgsReadWriteContext &) const
 Writes settings to a DOM element. More...
 

Static Public Member Functions

static QgsAbstractMaterialSettingscreate ()
 Returns a new instance of QgsNullMaterialSettings. More...
 
static bool supportsTechnique (QgsMaterialSettingsRenderingTechnique technique)
 Returns true if the specified technique is supported by the material. More...
 

Additional Inherited Members

- Public Types inherited from QgsAbstractMaterialSettings
enum  Property {
  Diffuse , Ambient , Warm , Cool ,
  Specular
}
 Data definable properties. More...
 

Detailed Description

3

Null shading material used for rendering models and scenes with native textures.

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 3.16.2

Definition at line 36 of file qgsnullmaterialsettings.h.

Constructor & Destructor Documentation

◆ QgsNullMaterialSettings()

QgsNullMaterialSettings::QgsNullMaterialSettings ( )
default

Constructor for QgsNullMaterialSettings.

Member Function Documentation

◆ addParametersToEffect()

void QgsNullMaterialSettings::addParametersToEffect ( Qt3DRender::QEffect *  effect) const
overridevirtual

Adds parameters from the material to a destination effect.

Implements QgsAbstractMaterialSettings.

Definition at line 64 of file qgsnullmaterialsettings.cpp.

◆ clone()

QgsNullMaterialSettings * QgsNullMaterialSettings::clone ( ) const
overridevirtual

Clones the material settings.

Caller takes ownership of the returned object.

Implements QgsAbstractMaterialSettings.

Definition at line 48 of file qgsnullmaterialsettings.cpp.

◆ create()

QgsAbstractMaterialSettings * QgsNullMaterialSettings::create ( )
static

Returns a new instance of QgsNullMaterialSettings.

Definition at line 43 of file qgsnullmaterialsettings.cpp.

◆ supportsTechnique()

bool QgsNullMaterialSettings::supportsTechnique ( QgsMaterialSettingsRenderingTechnique  technique)
static

Returns true if the specified technique is supported by the material.

Definition at line 25 of file qgsnullmaterialsettings.cpp.

◆ toExportParameters()

QMap< QString, QString > QgsNullMaterialSettings::toExportParameters ( ) const
overridevirtual

Returns the parameters to be exported to .mtl file.

Implements QgsAbstractMaterialSettings.

Definition at line 58 of file qgsnullmaterialsettings.cpp.

◆ toMaterial()

Qt3DRender::QMaterial * QgsNullMaterialSettings::toMaterial ( QgsMaterialSettingsRenderingTechnique  technique,
const QgsMaterialContext context 
) const
overridevirtual

Creates a new QMaterial object representing the material settings.

The technique argument specifies the rendering technique which will be used with the returned material.

Implements QgsAbstractMaterialSettings.

Definition at line 53 of file qgsnullmaterialsettings.cpp.

◆ type()

QString QgsNullMaterialSettings::type ( ) const
overridevirtual

Returns the unique type name for the material.

Implements QgsAbstractMaterialSettings.

Definition at line 20 of file qgsnullmaterialsettings.cpp.


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