Aspect_SkydomeBackground Class Reference

This class allows the definition of a window skydome background. More...

#include <Aspect_SkydomeBackground.hxx>

Public Member Functions
	Aspect_SkydomeBackground ()
	Creates a window skydome background. By default skydome is initialized with sun at its zenith (0.0, 1.0, 0.0), average clody (0.2), zero time parameter, zero fogginess, 512x512 texture size.
	Aspect_SkydomeBackground (const gp_Dir &theSunDirection, Standard_ShortReal theCloudiness, Standard_ShortReal theTime, Standard_ShortReal theFogginess, Standard_Integer theSize)
	Creates a window skydome background with given parameters.
	~Aspect_SkydomeBackground ()
	Destructor.
const gp_Dir &	SunDirection () const
	Get sun direction. By default this value is (0, 1, 0) Sun direction with negative Y component represents moon with (-X, -Y, -Z) direction.
Standard_ShortReal	Cloudiness () const
	Get cloud intensity. By default this value is 0.2 0.0 means no clouds at all and 1.0 - high clody.
Standard_ShortReal	TimeParameter () const
	Get time of cloud simulation. By default this value is 0.0 This value might be tweaked to slightly change appearance of clouds.
Standard_ShortReal	Fogginess () const
	Get fog intensity. By default this value is 0.0 0.0 means no fog and 1.0 - high fogginess.
Standard_Integer	Size () const
	Get size of cubemap. By default this value is 512.
void	SetSunDirection (const gp_Dir &theSunDirection)
	Set sun direction. By default this value is (0, 1, 0) Sun direction with negative Y component represents moon with (-X, -Y, -Z) direction.
void	SetCloudiness (Standard_ShortReal theCloudiness)
	Set cloud intensity. By default this value is 0.2 0.0 means no clouds at all and 1.0 - high clody.
void	SetTimeParameter (Standard_ShortReal theTime)
	Set time of cloud simulation. By default this value is 0.0 This value might be tweaked to slightly change appearance of clouds.
void	SetFogginess (Standard_ShortReal theFogginess)
	Set fog intensity. By default this value is 0.0 0.0 means no fog and 1.0 - high fogginess.
void	SetSize (Standard_Integer theSize)
	Set size of cubemap. By default this value is 512.
void	DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const
	Dumps the content of me into the stream.

Detailed Description

This class allows the definition of a window skydome background.

Constructor & Destructor Documentation

Aspect_SkydomeBackground() [1/2]

Aspect_SkydomeBackground::Aspect_SkydomeBackground

(

)

Creates a window skydome background. By default skydome is initialized with sun at its zenith (0.0, 1.0, 0.0), average clody (0.2), zero time parameter, zero fogginess, 512x512 texture size.

Aspect_SkydomeBackground() [2/2]

Aspect_SkydomeBackground::Aspect_SkydomeBackground	(	const gp_Dir &	theSunDirection,
		Standard_ShortReal	theCloudiness,
		Standard_ShortReal	theTime,
		Standard_ShortReal	theFogginess,
		Standard_Integer	theSize
	)

Creates a window skydome background with given parameters.

Parameters

[in]	theSunDirection	direction to the sun (moon). Sun direction with negative Y component represents moon with (-X, -Y, -Z) direction.
[in]	theCloudiness	cloud intensity, 0.0 means no clouds at all and 1.0 - high clody.
[in]	theTime	time parameter of simulation. Might be tweaked to slightly change appearance.
[in]	theFogginess	fog intensity, 0.0 means no fog and 1.0 - high fogginess
[in]	theSize	size of cubemap side in pixels.

~Aspect_SkydomeBackground()

Aspect_SkydomeBackground::~Aspect_SkydomeBackground

(

)

Destructor.

Member Function Documentation

Cloudiness()

Standard_ShortReal Aspect_SkydomeBackground::Cloudiness ( ) const

inline

Get cloud intensity. By default this value is 0.2 0.0 means no clouds at all and 1.0 - high clody.

DumpJson()

void Aspect_SkydomeBackground::DumpJson	(	Standard_OStream &	theOStream,
		Standard_Integer	theDepth = -1
	)		const

Dumps the content of me into the stream.

Fogginess()

Standard_ShortReal Aspect_SkydomeBackground::Fogginess ( ) const

inline

Get fog intensity. By default this value is 0.0 0.0 means no fog and 1.0 - high fogginess.

SetCloudiness()

void Aspect_SkydomeBackground::SetCloudiness

(

Standard_ShortReal

theCloudiness

)

Set cloud intensity. By default this value is 0.2 0.0 means no clouds at all and 1.0 - high clody.

SetFogginess()

void Aspect_SkydomeBackground::SetFogginess

(

Standard_ShortReal

theFogginess

)

Set fog intensity. By default this value is 0.0 0.0 means no fog and 1.0 - high fogginess.

SetSize()

void Aspect_SkydomeBackground::SetSize

(

Standard_Integer

theSize

)

Set size of cubemap. By default this value is 512.

SetSunDirection()

void Aspect_SkydomeBackground::SetSunDirection ( const gp_Dir &  theSunDirection )

inline

Set sun direction. By default this value is (0, 1, 0) Sun direction with negative Y component represents moon with (-X, -Y, -Z) direction.

SetTimeParameter()

void Aspect_SkydomeBackground::SetTimeParameter ( Standard_ShortReal  theTime )

inline

Set time of cloud simulation. By default this value is 0.0 This value might be tweaked to slightly change appearance of clouds.

Size()

Standard_Integer Aspect_SkydomeBackground::Size ( ) const

inline

Get size of cubemap. By default this value is 512.

SunDirection()

const gp_Dir & Aspect_SkydomeBackground::SunDirection ( ) const

inline

Get sun direction. By default this value is (0, 1, 0) Sun direction with negative Y component represents moon with (-X, -Y, -Z) direction.

TimeParameter()

Standard_ShortReal Aspect_SkydomeBackground::TimeParameter ( ) const

inline

Get time of cloud simulation. By default this value is 0.0 This value might be tweaked to slightly change appearance of clouds.

---

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

• Aspect_SkydomeBackground.hxx