QgsNullMaterialSettings Class Reference

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

#include <qgsnullmaterialsettings.h>

Inheritance diagram for QgsNullMaterialSettings:

Public Member Functions
	QgsNullMaterialSettings ()=default
void	addParametersToEffect (Qt3DRender::QEffect *effect, const QgsMaterialContext &materialContext) const override
	Adds parameters from the material to a destination effect.
QgsNullMaterialSettings *	clone () const override
	Clones the material settings.
bool	equals (const QgsAbstractMaterialSettings *other) const override
	Returns true if this settings exactly matches an other settings.
QMap< QString, QString >	toExportParameters () const override
	Returns the parameters to be exported to .mtl file.
QgsMaterial *	toMaterial (QgsMaterialSettingsRenderingTechnique technique, const QgsMaterialContext &context) const override
	Creates a new QgsMaterial object representing the material settings.
QString	type () const override
	Returns the unique type name for the material.
Public Member Functions inherited from QgsAbstractMaterialSettings
virtual	~QgsAbstractMaterialSettings ()=default
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.
virtual int	dataDefinedByteStride () const
	Returns byte stride of the data defined colors,used to fill the vertex colors data defined buffer for rendering.
QgsPropertyCollection	dataDefinedProperties () const
	Returns the symbol material property collection, used for data defined overrides.
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.
const QgsPropertiesDefinition &	propertyDefinitions () const
	Returns a reference to the material properties definition, used for data defined overrides.
virtual void	readXml (const QDomElement &element, const QgsReadWriteContext &)
	Reads settings from a DOM element.
void	setDataDefinedProperties (const QgsPropertyCollection &collection)
	Sets the material property collection, used for data defined overrides.
virtual void	writeXml (QDomElement &element, const QgsReadWriteContext &) const
	Writes settings to a DOM element.

Static Public Member Functions
static QgsAbstractMaterialSettings *	create ()
	Returns a new instance of QgsNullMaterialSettings.
static bool	supportsTechnique (QgsMaterialSettingsRenderingTechnique technique)
	Returns true if the specified technique is supported by the material.

Additional Inherited Members
Public Types inherited from QgsAbstractMaterialSettings
enum class	Property : int {   Diffuse , Ambient , Warm , Cool ,   Specular }
	Data definable properties. More...

Detailed Description

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

Member Function Documentation

addParametersToEffect()

void QgsNullMaterialSettings::addParametersToEffect ( Qt3DRender::QEffect * effect, const QgsMaterialContext & materialContext ) const

overridevirtual

Adds parameters from the material to a destination effect.

Implements QgsAbstractMaterialSettings.

Definition at line 75 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 50 of file qgsnullmaterialsettings.cpp.

create()

QgsAbstractMaterialSettings * QgsNullMaterialSettings::create ( )

static

Returns a new instance of QgsNullMaterialSettings.

Definition at line 45 of file qgsnullmaterialsettings.cpp.

equals()

bool QgsNullMaterialSettings::equals ( const QgsAbstractMaterialSettings * other ) const

overridevirtual

Returns true if this settings exactly matches an other settings.

Since

QGIS 3.42

Implements QgsAbstractMaterialSettings.

Definition at line 55 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 27 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 69 of file qgsnullmaterialsettings.cpp.

toMaterial()

QgsMaterial * QgsNullMaterialSettings::toMaterial ( QgsMaterialSettingsRenderingTechnique technique, const QgsMaterialContext & context ) const

overridevirtual

Creates a new QgsMaterial 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 64 of file qgsnullmaterialsettings.cpp.

type()

QString QgsNullMaterialSettings::type ( ) const

overridevirtual

Returns the unique type name for the material.

Implements QgsAbstractMaterialSettings.

Definition at line 22 of file qgsnullmaterialsettings.cpp.

---

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

• /build/qgis-3.99.0+git20251210+2fe06baccd8+99sid/src/3d/materials/qgsnullmaterialsettings.h
• /build/qgis-3.99.0+git20251210+2fe06baccd8+99sid/src/3d/materials/qgsnullmaterialsettings.cpp