Unigine.Plugins.IG.Meteo Class

Meteo Class

Properties

MeteoCameraEffects CameraEffects#

Region GlobalRegion#

int NumRegions#

double CloudBottom#

Members

Region GetRegion ( long id, bool auto_create ) #

Arguments

• long id - Weather region identifier .
• bool auto_create - true to automatically create the region with the specified ID if it doesn't exist yet; false - to return nullptr in case the region doesn't exist.

Return value

bool RemoveRegion ( long id ) #

Arguments

• long id - Identifier of the weather region to be removed .

Return value

void ClearRegions ( ) #

vec3 GetMeanWindSpeed ( dvec3 geo_pos ) #

Arguments

• dvec3 geo_pos - Geographic coordinates of a point (lat, lon, alt), for which an average wind speed and direction are to be calculated.

Return value

IntPtr AddOnCreateRegionCallback ( OnCreateRegionDelegate func ) #

Arguments

• OnCreateRegionDelegate func - Callback function with the following signature: void OnCreateRegion(Region region)

Return value

bool RemoveOnCreateRegionCallback ( IntPtr id ) #

Arguments

• IntPtr id - Create Region callback ID obtained when adding it.

Return value

void ClearOnCreateRegionCallbacks ( ) #

IntPtr AddOnRemoveRegionCallback ( OnRemoveRegionDelegate func ) #

Arguments

• OnRemoveRegionDelegate func - Callback function with the following signature: void OnRemoveRegion(Region region)

Return value

bool RemoveOnRemoveRegionCallback ( IntPtr id ) #

Arguments

• IntPtr id - Remove Region callback ID obtained when adding it.

Return value

void ClearOnRemoveRegionCallbacks ( ) #

IntPtr AddOnLightningStrikeCallback ( OnLightningStrikeDelegate func ) #

Arguments

• OnLightningStrikeDelegate func - Callback function with the following signature: void OnLightningStrike(Vec3 geo_pos, int type)

Return value

bool RemoveOnLightningStrikeCallback ( IntPtr id ) #

Arguments

• IntPtr id - Lightning Strike callback ID obtained when adding it.

Return value

void ClearOnLightningStrikeCallbacks ( ) #

IntPtr AddOnMeteoChangedCallback ( OnMeteoChangedDelegate callback ) #

/// callback function to be called when weather conditions change
void SomeClass::my_weather_callback()
{
	// setting orientation of the vane downwind
	vec3 wind_direction = ig_manager->getMeteo()->getMeanWindSpeed(vane_node->getWorldPosition());
	vane_node->setWorldDirection(wind_direction, vec3_up);
}

// ...
// somewhere in code
void SomeClass::init()
{
	// adding "my_weather_callback" to be called on changing weather conditions
	ig_manager->getMeteo()->addOnMeteoChangedCallback(this, Unigine::MakeCallback(this, &SomeClass::my_weather_callback );
}

Arguments

• OnMeteoChangedDelegate callback - Callback function with the following signature: void OnMeteoChangedDelegate()

Return value

void RemoveOnMeteoChangedCallback ( IntPtr subscriber ) #

Arguments

• IntPtr subscriber - Callback subscriber ID specified when adding it.

void ClearOnMeteoChangedCallbacks ( ) #

void LightningStrike ( dvec3 geo_pos, int type = -1 ) #

Arguments

• dvec3 geo_pos - Geocoordinates of the lightning strike location.
• int type

Region GetRegionByIndex ( int index ) #

Arguments

• int index - Weather region index in the range from 0 to the total number of regions.

Return value

double GetCloudBottom ( ) #

Return value