OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | List of all members
OpenSim.Region.Framework.Interfaces.ITerrainModule Interface Reference
Inheritance diagram for OpenSim.Region.Framework.Interfaces.ITerrainModule:
Inheritance graph
[legend]

Public Member Functions

void LoadFromFile (string filename)
 
void SaveToFile (string filename)
 
void ModifyTerrain (UUID user, Vector3 pos, byte size, byte action, UUID agentId)
 
void TaintTerrain ()
 Taint the terrain. This will lead to sending the terrain data to the clients again. Use this if you change terrain data outside of the terrain module (e.g. in osTerrainSetHeight) More...
 
void PushTerrain (IClientAPI pClient)
 When a client initially connects, all the terrain must be pushed to the viewer. This call causes all the terrain patches to be sent to the client. More...
 
void LoadFromStream (string filename, Stream stream)
 Load a terrain from a stream. More...
 
void LoadFromStream (string filename, System.Uri pathToTerrainHeightmap)
 
void LoadFromStream (string filename, Vector3 displacement, float radianRotation, Vector2 rotationDisplacement, Stream stream)
 
void LoadFromStream (string filename, Vector3 displacement, float rotationDegress, Vector2 boundingOrigin, Vector2 boundingSize, Stream stream)
 
void SaveToStream (string filename, Stream stream)
 Save a terrain to a stream. More...
 
void InstallPlugin (string name, ITerrainEffect plug)
 
void UndoTerrain (ITerrainChannel channel)
 

Detailed Description

Definition at line 34 of file ITerrainModule.cs.

Member Function Documentation

void OpenSim.Region.Framework.Interfaces.ITerrainModule.InstallPlugin ( string  name,
ITerrainEffect  plug 
)
void OpenSim.Region.Framework.Interfaces.ITerrainModule.LoadFromFile ( string  filename)
void OpenSim.Region.Framework.Interfaces.ITerrainModule.LoadFromStream ( string  filename,
Stream  stream 
)

Load a terrain from a stream.

Parameters
filenameOnly required here to identify the image type. Not otherwise used in the loading itself.
stream

Implemented in OpenSim.Region.CoreModules.World.Terrain.TerrainModule.

void OpenSim.Region.Framework.Interfaces.ITerrainModule.LoadFromStream ( string  filename,
System.Uri  pathToTerrainHeightmap 
)
void OpenSim.Region.Framework.Interfaces.ITerrainModule.LoadFromStream ( string  filename,
Vector3  displacement,
float  radianRotation,
Vector2  rotationDisplacement,
Stream  stream 
)
void OpenSim.Region.Framework.Interfaces.ITerrainModule.LoadFromStream ( string  filename,
Vector3  displacement,
float  rotationDegress,
Vector2  boundingOrigin,
Vector2  boundingSize,
Stream  stream 
)
void OpenSim.Region.Framework.Interfaces.ITerrainModule.ModifyTerrain ( UUID  user,
Vector3  pos,
byte  size,
byte  action,
UUID  agentId 
)
void OpenSim.Region.Framework.Interfaces.ITerrainModule.PushTerrain ( IClientAPI  pClient)

When a client initially connects, all the terrain must be pushed to the viewer. This call causes all the terrain patches to be sent to the client.

Implemented in OpenSim.Region.CoreModules.World.Terrain.TerrainModule.

void OpenSim.Region.Framework.Interfaces.ITerrainModule.SaveToFile ( string  filename)
void OpenSim.Region.Framework.Interfaces.ITerrainModule.SaveToStream ( string  filename,
Stream  stream 
)

Save a terrain to a stream.

Parameters
filenameOnly required here to identify the image type. Not otherwise used in the saving itself.
stream

Implemented in OpenSim.Region.CoreModules.World.Terrain.TerrainModule.

void OpenSim.Region.Framework.Interfaces.ITerrainModule.TaintTerrain ( )

Taint the terrain. This will lead to sending the terrain data to the clients again. Use this if you change terrain data outside of the terrain module (e.g. in osTerrainSetHeight)

Implemented in OpenSim.Region.CoreModules.World.Terrain.TerrainModule.

void OpenSim.Region.Framework.Interfaces.ITerrainModule.UndoTerrain ( ITerrainChannel  channel)

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