QGIS API Documentation 4.1.0-Master (ca2ac17535b)
Loading...
Searching...
No Matches
QgsEnvironmentLight Class Reference

An environment light entity. More...

#include <qgsenvironmentlight.h>

Inheritance diagram for QgsEnvironmentLight:

Public Types

enum class  Mode { Disabled , SpecularMapWithSphericalHarmonics }
 Environmental lighting modes. More...

Public Member Functions

 QgsEnvironmentLight (QgsFrameGraph *frameGraph, QNode *parent=nullptr)
 Constructor.
void setMode (Mode mode)
 Sets the environment light mode.
void setSpecularMap (Qt3DRender::QTextureCubeMap *specularTexture, int mipLevels)
 Sets the specular map texture and available mip levels.
void setSphericalHarmonics (const QVector< QVector3D > &harmonics)
 Sets the spherical harmonics for irradiant light.
void setStrength (float strength)
 Sets the strength of the environmental light, as a factor between 0 and 1.

Detailed Description

An environment light entity.

Since
QGIS 4.2

Definition at line 45 of file qgsenvironmentlight.h.

Member Enumeration Documentation

◆ Mode

enum class QgsEnvironmentLight::Mode
strong

Environmental lighting modes.

Enumerator
Disabled 

No environment lighting.

SpecularMapWithSphericalHarmonics 

Specular map, using spherical harmonics for irradiance.

Definition at line 51 of file qgsenvironmentlight.h.

Constructor & Destructor Documentation

◆ QgsEnvironmentLight()

QgsEnvironmentLight::QgsEnvironmentLight ( QgsFrameGraph * frameGraph,
QNode * parent = nullptr )

Constructor.

Definition at line 29 of file qgsenvironmentlight.cpp.

Member Function Documentation

◆ setMode()

void QgsEnvironmentLight::setMode ( Mode mode)

Sets the environment light mode.

Definition at line 51 of file qgsenvironmentlight.cpp.

◆ setSpecularMap()

void QgsEnvironmentLight::setSpecularMap ( Qt3DRender::QTextureCubeMap * specularTexture,
int mipLevels )

Sets the specular map texture and available mip levels.

Definition at line 81 of file qgsenvironmentlight.cpp.

◆ setSphericalHarmonics()

void QgsEnvironmentLight::setSphericalHarmonics ( const QVector< QVector3D > & harmonics)

Sets the spherical harmonics for irradiant light.

Definition at line 69 of file qgsenvironmentlight.cpp.

◆ setStrength()

void QgsEnvironmentLight::setStrength ( float strength)

Sets the strength of the environmental light, as a factor between 0 and 1.

Definition at line 64 of file qgsenvironmentlight.cpp.


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