OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
LowerModifier.cs
Go to the documentation of this file.
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 OpenSim.Region.CoreModules.World.Terrain;
29 using OpenSim.Region.Framework.Interfaces;
30 
31 namespace OpenSim.Region.CoreModules.World.Terrain.Modifiers
32 {
34  {
35  public LowerModifier(ITerrainModule module) : base(module)
36  {
37  }
38 
39  public override string ModifyTerrain(ITerrainChannel map, string[] args)
40  {
41  string result;
42  if (args.Length < 3)
43  {
44  result = "Usage: " + GetUsage();
45  }
46  else
47  {
49  result = this.parseParameters(args, out data);
50 
51  // Context-specific validation
52  if (result == String.Empty)
53  {
54  if (data.shape == String.Empty)
55  {
56  data.shape = "rectangle";
57  data.x0 = 0;
58  data.y0 = 0;
59  data.dx = map.Width;
60  data.dy = map.Height;
61  }
62  }
63 
64  // if it's all good, then do the work
65  if (result == String.Empty)
66  {
67  this.applyModification(map, data);
68  }
69  }
70 
71  return result;
72  }
73 
74  public override string GetUsage()
75  {
76  string val = "lower <delta> [ -rec=x1,y1,dx[,dy] | -ell=x0,y0,rx[,ry] ] [-taper=<delta2>]"
77  + "\nLowers all points within the specified range by the specified amount.";
78  return val;
79 
80  }
81 
82  public override double operate(double[,] map, TerrainModifierData data, int x, int y)
83  {
84  double factor = this.computeBevel(data, x, y);
85  double result = map[x, y] - (data.elevation - (data.elevation - data.bevelevation) * factor);
86  return result;
87  }
88 
89  }
90 
91 }
92 
override string ModifyTerrain(ITerrainChannel map, string[] args)
Creates the feature.
override double operate(double[,] map, TerrainModifierData data, int x, int y)
Apply the appropriate operation on the specified map, at (x, y).
override string GetUsage()
Gets a string describing the usage.