QgsMetalRoughMaterialSettings Class Reference

3 More...

#include <qgsmetalroughmaterialsettings.h>

Inheritance diagram for QgsMetalRoughMaterialSettings:

Public Member Functions
	QgsMetalRoughMaterialSettings ()=default
	Constructor for QgsMetalRoughMaterialSettings.
void	addParametersToEffect (Qt3DRender::QEffect *effect) const override
	Adds parameters from the material to a destination effect.
QColor	baseColor () const
	Returns the base material color.
QgsMetalRoughMaterialSettings *	clone () const override
	Clones the material settings.
float	metalness () const
	Returns the material's metalness.
bool	operator== (const QgsMetalRoughMaterialSettings &other) const
void	readXml (const QDomElement &elem, const QgsReadWriteContext &context) override
	Reads settings from a DOM element.
float	roughness () const
	Returns the material's roughness.
void	setBaseColor (const QColor &color)
	Sets the base material color.
void	setMetalness (float metalness)
	Returns the material's metalness.
void	setRoughness (float roughness)
	Returns the material's roughness.
QMap< QString, QString >	toExportParameters () const override
	Returns the parameters to be exported to .mtl file.
Qt3DRender::QMaterial *	toMaterial (QgsMaterialSettingsRenderingTechnique technique, const QgsMaterialContext &context) const override
	Creates a new QMaterial object representing the material settings.
QString	type () const override
	Returns the unique type name for the material.
void	writeXml (QDomElement &elem, const QgsReadWriteContext &context) const override
	Writes settings to a DOM element.
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.
void	setDataDefinedProperties (const QgsPropertyCollection &collection)
	Sets the material property collection, used for data defined overrides.

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

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

Detailed Description

3

A PBR metal rough shading material used for rendering.

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

Definition at line 35 of file qgsmetalroughmaterialsettings.h.

Constructor & Destructor Documentation

QgsMetalRoughMaterialSettings()

QgsMetalRoughMaterialSettings::QgsMetalRoughMaterialSettings ( )

default

Constructor for QgsMetalRoughMaterialSettings.

Member Function Documentation

addParametersToEffect()

void QgsMetalRoughMaterialSettings::addParametersToEffect ( Qt3DRender::QEffect *  effect ) const

overridevirtual

Adds parameters from the material to a destination effect.

Implements QgsAbstractMaterialSettings.

Definition at line 101 of file qgsmetalroughmaterialsettings.cpp.

baseColor()

QColor QgsMetalRoughMaterialSettings::baseColor ( ) const

inline

Returns the base material color.

See also

setBaseColor()

Definition at line 63 of file qgsmetalroughmaterialsettings.h.

clone()

QgsMetalRoughMaterialSettings * QgsMetalRoughMaterialSettings::clone ( ) const

overridevirtual

Clones the material settings.

Caller takes ownership of the returned object.

Implements QgsAbstractMaterialSettings.

Definition at line 48 of file qgsmetalroughmaterialsettings.cpp.

create()

QgsAbstractMaterialSettings * QgsMetalRoughMaterialSettings::create ( )

static

Returns a new instance of QgsMetalRoughMaterialSettings.

Definition at line 43 of file qgsmetalroughmaterialsettings.cpp.

metalness()

float QgsMetalRoughMaterialSettings::metalness ( ) const

inline

Returns the material's metalness.

See also

setMetalness()

Definition at line 70 of file qgsmetalroughmaterialsettings.h.

operator==()

bool QgsMetalRoughMaterialSettings::operator== ( const QgsMetalRoughMaterialSettings &  other ) const

inline

Definition at line 111 of file qgsmetalroughmaterialsettings.h.

readXml()

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

overridevirtual

Reads settings from a DOM element.

Reimplemented from QgsAbstractMaterialSettings.

Definition at line 53 of file qgsmetalroughmaterialsettings.cpp.

roughness()

float QgsMetalRoughMaterialSettings::roughness ( ) const

inline

Returns the material's roughness.

See also

setRoughness()

Definition at line 77 of file qgsmetalroughmaterialsettings.h.

setBaseColor()

void QgsMetalRoughMaterialSettings::setBaseColor ( const QColor &  color )

inline

Sets the base material color.

See also

baseColor()

Definition at line 86 of file qgsmetalroughmaterialsettings.h.

setMetalness()

void QgsMetalRoughMaterialSettings::setMetalness ( float  metalness )

inline

Returns the material's metalness.

See also

metalness()

Definition at line 93 of file qgsmetalroughmaterialsettings.h.

setRoughness()

void QgsMetalRoughMaterialSettings::setRoughness ( float  roughness )

inline

Returns the material's roughness.

See also

roughness()

Definition at line 100 of file qgsmetalroughmaterialsettings.h.

supportsTechnique()

bool QgsMetalRoughMaterialSettings::supportsTechnique ( QgsMaterialSettingsRenderingTechnique  technique )

static

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

Definition at line 25 of file qgsmetalroughmaterialsettings.cpp.

toExportParameters()

QMap< QString, QString > QgsMetalRoughMaterialSettings::toExportParameters ( ) const

overridevirtual

Returns the parameters to be exported to .mtl file.

Implements QgsAbstractMaterialSettings.

Definition at line 95 of file qgsmetalroughmaterialsettings.cpp.

toMaterial()

Qt3DRender::QMaterial * QgsMetalRoughMaterialSettings::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 71 of file qgsmetalroughmaterialsettings.cpp.

type()

QString QgsMetalRoughMaterialSettings::type ( ) const

overridevirtual

Returns the unique type name for the material.

Implements QgsAbstractMaterialSettings.

Definition at line 20 of file qgsmetalroughmaterialsettings.cpp.

writeXml()

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

overridevirtual

Writes settings to a DOM element.

Reimplemented from QgsAbstractMaterialSettings.

Definition at line 62 of file qgsmetalroughmaterialsettings.cpp.

---

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

• /build/qgis-3.36.0+99sid/src/3d/materials/qgsmetalroughmaterialsettings.h
• /build/qgis-3.36.0+99sid/src/3d/materials/qgsmetalroughmaterialsettings.cpp