QGIS/python/3d/auto_generated/lights/qgspointlightsettings.sip.in
2022-04-27 11:50:13 +10:00

109 lines
3.0 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/3d/lights/qgspointlightsettings.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsPointLightSettings : QgsLightSource
{
%Docstring(signature="appended")
Definition of a point light in a 3D map scene
Total light at the distance D from a point light with intensity I
is (I / TA) where TA is total attenuation which is calculated as
(A_0 + A_1 * D + A_2 * D^2). The terms A_0, A_1 and A_2 stand for
constant, linear and quadratic attenuation.
.. versionadded:: 3.6
%End
%TypeHeaderCode
#include "qgspointlightsettings.h"
%End
public:
QgsPointLightSettings();
%Docstring
Construct a point light with default values
%End
virtual Qgis::LightSourceType type() const;
virtual QgsPointLightSettings *clone() const /Factory/;
virtual QDomElement writeXml( QDomDocument &doc, const QgsReadWriteContext &context = QgsReadWriteContext() ) const;
virtual void readXml( const QDomElement &elem, const QgsReadWriteContext &context = QgsReadWriteContext() );
QgsVector3D position() const;
%Docstring
Returns position of the light (in 3D world coordinates)
%End
void setPosition( const QgsVector3D &pos );
%Docstring
Sets position of the light (in 3D world coordinates)
%End
QColor color() const;
%Docstring
Returns color of the light
%End
void setColor( const QColor &color );
%Docstring
Sets color of the light
%End
float intensity() const;
%Docstring
Returns intensity of the light
%End
void setIntensity( float intensity );
%Docstring
Sets intensity of the light
%End
float constantAttenuation() const;
%Docstring
Returns constant attenuation (A_0)
%End
void setConstantAttenuation( float value );
%Docstring
Sets constant attenuation (A_0)
%End
float linearAttenuation() const;
%Docstring
Returns linear attenuation (A_1)
%End
void setLinearAttenuation( float value );
%Docstring
Sets linear attenuation (A_1)
%End
float quadraticAttenuation() const;
%Docstring
Returns quadratic attenuation (A_2)
%End
void setQuadraticAttenuation( float value );
%Docstring
Sets quadratic attenuation (A_2)
%End
bool operator==( const QgsPointLightSettings &other );
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/3d/lights/qgspointlightsettings.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/