1
0

IMoapModule.cs 2.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  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;
  28. using OpenMetaverse;
  29. using OpenSim.Region.Framework.Scenes;
  30. namespace OpenSim.Region.Framework.Interfaces
  31. {
  32. /// <summary>
  33. /// Provides methods from manipulating media-on-a-prim
  34. /// </summary>
  35. public interface IMoapModule
  36. {
  37. /// <summary>
  38. /// Get the media entry for a given prim face.
  39. /// </summary>
  40. /// A copy of the media entry is returned rather than the original, so this can be altered at will without
  41. /// affecting the original settings.
  42. /// <param name="part"></param>
  43. /// <param name="face"></param>
  44. /// <returns></returns>
  45. MediaEntry GetMediaEntry(SceneObjectPart part, int face);
  46. /// <summary>
  47. /// Set the media entry for a given prim face.
  48. /// </summary>
  49. /// <param name="SceneObjectPart"></param>
  50. /// <param name="face"></param>
  51. /// <param name="me"></param>
  52. void SetMediaEntry(SceneObjectPart part, int face, MediaEntry me);
  53. /// <summary>
  54. /// Clear the media entry for a given prim face.
  55. /// </summary>
  56. ///
  57. /// This is the equivalent of setting a media entry of null
  58. ///
  59. /// <param name="part"></param>
  60. /// <param name="face">/param>
  61. void ClearMediaEntry(SceneObjectPart part, int face);
  62. }
  63. }