A PBR metal rough shading material used for rendering. More...

#include <qgsmetalroughmaterialsettings.h>

Inheritance diagram for QgsMetalRoughMaterialSettings:

Public Member Functions
	QgsMetalRoughMaterialSettings ()=default
double	anisotropy () const
	Returns the material's anisotropy, as a value between 0 and 1.
double	anisotropyRotation () const
	Returns the rotation of the material's anisotropy, as a angle in degrees.
QColor	averageColor () const override
	Returns an approximate color representing the blended material color.
QColor	baseColor () const
	Returns the base material color.
double	clearCoatFactor () const
	Returns the material's clear coat factor, as a value between 0 and 1.
double	clearCoatRoughness () const
	Returns the material's clear coat roughness, as a value between 0 and 1.
QgsMetalRoughMaterialSettings *	clone () const override
	Clones the material settings.
QColor	emissionColor () const
	Returns the material's emissive color.
double	emissionFactor () const
	Returns the emission factor, which dictates the strength of the emission effect.
bool	equals (const QgsAbstractMaterialSettings *other) const override
	Returns `true` if this settings exactly matches an other settings.
double	metalness () const
	Returns the material's metalness, as a value between 0 and 1.
double	opacity () const
	Returns the opacity of the surface.
bool	operator== (const QgsMetalRoughMaterialSettings &other) const
void	readXml (const QDomElement &elem, const QgsReadWriteContext &context) override
	Reads settings from a DOM element.
double	reflectance () const
	Returns the material's reflectance, as a value between 0 and 1.
bool	requiresTangents () const override
	Returns `true` if the material requires tangents generated during triangulation.
double	roughness () const
	Returns the material's roughness, as a value between 0 and 1.
void	setAnisotropy (double anisotropy)
	Sets the material's anisotropy, as a value between 0 and 1.
void	setAnisotropyRotation (double rotation)
	Sets the rotation of the material's anisotropy, as a angle in degrees.
void	setBaseColor (const QColor &color)
	Sets the base material color.
void	setClearCoatFactor (double factor)
	Sets the material's clear coat factor, as a value between 0 and 1.
void	setClearCoatRoughness (double roughness)
	Sets the material's clear coat roughness, as a value between 0 and 1.
void	setColorsFromBase (const QColor &baseColor) override
	Decomposes a base color into the material's color components, and sets the material's color accordingly.
void	setEmissionColor (const QColor &color)
	Sets the material's emissive color.
void	setEmissionFactor (double factor)
	Sets the emission factor, which dictates the strength of the emission effect.
void	setMetalness (double metalness)
	Sets the material's metalness, as a value between 0 and 1.
void	setOpacity (double opacity)
	Sets the opacity of the surface.
void	setReflectance (double reflectance)
	Sets the material's reflectance, as a value between 0 and 1.
void	setRoughness (double roughness)
	Sets the material's roughness, as a value between 0 and 1.
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
QgsPropertyCollection	dataDefinedProperties () const
	Returns the symbol material property collection, used for data defined overrides.
const QgsPropertiesDefinition &	propertyDefinitions () const
	Returns a reference to the material properties definition, used for data defined overrides.
virtual bool	requiresTextureCoordinates () const
	Returns `true` if the material requires texture coordinates to be generated during triangulation.
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 (Qgis::MaterialRenderingTechnique 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 , BaseColor , EmissionColor }
	Data definable properties. More...

Detailed Description

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

Member Function Documentation

◆ anisotropy()

double QgsMetalRoughMaterialSettings::anisotropy ( ) const

inline

Returns the material's anisotropy, as a value between 0 and 1.

Anisotropic materials are those with properties which vary in different directions.

See also: anisotropyRotation(); setAnisotropy()

Since: QGIS 4.2

Definition at line 96 of file qgsmetalroughmaterialsettings.h.

◆ anisotropyRotation()

double QgsMetalRoughMaterialSettings::anisotropyRotation ( ) const

inline

Returns the rotation of the material's anisotropy, as a angle in degrees.

Anisotropic materials are those with properties which vary in different directions.

See also: setAnisotropyRotation(); anisotropy()

Since: QGIS 4.2

Definition at line 107 of file qgsmetalroughmaterialsettings.h.

◆ averageColor()

QColor QgsMetalRoughMaterialSettings::averageColor ( ) const

overridevirtual

Returns an approximate color representing the blended material color.

Since this material contains only a single color, this function simply returns baseColor().

See also: baseColor()

Since: QGIS 4.2

Implements QgsAbstractMaterialSettings.

Definition at line 135 of file qgsmetalroughmaterialsettings.cpp.

◆ baseColor()

QColor QgsMetalRoughMaterialSettings::baseColor ( ) const

