makVrv::DtSkyObject Class Reference

The base sky object. More...

Inheritance diagram for makVrv::DtSkyObject:

List of all members.

Public Types
enum	CloudLayerTypes {   Cirrocumulus, CirrusFibratus, Nimbostratus, CumulusMediocris,   CumulusCongestus, CumulonimbusCapillatus }
	Cloud layer types. More...
Public Member Functions
	DtSkyObject (DtDe &de, DtUniqueID id)
	|brief CTOR
virtual	~DtSkyObject ()
	DTOR.
virtual void	setDateAndTime (unsigned short year, unsigned char month, unsigned char day, unsigned char hour, unsigned char minutes, double seconds, bool observeDaylightSavings)
	Set the date and time to show the sky.
virtual void	setLocation (const DtVector &location)
	Set the location of the viewer from which the sky is to be recalculated.
virtual void	addCloudLayer (int deckType, const DtVector &location, const DtVector &bounds, double density)
	Add new cloud deck.
virtual void	setCloudLayerEnabled (int index, bool enabled)=0
	Enable/disable a cloud layer.
virtual int	cloudLayerCount () const
	Get the number of cloud decks.
virtual void	removeCloudLayer (int index)=0
	Remove a cloud deck.
virtual void	setAirTurbidity (float turbidity)=0
	Set the air turbidity (haziness)
virtual void	setVisibleDistance (float distance)=0
	Set the visible distance.
virtual void	setPrecipitationEnabled (bool enabled)=0
	Set whether precipitation is enabled.
virtual void	setPrecipitationType (int type)=0
	Set the precipitation type.
virtual void	setPrecipitationIntensity (float intensity)=0
	Set the precipitation intensity.
virtual void	setCloudLayerPosition (int index, double xCoord, double yCoord)=0
	Move a cloud layer to a new position.

---

Detailed Description

The base sky object.

---

Member Enumeration Documentation

enum makVrv::DtSkyObject::CloudLayerTypes

Cloud layer types.

Enumerator:

Cirrocumulus
CirrusFibratus	! High planar cloud puffs
Nimbostratus	! High, thicker and fibrous clouds that signal changing weather
CumulusMediocris	! Low rain clouds that cover the sky
CumulusCongestus	! Low, puffy clouds on fair days
CumulonimbusCapillatus	! Large cumulus clouds that could turn into a thunderhead

---

Constructor & Destructor Documentation

makVrv::DtSkyObject::DtSkyObject	(	DtDe &	de,
		DtUniqueID	id
	)

|brief CTOR

virtual makVrv::DtSkyObject::~DtSkyObject

(

)

[virtual]

DTOR.

---

Member Function Documentation

virtual void makVrv::DtSkyObject::setDateAndTime	(	unsigned short	year,
		unsigned char	month,
		unsigned char	day,
		unsigned char	hour,
		unsigned char	minutes,
		double	seconds,
		bool	observeDaylightSavings
	)		[virtual]

Set the date and time to show the sky.

virtual void makVrv::DtSkyObject::setLocation

(

const DtVector &

location

)

[virtual]

Set the location of the viewer from which the sky is to be recalculated.

Parameters:

Input
location	is the local coordinate from which to generate the sky for. Typically it is the observer location.

Reimplemented in makVrv::DtOsgSkyObject.

virtual void makVrv::DtSkyObject::addCloudLayer	(	int	deckType,
		const DtVector &	location,
		const DtVector &	bounds,
		double	density
	)		[virtual]

Add new cloud deck.

Reimplemented in makVrv::DtOsgSkyObject.

virtual void makVrv::DtSkyObject::setCloudLayerEnabled	(	int	index,
		bool	enabled
	)		[pure virtual]

Enable/disable a cloud layer.

Implemented in makVrv::DtOsgSkyObject.

virtual int makVrv::DtSkyObject::cloudLayerCount

(

)

const [virtual]

Get the number of cloud decks.

Reimplemented in makVrv::DtOsgSkyObject.

virtual void makVrv::DtSkyObject::removeCloudLayer

(

int

index

)

[pure virtual]

Remove a cloud deck.

Implemented in makVrv::DtOsgSkyObject.

virtual void makVrv::DtSkyObject::setAirTurbidity

(

float

turbidity

)

[pure virtual]

Set the air turbidity (haziness)

Implemented in makVrv::DtOsgSkyObject.

virtual void makVrv::DtSkyObject::setVisibleDistance

(

float

distance

)

[pure virtual]

Set the visible distance.

Implemented in makVrv::DtOsgSkyObject.

virtual void makVrv::DtSkyObject::setPrecipitationEnabled

(

bool

enabled

)

[pure virtual]

Set whether precipitation is enabled.

Implemented in makVrv::DtOsgSkyObject.

virtual void makVrv::DtSkyObject::setPrecipitationType

(

int

type

)

[pure virtual]

Set the precipitation type.

Parameters:

input

0 = rain, 1 = snow.

Implemented in makVrv::DtOsgSkyObject.

virtual void makVrv::DtSkyObject::setPrecipitationIntensity

(

float

intensity

)

[pure virtual]

Set the precipitation intensity.

Implemented in makVrv::DtOsgSkyObject.

virtual void makVrv::DtSkyObject::setCloudLayerPosition	(	int	index,
		double	xCoord,
		double	yCoord
	)		[pure virtual]

Move a cloud layer to a new position.

Implemented in makVrv::DtOsgSkyObject.

---

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

• include/vrvCore/DtSkyObject.h