Class: QgsPhongMaterialSettings

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.

Class Hierarchy

Base classes

QgsAbstractMaterialSettings

Abstract base class for material settings.

Methods

ambient	Returns ambient color component
ambientCoefficient	Returns the coefficient for the ambient color contribution (ie strength factor of the ambient color).
diffuse	Returns diffuse color component
diffuseCoefficient	Returns the coefficient for the diffuse color contribution (ie strength factor of the diffuse color).
opacity	Returns the opacity of the surface
setAmbient	Sets ambient color component
setAmbientCoefficient	Sets the coefficient for the ambient color contribution (ie strength factor of the ambient color).
setDiffuse	Sets diffuse color component
setDiffuseCoefficient	Sets the coefficient for the diffuse color contribution (ie strength factor of the diffuse color).
setOpacity	Sets opacity of the surface
setShininess	Sets shininess of the surface
setSpecular	Sets specular color component
setSpecularCoefficient	Sets the coefficient for the specular color contribution (ie strength factor of the specular color).
shininess	Returns shininess of the surface
specular	Returns specular color component
specularCoefficient	Returns the coefficient for the specular color contribution (ie strength factor of the specular color).
toExportParameters

Static Methods

create	Returns a new instance of QgsPhongMaterialSettings.
supportsTechnique	Returns True if the specified technique is supported by the Phong material.

class qgis._3d.QgsPhongMaterialSettings

Bases: QgsAbstractMaterialSettings

ambient(self) → QColor

Returns ambient color component

Return type:

QColor

ambientCoefficient(self) → float

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

See also

setAmbientCoefficient()

See also

diffuseCoefficient()

See also

specularCoefficient()

Added in version 3.36.

Return type:

float

static create() → QgsAbstractMaterialSettings | None

Returns a new instance of QgsPhongMaterialSettings.

Return type:

Optional[QgsAbstractMaterialSettings]

diffuse(self) → QColor

Returns diffuse color component

Return type:

QColor

diffuseCoefficient(self) → float

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

See also

setDiffuseCoefficient()

See also

ambientCoefficient()

See also

specularCoefficient()

Added in version 3.36.

Return type:

float

opacity(self) → float

Returns the opacity of the surface

Added in version 3.26.

Return type:

float

setAmbient(self, ambient: QColor | Qt.GlobalColor)

Sets ambient color component

Parameters:

ambient (Union[QColor, Qt.GlobalColor])

setAmbientCoefficient(self, coefficient: float)

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

See also

ambientCoefficient()

See also

setDiffuseCoefficient()

See also

setSpecularCoefficient()

Added in version 3.36.

Parameters:

coefficient (float)

setDiffuse(self, diffuse: QColor | Qt.GlobalColor)

Sets diffuse color component

Parameters:

diffuse (Union[QColor, Qt.GlobalColor])

setDiffuseCoefficient(self, coefficient: float)

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

See also

diffuseCoefficient()

See also

setAmbientCoefficient()

See also

setSpecularCoefficient()

Added in version 3.36.

Parameters:

coefficient (float)

setOpacity(self, opacity: float)

Sets opacity of the surface

Added in version 3.26.

Parameters:

opacity (float)

setShininess(self, shininess: float)

Sets shininess of the surface

Parameters:

shininess (float)

setSpecular(self, specular: QColor | Qt.GlobalColor)

Sets specular color component

Parameters:

specular (Union[QColor, Qt.GlobalColor])

setSpecularCoefficient(self, coefficient: float)

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

See also

specularCoefficient()

See also

setDiffuseCoefficient()

See also

setAmbientCoefficient()

Added in version 3.36.

Parameters:

coefficient (float)

shininess(self) → float

Returns shininess of the surface

Return type:

float

specular(self) → QColor

Returns specular color component

Return type:

QColor

specularCoefficient(self) → float

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

See also

setSpecularCoefficient()

See also

diffuseCoefficient()

See also

ambientCoefficient()

Added in version 3.36.

Return type:

float

static supportsTechnique(technique: QgsMaterialSettingsRenderingTechnique) → bool

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

Parameters:

technique (QgsMaterialSettingsRenderingTechnique)

Return type:

bool

toExportParameters(self) → Dict[str, str]

Return type:

Dict[str, str]