OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Properties | List of all members
OpenSim.Region.OptionalModules.ViewerSupport.DynamicFloaterModule Class Reference
Inheritance diagram for OpenSim.Region.OptionalModules.ViewerSupport.DynamicFloaterModule:
Inheritance graph
[legend]
Collaboration diagram for OpenSim.Region.OptionalModules.ViewerSupport.DynamicFloaterModule:
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 Close ()
 This is the inverse to Initialise. After a Close(), this instance won't be usable anymore. 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 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...
 
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 DoUserFloater (UUID agentID, FloaterData dialogData, string configuration)
 
void FloaterControl (ScenePresence sp, FloaterData d, string msg)
 

Properties

string Name [get]
 
Type ReplaceableInterface [get]
 
- 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 52 of file DynamicFloaterModule.cs.

Member Function Documentation

void OpenSim.Region.OptionalModules.ViewerSupport.DynamicFloaterModule.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 78 of file DynamicFloaterModule.cs.

void OpenSim.Region.OptionalModules.ViewerSupport.DynamicFloaterModule.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 74 of file DynamicFloaterModule.cs.

void OpenSim.Region.OptionalModules.ViewerSupport.DynamicFloaterModule.DoUserFloater ( UUID  agentID,
FloaterData  dialogData,
string  configuration 
)
inline
void OpenSim.Region.OptionalModules.ViewerSupport.DynamicFloaterModule.FloaterControl ( ScenePresence  sp,
FloaterData  d,
string  msg 
)
inline
void OpenSim.Region.OptionalModules.ViewerSupport.DynamicFloaterModule.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 70 of file DynamicFloaterModule.cs.

void OpenSim.Region.OptionalModules.ViewerSupport.DynamicFloaterModule.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 86 of file DynamicFloaterModule.cs.

void OpenSim.Region.OptionalModules.ViewerSupport.DynamicFloaterModule.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 90 of file DynamicFloaterModule.cs.

Property Documentation

string OpenSim.Region.OptionalModules.ViewerSupport.DynamicFloaterModule.Name
get

Definition at line 61 of file DynamicFloaterModule.cs.

Type OpenSim.Region.OptionalModules.ViewerSupport.DynamicFloaterModule.ReplaceableInterface
get

Definition at line 66 of file DynamicFloaterModule.cs.


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