inline

Returns the base material color.

See also: setBaseColor()

Definition at line 61 of file qgsmetalroughmaterialsettings.h.

◆ clearCoatFactor()

double QgsMetalRoughMaterialSettings::clearCoatFactor ( ) const

inline

Returns the material's clear coat factor, as a value between 0 and 1.

See also: setClearCoatFactor(); clearCoatRoughness()

Since: QGIS 4.2

Definition at line 239 of file qgsmetalroughmaterialsettings.h.

◆ clearCoatRoughness()

double QgsMetalRoughMaterialSettings::clearCoatRoughness ( ) const

inline

Returns the material's clear coat roughness, as a value between 0 and 1.

See also: setClearCoatRoughness(); clearCoatFactor()

Since: QGIS 4.2

Definition at line 257 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 53 of file qgsmetalroughmaterialsettings.cpp.

◆ create()

QgsAbstractMaterialSettings * QgsMetalRoughMaterialSettings::create ( )

static

Returns a new instance of QgsMetalRoughMaterialSettings.

Definition at line 48 of file qgsmetalroughmaterialsettings.cpp.

◆ emissionColor()

QColor QgsMetalRoughMaterialSettings::emissionColor ( ) const

inline

Returns the material's emissive color.

See also: setEmissionColor()

Since: QGIS 4.2

Definition at line 115 of file qgsmetalroughmaterialsettings.h.

◆ emissionFactor()

double QgsMetalRoughMaterialSettings::emissionFactor ( ) const

inline

Returns the emission factor, which dictates the strength of the emission effect.

A value of 1.0 indicates that the emission color values should be used directly. Larger values result in more light emission.

See also: setEmissionFactor(); emissionColor()

Since: QGIS 4.2

Definition at line 128 of file qgsmetalroughmaterialsettings.h.

◆ equals()

bool QgsMetalRoughMaterialSettings::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 58 of file qgsmetalroughmaterialsettings.cpp.

◆ metalness()

double QgsMetalRoughMaterialSettings::metalness ( ) const

inline

Returns the material's metalness, as a value between 0 and 1.

See also: setMetalness()

Definition at line 68 of file qgsmetalroughmaterialsettings.h.

◆ opacity()

double QgsMetalRoughMaterialSettings::opacity ( ) const

inline

Returns the opacity of the surface.

See also: setOpacity()

Since: QGIS 4.2

Definition at line 136 of file qgsmetalroughmaterialsettings.h.

◆ operator==()

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

inline

Definition at line 285 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 72 of file qgsmetalroughmaterialsettings.cpp.

◆ reflectance()

double QgsMetalRoughMaterialSettings::reflectance ( ) const

inline

Returns the material's reflectance, as a value between 0 and 1.

This controls the specular intensity for non-metals.

See also: setReflectance()

Since: QGIS 4.2

Definition at line 85 of file qgsmetalroughmaterialsettings.h.

◆ requiresTangents()

bool QgsMetalRoughMaterialSettings::requiresTangents ( ) const

overridevirtual

Returns true if the material requires tangents generated during triangulation.

Since: QGIS 4.2

Reimplemented from QgsAbstractMaterialSettings.

Definition at line 67 of file qgsmetalroughmaterialsettings.cpp.

◆ roughness()

double QgsMetalRoughMaterialSettings::roughness ( ) const

inline

Returns the material's roughness, as a value between 0 and 1.

See also: setRoughness()

Definition at line 75 of file qgsmetalroughmaterialsettings.h.

◆ setAnisotropy()

void QgsMetalRoughMaterialSettings::setAnisotropy ( double anisotropy )

inline

Sets the material's anisotropy, as a value between 0 and 1.

Anisotropic materials are those with properties which vary in different directions.

See also: setAnisotropyRotation(); anisotropy()

Since: QGIS 4.2

Definition at line 190 of file qgsmetalroughmaterialsettings.h.

◆ setAnisotropyRotation()

void QgsMetalRoughMaterialSettings::setAnisotropyRotation ( double rotation )

inline

Sets the rotation of the material's anisotropy, as a angle in degrees.

Anisotropic materials are those with properties which vary in different directions.

See also: anisotropyRotation(); setAnisotropy()

Since: QGIS 4.2

Definition at line 201 of file qgsmetalroughmaterialsettings.h.

◆ setBaseColor()

void QgsMetalRoughMaterialSettings::setBaseColor ( const QColor & color )

inline

Sets the base material color.

See also: baseColor()

Definition at line 155 of file qgsmetalroughmaterialsettings.h.

◆ setClearCoatFactor()

void QgsMetalRoughMaterialSettings::setClearCoatFactor ( double factor )

