#include <qgsphongtexturedmaterialsettings.h>

Inheritance diagram for QgsPhongTexturedMaterialSettings:

Public Member Functions
	QgsPhongTexturedMaterialSettings ()=default

void	addParametersToEffect (Qt3DRender::QEffect *effect, const QgsMaterialContext &materialContext) const override
	Adds parameters from the material to a destination effect.

QColor	ambient () const
	Returns ambient color component.

QgsPhongTexturedMaterialSettings *	clone () const override
	Clones the material settings.

QString	diffuseTexturePath () const
	Returns the diffuse texture path.

double	opacity () const
	Returns the opacity of the surface.

bool	operator== (const QgsPhongTexturedMaterialSettings &other) const

void	readXml (const QDomElement &elem, const QgsReadWriteContext &context) override
	Reads settings from a DOM element.

bool	requiresTextureCoordinates () const
	Returns `true` if the material requires texture coordinates to be generated during triangulation.quiresTextureCoordinates.

void	setAmbient (const QColor &ambient)
	Sets ambient color component.

void	setDiffuseTexturePath (const QString &path)
	Sets the path of the diffuse texture.

void	setOpacity (float 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	setTextureRotation (float rotation)
	Sets the texture rotation in degrees.

void	setTextureScale (float scale)
	Sets the texture scale The texture scale changes the size of the displayed texture in the 3D scene If the texture scale is less than 1 the texture will be stretched.

double	shininess () const
	Returns shininess of the surface.

QColor	specular () const
	Returns specular color component.

float	textureRotation () const
	Returns the texture rotation, in degrees.

float	textureScale () const
	Returns the texture scale The texture scale changes the size of the displayed texture in the 3D scene If the texture scale is less than 1 the texture will be stretched.

QMap< QString, QString >	toExportParameters () const override
	Returns the parameters to be exported to .mtl file.

QgsMaterial *	toMaterial (QgsMaterialSettingsRenderingTechnique technique, const QgsMaterialContext &context) const override
	Creates a new QgsMaterial object representing the material settings.

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

virtual void	applyDataDefinedToGeometry (Qt3DCore::QGeometry *geometry, int vertexCount, const QByteArray &dataDefinedBytes) const
	Applies the data defined bytes, dataDefinedBytes, on the geometry by filling a specific vertex buffer that will be used by the shader.

virtual int	dataDefinedByteStride () const
	Returns byte stride of the data defined colors,used to fill the vertex colors data defined buffer for rendering.

QgsPropertyCollection	dataDefinedProperties () const
	Returns the symbol material property collection, used for data defined overrides.

virtual QByteArray	dataDefinedVertexColorsAsByte (const QgsExpressionContext &expressionContext) const
	Returns byte array corresponding to the data defined colors depending of the expressionContext, used to fill the specific vertex buffer used for rendering the geometry.

const QgsPropertiesDefinition &	propertyDefinitions () const
	Returns a reference to the material properties definition, used for data defined overrides.

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 QgsPhongTexturedMaterialSettings.

static bool	supportsTechnique (QgsMaterialSettingsRenderingTechnique 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

3

A phong shading model with diffuse texture map.

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.16

Definition at line 36 of file qgsphongtexturedmaterialsettings.h.

Constructor & Destructor Documentation

◆ QgsPhongTexturedMaterialSettings()

QgsPhongTexturedMaterialSettings::QgsPhongTexturedMaterialSettings ( )

default

Member Function Documentation

◆ addParametersToEffect()

void QgsPhongTexturedMaterialSettings::addParametersToEffect	(	Qt3DRender::QEffect *	effect,
		const QgsMaterialContext &	materialContext
	)		const

overridevirtual

Adds parameters from the material to a destination effect.

Implements QgsAbstractMaterialSettings.

Definition at line 173 of file qgsphongtexturedmaterialsettings.cpp.

◆ ambient()

QColor QgsPhongTexturedMaterialSettings::ambient ( ) const

inline

Returns ambient color component.

Definition at line 57 of file qgsphongtexturedmaterialsettings.h.

◆ clone()

QgsPhongTexturedMaterialSettings * QgsPhongTexturedMaterialSettings::clone ( ) const

overridevirtual

Clones the material settings.

Caller takes ownership of the returned object.

Implements QgsAbstractMaterialSettings.

Definition at line 61 of file qgsphongtexturedmaterialsettings.cpp.

◆ create()

QgsAbstractMaterialSettings * QgsPhongTexturedMaterialSettings::create ( )

static

Returns a new instance of QgsPhongTexturedMaterialSettings.

Definition at line 56 of file qgsphongtexturedmaterialsettings.cpp.

◆ diffuseTexturePath()

QString QgsPhongTexturedMaterialSettings::diffuseTexturePath ( ) const

inline

Returns the diffuse texture path.

See also: setDiffuseTexturePath()

Definition at line 70 of file qgsphongtexturedmaterialsettings.h.

◆ opacity()

double QgsPhongTexturedMaterialSettings::opacity ( ) const

inline

Returns the opacity of the surface.

Since: QGIS 3.28

Definition at line 94 of file qgsphongtexturedmaterialsettings.h.

◆ operator==()

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

inline

Definition at line 134 of file qgsphongtexturedmaterialsettings.h.

◆ readXml()

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

overridevirtual

Reads settings from a DOM element.

Reimplemented from QgsAbstractMaterialSettings.

Definition at line 71 of file qgsphongtexturedmaterialsettings.cpp.

◆ requiresTextureCoordinates()

bool QgsPhongTexturedMaterialSettings::requiresTextureCoordinates ( ) const

inline

Returns true if the material requires texture coordinates to be generated during triangulation.quiresTextureCoordinates.

Definition at line 83 of file qgsphongtexturedmaterialsettings.h.

◆ setAmbient()

void QgsPhongTexturedMaterialSettings::setAmbient ( const QColor & ambient )

inline

Sets ambient color component.

Definition at line 97 of file qgsphongtexturedmaterialsettings.h.

◆ setDiffuseTexturePath()

void QgsPhongTexturedMaterialSettings::setDiffuseTexturePath ( const QString & path )

inline

Sets the path of the diffuse texture.

See also: diffuseTexturePath()

Definition at line 108 of file qgsphongtexturedmaterialsettings.h.

◆ setOpacity()

void QgsPhongTexturedMaterialSettings::setOpacity ( float opacity )

inline

Sets opacity of the surface.

Since: QGIS 3.28

Definition at line 124 of file qgsphongtexturedmaterialsettings.h.

◆ setShininess()

void QgsPhongTexturedMaterialSettings::setShininess ( double shininess )

inline

Sets shininess of the surface.

Definition at line 102 of file qgsphongtexturedmaterialsettings.h.

◆ setSpecular()

void QgsPhongTexturedMaterialSettings::setSpecular ( const QColor & specular )

inline

Sets specular color component.

Definition at line 100 of file qgsphongtexturedmaterialsettings.h.

◆ setTextureRotation()

void QgsPhongTexturedMaterialSettings::setTextureRotation ( float rotation )

inline

Sets the texture rotation in degrees.

Definition at line 118 of file qgsphongtexturedmaterialsettings.h.

◆ setTextureScale()

void QgsPhongTexturedMaterialSettings::setTextureScale ( float scale )

inline

Sets the texture scale The texture scale changes the size of the displayed texture in the 3D scene If the texture scale is less than 1 the texture will be stretched.

Definition at line 115 of file qgsphongtexturedmaterialsettings.h.

◆ shininess()

double QgsPhongTexturedMaterialSettings::shininess ( ) const

inline

Returns shininess of the surface.

Definition at line 61 of file qgsphongtexturedmaterialsettings.h.

◆ specular()

QColor QgsPhongTexturedMaterialSettings::specular ( ) const

inline

Returns specular color component.

Definition at line 59 of file qgsphongtexturedmaterialsettings.h.

◆ supportsTechnique()

bool QgsPhongTexturedMaterialSettings::supportsTechnique ( QgsMaterialSettingsRenderingTechnique technique )

static

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

Definition at line 38 of file qgsphongtexturedmaterialsettings.cpp.

◆ textureRotation()

float QgsPhongTexturedMaterialSettings::textureRotation ( ) const

Returns the texture rotation, in degrees.

Definition at line 66 of file qgsphongtexturedmaterialsettings.cpp.

◆ textureScale()

float QgsPhongTexturedMaterialSettings::textureScale ( ) const

inline

Returns the texture scale The texture scale changes the size of the displayed texture in the 3D scene If the texture scale is less than 1 the texture will be stretched.

Definition at line 77 of file qgsphongtexturedmaterialsettings.h.

◆ toExportParameters()

QMap< QString, QString > QgsPhongTexturedMaterialSettings::toExportParameters ( ) const

overridevirtual

Returns the parameters to be exported to .mtl file.

Implements QgsAbstractMaterialSettings.

Definition at line 164 of file qgsphongtexturedmaterialsettings.cpp.

◆ toMaterial()

QgsMaterial * QgsPhongTexturedMaterialSettings::toMaterial	(	QgsMaterialSettingsRenderingTechnique	technique,
		const QgsMaterialContext &	context
	)		const

overridevirtual

Creates a new QgsMaterial object representing the material settings.

The technique argument specifies the rendering technique which will be used with the returned material.

Implements QgsAbstractMaterialSettings.

Definition at line 97 of file qgsphongtexturedmaterialsettings.cpp.

◆ type()

QString QgsPhongTexturedMaterialSettings::type ( ) const

overridevirtual

Returns the unique type name for the material.

Implements QgsAbstractMaterialSettings.

Definition at line 33 of file qgsphongtexturedmaterialsettings.cpp.

◆ writeXml()

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

overridevirtual

Writes settings to a DOM element.

Reimplemented from QgsAbstractMaterialSettings.

Definition at line 84 of file qgsphongtexturedmaterialsettings.cpp.

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

/build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/3d/materials/qgsphongtexturedmaterialsettings.h
/build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/3d/materials/qgsphongtexturedmaterialsettings.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsPhongTexturedMaterialSettings()

Member Function Documentation

◆ addParametersToEffect()

◆ ambient()

◆ clone()

◆ create()

◆ diffuseTexturePath()

◆ opacity()

◆ operator==()

◆ readXml()

◆ requiresTextureCoordinates()

◆ setAmbient()

◆ setDiffuseTexturePath()

◆ setOpacity()

◆ setShininess()

◆ setSpecular()

◆ setTextureRotation()

◆ setTextureScale()

◆ shininess()

◆ specular()

◆ supportsTechnique()

◆ textureRotation()

◆ textureScale()

◆ toExportParameters()

◆ toMaterial()

◆ type()

◆ writeXml()