luciad::SunlightModel Class Reference

Light with a direction that approximates the direction of sunlight at a given time. More...

#include <luciad/maps/effects/LightModel.h>

Inheritance diagram for luciad::SunlightModel:

Classes
class	Builder
	Builder for a luciad::SunlightModel. More...

Public Member Functions
	~SunlightModel () override
Builder	asBuilder () const
	Creates a builder pre-filled with this light's parameters.
Color	getAmbientColor () const
	Returns the ambient color of the light.
Color	getDiffuseColor () const
	Returns the diffuse color of the light.
int64_t	getTime () const
	Returns the time in milliseconds since midnight GMT+0 (UTC), 01 January 1970.
bool	operator== (const SunlightModel &other) const
	Returns whether this light is equal to another.
Public Member Functions inherited from luciad::LightModel
	LightModel (const LightModel &)=delete
virtual	~LightModel ()=default
LightModel &	operator= (const LightModel &)=delete

Static Public Member Functions
static Builder	newBuilder ()
	Creates a new builder with the default sunlight parameters.

Additional Inherited Members
Protected Member Functions inherited from luciad::LightModel
	LightModel ()=default
	Default constructor.

Detailed Description

Light with a direction that approximates the direction of sunlight at a given time.

Since

2026.1

Constructor & Destructor Documentation

~SunlightModel()

luciad::SunlightModel::~SunlightModel ( )

override

Member Function Documentation

asBuilder()

Builder luciad::SunlightModel::asBuilder

(

)

const

Creates a builder pre-filled with this light's parameters.

Returns

a builder pre-filled with this light's parameters.

getAmbientColor()

Color luciad::SunlightModel::getAmbientColor

(

)

const

Returns the ambient color of the light.

Returns

the ambient color of the light.

getDiffuseColor()

Color luciad::SunlightModel::getDiffuseColor

(

)

const

Returns the diffuse color of the light.

Returns

the diffuse color of the light.

getTime()

int64_t luciad::SunlightModel::getTime

(

)

const

Returns the time in milliseconds since midnight GMT+0 (UTC), 01 January 1970.

Returns

the time in milliseconds since midnight GMT+0 (UTC), 01 January 1970.

newBuilder()

Builder luciad::SunlightModel::newBuilder ( )

static

Creates a new builder with the default sunlight parameters.

The time is mandatory and must still be set.

Returns

a new builder.

operator==()

bool luciad::SunlightModel::operator==

(

const SunlightModel &

other

)

const

Returns whether this light is equal to another.

Parameters

other

the light to compare with.

Returns

whether this light is equal to another.