walberla::pe::raytracing::Lighting Struct Reference

Detailed Description

The Lighting struct defines the properties of a point light in the scene.

#include <Lighting.h>

Public Member Functions

 Lighting ()
 Instantiation constructor for the Lighting struct. More...
 
 Lighting (const Vec3 &_pointLightOrigin, const Color &_diffuseColor, const Color &_specularColor, const Color &_ambientColor)
 Instantiation constructor for the Lighting struct. More...
 
 Lighting (const Config::BlockHandle &config)
 Instantiation constructor for the Lighting struct. More...
 

Public Attributes

Vec3 pointLightOrigin
 
Color diffuseColor
 
Color specularColor
 
Color ambientColor
 

Constructor & Destructor Documentation

walberla::pe::raytracing::Lighting::Lighting ( )
inline

Instantiation constructor for the Lighting struct.

walberla::pe::raytracing::Lighting::Lighting ( const Vec3 _pointLightOrigin,
const Color _diffuseColor,
const Color _specularColor,
const Color _ambientColor 
)
inline

Instantiation constructor for the Lighting struct.

Parameters
pointLightOriginOrigin of the point light.
diffuseColorDiffuse color (base color of the light).
specularColorSpecular color (color of light refractions on an objects surface).
ambientColorColor of the ambient light in the scene.
walberla::pe::raytracing::Lighting::Lighting ( const Config::BlockHandle &  config)
inline

Instantiation constructor for the Lighting struct.

Parameters
configConfig handle.

The config block has to contain a pointLightOrigin parameter (Vec3). Optional are ambientColor (Vec3), diffuseColor (Vec3), specularColor (Vec3). Colors are Vec3's with values from 0 to 1.

Member Data Documentation

Color walberla::pe::raytracing::Lighting::ambientColor
Color walberla::pe::raytracing::Lighting::diffuseColor
Vec3 walberla::pe::raytracing::Lighting::pointLightOrigin
Color walberla::pe::raytracing::Lighting::specularColor

The documentation for this struct was generated from the following file: