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¶
Abstract base class for material settings. |
Methods
Returns ambient color component |
|
Returns the coefficient for the ambient color contribution (ie strength factor of the ambient color). |
|
Returns diffuse color component |
|
Returns the coefficient for the diffuse color contribution (ie strength factor of the diffuse color). |
|
Returns the opacity of the surface |
|
Sets ambient color component |
|
Sets the coefficient for the ambient color contribution (ie strength factor of the ambient color). |
|
Sets diffuse color component |
|
Sets the coefficient for the diffuse color contribution (ie strength factor of the diffuse color). |
|
Sets opacity of the surface |
|
Sets shininess of the surface |
|
Sets specular color component |
|
Sets the coefficient for the specular color contribution (ie strength factor of the specular color). |
|
Returns shininess of the surface |
|
Returns specular color component |
|
Returns the coefficient for the specular color contribution (ie strength factor of the specular color). |
Virtual Methods
In PyQGIS, only methods marked as virtual
can be safely overridden in a Python subclass of QgsPhongMaterialSettings. See the FAQ for more details.
Static Methods
Returns a new instance of QgsPhongMaterialSettings. |
|
Returns |
- class qgis._3d.QgsPhongMaterialSettings[source]¶
Bases:
QgsAbstractMaterialSettings
- ambientCoefficient(self) float [source]¶
Returns the coefficient for the ambient color contribution (ie strength factor of the ambient color).
See also
See also
See also
Added in version 3.36.
- Return type:
float
- static create() QgsAbstractMaterialSettings | None [source]¶
Returns a new instance of QgsPhongMaterialSettings.
- Return type:
Optional[QgsAbstractMaterialSettings]
- diffuseCoefficient(self) float [source]¶
Returns the coefficient for the diffuse color contribution (ie strength factor of the diffuse color).
See also
See also
See also
Added in version 3.36.
- Return type:
float
- opacity(self) float [source]¶
Returns the opacity of the surface
Added in version 3.26.
- Return type:
float
- setAmbient(self, ambient: QColor | Qt.GlobalColor)[source]¶
Sets ambient color component
- Parameters:
ambient (Union[QColor, Qt.GlobalColor])
- setAmbientCoefficient(self, coefficient: float)[source]¶
Sets the
coefficient
for the ambient color contribution (ie strength factor of the ambient color).See also
See also
See also
Added in version 3.36.
- Parameters:
coefficient (float)
- setDiffuse(self, diffuse: QColor | Qt.GlobalColor)[source]¶
Sets diffuse color component
- Parameters:
diffuse (Union[QColor, Qt.GlobalColor])
- setDiffuseCoefficient(self, coefficient: float)[source]¶
Sets the
coefficient
for the diffuse color contribution (ie strength factor of the diffuse color).See also
See also
See also
Added in version 3.36.
- Parameters:
coefficient (float)
- setOpacity(self, opacity: float)[source]¶
Sets opacity of the surface
Added in version 3.26.
- Parameters:
opacity (float)
- setShininess(self, shininess: float)[source]¶
Sets shininess of the surface
- Parameters:
shininess (float)
- setSpecular(self, specular: QColor | Qt.GlobalColor)[source]¶
Sets specular color component
- Parameters:
specular (Union[QColor, Qt.GlobalColor])
- setSpecularCoefficient(self, coefficient: float)[source]¶
Sets the
coefficient
for the specular color contribution (ie strength factor of the specular color).See also
See also
See also
Added in version 3.36.
- Parameters:
coefficient (float)
- specularCoefficient(self) float [source]¶
Returns the coefficient for the specular color contribution (ie strength factor of the specular color).
See also
See also
See also
Added in version 3.36.
- Return type:
float
- static supportsTechnique(technique: QgsMaterialSettingsRenderingTechnique) bool [source]¶
Returns
True
if the specifiedtechnique
is supported by the Phong material.- Parameters:
technique (QgsMaterialSettingsRenderingTechnique)
- Return type:
bool
- virtual toExportParameters(self) Dict[str, str] ¶
- Return type:
Dict[str, str]