Basic shading material used for rendering based on the Phong shading model with three color components: ambient, diffuse and specular. More...

#include <qgsphongmaterialsettings.h>

Inheritance diagram for QgsPhongMaterialSettings:

[legend]

Public Member Functions
	QgsPhongMaterialSettings ()=default
QColor	ambient () const
	Returns ambient color component.
double	ambientCoefficient () const
	Returns the coefficient for the ambient color contribution (ie strength factor of the ambient color).
QColor	averageColor () const override
	Returns an approximate color representing the blended material color.
QgsPhongMaterialSettings *	clone () const override
	Clones the material settings.
QColor	diffuse () const
	Returns diffuse color component.
double	diffuseCoefficient () const
	Returns the coefficient for the diffuse color contribution (ie strength factor of the diffuse color).
bool	equals (const QgsAbstractMaterialSettings *other) const override
	Returns `true` if this settings exactly matches an other settings.
double	opacity () const
	Returns the opacity of the surface.
bool	operator== (const QgsPhongMaterialSettings &other) const
void	readXml (const QDomElement &elem, const QgsReadWriteContext &context) override
	Reads settings from a DOM element.
void	setAmbient (const QColor &ambient)
	Sets ambient color component.
void	setAmbientCoefficient (double coefficient)
	Sets the coefficient for the ambient color contribution (ie strength factor of the ambient color).
void	setColorsFromBase (const QColor &baseColor) override
	Decomposes a base color into Phong material components.
void	setColorsFromBase (const QColor &baseColor, float metallic)
	Decomposes a base color into Phong material components, and sets the material's colors accordingly.
void	setDiffuse (const QColor &diffuse)
	Sets diffuse color component.
void	setDiffuseCoefficient (double coefficient)
	Sets the coefficient for the diffuse color contribution (ie strength factor of the diffuse color).
void	setOpacity (double opacity)
	Sets opacity of the surface.
void	setShininess (double shininess)
	Sets shininess of the surface.
void	setSpecular (const QColor &specular)
	Sets specular color component.
void	setSpecularCoefficient (double coefficient)
	Sets the coefficient for the specular color contribution (ie strength factor of the specular color).
double	shininess () const
	Returns shininess of the surface.
QColor	specular () const
	Returns specular color component.
double	specularCoefficient () const
	Returns the coefficient for the specular color contribution (ie strength factor of the specular color).
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	requiresTangents () const
	Returns `true` if the material requires tangents generated during triangulation.
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 QgsPhongMaterialSettings.
static bool	supportsTechnique (Qgis::MaterialRenderingTechnique technique)
	Returns `true` if the specified technique is supported by the Phong material.

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

Detailed Description

Basic shading material used for rendering based on the Phong shading model with three color components: ambient, diffuse and specular.

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 36 of file qgsphongmaterialsettings.h.

Constructor & Destructor Documentation

◆ QgsPhongMaterialSettings()

QgsPhongMaterialSettings::QgsPhongMaterialSettings ( )

default

Member Function Documentation

◆ ambient()

QColor QgsPhongMaterialSettings::ambient ( ) const

inline

Returns ambient color component.

Definition at line 57 of file qgsphongmaterialsettings.h.

◆ ambientCoefficient()

double QgsPhongMaterialSettings::ambientCoefficient ( ) const

inline

Returns the coefficient for the ambient color contribution (ie strength factor of the ambient color).

See also: setAmbientCoefficient(); diffuseCoefficient(); specularCoefficient()

Since: QGIS 3.36

Definition at line 80 of file qgsphongmaterialsettings.h.

◆ averageColor()

QColor QgsPhongMaterialSettings::averageColor ( ) const

overridevirtual

Returns an approximate color representing the blended material color.

This function calculates a weighted average of the ambient, diffuse, and specular color components to produce a single representative color.

See also: ambient(); diffuse(); specular()

Since: QGIS 4.2

Implements QgsAbstractMaterialSettings.

Definition at line 68 of file qgsphongmaterialsettings.cpp.

◆ clone()

QgsPhongMaterialSettings * QgsPhongMaterialSettings::clone ( ) const

overridevirtual

Clones the material settings.

Caller takes ownership of the returned object.

Implements QgsAbstractMaterialSettings.

Definition at line 54 of file qgsphongmaterialsettings.cpp.

◆ create()

QgsAbstractMaterialSettings * QgsPhongMaterialSettings::create ( )

static

Returns a new instance of QgsPhongMaterialSettings.

Definition at line 49 of file qgsphongmaterialsettings.cpp.

◆ diffuse()

QColor QgsPhongMaterialSettings::diffuse ( ) const

inline

Returns diffuse color component.

Definition at line 59 of file qgsphongmaterialsettings.h.

◆ diffuseCoefficient()

double QgsPhongMaterialSettings::diffuseCoefficient ( ) const

inline

Returns the coefficient for the diffuse color contribution (ie strength factor of the diffuse color).

See also: setDiffuseCoefficient(); ambientCoefficient(); specularCoefficient()

Since: QGIS 3.36

Definition at line 91 of file qgsphongmaterialsettings.h.

◆ equals()

bool QgsPhongMaterialSettings::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 59 of file qgsphongmaterialsettings.cpp.

◆ opacity()

double QgsPhongMaterialSettings::opacity ( ) const

inline

Returns the opacity of the surface.

Since: QGIS 3.26

Definition at line 69 of file qgsphongmaterialsettings.h.

◆ operator==()

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

inline

Definition at line 205 of file qgsphongmaterialsettings.h.

◆ readXml()

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

overridevirtual

Reads settings from a DOM element.

Reimplemented from QgsAbstractMaterialSettings.

Definition at line 124 of file qgsphongmaterialsettings.cpp.

◆ setAmbient()

