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, float theCloudiness, float theTime, float theFogginess, int 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.
float	Cloudiness () const
	Get cloud intensity. By default this value is 0.2 0.0 means no clouds at all and 1.0 - high clody.
float	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.
float	Fogginess () const
	Get fog intensity. By default this value is 0.0 0.0 means no fog and 1.0 - high fogginess.
int	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 (float 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 (float 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 (float theFogginess)
	Set fog intensity. By default this value is 0.0 0.0 means no fog and 1.0 - high fogginess.
void	SetSize (int theSize)
	Set size of cubemap. By default this value is 512.
void	DumpJson (Standard_OStream &theOStream, int 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,
		float	theCloudiness,
		float	theTime,
		float	theFogginess,
		int	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()

float 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,
		int	theDepth = -1 ) const

Dumps the content of me into the stream.

Fogginess()

float 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

(

float

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

(

float

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

(

int

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 ( float 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()

int 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()

float 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