#include <qgsabstractmaterialsettings.h>

Inheritance diagram for QgsAbstractMaterialSettings:

[legend]

Public Types
enum class	Property : int { Diffuse , Ambient , Warm , Cool , Specular }
	Data definable properties. More...

Public Member Functions
virtual	~QgsAbstractMaterialSettings ()=default

virtual void	addParametersToEffect (Qt3DRender::QEffect *effect, const QgsMaterialContext &materialContext) const =0
	Adds parameters from the material to a destination effect.

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 QgsAbstractMaterialSettings *	clone () const =0
	Clones the material settings.

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 QMap< QString, QString >	toExportParameters () const =0
	Returns the parameters to be exported to .mtl file.

virtual QgsMaterial *	toMaterial (QgsMaterialSettingsRenderingTechnique technique, const QgsMaterialContext &context) const =0
	Creates a new QgsMaterial object representing the material settings.

virtual QString	type () const =0
	Returns the unique type name for the material.

virtual void	writeXml (QDomElement &element, const QgsReadWriteContext &) const
	Writes settings to a DOM element.

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.

Definition at line 120 of file qgsabstractmaterialsettings.h.

Member Enumeration Documentation

◆ Property

enum class QgsAbstractMaterialSettings::Property : int

strong

Data definable properties.

Enumerator
Diffuse	Diffuse color.
Ambient	Ambient color (phong material)
Warm	Warm color (gooch material)
Cool	Cool color (gooch material)
Specular	Specular color.

Definition at line 196 of file qgsabstractmaterialsettings.h.

Constructor & Destructor Documentation

◆ ~QgsAbstractMaterialSettings()

virtual QgsAbstractMaterialSettings::~QgsAbstractMaterialSettings ( )

virtualdefault

Member Function Documentation

◆ addParametersToEffect()

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

pure virtual

Adds parameters from the material to a destination effect.

Implemented in QgsGoochMaterialSettings, QgsMetalRoughMaterialSettings, QgsNullMaterialSettings, QgsPhongMaterialSettings, QgsPhongTexturedMaterialSettings, and QgsSimpleLineMaterialSettings.

◆ applyDataDefinedToGeometry()

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

virtual

Applies the data defined bytes, dataDefinedBytes, on the geometry by filling a specific vertex buffer that will be used by the shader.

Since: QGIS 3.18

Reimplemented in QgsGoochMaterialSettings, QgsPhongMaterialSettings, and QgsSimpleLineMaterialSettings.

Definition at line 57 of file qgsabstractmaterialsettings.cpp.

◆ clone()

virtual QgsAbstractMaterialSettings * QgsAbstractMaterialSettings::clone ( ) const

pure virtual

Clones the material settings.

Caller takes ownership of the returned object.

Implemented in QgsGoochMaterialSettings, QgsMetalRoughMaterialSettings, QgsNullMaterialSettings, QgsPhongMaterialSettings, QgsPhongTexturedMaterialSettings, and QgsSimpleLineMaterialSettings.

◆ dataDefinedByteStride()

virtual int QgsAbstractMaterialSettings::dataDefinedByteStride ( ) const

inlinevirtual

Returns byte stride of the data defined colors,used to fill the vertex colors data defined buffer for rendering.

Since: QGIS 3.18

Reimplemented in QgsGoochMaterialSettings, and QgsPhongMaterialSettings.

Definition at line 246 of file qgsabstractmaterialsettings.h.

◆ dataDefinedProperties()

QgsPropertyCollection QgsAbstractMaterialSettings::dataDefinedProperties ( ) const

Returns the symbol material property collection, used for data defined overrides.

Since: QGIS 3.18

Definition at line 39 of file qgsabstractmaterialsettings.cpp.

◆ dataDefinedVertexColorsAsByte()

QByteArray QgsAbstractMaterialSettings::dataDefinedVertexColorsAsByte ( const QgsExpressionContext & expressionContext ) const

virtual

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.

See also: applyDataDefinedToGeometry()

Since: QGIS 3.18

Reimplemented in QgsGoochMaterialSettings, QgsPhongMaterialSettings, and QgsSimpleLineMaterialSettings.

Definition at line 48 of file qgsabstractmaterialsettings.cpp.

◆ propertyDefinitions()

const QgsPropertiesDefinition & QgsAbstractMaterialSettings::propertyDefinitions ( ) const

Returns a reference to the material properties definition, used for data defined overrides.

Since: QGIS 3.18

Definition at line 41 of file qgsabstractmaterialsettings.cpp.

◆ readXml()

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

virtual

Reads settings from a DOM element.

Reimplemented in QgsGoochMaterialSettings, QgsMetalRoughMaterialSettings, QgsPhongMaterialSettings, QgsPhongTexturedMaterialSettings, and QgsSimpleLineMaterialSettings.

Definition at line 20 of file qgsabstractmaterialsettings.cpp.

◆ setDataDefinedProperties()

void QgsAbstractMaterialSettings::setDataDefinedProperties ( const QgsPropertyCollection & collection )

Sets the material property collection, used for data defined overrides.

Since: QGIS 3.18

Definition at line 34 of file qgsabstractmaterialsettings.cpp.

◆ toExportParameters()

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

pure virtual

Returns the parameters to be exported to .mtl file.

Implemented in QgsGoochMaterialSettings, QgsMetalRoughMaterialSettings, QgsNullMaterialSettings, QgsPhongMaterialSettings, QgsPhongTexturedMaterialSettings, and QgsSimpleLineMaterialSettings.

◆ toMaterial()

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

pure virtual

Creates a new QgsMaterial object representing the material settings.

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

Implemented in QgsGoochMaterialSettings, QgsMetalRoughMaterialSettings, QgsNullMaterialSettings, QgsPhongMaterialSettings, QgsPhongTexturedMaterialSettings, and QgsSimpleLineMaterialSettings.

◆ type()

virtual QString QgsAbstractMaterialSettings::type ( ) const

pure virtual

Returns the unique type name for the material.

Implemented in QgsGoochMaterialSettings, QgsMetalRoughMaterialSettings, QgsNullMaterialSettings, QgsPhongMaterialSettings, QgsPhongTexturedMaterialSettings, and QgsSimpleLineMaterialSettings.

◆ writeXml()

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

virtual

Writes settings to a DOM element.

Reimplemented in QgsGoochMaterialSettings, QgsMetalRoughMaterialSettings, QgsPhongMaterialSettings, QgsPhongTexturedMaterialSettings, and QgsSimpleLineMaterialSettings.

Definition at line 27 of file qgsabstractmaterialsettings.cpp.

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

/build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/3d/materials/qgsabstractmaterialsettings.h
/build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/3d/materials/qgsabstractmaterialsettings.cpp

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ Property

Constructor & Destructor Documentation

◆ ~QgsAbstractMaterialSettings()

Member Function Documentation

◆ addParametersToEffect()

◆ applyDataDefinedToGeometry()

◆ clone()

◆ dataDefinedByteStride()

◆ dataDefinedProperties()

◆ dataDefinedVertexColorsAsByte()

◆ propertyDefinitions()

◆ readXml()

◆ setDataDefinedProperties()

◆ toExportParameters()

◆ toMaterial()

◆ type()

◆ writeXml()