OpenSim.Region.Framework.Interfaces.IWindModelPlugin Interface Reference

Inheritance diagram for OpenSim.Region.Framework.Interfaces.IWindModelPlugin:

Collaboration diagram for OpenSim.Region.Framework.Interfaces.IWindModelPlugin:

Public Member Functions
void	WindConfig (Scene scene, IConfig windConfig)
	Provides access to the wind configuration, if any. More...
void	WindUpdate (uint frame)
	Update wind. More...
Vector3	WindSpeed (float x, float y, float z)
	Returns the wind vector at the given local region coordinates. More...
Vector2[]	WindLLClientArray ()
	Generate a 16 x 16 Vector2 array of wind speeds for LL* based viewers More...
Dictionary< string, string >	WindParams ()
	Retrieve a list of parameter/description pairs. More...
void	WindParamSet (string param, float value)
	Set the specified parameter More...
float	WindParamGet (string param)
	Get the specified parameter More...
Public Member Functions inherited from OpenSim.Framework.IPlugin
void	Initialise ()
	Default-initialises the plugin More...

Properties
string	Description [get]
	Brief description of this plugin's wind model More...
Properties inherited from OpenSim.Framework.IPlugin
string	Version [get]
	Returns the plugin version More...
string	Name [get]
	Returns the plugin name More...

Detailed Description

Definition at line 41 of file IWindModelPlugin.cs.

Member Function Documentation

void OpenSim.Region.Framework.Interfaces.IWindModelPlugin.WindConfig	(	Scene	scene,
		IConfig	windConfig
	)

Provides access to the wind configuration, if any.

Vector2 [] OpenSim.Region.Framework.Interfaces.IWindModelPlugin.WindLLClientArray

(

)

Generate a 16 x 16 Vector2 array of wind speeds for LL* based viewers

Returns

Must return a Vector2[256]

Implemented in OpenSim.Region.CoreModules.World.Wind.Plugins.ConfigurableWind, and OpenSim.Region.CoreModules.World.Wind.Plugins.SimpleRandomWind.

float OpenSim.Region.Framework.Interfaces.IWindModelPlugin.WindParamGet

(

string

param

)

Get the specified parameter

Implemented in OpenSim.Region.CoreModules.World.Wind.Plugins.ConfigurableWind, and OpenSim.Region.CoreModules.World.Wind.Plugins.SimpleRandomWind.

Dictionary<string, string> OpenSim.Region.Framework.Interfaces.IWindModelPlugin.WindParams

(

)

Retrieve a list of parameter/description pairs.

Returns

Implemented in OpenSim.Region.CoreModules.World.Wind.Plugins.ConfigurableWind, and OpenSim.Region.CoreModules.World.Wind.Plugins.SimpleRandomWind.

Here is the caller graph for this function:

void OpenSim.Region.Framework.Interfaces.IWindModelPlugin.WindParamSet	(	string	param,
		float	value
	)

Set the specified parameter

Implemented in OpenSim.Region.CoreModules.World.Wind.Plugins.ConfigurableWind, and OpenSim.Region.CoreModules.World.Wind.Plugins.SimpleRandomWind.

Vector3 OpenSim.Region.Framework.Interfaces.IWindModelPlugin.WindSpeed	(	float	x,
		float	y,
		float	z
	)

Returns the wind vector at the given local region coordinates.

Implemented in OpenSim.Region.CoreModules.World.Wind.Plugins.ConfigurableWind, and OpenSim.Region.CoreModules.World.Wind.Plugins.SimpleRandomWind.

void OpenSim.Region.Framework.Interfaces.IWindModelPlugin.WindUpdate

(

uint

frame

)

Update wind.

Implemented in OpenSim.Region.CoreModules.World.Wind.Plugins.ConfigurableWind, and OpenSim.Region.CoreModules.World.Wind.Plugins.SimpleRandomWind.

Property Documentation

string OpenSim.Region.Framework.Interfaces.IWindModelPlugin.Description

get

Brief description of this plugin's wind model

Definition at line 46 of file IWindModelPlugin.cs.

---

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

• Region/Framework/Interfaces/IWindModelPlugin.cs