aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim/Region/Framework/Interfaces/ITerrainModule.cs
diff options
context:
space:
mode:
Diffstat (limited to 'OpenSim/Region/Framework/Interfaces/ITerrainModule.cs')
-rw-r--r--OpenSim/Region/Framework/Interfaces/ITerrainModule.cs76
1 files changed, 76 insertions, 0 deletions
diff --git a/OpenSim/Region/Framework/Interfaces/ITerrainModule.cs b/OpenSim/Region/Framework/Interfaces/ITerrainModule.cs
new file mode 100644
index 0000000..28f797a
--- /dev/null
+++ b/OpenSim/Region/Framework/Interfaces/ITerrainModule.cs
@@ -0,0 +1,76 @@
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 */
27using System.IO;
28
29using OpenSim.Framework;
30
31using OpenMetaverse;
32
33namespace OpenSim.Region.Framework.Interfaces
34{
35 public interface ITerrainModule
36 {
37 void LoadFromFile(string filename);
38 void SaveToFile(string filename);
39 void ModifyTerrain(UUID user, Vector3 pos, byte size, byte action, UUID agentId);
40
41 /// <summary>
42 /// Taint the terrain. This will lead to sending the terrain data to the clients again.
43 /// Use this if you change terrain data outside of the terrain module (e.g. in osTerrainSetHeight)
44 /// </summary>
45 void TaintTerrain();
46
47 /// <summary>
48 /// When a client initially connects, all the terrain must be pushed to the viewer.
49 /// This call causes all the terrain patches to be sent to the client.
50 /// </summary>
51 void PushTerrain(IClientAPI pClient);
52
53 /// <summary>
54 /// Load a terrain from a stream.
55 /// </summary>
56 /// <param name="filename">
57 /// Only required here to identify the image type. Not otherwise used in the loading itself.
58 /// </param>
59 /// <param name="stream"></param>
60 void LoadFromStream(string filename, Stream stream);
61 void LoadFromStream(string filename, Vector3 displacement, float radianRotation, Vector2 rotationDisplacement, Stream stream);
62 void LoadFromStream(string filename, System.Uri pathToTerrainHeightmap);
63 /// <summary>
64 /// Save a terrain to a stream.
65 /// </summary>
66 /// <param name="filename">
67 /// Only required here to identify the image type. Not otherwise used in the saving itself.
68 /// </param>
69 /// <param name="stream"></param>
70 void SaveToStream(string filename, Stream stream);
71
72 void InstallPlugin(string name, ITerrainEffect plug);
73
74 void UndoTerrain(ITerrainChannel channel);
75 }
76}