QgsAbstractMaterialSettings Class Reference

3 Abstract base class for material settings. More...

#include <qgsabstractmaterialsettings.h>

Inheritance diagram for QgsAbstractMaterialSettings:

Public Member Functions
virtual	~QgsAbstractMaterialSettings ()=default
virtual void	addParametersToEffect (Qt3DRender::QEffect *effect) const =0
	Adds parameters from the material to a destination effect. More...
virtual QgsAbstractMaterialSettings *	clone () const =0
	Clones the material settings. More...
virtual void	readXml (const QDomElement &element, const QgsReadWriteContext &context)=0
	Reads settings from a DOM element. 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 &context) const =0
	Writes settings to a DOM element. More...

Detailed Description

3 Abstract base class for material settings.

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.0

Definition at line 104 of file qgsabstractmaterialsettings.h.

Constructor & Destructor Documentation

~QgsAbstractMaterialSettings()

virtual QgsAbstractMaterialSettings::~QgsAbstractMaterialSettings ( )

virtualdefault

Member Function Documentation

addParametersToEffect()

virtual void QgsAbstractMaterialSettings::addParametersToEffect ( Qt3DRender::QEffect *  effect ) const

pure virtual

Adds parameters from the material to a destination effect.

Implemented in QgsSimpleLineMaterialSettings, QgsPhongTexturedMaterialSettings, QgsPhongMaterialSettings, and QgsGoochMaterialSettings.

clone()

virtual QgsAbstractMaterialSettings* QgsAbstractMaterialSettings::clone ( ) const

pure virtual

Clones the material settings.

Caller takes ownership of the returned object.

Implemented in QgsSimpleLineMaterialSettings, QgsPhongTexturedMaterialSettings, QgsPhongMaterialSettings, and QgsGoochMaterialSettings.

readXml()

virtual void QgsAbstractMaterialSettings::readXml ( const QDomElement &  element, const QgsReadWriteContext &  context  )

pure virtual

Reads settings from a DOM element.

Implemented in QgsSimpleLineMaterialSettings, QgsPhongTexturedMaterialSettings, QgsPhongMaterialSettings, and QgsGoochMaterialSettings.

toExportParameters()

virtual QMap<QString, QString> QgsAbstractMaterialSettings::toExportParameters ( ) const

pure virtual

Returns the parameters to be exported to .mtl file.

Implemented in QgsSimpleLineMaterialSettings, QgsPhongTexturedMaterialSettings, QgsPhongMaterialSettings, and QgsGoochMaterialSettings.

toMaterial()

virtual Qt3DRender::QMaterial* QgsAbstractMaterialSettings::toMaterial ( QgsMaterialSettingsRenderingTechnique  technique, const QgsMaterialContext &  context  ) const

pure virtual

Creates a new QMaterial object representing the material settings.

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

Implemented in QgsSimpleLineMaterialSettings, QgsPhongTexturedMaterialSettings, QgsPhongMaterialSettings, and QgsGoochMaterialSettings.

type()

virtual QString QgsAbstractMaterialSettings::type ( ) const

pure virtual

Returns the unique type name for the material.

Implemented in QgsSimpleLineMaterialSettings, QgsPhongTexturedMaterialSettings, QgsPhongMaterialSettings, and QgsGoochMaterialSettings.

writeXml()

virtual void QgsAbstractMaterialSettings::writeXml ( QDomElement &  element, const QgsReadWriteContext &  context  ) const

pure virtual

Writes settings to a DOM element.

Implemented in QgsSimpleLineMaterialSettings, QgsPhongTexturedMaterialSettings, QgsPhongMaterialSettings, and QgsGoochMaterialSettings.

---

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

• /build/qgis-3.16.0+99unstable/src/3d/materials/qgsabstractmaterialsettings.h