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

Public Member Functions

void Initialise (IConfigSource config)
 This is called to initialize the region module. For shared modules, this is called exactly once, after creating the single (shared) instance. For non-shared modules, this is called once on each instance, after the instace for the region has been created. More...
 
void AddRegion (Scene scene)
 This is called whenever a Scene is added. For shared modules, this can happen several times. For non-shared modules, this happens exactly once, after Initialise has been called. More...
 
void RemoveRegion (Scene scene)
 This is called whenever a Scene is removed. For shared modules, this can happen several times. For non-shared modules, this happens exactly once, if the scene this instance is associated with is removed. More...
 
void Close ()
 This is the inverse to Initialise. After a Close(), this instance won't be usable anymore. More...
 
void RegionLoaded (Scene scene)
 This will be called once for every scene loaded. In a shared module this will be multiple times in one instance, while a nonshared module instance will only be called once. This method is called after AddRegion has been called in all modules for that scene, providing an opportunity to request another module's interface, or hook an event from another module. More...
 
Vector3 WindSpeed (int x, int y, int z)
 Retrieve the wind speed at the given region coordinate. This implimentation ignores Z. More...
 
void WindParamSet (string plugin, string param, float value)
 Set Wind Plugin Parameter More...
 
float WindParamGet (string plugin, string param)
 Get Wind Plugin Parameter More...
 
void WindUpdate ()
 Called on each frame update. Updates the wind model and clients as necessary. More...
 
void OnAgentEnteredRegion (ScenePresence avatar)
 

Properties

string Name [get]
 
Type ReplaceableInterface [get]
 
string WindActiveModelPluginName [get]
 
- Properties inherited from OpenSim.Region.Framework.Interfaces.IWindModule
string WindActiveModelPluginName [get]
 Current active wind model plugin or String.Empty More...
 
- Properties inherited from OpenSim.Region.Framework.Interfaces.IRegionModuleBase
string Name [get]
 
Type ReplaceableInterface [get]
 If this returns non-null, it is the type of an interface that this module intends to register. This will cause the loader to defer loading of this module until all other modules have been loaded. If no other module has registered the interface by then, this module will be activated, else it will remain inactive, letting the other module take over. This should return non-null ONLY in modules that are intended to be easily replaceable, e.g. stub implementations that the developer expects to be replaced by third party provided modules. More...
 

Detailed Description

Definition at line 44 of file WindModule.cs.

Member Function Documentation

void OpenSim.Region.CoreModules.WindModule.AddRegion ( Scene  scene)
inline

This is called whenever a Scene is added. For shared modules, this can happen several times. For non-shared modules, this happens exactly once, after Initialise has been called.

Parameters
sceneA Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 92 of file WindModule.cs.

Here is the call graph for this function:

void OpenSim.Region.CoreModules.WindModule.Close ( )
inline

This is the inverse to Initialise. After a Close(), this instance won't be usable anymore.

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 191 of file WindModule.cs.

void OpenSim.Region.CoreModules.WindModule.Initialise ( IConfigSource  source)
inline

This is called to initialize the region module. For shared modules, this is called exactly once, after creating the single (shared) instance. For non-shared modules, this is called once on each instance, after the instace for the region has been created.

Parameters
sourceA IConfigSource

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 66 of file WindModule.cs.

void OpenSim.Region.CoreModules.WindModule.OnAgentEnteredRegion ( ScenePresence  avatar)
inline

Definition at line 429 of file WindModule.cs.

void OpenSim.Region.CoreModules.WindModule.RegionLoaded ( Scene  scene)
inline

This will be called once for every scene loaded. In a shared module this will be multiple times in one instance, while a nonshared module instance will only be called once. This method is called after AddRegion has been called in all modules for that scene, providing an opportunity to request another module's interface, or hook an event from another module.

Parameters
sceneA Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 205 of file WindModule.cs.

void OpenSim.Region.CoreModules.WindModule.RemoveRegion ( Scene  scene)
inline

This is called whenever a Scene is removed. For shared modules, this can happen several times. For non-shared modules, this happens exactly once, if the scene this instance is associated with is removed.

Parameters
sceneA Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 169 of file WindModule.cs.

float OpenSim.Region.CoreModules.WindModule.WindParamGet ( string  plugin,
string  param 
)
inline

Get Wind Plugin Parameter

Implements OpenSim.Region.Framework.Interfaces.IWindModule.

Definition at line 384 of file WindModule.cs.

void OpenSim.Region.CoreModules.WindModule.WindParamSet ( string  plugin,
string  param,
float  value 
)
inline

Set Wind Plugin Parameter

Implements OpenSim.Region.Framework.Interfaces.IWindModule.

Definition at line 371 of file WindModule.cs.

Vector3 OpenSim.Region.CoreModules.WindModule.WindSpeed ( int  x,
int  y,
int  z 
)
inline

Retrieve the wind speed at the given region coordinate. This implimentation ignores Z.

Parameters
x0...255
y0...255

Implements OpenSim.Region.Framework.Interfaces.IWindModule.

Definition at line 359 of file WindModule.cs.

void OpenSim.Region.CoreModules.WindModule.WindUpdate ( )
inline

Called on each frame update. Updates the wind model and clients as necessary.

Definition at line 417 of file WindModule.cs.

Property Documentation

string OpenSim.Region.CoreModules.WindModule.Name
get

Definition at line 196 of file WindModule.cs.

Type OpenSim.Region.CoreModules.WindModule.ReplaceableInterface
get

Definition at line 201 of file WindModule.cs.

string OpenSim.Region.CoreModules.WindModule.WindActiveModelPluginName
get

Definition at line 398 of file WindModule.cs.


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