QgsPointLightSettings class

3 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.

Constructors, destructors, conversion operators

QgsPointLightSettings() defaulted

Construct a point light with default values.

Public functions

auto color() const -> QColor

Returns color of the light.

auto constantAttenuation() const -> float

Returns constant attenuation (A_0)

auto intensity() const -> float

Returns intensity of the light.

auto linearAttenuation() const -> float

Returns linear attenuation (A_1)

auto position() const -> QgsVector3D

Returns position of the light (in 3D world coordinates)

auto quadraticAttenuation() const -> float

Returns quadratic attenuation (A_2)

void readXml(const QDomElement& elem)

Reads configuration from a DOM element previously written using writeXml()

void setColor(const QColor& color)

Sets color of the light.

void setConstantAttenuation(float value)

Sets constant attenuation (A_0)

void setIntensity(float intensity)

Sets intensity of the light.

void setLinearAttenuation(float value)

Sets linear attenuation (A_1)

void setPosition(const QgsVector3D& pos)

Sets position of the light (in 3D world coordinates)

void setQuadraticAttenuation(float value)

Sets quadratic attenuation (A_2)

auto writeXml(QDomDocument& doc) const -> QDomElement

Writes configuration to a new DOM element and returns it.