clockwerk-opensim – Blame information for rev 1

Subversion Repositories:
Rev:
Rev Author Line No. Line
1 vero 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.IO;
29 using OpenSim.Region.Framework.Interfaces;
30  
31 namespace OpenSim.Region.CoreModules.World.Terrain
32 {
33 public interface ITerrainLoader
34 {
35 // Returns true if that extension can be used for terrain save-tile
36 // (Look into each file in Region.CoreModules.World.Terrain.FileLoaders)
37 bool SupportsTileSave();
38  
39 string FileExtension { get; }
40 ITerrainChannel LoadFile(string filename);
41 ITerrainChannel LoadFile(string filename, int fileStartX, int fileStartY, int fileWidth, int fileHeight, int sectionWidth, int sectionHeight);
42 ITerrainChannel LoadStream(Stream stream);
43 void SaveFile(string filename, ITerrainChannel map);
44 void SaveStream(Stream stream, ITerrainChannel map);
45  
46 /// <summary>
47 /// Save a number of map tiles to a single big image file.
48 /// </summary>
49 /// <remarks>
50 /// If the image file already exists then the tiles saved will replace those already in the file - other tiles
51 /// will be untouched.
52 /// </remarks>
53 /// <param name="filename">The terrain file to save</param>
54 /// <param name="offsetX">The map x co-ordinate at which to begin the save.</param>
55 /// <param name="offsetY">The may y co-ordinate at which to begin the save.</param>
56 /// <param name="fileWidth">The number of tiles to save along the X axis.</param>
57 /// <param name="fileHeight">The number of tiles to save along the Y axis.</param>
58 /// <param name="regionSizeX">The width of a map tile.</param>
59 /// <param name="regionSizeY">The height of a map tile.</param>
60 void SaveFile(ITerrainChannel map, string filename, int offsetX, int offsetY, int fileWidth, int fileHeight, int regionSizeX, int regionSizeY);
61 }
62 }