Class: QgsPhongMaterialSettings¶
- class qgis._3d.QgsPhongMaterialSettings¶
Bases:
qgis._3d.QgsAbstractMaterialSettings
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.
QgsPhongMaterialSettings() Constructor for QgsPhongMaterialSettings.
QgsPhongMaterialSettings(
QgsPhongMaterialSettings
)Methods
Returns ambient color component
Returns the coefficient for the ambient color contribution (ie strength factor of the ambient color).
- rtype:
QgsPhongMaterialSettings
Returns a new instance of QgsPhongMaterialSettings.
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
- param elem:
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).
Returns
True
if the specifiedtechnique
is supported by the Phong material.- rtype:
Dict[str, str]
- rtype:
str
- param elem:
- 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
See also
See also
New in version 3.36.
- Return type:
float
- clone(self) QgsPhongMaterialSettings ¶
- Return type:
- create() QgsAbstractMaterialSettings ¶
Returns a new instance of QgsPhongMaterialSettings.
- Return type:
- 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
See also
See also
New in version 3.36.
- Return type:
float
- opacity(self) float ¶
Returns the opacity of the surface
New in version 3.26.
- Return type:
float
- readXml(self, elem: QDomElement, context: QgsReadWriteContext)¶
- Parameters:
elem (QDomElement) –
context (QgsReadWriteContext) –
- setAmbient(self, ambient: QColor | Qt.GlobalColor)¶
Sets ambient color component
- Parameters:
ambient (Union[QColor) –
- setAmbientCoefficient(self, coefficient: float)¶
Sets the
coefficient
for the ambient color contribution (ie strength factor of the ambient color).See also
See also
See also
New in version 3.36.
- Parameters:
coefficient (float) –
- setDiffuse(self, diffuse: QColor | Qt.GlobalColor)¶
Sets diffuse color component
- Parameters:
diffuse (Union[QColor) –
- setDiffuseCoefficient(self, coefficient: float)¶
Sets the
coefficient
for the diffuse color contribution (ie strength factor of the diffuse color).See also
See also
See also
New in version 3.36.
- Parameters:
coefficient (float) –
- setOpacity(self, opacity: float)¶
Sets opacity of the surface
New 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) –
- setSpecularCoefficient(self, coefficient: float)¶
Sets the
coefficient
for the specular color contribution (ie strength factor of the specular color).See also
See also
See also
New 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
See also
See also
New in version 3.36.
- Return type:
float
- supportsTechnique(technique: QgsMaterialSettingsRenderingTechnique) bool ¶
Returns
True
if the specifiedtechnique
is supported by the Phong material.- Parameters:
technique (QgsMaterialSettingsRenderingTechnique) –
- Return type:
bool
- toExportParameters(self) Dict[str, str] ¶
- Return type:
Dict[str, str]
- type(self) str ¶
- Return type:
str
- writeXml(self, elem: QDomElement, context: QgsReadWriteContext)¶
- Parameters:
elem (QDomElement) –
context (QgsReadWriteContext) –