QGIS API Documentation 4.1.0-Master (01362494303)
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
QgsAbstractMaterialSettings Class Referenceabstract
core library

Abstract base class for material settings. More...

#include <qgsabstractmaterialsettings.h>

Inheritance diagram for QgsAbstractMaterialSettings:
Inheritance graph
[legend]

Public Types

enum class  Property : int {
  Diffuse , Ambient , Warm , Cool ,
  Specular
}
 Data definable properties. More...

Public Member Functions

virtual ~QgsAbstractMaterialSettings ()=default
virtual QgsAbstractMaterialSettings * clone () const =0
 Clones the material settings.
QgsPropertyCollection dataDefinedProperties () const
 Returns the symbol material property collection, used for data defined overrides.
virtual bool equals (const QgsAbstractMaterialSettings *other) const =0
 Returns true if this settings exactly matches an other settings.
const QgsPropertiesDefinition & propertyDefinitions () const
 Returns a reference to the material properties definition, used for data defined overrides.
virtual void readXml (const QDomElement &element, const QgsReadWriteContext &)
 Reads settings from a DOM element.
virtual bool requiresTangents () const
 Returns true if the material requires tangents generated during triangulation.
virtual bool requiresTextureCoordinates () const
 Returns true if the material requires texture coordinates to be generated during triangulation.
void setDataDefinedProperties (const QgsPropertyCollection &collection)
 Sets the material property collection, used for data defined overrides.
virtual QString type () const =0
 Returns the unique type name for the material.
virtual void writeXml (QDomElement &element, const QgsReadWriteContext &) const
 Writes settings to a DOM element.

Detailed Description

Abstract base class for material settings.

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.

Definition at line 41 of file qgsabstractmaterialsettings.h.

Member Enumeration Documentation

◆ Property

enum class QgsAbstractMaterialSettings::Property : int
strong

Data definable properties.

Enumerator
Diffuse 

Diffuse color.

Ambient 

Ambient color (phong material).

Warm 

Warm color (gooch material).

Cool 

Cool color (gooch material).

Specular 

Specular color.

Definition at line 126 of file qgsabstractmaterialsettings.h.

Constructor & Destructor Documentation

◆ ~QgsAbstractMaterialSettings()

virtual QgsAbstractMaterialSettings::~QgsAbstractMaterialSettings ( )
virtualdefault

Member Function Documentation

◆ clone()

virtual QgsAbstractMaterialSettings * QgsAbstractMaterialSettings::clone ( ) const
pure virtual

Clones the material settings.

Caller takes ownership of the returned object.

Implemented in QgsGoochMaterialSettings, QgsMetalRoughMaterialSettings, QgsMetalRoughTexturedMaterialSettings, QgsNullMaterialSettings, QgsPhongMaterialSettings, QgsPhongTexturedMaterialSettings, and QgsSimpleLineMaterialSettings.

◆ dataDefinedProperties()

QgsPropertyCollection QgsAbstractMaterialSettings::dataDefinedProperties ( ) const

Returns the symbol material property collection, used for data defined overrides.

Since
QGIS 4.2

Definition at line 54 of file qgsabstractmaterialsettings.cpp.

◆ equals()

virtual bool QgsAbstractMaterialSettings::equals ( const QgsAbstractMaterialSettings * other) const
pure virtual

Returns true if this settings exactly matches an other settings.

Since
QGIS 3.42

Implemented in QgsGoochMaterialSettings, QgsMetalRoughMaterialSettings, QgsMetalRoughTexturedMaterialSettings, QgsNullMaterialSettings, QgsPhongMaterialSettings, QgsPhongTexturedMaterialSettings, and QgsSimpleLineMaterialSettings.

◆ propertyDefinitions()

const QgsPropertiesDefinition & QgsAbstractMaterialSettings::propertyDefinitions ( ) const

Returns a reference to the material properties definition, used for data defined overrides.

Since
QGIS 4.2

Definition at line 59 of file qgsabstractmaterialsettings.cpp.

◆ readXml()

void QgsAbstractMaterialSettings::readXml ( const QDomElement & element,
const QgsReadWriteContext &  )
virtual

Reads settings from a DOM element.

Reimplemented in QgsGoochMaterialSettings, QgsMetalRoughMaterialSettings, QgsMetalRoughTexturedMaterialSettings, QgsPhongMaterialSettings, QgsPhongTexturedMaterialSettings, and QgsSimpleLineMaterialSettings.

Definition at line 24 of file qgsabstractmaterialsettings.cpp.

◆ requiresTangents()

bool QgsAbstractMaterialSettings::requiresTangents ( ) const
virtual

Returns true if the material requires tangents generated during triangulation.

Since
QGIS 4.2

Reimplemented in QgsMetalRoughTexturedMaterialSettings.

Definition at line 44 of file qgsabstractmaterialsettings.cpp.

◆ requiresTextureCoordinates()

bool QgsAbstractMaterialSettings::requiresTextureCoordinates ( ) const
virtual

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

Since
QGIS 4.2

Reimplemented in QgsMetalRoughTexturedMaterialSettings, and QgsPhongTexturedMaterialSettings.

Definition at line 39 of file qgsabstractmaterialsettings.cpp.

◆ setDataDefinedProperties()

void QgsAbstractMaterialSettings::setDataDefinedProperties ( const QgsPropertyCollection & collection)

Sets the material property collection, used for data defined overrides.

Since
QGIS 4.2

Definition at line 49 of file qgsabstractmaterialsettings.cpp.

◆ type()

virtual QString QgsAbstractMaterialSettings::type ( ) const
pure virtual

Returns the unique type name for the material.

Implemented in QgsGoochMaterialSettings, QgsMetalRoughMaterialSettings, QgsMetalRoughTexturedMaterialSettings, QgsNullMaterialSettings, QgsPhongMaterialSettings, QgsPhongTexturedMaterialSettings, and QgsSimpleLineMaterialSettings.

◆ writeXml()

void QgsAbstractMaterialSettings::writeXml ( QDomElement & element,
const QgsReadWriteContext &  ) const
virtual

Writes settings to a DOM element.

Reimplemented in QgsGoochMaterialSettings, QgsMetalRoughMaterialSettings, QgsMetalRoughTexturedMaterialSettings, QgsPhongMaterialSettings, QgsPhongTexturedMaterialSettings, and QgsSimpleLineMaterialSettings.

Definition at line 31 of file qgsabstractmaterialsettings.cpp.

The documentation for this class was generated from the following files:
Generated on for QGIS API Documentation by doxygen 1.15.0