QGIS API Documentation  3.23.0-Master (4fd2f04bd0)
Public Member Functions | Static Public Member Functions | List of all members
QgsPhongMaterialSettings Class Reference

3 More...

#include <qgsphongmaterialsettings.h>

Inheritance diagram for QgsPhongMaterialSettings:
Inheritance graph
[legend]

Public Member Functions

 QgsPhongMaterialSettings ()=default
 Constructor for QgsPhongMaterialSettings. More...
 
void addParametersToEffect (Qt3DRender::QEffect *effect) const override
 Adds parameters from the material to a destination effect. More...
 
QColor ambient () const
 Returns ambient color component. More...
 
void applyDataDefinedToGeometry (Qt3DRender::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. More...
 
QgsPhongMaterialSettingsclone () const override
 Clones the material settings. More...
 
int dataDefinedByteStride () const override
 Returns byte stride of the data defined colors,used to fill the vertex colors data defined buffer for rendering. More...
 
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. More...
 
QColor diffuse () const
 Returns diffuse color component. More...
 
bool operator== (const QgsPhongMaterialSettings &other) const
 
void readXml (const QDomElement &elem, const QgsReadWriteContext &context) override
 Reads settings from a DOM element. More...
 
void setAmbient (const QColor &ambient)
 Sets ambient color component. More...
 
void setDiffuse (const QColor &diffuse)
 Sets diffuse color component. More...
 
void setShininess (float shininess)
 Sets shininess of the surface. More...
 
void setSpecular (const QColor &specular)
 Sets specular color component. More...
 
float shininess () const
 Returns shininess of the surface. More...
 
QColor specular () const
 Returns specular 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
 
QgsPropertyCollection dataDefinedProperties () const
 Returns the symbol material property collection, used for data defined overrides. More...
 
const QgsPropertiesDefinitionpropertyDefinitions () const
 Returns a reference to the material properties definition, used for data defined overrides. More...
 
void setDataDefinedProperties (const QgsPropertyCollection &collection)
 Sets the material property collection, used for data defined overrides. More...
 

Static Public Member Functions

static QgsAbstractMaterialSettingscreate ()
 Returns a new instance of QgsPhongMaterialSettings. More...
 
static bool supportsTechnique (QgsMaterialSettingsRenderingTechnique technique)
 Returns true if the specified technique is supported by the Phong 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 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.
Since
QGIS 3.0

Definition at line 44 of file qgsphongmaterialsettings.h.

Constructor & Destructor Documentation

◆ QgsPhongMaterialSettings()

QgsPhongMaterialSettings::QgsPhongMaterialSettings ( )
default

Constructor for QgsPhongMaterialSettings.

Member Function Documentation

◆ addParametersToEffect()

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

Adds parameters from the material to a destination effect.

Implements QgsAbstractMaterialSettings.

Definition at line 132 of file qgsphongmaterialsettings.cpp.

◆ ambient()

QColor QgsPhongMaterialSettings::ambient ( ) const
inline

Returns ambient color component.

Definition at line 68 of file qgsphongmaterialsettings.h.

◆ applyDataDefinedToGeometry()

void QgsPhongMaterialSettings::applyDataDefinedToGeometry ( Qt3DRender::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 177 of file qgsphongmaterialsettings.cpp.

◆ clone()

QgsPhongMaterialSettings * QgsPhongMaterialSettings::clone ( ) const
overridevirtual

Clones the material settings.

Caller takes ownership of the returned object.

Implements QgsAbstractMaterialSettings.

Definition at line 61 of file qgsphongmaterialsettings.cpp.

◆ create()

QgsAbstractMaterialSettings * QgsPhongMaterialSettings::create ( )
static

Returns a new instance of QgsPhongMaterialSettings.

Definition at line 56 of file qgsphongmaterialsettings.cpp.

◆ dataDefinedByteStride()

int QgsPhongMaterialSettings::dataDefinedByteStride ( ) const
overridevirtual

Returns byte stride of the data defined colors,used to fill the vertex colors data defined buffer for rendering.

Since
QGIS 3.18

Reimplemented from QgsAbstractMaterialSettings.

Definition at line 175 of file qgsphongmaterialsettings.cpp.

◆ dataDefinedVertexColorsAsByte()

QByteArray QgsPhongMaterialSettings::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 150 of file qgsphongmaterialsettings.cpp.

◆ diffuse()

QColor QgsPhongMaterialSettings::diffuse ( ) const
inline

Returns diffuse color component.

Definition at line 70 of file qgsphongmaterialsettings.h.

◆ operator==()

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

Definition at line 100 of file qgsphongmaterialsettings.h.

◆ readXml()

void QgsPhongMaterialSettings::readXml ( const QDomElement &  element,
const QgsReadWriteContext  
)
overridevirtual

Reads settings from a DOM element.

Reimplemented from QgsAbstractMaterialSettings.

Definition at line 66 of file qgsphongmaterialsettings.cpp.

◆ setAmbient()

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

Sets ambient color component.

Definition at line 79 of file qgsphongmaterialsettings.h.

◆ setDiffuse()

void QgsPhongMaterialSettings::setDiffuse ( const QColor &  diffuse)
inline

Sets diffuse color component.

Definition at line 81 of file qgsphongmaterialsettings.h.

◆ setShininess()

void QgsPhongMaterialSettings::setShininess ( float  shininess)
inline

Sets shininess of the surface.

Definition at line 85 of file qgsphongmaterialsettings.h.

◆ setSpecular()

void QgsPhongMaterialSettings::setSpecular ( const QColor &  specular)
inline

Sets specular color component.

Definition at line 83 of file qgsphongmaterialsettings.h.

◆ shininess()

float QgsPhongMaterialSettings::shininess ( ) const
inline

Returns shininess of the surface.

Definition at line 74 of file qgsphongmaterialsettings.h.

◆ specular()

QColor QgsPhongMaterialSettings::specular ( ) const
inline

Returns specular color component.

Definition at line 72 of file qgsphongmaterialsettings.h.

◆ supportsTechnique()

bool QgsPhongMaterialSettings::supportsTechnique ( QgsMaterialSettingsRenderingTechnique  technique)
static

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

Definition at line 38 of file qgsphongmaterialsettings.cpp.

◆ toExportParameters()

QMap< QString, QString > QgsPhongMaterialSettings::toExportParameters ( ) const
overridevirtual

Returns the parameters to be exported to .mtl file.

Implements QgsAbstractMaterialSettings.

Definition at line 122 of file qgsphongmaterialsettings.cpp.

◆ toMaterial()

Qt3DRender::QMaterial * QgsPhongMaterialSettings::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 87 of file qgsphongmaterialsettings.cpp.

◆ type()

QString QgsPhongMaterialSettings::type ( ) const
overridevirtual

Returns the unique type name for the material.

Implements QgsAbstractMaterialSettings.

Definition at line 33 of file qgsphongmaterialsettings.cpp.

◆ writeXml()

void QgsPhongMaterialSettings::writeXml ( QDomElement &  element,
const QgsReadWriteContext  
) const
overridevirtual

Writes settings to a DOM element.

Reimplemented from QgsAbstractMaterialSettings.

Definition at line 76 of file qgsphongmaterialsettings.cpp.


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