OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Properties | List of all members
OpenSim.Region.CoreModules.World.Wind.Plugins.ConfigurableWind Class Reference
Inheritance diagram for OpenSim.Region.CoreModules.World.Wind.Plugins.ConfigurableWind:
Inheritance graph
[legend]
Collaboration diagram for OpenSim.Region.CoreModules.World.Wind.Plugins.ConfigurableWind:
Collaboration graph
[legend]

Public Member Functions

void Initialise ()
 Default-initialises the plugin More...
 
void Dispose ()
 
void WindConfig (OpenSim.Region.Framework.Scenes.Scene scene, Nini.Config.IConfig windConfig)
 
void WindUpdate (uint frame)
 Update wind. More...
 
Vector3 WindSpeed (float fX, float fY, float fZ)
 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...
 
System.Collections.Generic.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.Region.Framework.Interfaces.IWindModelPlugin
void WindConfig (Scene scene, IConfig windConfig)
 Provides access to the wind configuration, if any. More...
 

Properties

string Version [get]
 
string Name [get]
 
string Description [get]
 
- Properties inherited from OpenSim.Region.Framework.Interfaces.IWindModelPlugin
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 42 of file ConfigurableWind.cs.

Member Function Documentation

void OpenSim.Region.CoreModules.World.Wind.Plugins.ConfigurableWind.Dispose ( )
inline

Definition at line 80 of file ConfigurableWind.cs.

void OpenSim.Region.CoreModules.World.Wind.Plugins.ConfigurableWind.Initialise ( )
inline

Default-initialises the plugin

Implements OpenSim.Framework.IPlugin.

Definition at line 71 of file ConfigurableWind.cs.

void OpenSim.Region.CoreModules.World.Wind.Plugins.ConfigurableWind.WindConfig ( OpenSim.Region.Framework.Scenes.Scene  scene,
Nini.Config.IConfig  windConfig 
)
inline

Definition at line 89 of file ConfigurableWind.cs.

Vector2 [] OpenSim.Region.CoreModules.World.Wind.Plugins.ConfigurableWind.WindLLClientArray ( )
inline

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

Returns
Must return a Vector2[256]

Implements OpenSim.Region.Framework.Interfaces.IWindModelPlugin.

Definition at line 154 of file ConfigurableWind.cs.

float OpenSim.Region.CoreModules.World.Wind.Plugins.ConfigurableWind.WindParamGet ( string  param)
inline

Get the specified parameter

Implements OpenSim.Region.Framework.Interfaces.IWindModelPlugin.

Definition at line 202 of file ConfigurableWind.cs.

System.Collections.Generic.Dictionary<string, string> OpenSim.Region.CoreModules.World.Wind.Plugins.ConfigurableWind.WindParams ( )
inline

Retrieve a list of parameter/description pairs.

Returns

Implements OpenSim.Region.Framework.Interfaces.IWindModelPlugin.

Definition at line 167 of file ConfigurableWind.cs.

void OpenSim.Region.CoreModules.World.Wind.Plugins.ConfigurableWind.WindParamSet ( string  param,
float  value 
)
inline

Set the specified parameter

Implements OpenSim.Region.Framework.Interfaces.IWindModelPlugin.

Definition at line 180 of file ConfigurableWind.cs.

Vector3 OpenSim.Region.CoreModules.World.Wind.Plugins.ConfigurableWind.WindSpeed ( float  x,
float  y,
float  z 
)
inline

Returns the wind vector at the given local region coordinates.

Implements OpenSim.Region.Framework.Interfaces.IWindModelPlugin.

Definition at line 149 of file ConfigurableWind.cs.

void OpenSim.Region.CoreModules.World.Wind.Plugins.ConfigurableWind.WindUpdate ( uint  frame)
inline

Update wind.

Implements OpenSim.Region.Framework.Interfaces.IWindModelPlugin.

Definition at line 106 of file ConfigurableWind.cs.

Property Documentation

string OpenSim.Region.CoreModules.World.Wind.Plugins.ConfigurableWind.Description
get

Definition at line 160 of file ConfigurableWind.cs.

string OpenSim.Region.CoreModules.World.Wind.Plugins.ConfigurableWind.Name
get

Definition at line 67 of file ConfigurableWind.cs.

string OpenSim.Region.CoreModules.World.Wind.Plugins.ConfigurableWind.Version
get

Definition at line 62 of file ConfigurableWind.cs.


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