void QgsPhongMaterialSettings::setAmbient ( const QColor & ambient )

inline

Sets ambient color component.

Definition at line 105 of file qgsphongmaterialsettings.h.

◆ setAmbientCoefficient()

void QgsPhongMaterialSettings::setAmbientCoefficient ( double coefficient )

inline

Sets the coefficient for the ambient color contribution (ie strength factor of the ambient color).

See also: ambientCoefficient(); setDiffuseCoefficient(); setSpecularCoefficient()

Since: QGIS 3.36

Definition at line 128 of file qgsphongmaterialsettings.h.

◆ setColorsFromBase() [1/2]

void QgsPhongMaterialSettings::setColorsFromBase ( const QColor & baseColor )

overridevirtual

Decomposes a base color into Phong material components.

Sets ambient, diffuse, and specular colors from the input color. This is equivalent to calling setColorsFromBase with the metallic parameter equal to 0: setColorsFromBase(baseColor, 0).

Parameters

baseColor The color to decompose

See also: setAmbient(); setDiffuse(); setSpecular()

Since: QGIS 4.2

Implements QgsAbstractMaterialSettings.

Definition at line 119 of file qgsphongmaterialsettings.cpp.

◆ setColorsFromBase() [2/2]

void QgsPhongMaterialSettings::setColorsFromBase	(	const QColor &	baseColor,
		float	metallic )

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

Sets ambient, diffuse, and specular colors from the input color. This also sets the shininess parameter based on the metallic value.

Parameters

baseColor	The color to decompose
metallic	Controls how "metal-like" a material appears. Value between 0 and 1

See also: setAmbient(); setDiffuse(); setSpecular(); setShininess()

Since: QGIS 4.2

Definition at line 86 of file qgsphongmaterialsettings.cpp.

◆ setDiffuse()

void QgsPhongMaterialSettings::setDiffuse ( const QColor & diffuse )

inline

Sets diffuse color component.

Definition at line 107 of file qgsphongmaterialsettings.h.

◆ setDiffuseCoefficient()

void QgsPhongMaterialSettings::setDiffuseCoefficient ( double coefficient )

inline

Sets the coefficient for the diffuse color contribution (ie strength factor of the diffuse color).

See also: diffuseCoefficient(); setAmbientCoefficient(); setSpecularCoefficient()

Since: QGIS 3.36

Definition at line 139 of file qgsphongmaterialsettings.h.

◆ setOpacity()

void QgsPhongMaterialSettings::setOpacity ( double opacity )

inline

Sets opacity of the surface.

Since: QGIS 3.26

Definition at line 117 of file qgsphongmaterialsettings.h.

◆ setShininess()

void QgsPhongMaterialSettings::setShininess ( double shininess )

inline

Sets shininess of the surface.

Definition at line 111 of file qgsphongmaterialsettings.h.

◆ setSpecular()

void QgsPhongMaterialSettings::setSpecular ( const QColor & specular )

inline

Sets specular color component.

Definition at line 109 of file qgsphongmaterialsettings.h.

◆ setSpecularCoefficient()

void QgsPhongMaterialSettings::setSpecularCoefficient ( double coefficient )

inline

Sets the coefficient for the specular color contribution (ie strength factor of the specular color).

See also: specularCoefficient(); setDiffuseCoefficient(); setAmbientCoefficient()

Since: QGIS 3.36

Definition at line 150 of file qgsphongmaterialsettings.h.

◆ shininess()

double QgsPhongMaterialSettings::shininess ( ) const

inline

Returns shininess of the surface.

Definition at line 63 of file qgsphongmaterialsettings.h.

◆ specular()

QColor QgsPhongMaterialSettings::specular ( ) const

inline

Returns specular color component.

Definition at line 61 of file qgsphongmaterialsettings.h.

◆ specularCoefficient()

double QgsPhongMaterialSettings::specularCoefficient ( ) const

inline

Returns the coefficient for the specular color contribution (ie strength factor of the specular color).

See also: setSpecularCoefficient(); diffuseCoefficient(); ambientCoefficient()

Since: QGIS 3.36

Definition at line 102 of file qgsphongmaterialsettings.h.

◆ supportsTechnique()

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

static

Returns true if the specified technique is supported by the Phong material.

Definition at line 30 of file qgsphongmaterialsettings.cpp.

◆ type()

QString QgsPhongMaterialSettings::type ( ) const

overridevirtual

Returns the unique type name for the material.

Implements QgsAbstractMaterialSettings.

Definition at line 25 of file qgsphongmaterialsettings.cpp.

◆ writeXml()

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

overridevirtual

Writes settings to a DOM element.

Reimplemented from QgsAbstractMaterialSettings.

Definition at line 138 of file qgsphongmaterialsettings.cpp.

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

/build/qgis-4.1.0+git20260522+9af12b5a203+99sid/src/core/3d/materials/qgsphongmaterialsettings.h
/build/qgis-4.1.0+git20260522+9af12b5a203+99sid/src/core/3d/materials/qgsphongmaterialsettings.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsPhongMaterialSettings()

Member Function Documentation

◆ ambient()

◆ ambientCoefficient()

◆ averageColor()

◆ clone()

◆ create()

◆ diffuse()

◆ diffuseCoefficient()

◆ equals()

◆ opacity()

◆ operator==()

◆ readXml()

◆ setAmbient()

◆ setAmbientCoefficient()

◆ setColorsFromBase() [1/2]

◆ setColorsFromBase() [2/2]

◆ setDiffuse()

◆ setDiffuseCoefficient()

◆ setOpacity()

◆ setShininess()

◆ setSpecular()

◆ setSpecularCoefficient()

◆ shininess()

◆ specular()

◆ specularCoefficient()

◆ supportsTechnique()

◆ type()

◆ writeXml()