OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Public Attributes | Properties | List of all members
OpenSim.Region.CoreModules.Avatar.AvatarFactory.AvatarFactoryModule Class Reference
Inheritance diagram for OpenSim.Region.CoreModules.Avatar.AvatarFactory.AvatarFactoryModule:
Inheritance graph
[legend]
Collaboration diagram for OpenSim.Region.CoreModules.Avatar.AvatarFactory.AvatarFactoryModule:
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 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 Close ()
 This is the inverse to Initialise. After a Close(), this instance won't be usable anymore. More...
 
void SetAppearance (IScenePresence sp, AvatarAppearance appearance, WearableCacheItem[] cacheItems)
 
void SetAppearance (IScenePresence sp, Primitive.TextureEntry textureEntry, byte[] visualParams, Vector3 avSize, WearableCacheItem[] cacheItems)
 
void SetAppearance (IScenePresence sp, Primitive.TextureEntry textureEntry, byte[] visualParams, WearableCacheItem[] cacheItems)
 Set appearance data (texture asset IDs and slider settings) More...
 
bool SendAppearance (UUID agentId)
 Send the appearance of an avatar to others in the scene. More...
 
Dictionary< BakeType,
Primitive.TextureEntryFace > 
GetBakedTextureFaces (UUID agentId)
 Return the baked texture ids of the given agent. More...
 
WearableCacheItem[] GetCachedItems (UUID agentId)
 
bool SaveBakedTextures (UUID agentId)
 Save the baked textures for the given agent permanently in the asset database. More...
 
void QueueAppearanceSend (UUID agentid)
 Queue up a request to send appearance. More...
 
void QueueAppearanceSave (UUID agentid)
 
bool UpdateBakedTextureCache (IScenePresence sp, WearableCacheItem[] cacheItems)
 
bool ValidateBakedTextureCache (IScenePresence sp)
 Validate that OpenSim can find the baked textures need to display a given avatar More...
 
int RequestRebake (IScenePresence sp, bool missingTexturesOnly)
 Request a rebake of textures for an avatar. More...
 
void WriteBakedTexturesReport (IScenePresence sp, ReportOutputAction outputAction)
 Get a report about the current state of a scene presence's baked appearance textures. More...
 

Public Attributes

const string BAKED_TEXTURES_REPORT_FORMAT = "{0,-9} {1}"
 

Properties

string Name [get]
 
