QgsSimpleLineMaterialSettings Class Reference

3 More...

#include <qgssimplelinematerialsettings.h>

Inheritance diagram for QgsSimpleLineMaterialSettings:

Public Member Functions
	QgsSimpleLineMaterialSettings ()=default
void	addParametersToEffect (Qt3DRender::QEffect *effect, const QgsMaterialContext &materialContext) const override
	Adds parameters from the material to a destination effect.
QColor	ambient () const
	Returns the ambient color component.
void	applyDataDefinedToGeometry (Qt3DCore::QGeometry *geometry, int vertexCount, const QByteArray &data) const override
	Applies the data defined bytes, dataDefinedBytes, on the geometry by filling a specific vertex buffer that will be used by the shader.
QgsSimpleLineMaterialSettings *	clone () const override
	Clones the material settings.
QByteArray	dataDefinedVertexColorsAsByte (const QgsExpressionContext &expressionContext) const override
	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.
bool	operator== (const QgsSimpleLineMaterialSettings &other) const
void	readXml (const QDomElement &elem, const QgsReadWriteContext &context) override
	Reads settings from a DOM element.
void	setAmbient (const QColor &ambient)
	Sets the ambient color component.
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 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.
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 QgsSimpleLineMaterialSettings.
static bool	supportsTechnique (QgsMaterialSettingsRenderingTechnique technique)
	Returns true if the specified technique is supported by the 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

Basic shading material used for rendering simple lines as solid line components.

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 37 of file qgssimplelinematerialsettings.h.

Constructor & Destructor Documentation

QgsSimpleLineMaterialSettings()

QgsSimpleLineMaterialSettings::QgsSimpleLineMaterialSettings ( )

default

Member Function Documentation

addParametersToEffect()

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

overridevirtual

Adds parameters from the material to a destination effect.

Implements QgsAbstractMaterialSettings.

Definition at line 129 of file qgssimplelinematerialsettings.cpp.

ambient()

QColor QgsSimpleLineMaterialSettings::ambient ( ) const

inline

Returns the ambient color component.

See also

setAmbient()

Definition at line 62 of file qgssimplelinematerialsettings.h.

applyDataDefinedToGeometry()

void QgsSimpleLineMaterialSettings::applyDataDefinedToGeometry ( Qt3DCore::QGeometry *  geometry, int  vertexCount, const QByteArray &  dataDefinedBytes  ) const

overridevirtual

Applies the data defined bytes, dataDefinedBytes, on the geometry by filling a specific vertex buffer that will be used by the shader.

Since

QGIS 3.18

Reimplemented from QgsAbstractMaterialSettings.

Definition at line 150 of file qgssimplelinematerialsettings.cpp.

clone()

QgsSimpleLineMaterialSettings * QgsSimpleLineMaterialSettings::clone ( ) const

overridevirtual

Clones the material settings.

Caller takes ownership of the returned object.

Implements QgsAbstractMaterialSettings.

Definition at line 71 of file qgssimplelinematerialsettings.cpp.

create()

QgsAbstractMaterialSettings * QgsSimpleLineMaterialSettings::create ( )

static

Returns a new instance of QgsSimpleLineMaterialSettings.

Definition at line 66 of file qgssimplelinematerialsettings.cpp.

dataDefinedVertexColorsAsByte()

QByteArray QgsSimpleLineMaterialSettings::dataDefinedVertexColorsAsByte ( const QgsExpressionContext &  expressionContext ) const

overridevirtual

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.

See also

applyDataDefinedToGeometry()

Since

QGIS 3.18

Reimplemented from QgsAbstractMaterialSettings.

Definition at line 136 of file qgssimplelinematerialsettings.cpp.

operator==()

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

inline

Definition at line 86 of file qgssimplelinematerialsettings.h.

readXml()

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

overridevirtual

Reads settings from a DOM element.

Reimplemented from QgsAbstractMaterialSettings.

Definition at line 76 of file qgssimplelinematerialsettings.cpp.

setAmbient()

void QgsSimpleLineMaterialSettings::setAmbient ( const QColor &  ambient )

inline

Sets the ambient color component.

See also

ambient()

Definition at line 69 of file qgssimplelinematerialsettings.h.

supportsTechnique()

bool QgsSimpleLineMaterialSettings::supportsTechnique ( QgsMaterialSettingsRenderingTechnique  technique )

static

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

Definition at line 48 of file qgssimplelinematerialsettings.cpp.

toExportParameters()

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

overridevirtual

Returns the parameters to be exported to .mtl file.

Implements QgsAbstractMaterialSettings.

Definition at line 122 of file qgssimplelinematerialsettings.cpp.

toMaterial()

QgsMaterial * QgsSimpleLineMaterialSettings::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 90 of file qgssimplelinematerialsettings.cpp.

type()

QString QgsSimpleLineMaterialSettings::type ( ) const

overridevirtual

Returns the unique type name for the material.

Implements QgsAbstractMaterialSettings.

Definition at line 43 of file qgssimplelinematerialsettings.cpp.

writeXml()

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

overridevirtual

Writes settings to a DOM element.

Reimplemented from QgsAbstractMaterialSettings.

Definition at line 83 of file qgssimplelinematerialsettings.cpp.

---

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

• /build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/3d/materials/qgssimplelinematerialsettings.h
• /build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/3d/materials/qgssimplelinematerialsettings.cpp