C# Class OpenSim.Region.CoreModules.World.Terrain.TerrainModule

Inheritance: INonSharedRegionModule, ICommandableModule, ITerrainModule

Datei anzeigen Open project: openmetaversefoundation/fortis-opensim Class Usage Examples

Public Methods

Method	Description
AddRegion ( Scene scene ) : void
Close ( ) : void
Initialise ( IConfigSource config ) : void	Creates and initialises a terrain module for a region
InstallPlugin ( string pluginName, ITerrainEffect effect ) : void
LoadFromFile ( string filename ) : void	Loads a terrain file from disk and installs it in the scene.
LoadFromFile ( string filename, int fileWidth, int fileHeight, int fileStartX, int fileStartY ) : void	Loads a tile from a larger terrain file and installs it into the region.
LoadFromStream ( string filename, Stream stream ) : void	Loads a terrain file from a stream and installs it in the scene.
LoadFromStream ( string filename, Uri pathToTerrainHeightmap ) : void	Loads a terrain file from the specified URI
ModifyTerrain ( UUID user, System.Vector3 pos, byte size, byte action, UUID agentId ) : void	Modify Land
RegionLoaded ( Scene scene ) : void
RemoveRegion ( Scene scene ) : void
SaveToFile ( string filename ) : void	Saves the current heightmap to a specified file.
SaveToStream ( string filename, Stream stream ) : void	Saves the current heightmap to a specified stream.
TaintTerrain ( ) : void
UndoTerrain ( ITerrainChannel channel ) : void
UpdateRevertMap ( ) : void	Saves the current state of the region into the revert map buffer.

Protected Methods

Method	Description
client_OnUnackedTerrain ( IClientAPI client, int patchX, int patchY ) : void

Private Methods

Method	Description
CheckForTerrainUpdates ( ) : void	Checks to see if the terrain has been modified since last check but won't attempt to limit those changes to the limits specified in the estate settings currently invoked by the command line operations in the region server only
CheckForTerrainUpdates ( bool respectEstateSettings ) : void	Checks to see if the terrain has been modified since last check. If it has been modified, every all the terrain patches are sent to the client. If the call is asked to respect the estate settings for terrain_raise_limit and terrain_lower_limit, it will clamp terrain updates between these values currently invoked by client_OnModifyTerrain only and not the Commander interfaces should height map deltas be limited to the estate settings limits
EventManager_OnNewClient ( IClientAPI client ) : void	Installs terrain brush hook to IClientAPI
EventManager_OnPluginConsole ( string args ) : void	Processes commandline input. Do not call directly.
EventManager_OnTerrainTick ( ) : void	Performs updates to the region periodically, synchronising physics and other heightmap aware sections
InstallDefaultEffects ( ) : void	Installs into terrain module the standard suite of brushes
InstallInterfaces ( ) : void
InterfaceBakeTerrain ( Object args ) : void
InterfaceElevateTerrain ( Object args ) : void
InterfaceEnableExperimentalBrushes ( Object args ) : void
InterfaceFillTerrain ( Object args ) : void
InterfaceFlipTerrain ( Object args ) : void
InterfaceLoadFile ( Object args ) : void
InterfaceLoadTileFile ( Object args ) : void
InterfaceLowerTerrain ( Object args ) : void
InterfaceMultiplyTerrain ( Object args ) : void
InterfaceRescaleTerrain ( Object args ) : void
InterfaceRevertTerrain ( Object args ) : void
InterfaceRunPluginEffect ( Object args ) : void
InterfaceSaveFile ( Object args ) : void
InterfaceShowDebugStats ( Object args ) : void
LimitChannelChanges ( int xStart, int yStart ) : bool	Checks to see height deltas in the tainted terrain patch at xStart ,yStart are all within the current estate limits true if changes were limited, false otherwise
LoadPlugins ( ) : void
SendToClients ( float serialised, int x, int y ) : void	Sends a copy of the current terrain to the scenes clients
StoreUndoState ( ) : void
URIFetch ( Uri uri ) : Stream
client_OnBakeTerrain ( IClientAPI remoteClient ) : void
client_OnLandUndo ( IClientAPI client ) : void
client_OnModifyTerrain ( UUID user, float height, float seconds, byte size, byte action, float north, float west, float south, float east, UUID agentId ) : void

Method Details

AddRegion() public method

public AddRegion ( Scene scene ) : void
scene	OpenSim.Region.Framework.Scenes.Scene
return	void

Close() public method

public Close ( ) : void
return	void

Initialise() public method

Creates and initialises a terrain module for a region

public Initialise ( IConfigSource config ) : void
config	IConfigSource	Config for the region
return	void

InstallPlugin() public method

public InstallPlugin ( string pluginName, ITerrainEffect effect ) : void
pluginName	string
effect	ITerrainEffect
return	void

LoadFromFile() public method

Loads a terrain file from disk and installs it in the scene.

public LoadFromFile ( string filename ) : void
filename	string	Filename to terrain file. Type is determined by extension.
return	void

LoadFromFile() public method

Loads a tile from a larger terrain file and installs it into the region.

public LoadFromFile ( string filename, int fileWidth, int fileHeight, int fileStartX, int fileStartY ) : void
filename	string	The terrain file to load
fileWidth	int	The width of the file in units
fileHeight	int	The height of the file in units
fileStartX	int	Where to begin our slice
fileStartY	int	Where to begin our slice
return	void

LoadFromStream() public method

Loads a terrain file from a stream and installs it in the scene.

public LoadFromStream ( string filename, Stream stream ) : void
filename	string	Filename to terrain file. Type is determined by extension.
stream	Stream
return	void

LoadFromStream() public method

Loads a terrain file from the specified URI

public LoadFromStream ( string filename, Uri pathToTerrainHeightmap ) : void
filename	string	The name of the terrain to load
pathToTerrainHeightmap	System.Uri	The URI to the terrain height map
return	void

ModifyTerrain() public method

Modify Land

public ModifyTerrain ( UUID user, System.Vector3 pos, byte size, byte action, UUID agentId ) : void
user	UUID
pos	System.Vector3	Land-position (X,Y,0)
size	byte	The size of the brush (0=small, 1=medium, 2=large)
action	byte	0=LAND_LEVEL, 1=LAND_RAISE, 2=LAND_LOWER, 3=LAND_SMOOTH, 4=LAND_NOISE, 5=LAND_REVERT
agentId	UUID	UUID of script-owner
return	void

RegionLoaded() public method

public RegionLoaded ( Scene scene ) : void
scene	OpenSim.Region.Framework.Scenes.Scene
return	void

RemoveRegion() public method

public RemoveRegion ( Scene scene ) : void
scene	OpenSim.Region.Framework.Scenes.Scene
return	void

SaveToFile() public method

Saves the current heightmap to a specified file.

public SaveToFile ( string filename ) : void
filename	string	The destination filename
return	void

SaveToStream() public method

Saves the current heightmap to a specified stream.

public SaveToStream ( string filename, Stream stream ) : void
filename	string	The destination filename. Used here only to identify the image type
stream	Stream
return	void

TaintTerrain() public method

public TaintTerrain ( ) : void
return	void

UndoTerrain() public method

public UndoTerrain ( ITerrainChannel channel ) : void
channel	ITerrainChannel
return	void

UpdateRevertMap() public method

Saves the current state of the region into the revert map buffer.

public UpdateRevertMap ( ) : void
return	void

client_OnUnackedTerrain() protected method

protected client_OnUnackedTerrain ( IClientAPI client, int patchX, int patchY ) : void
client	IClientAPI
patchX	int
patchY	int
return	void