OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Properties | List of all members
OpenSim.Services.Connectors.SimianGrid.SimianAvatarServiceConnector Class Reference

Connects avatar appearance data to the SimianGrid backend More...

Inheritance diagram for OpenSim.Services.Connectors.SimianGrid.SimianAvatarServiceConnector:
Inheritance graph
[legend]
Collaboration diagram for OpenSim.Services.Connectors.SimianGrid.SimianAvatarServiceConnector:
Collaboration graph
[legend]

Public Member Functions

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 PostInitialise ()
 This is called exactly once after all the shared region-modules have been instanciated and IRegionModuleBase.Initialised. More...
 
void Close ()
 This is the inverse to Initialise. After a Close(), this instance won't be usable anymore. More...
 
 SimianAvatarServiceConnector ()
 
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...
 
 SimianAvatarServiceConnector (IConfigSource source)
 
void Initialise (IConfigSource source)
 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...
 
AvatarAppearance GetAppearance (UUID userID)
 Called by the login service More...
 
bool SetAppearance (UUID userID, AvatarAppearance appearance)
 Called by everyone who can change the avatar data (so, regions) More...
 
AvatarData GetAvatar (UUID userID)
 Called by the login service More...
 
bool SetAvatar (UUID userID, AvatarData avatar)
 Called by everyone who can change the avatar data (so, regions) More...
 
bool ResetAvatar (UUID userID)
 Not sure if it's needed More...
 
bool SetItems (UUID userID, string[] names, string[] values)
 These methods raison d'etre: No need to send the entire avatar data (SetAvatar) for changing attachments More...
 
bool RemoveItems (UUID userID, string[] names)
 

Properties

Type ReplaceableInterface [get]
 
string Name [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

Connects avatar appearance data to the SimianGrid backend

Definition at line 51 of file SimianAvatarServiceConnector.cs.

Constructor & Destructor Documentation

OpenSim.Services.Connectors.SimianGrid.SimianAvatarServiceConnector.SimianAvatarServiceConnector ( )
inline

Definition at line 68 of file SimianAvatarServiceConnector.cs.

OpenSim.Services.Connectors.SimianGrid.SimianAvatarServiceConnector.SimianAvatarServiceConnector ( IConfigSource  source)
inline

Definition at line 75 of file SimianAvatarServiceConnector.cs.

Member Function Documentation

void OpenSim.Services.Connectors.SimianGrid.SimianAvatarServiceConnector.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 70 of file SimianAvatarServiceConnector.cs.

void OpenSim.Services.Connectors.SimianGrid.SimianAvatarServiceConnector.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 66 of file SimianAvatarServiceConnector.cs.

AvatarAppearance OpenSim.Services.Connectors.SimianGrid.SimianAvatarServiceConnector.GetAppearance ( UUID  userID)
inline

Called by the login service

Parameters
userID
Returns

Implements OpenSim.Services.Interfaces.IAvatarService.

Definition at line 117 of file SimianAvatarServiceConnector.cs.

AvatarData OpenSim.Services.Connectors.SimianGrid.SimianAvatarServiceConnector.GetAvatar ( UUID  userID)
inline

Called by the login service

Parameters
userID
Returns

Implements OpenSim.Services.Interfaces.IAvatarService.

Definition at line 185 of file SimianAvatarServiceConnector.cs.

void OpenSim.Services.Connectors.SimianGrid.SimianAvatarServiceConnector.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 80 of file SimianAvatarServiceConnector.cs.

void OpenSim.Services.Connectors.SimianGrid.SimianAvatarServiceConnector.PostInitialise ( )
inline

This is called exactly once after all the shared region-modules have been instanciated and IRegionModuleBase.Initialised.

Implements OpenSim.Region.Framework.Interfaces.ISharedRegionModule.

Definition at line 65 of file SimianAvatarServiceConnector.cs.

void OpenSim.Services.Connectors.SimianGrid.SimianAvatarServiceConnector.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 64 of file SimianAvatarServiceConnector.cs.

bool OpenSim.Services.Connectors.SimianGrid.SimianAvatarServiceConnector.RemoveItems ( UUID  userID,
string[]  names 
)
inline
void OpenSim.Services.Connectors.SimianGrid.SimianAvatarServiceConnector.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 71 of file SimianAvatarServiceConnector.cs.

bool OpenSim.Services.Connectors.SimianGrid.SimianAvatarServiceConnector.ResetAvatar ( UUID  userID)
inline

Not sure if it's needed

Parameters
userID
Returns

Implements OpenSim.Services.Interfaces.IAvatarService.

Definition at line 325 of file SimianAvatarServiceConnector.cs.

bool OpenSim.Services.Connectors.SimianGrid.SimianAvatarServiceConnector.SetAppearance ( UUID  userID,
AvatarAppearance  appearance 
)
inline

Called by everyone who can change the avatar data (so, regions)

Parameters
userID
appearance
Returns

Implements OpenSim.Services.Interfaces.IAvatarService.

Definition at line 153 of file SimianAvatarServiceConnector.cs.

bool OpenSim.Services.Connectors.SimianGrid.SimianAvatarServiceConnector.SetAvatar ( UUID  userID,
AvatarData  avatar 
)
inline

Called by everyone who can change the avatar data (so, regions)

Parameters
userID
avatar
Returns

Implements OpenSim.Services.Interfaces.IAvatarService.

Definition at line 255 of file SimianAvatarServiceConnector.cs.

bool OpenSim.Services.Connectors.SimianGrid.SimianAvatarServiceConnector.SetItems ( UUID  userID,
string[]  names,
string[]  values 
)
inline

These methods raison d'etre: No need to send the entire avatar data (SetAvatar) for changing attachments

Parameters
userID
attach
Returns

Implements OpenSim.Services.Interfaces.IAvatarService.

Definition at line 331 of file SimianAvatarServiceConnector.cs.

Property Documentation

string OpenSim.Services.Connectors.SimianGrid.SimianAvatarServiceConnector.Name
get

Definition at line 69 of file SimianAvatarServiceConnector.cs.

Type OpenSim.Services.Connectors.SimianGrid.SimianAvatarServiceConnector.ReplaceableInterface
get

Definition at line 63 of file SimianAvatarServiceConnector.cs.


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