QGIS API Documentation  3.20.0-Odense (decaadbb31)
Public Member Functions | List of all members
QgsDirectionalLightSettings Class Reference

3 More...

#include <qgsdirectionallightsettings.h>

Public Member Functions

 QgsDirectionalLightSettings ()=default
 Construct a directional light with default values. More...
 
QColor color () const
 Returns color of the light. More...
 
QgsVector3D direction () const
 Returns the direction of the light in degrees. More...
 
float intensity () const
 Returns intensity of the light. More...
 
bool operator== (const QgsDirectionalLightSettings &other)
 
void readXml (const QDomElement &elem)
 Reads configuration from a DOM element previously written using writeXml() More...
 
void setColor (const QColor &color)
 Sets color of the light. More...
 
void setDirection (const QgsVector3D &direction)
 Sets the direction of the light in degrees. More...
 
void setIntensity (float intensity)
 Sets intensity of the light. More...
 
QDomElement writeXml (QDomDocument &doc) const
 Writes configuration to a new DOM element and returns it. More...
 

Detailed Description

3

Definition of a directional light in a 3D map scene

Since
QGIS 3.16

Definition at line 32 of file qgsdirectionallightsettings.h.

Constructor & Destructor Documentation

◆ QgsDirectionalLightSettings()

QgsDirectionalLightSettings::QgsDirectionalLightSettings ( )
default

Construct a directional light with default values.

Member Function Documentation

◆ color()

QColor QgsDirectionalLightSettings::color ( ) const
inline

Returns color of the light.

Definition at line 44 of file qgsdirectionallightsettings.h.

◆ direction()

QgsVector3D QgsDirectionalLightSettings::direction ( ) const
inline

Returns the direction of the light in degrees.

Definition at line 39 of file qgsdirectionallightsettings.h.

◆ intensity()

float QgsDirectionalLightSettings::intensity ( ) const
inline

Returns intensity of the light.

Definition at line 49 of file qgsdirectionallightsettings.h.

◆ operator==()

bool QgsDirectionalLightSettings::operator== ( const QgsDirectionalLightSettings other)

Definition at line 43 of file qgsdirectionallightsettings.cpp.

◆ readXml()

void QgsDirectionalLightSettings::readXml ( const QDomElement &  elem)

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

Definition at line 34 of file qgsdirectionallightsettings.cpp.

◆ setColor()

void QgsDirectionalLightSettings::setColor ( const QColor &  color)
inline

Sets color of the light.

Definition at line 46 of file qgsdirectionallightsettings.h.

◆ setDirection()

void QgsDirectionalLightSettings::setDirection ( const QgsVector3D direction)
inline

Sets the direction of the light in degrees.

Definition at line 41 of file qgsdirectionallightsettings.h.

◆ setIntensity()

void QgsDirectionalLightSettings::setIntensity ( float  intensity)
inline

Sets intensity of the light.

Definition at line 51 of file qgsdirectionallightsettings.h.

◆ writeXml()

QDomElement QgsDirectionalLightSettings::writeXml ( QDomDocument &  doc) const

Writes configuration to a new DOM element and returns it.

Definition at line 23 of file qgsdirectionallightsettings.cpp.


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