mirror of
https://github.com/qgis/QGIS.git
synced 2025-02-24 00:47:57 -05:00
These classes are supposed to store the original setting values, so doubles are more appropriate as they won't slightly change eg when round-tripping through qgis project XML. (The actual 3d material classes still use floats, this is just for the settings classes)
156 lines
4.1 KiB
Plaintext
156 lines
4.1 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/3d/materials/qgsphongtexturedmaterialsettings.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.py again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
|
|
|
|
class QgsPhongTexturedMaterialSettings : QgsAbstractMaterialSettings
|
|
{
|
|
%Docstring(signature="appended")
|
|
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.
|
|
|
|
.. versionadded:: 3.16
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsphongtexturedmaterialsettings.h"
|
|
%End
|
|
public:
|
|
|
|
QgsPhongTexturedMaterialSettings();
|
|
|
|
virtual QString type() const;
|
|
|
|
|
|
static bool supportsTechnique( QgsMaterialSettingsRenderingTechnique technique );
|
|
%Docstring
|
|
Returns ``True`` if the specified ``technique`` is supported by the Phong material.
|
|
%End
|
|
|
|
static QgsAbstractMaterialSettings *create() /Factory/;
|
|
%Docstring
|
|
Returns a new instance of QgsPhongTexturedMaterialSettings.
|
|
%End
|
|
|
|
virtual QgsPhongTexturedMaterialSettings *clone() const /Factory/;
|
|
|
|
virtual bool equals( const QgsAbstractMaterialSettings *other ) const;
|
|
|
|
|
|
QColor ambient() const;
|
|
%Docstring
|
|
Returns ambient color component
|
|
%End
|
|
QColor specular() const;
|
|
%Docstring
|
|
Returns specular color component
|
|
%End
|
|
double shininess() const;
|
|
%Docstring
|
|
Returns shininess of the surface
|
|
%End
|
|
|
|
virtual QMap<QString, QString> toExportParameters() const;
|
|
|
|
|
|
QString diffuseTexturePath() const;
|
|
%Docstring
|
|
Returns the diffuse texture path.
|
|
|
|
.. seealso:: :py:func:`setDiffuseTexturePath`
|
|
%End
|
|
|
|
double textureScale() const;
|
|
%Docstring
|
|
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
|
|
%End
|
|
|
|
bool requiresTextureCoordinates() const;
|
|
%Docstring
|
|
Returns ``True`` if the material requires texture coordinates to be generated
|
|
during triangulation.quiresTextureCoordinates
|
|
%End
|
|
|
|
double textureRotation() const;
|
|
%Docstring
|
|
Returns the texture rotation, in degrees.
|
|
%End
|
|
|
|
double opacity() const;
|
|
%Docstring
|
|
Returns the opacity of the surface
|
|
|
|
.. versionadded:: 3.28
|
|
%End
|
|
|
|
void setAmbient( const QColor &ambient );
|
|
%Docstring
|
|
Sets ambient color component
|
|
%End
|
|
|
|
void setSpecular( const QColor &specular );
|
|
%Docstring
|
|
Sets specular color component
|
|
%End
|
|
void setShininess( double shininess );
|
|
%Docstring
|
|
Sets shininess of the surface
|
|
%End
|
|
|
|
void setDiffuseTexturePath( const QString &path );
|
|
%Docstring
|
|
Sets the ``path`` of the diffuse texture.
|
|
|
|
.. seealso:: :py:func:`diffuseTexturePath`
|
|
%End
|
|
|
|
void setTextureScale( double scale );
|
|
%Docstring
|
|
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
|
|
%End
|
|
|
|
void setTextureRotation( double rotation );
|
|
%Docstring
|
|
Sets the texture rotation in degrees
|
|
%End
|
|
|
|
void setOpacity( double opacity );
|
|
%Docstring
|
|
Sets opacity of the surface.
|
|
|
|
.. versionadded:: 3.28
|
|
%End
|
|
|
|
virtual void readXml( const QDomElement &elem, const QgsReadWriteContext &context );
|
|
|
|
virtual void writeXml( QDomElement &elem, const QgsReadWriteContext &context ) const;
|
|
|
|
|
|
bool operator==( const QgsPhongTexturedMaterialSettings &other ) const;
|
|
|
|
};
|
|
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/3d/materials/qgsphongtexturedmaterialsettings.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.py again *
|
|
************************************************************************/
|