diff options
Diffstat (limited to 'OpenSim/Region/Framework/Interfaces/IAvatarFactoryModule.cs')
-rw-r--r-- | OpenSim/Region/Framework/Interfaces/IAvatarFactoryModule.cs | 104 |
1 files changed, 104 insertions, 0 deletions
diff --git a/OpenSim/Region/Framework/Interfaces/IAvatarFactoryModule.cs b/OpenSim/Region/Framework/Interfaces/IAvatarFactoryModule.cs new file mode 100644 index 0000000..d25c930 --- /dev/null +++ b/OpenSim/Region/Framework/Interfaces/IAvatarFactoryModule.cs | |||
@@ -0,0 +1,104 @@ | |||
1 | /* | ||
2 | * Copyright (c) Contributors, http://opensimulator.org/ | ||
3 | * See CONTRIBUTORS.TXT for a full list of copyright holders. | ||
4 | * | ||
5 | * Redistribution and use in source and binary forms, with or without | ||
6 | * modification, are permitted provided that the following conditions are met: | ||
7 | * * Redistributions of source code must retain the above copyright | ||
8 | * notice, this list of conditions and the following disclaimer. | ||
9 | * * Redistributions in binary form must reproduce the above copyright | ||
10 | * notice, this list of conditions and the following disclaimer in the | ||
11 | * documentation and/or other materials provided with the distribution. | ||
12 | * * Neither the name of the OpenSimulator Project nor the | ||
13 | * names of its contributors may be used to endorse or promote products | ||
14 | * derived from this software without specific prior written permission. | ||
15 | * | ||
16 | * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY | ||
17 | * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED | ||
18 | * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | ||
19 | * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY | ||
20 | * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES | ||
21 | * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; | ||
22 | * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND | ||
23 | * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
24 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | ||
25 | * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
26 | */ | ||
27 | |||
28 | using System.Collections.Generic; | ||
29 | using OpenMetaverse; | ||
30 | using OpenSim.Framework; | ||
31 | |||
32 | namespace OpenSim.Region.Framework.Interfaces | ||
33 | { | ||
34 | public delegate void ReportOutputAction(string format, params object[] args); | ||
35 | |||
36 | public interface IAvatarFactoryModule | ||
37 | { | ||
38 | void SetAppearance(IScenePresence sp, AvatarAppearance appearance, WearableCacheItem[] cacheItems); | ||
39 | void SetAppearance(IScenePresence sp, Primitive.TextureEntry textureEntry, byte[] visualParams, WearableCacheItem[] cacheItems); | ||
40 | |||
41 | /// <summary> | ||
42 | /// Send the appearance of an avatar to others in the scene. | ||
43 | /// </summary> | ||
44 | /// <param name="agentId"></param> | ||
45 | /// <returns></returns> | ||
46 | bool SendAppearance(UUID agentId); | ||
47 | |||
48 | /// <summary> | ||
49 | /// Return the baked texture ids of the given agent. | ||
50 | /// </summary> | ||
51 | /// <param name="agentId"></param> | ||
52 | /// <returns>An empty list if this agent has no baked textures (e.g. because it's a child agent)</returns> | ||
53 | Dictionary<BakeType, Primitive.TextureEntryFace> GetBakedTextureFaces(UUID agentId); | ||
54 | |||
55 | |||
56 | WearableCacheItem[] GetCachedItems(UUID agentId); | ||
57 | /// <summary> | ||
58 | /// Save the baked textures for the given agent permanently in the asset database. | ||
59 | /// </summary> | ||
60 | /// <remarks> | ||
61 | /// This is used to preserve apperance textures for NPCs | ||
62 | /// </remarks> | ||
63 | /// <param name="agentId"></param> | ||
64 | /// <returns>true if a valid agent was found, false otherwise</returns> | ||
65 | bool SaveBakedTextures(UUID agentId); | ||
66 | |||
67 | /// <summary> | ||
68 | /// Validate that OpenSim can find the baked textures need to display a given avatar | ||
69 | /// </summary> | ||
70 | /// <param name="client"></param> | ||
71 | /// <param name="checkonly"></param> | ||
72 | /// <returns> | ||
73 | /// true if all the baked textures referenced by the texture IDs exist or the appearance is only using default textures. false otherwise. | ||
74 | /// </returns> | ||
75 | bool ValidateBakedTextureCache(IScenePresence sp); | ||
76 | |||
77 | /// <summary> | ||
78 | /// Request a rebake of textures for an avatar. | ||
79 | /// </summary> | ||
80 | /// <remarks> | ||
81 | /// This will send the request to the viewer, since it's there that the rebake is done. | ||
82 | /// </remarks> | ||
83 | /// <param name="sp">Avatar to rebake.</param> | ||
84 | /// <param name="missingTexturesOnly"> | ||
85 | /// If true, only request a rebake for the textures that are missing. | ||
86 | /// If false then we request a rebake of all textures for which we already have references. | ||
87 | /// </param> | ||
88 | /// <returns> | ||
89 | /// Number of rebake requests made. This will depend upon whether we've previously received texture IDs. | ||
90 | /// </returns> | ||
91 | int RequestRebake(IScenePresence sp, bool missingTexturesOnly); | ||
92 | |||
93 | void QueueAppearanceSend(UUID agentid); | ||
94 | void QueueAppearanceSave(UUID agentid); | ||
95 | |||
96 | /// <summary> | ||
97 | /// Get a report about the current state of a scene presence's baked appearance textures. | ||
98 | /// </summary> | ||
99 | /// <param name="sp"></param> | ||
100 | /// <param name="reportOutputAction"></param> | ||
101 | /// <returns></returns> | ||
102 | void WriteBakedTexturesReport(IScenePresence sp, ReportOutputAction reportOutputAction); | ||
103 | } | ||
104 | } \ No newline at end of file | ||