bool IsSharedModule [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 48 of file AvatarFactoryModule.cs.

Member Function Documentation

void OpenSim.Region.CoreModules.Avatar.AvatarFactory.AvatarFactoryModule.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 84 of file AvatarFactoryModule.cs.

void OpenSim.Region.CoreModules.Avatar.AvatarFactory.AvatarFactoryModule.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 112 of file AvatarFactoryModule.cs.

Dictionary<BakeType, Primitive.TextureEntryFace> OpenSim.Region.CoreModules.Avatar.AvatarFactory.AvatarFactoryModule.GetBakedTextureFaces ( UUID  agentId)
inline

Return the baked texture ids of the given agent.

Parameters
agentId
Returns
An empty list if this agent has no baked textures (e.g. because it's a child agent)

Implements OpenSim.Region.Framework.Interfaces.IAvatarFactoryModule.

Definition at line 254 of file AvatarFactoryModule.cs.

WearableCacheItem [] OpenSim.Region.CoreModules.Avatar.AvatarFactory.AvatarFactoryModule.GetCachedItems ( UUID  agentId)
inline
void OpenSim.Region.CoreModules.Avatar.AvatarFactory.AvatarFactoryModule.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 69 of file AvatarFactoryModule.cs.

void OpenSim.Region.CoreModules.Avatar.AvatarFactory.AvatarFactoryModule.QueueAppearanceSave ( UUID  agentid)
inline
void OpenSim.Region.CoreModules.Avatar.AvatarFactory.AvatarFactoryModule.QueueAppearanceSend ( UUID  agentid)
inline

Queue up a request to send appearance.

Makes it possible to accumulate changes without sending out each one separately.

Parameters
agentId

Implements OpenSim.Region.Framework.Interfaces.IAvatarFactoryModule.

Definition at line 332 of file AvatarFactoryModule.cs.

void OpenSim.Region.CoreModules.Avatar.AvatarFactory.AvatarFactoryModule.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 104 of file AvatarFactoryModule.cs.

void OpenSim.Region.CoreModules.Avatar.AvatarFactory.AvatarFactoryModule.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 93 of file AvatarFactoryModule.cs.

int OpenSim.Region.CoreModules.Avatar.AvatarFactory.AvatarFactoryModule.RequestRebake ( IScenePresence  sp,
bool  missingTexturesOnly 
)
inline

Request a rebake of textures for an avatar.

This will send the request to the viewer, since it's there that the rebake is done.

Parameters
spAvatar to rebake.
missingTexturesOnlyIf true, only request a rebake for the textures that are missing. If false then we request a rebake of all textures for which we already have references.
Returns
Number of rebake requests made. This will depend upon whether we've previously received texture IDs.

Implements OpenSim.Region.Framework.Interfaces.IAvatarFactoryModule.

Definition at line 700 of file AvatarFactoryModule.cs.

bool OpenSim.Region.CoreModules.Avatar.AvatarFactory.AvatarFactoryModule.SaveBakedTextures ( UUID  agentId)
inline

Save the baked textures for the given agent permanently in the asset database.

This is used to preserve apperance textures for NPCs

Parameters
agentId
Returns
true if a valid agent was found, false otherwise

Implements OpenSim.Region.Framework.Interfaces.IAvatarFactoryModule.

Definition at line 275 of file AvatarFactoryModule.cs.

bool OpenSim.Region.CoreModules.Avatar.AvatarFactory.AvatarFactoryModule.SendAppearance ( UUID  agentId)
inline

Send the appearance of an avatar to others in the scene.

Parameters
agentId
Returns

Implements OpenSim.Region.Framework.Interfaces.IAvatarFactoryModule.

Definition at line 238 of file AvatarFactoryModule.cs.

void OpenSim.Region.CoreModules.Avatar.AvatarFactory.AvatarFactoryModule.SetAppearance ( IScenePresence  sp,
AvatarAppearance  appearance,
WearableCacheItem[]  cacheItems 
)
inline
Parameters
sp
texture
visualParam

Implements OpenSim.Region.Framework.Interfaces.IAvatarFactoryModule.

Definition at line 148 of file AvatarFactoryModule.cs.

Here is the call graph for this function:

void OpenSim.Region.CoreModules.Avatar.AvatarFactory.AvatarFactoryModule.SetAppearance ( IScenePresence  sp,
Primitive.TextureEntry  textureEntry,
byte[]  visualParams,
Vector3  avSize,
WearableCacheItem[]  cacheItems 
)
inline

Definition at line 154 of file AvatarFactoryModule.cs.

Here is the call graph for this function:

void OpenSim.Region.CoreModules.Avatar.AvatarFactory.AvatarFactoryModule.SetAppearance ( IScenePresence  sp,
Primitive.TextureEntry  textureEntry,
byte[]  visualParams,
WearableCacheItem[]  cacheItems 
)
inline

Set appearance data (texture asset IDs and slider settings)

Parameters
sp
texture
visualParam

Implements OpenSim.Region.Framework.Interfaces.IAvatarFactoryModule.

Definition at line 174 of file AvatarFactoryModule.cs.

bool OpenSim.Region.CoreModules.Avatar.AvatarFactory.AvatarFactoryModule.UpdateBakedTextureCache ( IScenePresence  sp,
WearableCacheItem[]  cacheItems 
)
inline

Definition at line 359 of file AvatarFactoryModule.cs.

bool OpenSim.Region.CoreModules.Avatar.AvatarFactory.AvatarFactoryModule.ValidateBakedTextureCache ( IScenePresence  sp)
inline

Validate that OpenSim can find the baked textures need to display a given avatar

Parameters
client
checkonly
Returns
true if all the baked textures referenced by the texture IDs exist or the appearance is only using default textures. false otherwise.

Implements OpenSim.Region.Framework.Interfaces.IAvatarFactoryModule.

Definition at line 504 of file AvatarFactoryModule.cs.

Here is the call graph for this function:

void OpenSim.Region.CoreModules.Avatar.AvatarFactory.AvatarFactoryModule.WriteBakedTexturesReport ( IScenePresence  sp,
ReportOutputAction  reportOutputAction 
)
inline

Get a report about the current state of a scene presence's baked appearance textures.

Parameters
sp
reportOutputAction
Returns

Implements OpenSim.Region.Framework.Interfaces.IAvatarFactoryModule.

Definition at line 1341 of file AvatarFactoryModule.cs.

Member Data Documentation

const string OpenSim.Region.CoreModules.Avatar.AvatarFactory.AvatarFactoryModule.BAKED_TEXTURES_REPORT_FORMAT = "{0,-9} {1}"

Definition at line 52 of file AvatarFactoryModule.cs.

Property Documentation

bool OpenSim.Region.CoreModules.Avatar.AvatarFactory.AvatarFactoryModule.IsSharedModule
get

Definition at line 122 of file AvatarFactoryModule.cs.

string OpenSim.Region.CoreModules.Avatar.AvatarFactory.AvatarFactoryModule.Name
get

Definition at line 117 of file AvatarFactoryModule.cs.

Type OpenSim.Region.CoreModules.Avatar.AvatarFactory.AvatarFactoryModule.ReplaceableInterface
get

Definition at line 127 of file AvatarFactoryModule.cs.


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