inline

Sets the material's clear coat factor, as a value between 0 and 1.

See also: clearCoatFactor(); setClearCoatRoughness()

Since: QGIS 4.2

Definition at line 248 of file qgsmetalroughmaterialsettings.h.

◆ setClearCoatRoughness()

void QgsMetalRoughMaterialSettings::setClearCoatRoughness ( double roughness )

inline

Sets the material's clear coat roughness, as a value between 0 and 1.

See also: clearCoatRoughness(); setClearCoatFactor()

Since: QGIS 4.2

Definition at line 266 of file qgsmetalroughmaterialsettings.h.

◆ setColorsFromBase()

void QgsMetalRoughMaterialSettings::setColorsFromBase ( const QColor & baseColor )

overridevirtual

Decomposes a base color into the material's color components, and sets the material's color accordingly.

Since this material contains only a single color, this function is equivalent to calling setBaseColor(baseColor).

Parameters

baseColor The color to decompose

See also: setBaseColor()

Since: QGIS 4.2

Implements QgsAbstractMaterialSettings.

Definition at line 140 of file qgsmetalroughmaterialsettings.cpp.

◆ setEmissionColor()

void QgsMetalRoughMaterialSettings::setEmissionColor ( const QColor & color )

inline

Sets the material's emissive color.

See also: emissionColor()

Since: QGIS 4.2

Definition at line 217 of file qgsmetalroughmaterialsettings.h.

◆ setEmissionFactor()

void QgsMetalRoughMaterialSettings::setEmissionFactor ( double factor )

inline

Sets the emission factor, which dictates the strength of the emission effect.

A value of 1.0 indicates that the emission color values should be used directly. Larger values result in more light emission.

See also: emissionFactor(); setEmissionColor()

Since: QGIS 4.2

Definition at line 230 of file qgsmetalroughmaterialsettings.h.

◆ setMetalness()

void QgsMetalRoughMaterialSettings::setMetalness ( double metalness )

inline

Sets the material's metalness, as a value between 0 and 1.

See also: metalness()

Definition at line 162 of file qgsmetalroughmaterialsettings.h.

◆ setOpacity()

void QgsMetalRoughMaterialSettings::setOpacity ( double opacity )

inline

Sets the opacity of the surface.

See also: opacity()

Since: QGIS 4.2

Definition at line 209 of file qgsmetalroughmaterialsettings.h.

◆ setReflectance()

void QgsMetalRoughMaterialSettings::setReflectance ( double reflectance )

inline

Sets the material's reflectance, as a value between 0 and 1.

This controls the specular intensity for non-metals.

See also: reflectance()

Since: QGIS 4.2

Definition at line 179 of file qgsmetalroughmaterialsettings.h.

◆ setRoughness()

void QgsMetalRoughMaterialSettings::setRoughness ( double roughness )

inline

Sets the material's roughness, as a value between 0 and 1.

See also: roughness()

Definition at line 169 of file qgsmetalroughmaterialsettings.h.

◆ supportsTechnique()

bool QgsMetalRoughMaterialSettings::supportsTechnique ( Qgis::MaterialRenderingTechnique technique )

static

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

Definition at line 29 of file qgsmetalroughmaterialsettings.cpp.

◆ type()

QString QgsMetalRoughMaterialSettings::type ( ) const

overridevirtual

Returns the unique type name for the material.

Implements QgsAbstractMaterialSettings.

Definition at line 24 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 94 of file qgsmetalroughmaterialsettings.cpp.

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

/build/qgis-4.1.0+git20260608+26185ffb827+99sid/src/core/3d/materials/qgsmetalroughmaterialsettings.h
/build/qgis-4.1.0+git20260608+26185ffb827+99sid/src/core/3d/materials/qgsmetalroughmaterialsettings.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsMetalRoughMaterialSettings()

Member Function Documentation

◆ anisotropy()

◆ anisotropyRotation()

◆ averageColor()

◆ baseColor()

◆ clearCoatFactor()

◆ clearCoatRoughness()

◆ clone()

◆ create()

◆ emissionColor()

◆ emissionFactor()

◆ equals()

◆ metalness()

◆ opacity()

◆ operator==()

◆ readXml()

◆ reflectance()

◆ requiresTangents()

◆ roughness()

◆ setAnisotropy()

◆ setAnisotropyRotation()

◆ setBaseColor()

◆ setClearCoatFactor()

◆ setClearCoatRoughness()

◆ setColorsFromBase()

◆ setEmissionColor()

◆ setEmissionFactor()

◆ setMetalness()

◆ setOpacity()

◆ setReflectance()

◆ setRoughness()

◆ supportsTechnique()

◆ type()

◆ writeXml()