OpenSim::Region::OptionalModules::Scripting::Minimodule::Heightmap Class Reference

Inheritance diagram for OpenSim::Region::OptionalModules::Scripting::Minimodule::Heightmap:

List of all members.

Public Member Functions
	Heightmap (Scene scene)
Protected Member Functions
double	Get (int x, int y)
void	Set (int x, int y, double val)
Properties
double	this [int x, int y] [get, set]
	Returns [or sets] the heightmap value at specified coordinates.
int	Length [get]
	The maximum length of the region (Y axis), exclusive. (eg Height = 256, max Y = 255). Minimum is always 0 inclusive.
int	Width [get]
	The maximum width of the region (X axis), exclusive. (eg Width = 256, max X = 255). Minimum is always 0 inclusive.

---

Constructor & Destructor Documentation

OpenSim::Region::OptionalModules::Scripting::Minimodule::Heightmap::Heightmap

(

Scene

scene

)

[inline]

---

Member Function Documentation

double OpenSim::Region::OptionalModules::Scripting::Minimodule::Heightmap::Get	(	int	x,
		int	y
	)			[inline, protected]

void OpenSim::Region::OptionalModules::Scripting::Minimodule::Heightmap::Set	(	int	x,
		int	y,
		double	val
	)			[inline, protected]

---

Property Documentation

double OpenSim::Region::OptionalModules::Scripting::Minimodule::Heightmap::this[int x, int y] [get, set]

Returns [or sets] the heightmap value at specified coordinates.

Parameters:

	x	X Coordinate
	y	Y Coordinate

Returns:

A value in meters representing height. Can be negative. Value correlates with Z parameter in world coordinates

double heightVal = World.Heightmap[128,128]; World.Heightmap[128,128] *= 5.0; World.Heightmap[128,128] = 25;

Implements OpenSim::Region::OptionalModules::Scripting::Minimodule::IHeightmap.

int OpenSim::Region::OptionalModules::Scripting::Minimodule::Heightmap::Length [get]

The maximum length of the region (Y axis), exclusive. (eg Height = 256, max Y = 255). Minimum is always 0 inclusive.

Host.Console.Info("The terrain length of this region is " + World.Heightmap.Length);

Implements OpenSim::Region::OptionalModules::Scripting::Minimodule::IHeightmap.

int OpenSim::Region::OptionalModules::Scripting::Minimodule::Heightmap::Width [get]

The maximum width of the region (X axis), exclusive. (eg Width = 256, max X = 255). Minimum is always 0 inclusive.

Host.Console.Info("The terrain width of this region is " + World.Heightmap.Width);

Implements OpenSim::Region::OptionalModules::Scripting::Minimodule::IHeightmap.

---

The documentation for this class was generated from the following file:

• /home/sdague/opensim-docsgit/opensim/OpenSim/Region/OptionalModules/Scripting/Minimodule/Heightmap.cs