QGIS API Documentation 3.28.0-Firenze (ed3ad0430f)
Public Member Functions | Static Public Member Functions | List of all members
QgsSimpleLineMaterialSettings Class Reference

3 More...

#include <qgssimplelinematerialsettings.h>

Inheritance diagram for QgsSimpleLineMaterialSettings:
Inheritance graph
[legend]

Public Member Functions

 QgsSimpleLineMaterialSettings ()=default
 Constructor for QgsSimpleLineMaterialSettings. More...
 
void addParametersToEffect (Qt3DRender::QEffect *effect) const override
 Adds parameters from the material to a destination effect. More...
 
QColor ambient () const
 Returns the ambient color component. More...
 
QgsSimpleLineMaterialSettingsclone () const override
 Clones the material settings. More...
 
bool operator== (const QgsSimpleLineMaterialSettings &other) const
 
void readXml (const QDomElement &elem, const QgsReadWriteContext &context) override
 Reads settings from a DOM element. More...
 
void setAmbient (const QColor &ambient)
 Sets the ambient color component. More...
 
QMap< QString, QString > toExportParameters () const override
 Returns the parameters to be exported to .mtl file. More...
 
Qt3DRender::QMaterial * toMaterial (QgsMaterialSettingsRenderingTechnique technique, const QgsMaterialContext &context) const override
 Creates a new QMaterial object representing the material settings. More...
 
QString type () const override
 Returns the unique type name for the material. More...
 
void writeXml (QDomElement &elem, const QgsReadWriteContext &context) const override
 Writes settings to a DOM element. More...
 
- Public Member Functions inherited from QgsAbstractMaterialSettings
virtual ~QgsAbstractMaterialSettings ()=default
 
virtual void addParametersToEffect (Qt3DRender::QEffect *effect) const =0
 Adds parameters from the material to a destination effect. More...
 
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. More...
 
virtual QgsAbstractMaterialSettingsclone () const =0
 Clones the material settings. More...
 
virtual int dataDefinedByteStride () const
 Returns byte stride of the data defined colors,used to fill the vertex colors data defined buffer for rendering. More...
 
QgsPropertyCollection dataDefinedProperties () const
 Returns the symbol material property collection, used for data defined overrides. More...
 
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. More...
 
const QgsPropertiesDefinitionpropertyDefinitions () const
 Returns a reference to the material properties definition, used for data defined overrides. More...
 
virtual void readXml (const QDomElement &element, const QgsReadWriteContext &)
 Reads settings from a DOM element. More...
 
void setDataDefinedProperties (const QgsPropertyCollection &collection)
 Sets the material property collection, used for data defined overrides. More...
 
virtual QMap< QString, QString > toExportParameters () const =0
 Returns the parameters to be exported to .mtl file. More...
 
virtual Qt3DRender::QMaterial * toMaterial (QgsMaterialSettingsRenderingTechnique technique, const QgsMaterialContext &context) const =0
 Creates a new QMaterial object representing the material settings. More...
 
virtual QString type () const =0
 Returns the unique type name for the material. More...
 
virtual void writeXml (QDomElement &element, const QgsReadWriteContext &) const
 Writes settings to a DOM element. More...
 

Static Public Member Functions

static QgsAbstractMaterialSettingscreate ()
 Returns a new instance of QgsSimpleLineMaterialSettings. More...
 
static bool supportsTechnique (QgsMaterialSettingsRenderingTechnique technique)
 Returns true if the specified technique is supported by the material. More...
 

Additional Inherited Members

- Public Types inherited from QgsAbstractMaterialSettings
enum  Property {
  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 36 of file qgssimplelinematerialsettings.h.

Constructor & Destructor Documentation

◆ QgsSimpleLineMaterialSettings()

QgsSimpleLineMaterialSettings::QgsSimpleLineMaterialSettings ( )
default

Member Function Documentation

◆ addParametersToEffect()

void QgsSimpleLineMaterialSettings::addParametersToEffect ( Qt3DRender::QEffect *  effect) const
overridevirtual

Adds parameters from the material to a destination effect.

Implements QgsAbstractMaterialSettings.

Definition at line 102 of file qgssimplelinematerialsettings.cpp.

◆ ambient()

QColor QgsSimpleLineMaterialSettings::ambient ( ) const
inline

Returns the ambient color component.

See also
setAmbient()

Definition at line 64 of file qgssimplelinematerialsettings.h.

◆ clone()

QgsSimpleLineMaterialSettings * QgsSimpleLineMaterialSettings::clone ( ) const
overridevirtual

Clones the material settings.

Caller takes ownership of the returned object.

Implements QgsAbstractMaterialSettings.

Definition at line 53 of file qgssimplelinematerialsettings.cpp.

◆ create()

QgsAbstractMaterialSettings * QgsSimpleLineMaterialSettings::create ( )
static

Returns a new instance of QgsSimpleLineMaterialSettings.

Definition at line 48 of file qgssimplelinematerialsettings.cpp.

◆ operator==()

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

Definition at line 82 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 58 of file qgssimplelinematerialsettings.cpp.

◆ setAmbient()

void QgsSimpleLineMaterialSettings::setAmbient ( const QColor &  ambient)
inline

Sets the ambient color component.

See also
ambient()

Definition at line 71 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 30 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 95 of file qgssimplelinematerialsettings.cpp.

◆ toMaterial()

Qt3DRender::QMaterial * QgsSimpleLineMaterialSettings::toMaterial ( QgsMaterialSettingsRenderingTechnique  technique,
const QgsMaterialContext context 
) const
overridevirtual

Creates a new QMaterial 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 68 of file qgssimplelinematerialsettings.cpp.

◆ type()

QString QgsSimpleLineMaterialSettings::type ( ) const
overridevirtual

Returns the unique type name for the material.

Implements QgsAbstractMaterialSettings.

Definition at line 25 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 63 of file qgssimplelinematerialsettings.cpp.


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