IAvatarFactoryModule.cs 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104
  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. using System.Collections.Generic;
  28. using OpenMetaverse;
  29. using OpenSim.Framework;
  30. namespace OpenSim.Region.Framework.Interfaces
  31. {
  32. public delegate void ReportOutputAction(string format, params object[] args);
  33. public interface IAvatarFactoryModule
  34. {
  35. void SetAppearance(IScenePresence sp, AvatarAppearance appearance, WearableCacheItem[] cacheItems);
  36. void SetAppearance(IScenePresence sp, Primitive.TextureEntry textureEntry, byte[] visualParams, WearableCacheItem[] cacheItems);
  37. void SetPreferencesHoverZ(UUID agentId, float val);
  38. /// <summary>
  39. /// Send the appearance of an avatar to others in the scene.
  40. /// </summary>
  41. /// <param name="agentId"></param>
  42. /// <returns></returns>
  43. bool SendAppearance(UUID agentId);
  44. /// <summary>
  45. /// Return the baked texture ids of the given agent.
  46. /// </summary>
  47. /// <param name="agentId"></param>
  48. /// <returns>An empty list if this agent has no baked textures (e.g. because it's a child agent)</returns>
  49. Dictionary<BakeType, Primitive.TextureEntryFace> GetBakedTextureFaces(UUID agentId);
  50. WearableCacheItem[] GetCachedItems(UUID agentId);
  51. /// <summary>
  52. /// Save the baked textures for the given agent permanently in the asset database.
  53. /// </summary>
  54. /// <remarks>
  55. /// This is used to preserve apperance textures for NPCs
  56. /// </remarks>
  57. /// <param name="agentId"></param>
  58. /// <returns>true if a valid agent was found, false otherwise</returns>
  59. bool SaveBakedTextures(UUID agentId);
  60. /// <summary>
  61. /// Validate that OpenSim can find the baked textures need to display a given avatar
  62. /// </summary>
  63. /// <param name="client"></param>
  64. /// <param name="checkonly"></param>
  65. /// <returns>
  66. /// true if all the baked textures referenced by the texture IDs exist or the appearance is only using default textures. false otherwise.
  67. /// </returns>
  68. bool ValidateBakedTextureCache(IScenePresence sp);
  69. /// <summary>
  70. /// Request a rebake of textures for an avatar.
  71. /// </summary>
  72. /// <remarks>
  73. /// This will send the request to the viewer, since it's there that the rebake is done.
  74. /// </remarks>
  75. /// <param name="sp">Avatar to rebake.</param>
  76. /// <param name="missingTexturesOnly">
  77. /// If true, only request a rebake for the textures that are missing.
  78. /// If false then we request a rebake of all textures for which we already have references.
  79. /// </param>
  80. /// <returns>
  81. /// Number of rebake requests made. This will depend upon whether we've previously received texture IDs.
  82. /// </returns>
  83. int RequestRebake(IScenePresence sp, bool missingTexturesOnly);
  84. void QueueAppearanceSend(UUID agentid);
  85. void QueueAppearanceSave(UUID agentid);
  86. /// <summary>
  87. /// Get a report about the current state of a scene presence's baked appearance textures.
  88. /// </summary>
  89. /// <param name="sp"></param>
  90. /// <param name="reportOutputAction"></param>
  91. /// <returns></returns>
  92. void WriteBakedTexturesReport(IScenePresence sp, ReportOutputAction reportOutputAction);
  93. }
  94. }