Inheritance diagram for OpenSim.Region.CoreModules.World.WorldMap.WorldMapModule:

Collaboration diagram for OpenSim.Region.CoreModules.World.WorldMap.WorldMapModule:

Public Member Functions
virtual void	Initialise (IConfigSource config)
	This is called to initialize the region module. For shared modules, this is called exactly once, after creating the single (shared) instance. For non-shared modules, this is called once on each instance, after the instace for the region has been created. More...

virtual void	AddRegion (Scene scene)
	This is called whenever a Scene is added. For shared modules, this can happen several times. For non-shared modules, this happens exactly once, after Initialise has been called. More...

virtual void	RemoveRegion (Scene scene)
	This is called whenever a Scene is removed. For shared modules, this can happen several times. For non-shared modules, this happens exactly once, if the scene this instance is associated with is removed. More...

virtual void	RegionLoaded (Scene scene)
	This will be called once for every scene loaded. In a shared module this will be multiple times in one instance, while a nonshared module instance will only be called once. This method is called after AddRegion has been called in all modules for that scene, providing an opportunity to request another module's interface, or hook an event from another module. More...

virtual void	Close ()
	This is the inverse to Initialise. After a Close(), this instance won't be usable anymore. More...

void	OnRegisterCaps (UUID agentID, Caps caps)

string	MapLayerRequest (string request, string path, string param, UUID agentID, Caps caps)
	Callback for a map layer request More...

LLSDMapLayerResponse	GetMapLayer (LLSDMapRequest mapReq)

virtual void	HandleMapItemRequest (IClientAPI remoteClient, uint flags, uint EstateID, bool godlike, uint itemtype, ulong regionhandle)

void	process ()
	Processing thread main() loop for doing remote mapitem requests More...

void	RequestMapItems (string httpserver, UUID id, uint flags, uint EstateID, bool godlike, uint itemtype, ulong regionhandle)
	Enqueue the MapItem request for remote processing More...

void	RequestMapBlocks (IClientAPI remoteClient, int minX, int minY, int maxX, int maxY, uint flag)
	Requests map blocks in area of minX, maxX, minY, MaxY in world cordinates More...

void	MapBlockFromGridRegion (MapBlockData block, GridRegion r, uint flag)

Hashtable	OnHTTPThrottled (Hashtable keysvals)

Hashtable	OnHTTPGetMapImage (Hashtable keysvals)

void	HandleExportWorldMapConsoleCommand (string module, string[] cmdparams)
	Export the world map More...

void	HandleGenerateMapConsoleCommand (string module, string[] cmdparams)

OSD	HandleRemoteMapItemRequest (string path, OSD request, string endpoint)

void	GenerateMaptile ()
	Generate a map tile for the scene. a terrain texture for this scene More...

void	OnRegionUp (GridRegion otherRegion)

Protected Member Functions
virtual void	AddHandlers ()

virtual void	RemoveHandlers ()

virtual List< MapBlockData >	GetAndSendBlocks (IClientAPI remoteClient, int minX, int minY, int maxX, int maxY, uint flag)

void	MapBlockSendThread ()

virtual List< MapBlockData >	GetAndSendBlocksInternal (IClientAPI remoteClient, int minX, int minY, int maxX, int maxY, uint flag)

Static Protected Member Functions
static OSDMapLayer	GetOSDMapLayerResponse ()

Protected Attributes
Scene	m_scene

volatile bool	m_Enabled = false

Properties
Type	ReplaceableInterface `[get]`

virtual string	Name `[get]`

Properties inherited from OpenSim.Region.Framework.Interfaces.IRegionModuleBase
string	Name `[get]`

Type	ReplaceableInterface `[get]`
	If this returns non-null, it is the type of an interface that this module intends to register. This will cause the loader to defer loading of this module until all other modules have been loaded. If no other module has registered the interface by then, this module will be activated, else it will remain inactive, letting the other module take over. This should return non-null ONLY in modules that are intended to be easily replaceable, e.g. stub implementations that the developer expects to be replaced by third party provided modules. More...

Detailed Description

Definition at line 60 of file WorldMapModule.cs.

Member Function Documentation

virtual void OpenSim.Region.CoreModules.World.WorldMap.WorldMapModule.AddHandlers ( )

inlineprotectedvirtual

Definition at line 172 of file WorldMapModule.cs.

virtual void OpenSim.Region.CoreModules.World.WorldMap.WorldMapModule.AddRegion ( Scene scene )

inlinevirtual

This is called whenever a Scene is added. For shared modules, this can happen several times. For non-shared modules, this happens exactly once, after Initialise has been called.

Parameters

scene A Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Reimplemented in OpenSim.Region.CoreModules.Hypergrid.HGWorldMapModule.

Definition at line 108 of file WorldMapModule.cs.

virtual void OpenSim.Region.CoreModules.World.WorldMap.WorldMapModule.Close ( )

inlinevirtual

This is the inverse to Initialise. After a Close(), this instance won't be usable anymore.

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 155 of file WorldMapModule.cs.

void OpenSim.Region.CoreModules.World.WorldMap.WorldMapModule.GenerateMaptile ( )

inline

Generate a map tile for the scene. a terrain texture for this scene

Implements OpenSim.Region.Framework.Interfaces.IWorldMapModule.

Definition at line 1504 of file WorldMapModule.cs.

virtual List<MapBlockData> OpenSim.Region.CoreModules.World.WorldMap.WorldMapModule.GetAndSendBlocks	(	IClientAPI	remoteClient,
		int	minX,
		int	minY,
		int	maxX,
		int	maxY,
		uint	flag
	)

inlineprotectedvirtual

Definition at line 1068 of file WorldMapModule.cs.

virtual List<MapBlockData> OpenSim.Region.CoreModules.World.WorldMap.WorldMapModule.GetAndSendBlocksInternal	(	IClientAPI	remoteClient,
		int	minX,
		int	minY,
		int	maxX,
		int	maxY,
		uint	flag
	)

inlineprotectedvirtual

Reimplemented in OpenSim.Region.CoreModules.Hypergrid.HGWorldMapModule.

Definition at line 1125 of file WorldMapModule.cs.

LLSDMapLayerResponse OpenSim.Region.CoreModules.World.WorldMap.WorldMapModule.GetMapLayer ( LLSDMapRequest mapReq )

inline

Parameters

mapReq

Returns

Definition at line 325 of file WorldMapModule.cs.

static OSDMapLayer OpenSim.Region.CoreModules.World.WorldMap.WorldMapModule.GetOSDMapLayerResponse ( )

inlinestaticprotected

Returns

Definition at line 337 of file WorldMapModule.cs.

void OpenSim.Region.CoreModules.World.WorldMap.WorldMapModule.HandleExportWorldMapConsoleCommand	(	string	module,
		string[]	cmdparams
	)

inline

Export the world map

Parameters

fileName

Definition at line 1310 of file WorldMapModule.cs.

void OpenSim.Region.CoreModules.World.WorldMap.WorldMapModule.HandleGenerateMapConsoleCommand	(	string	module,
		string[]	cmdparams
	)

inline

Definition at line 1383 of file WorldMapModule.cs.

virtual void OpenSim.Region.CoreModules.World.WorldMap.WorldMapModule.HandleMapItemRequest	(	IClientAPI	remoteClient,
		uint	flags,
		uint	EstateID,
		bool	godlike,
		uint	itemtype,
		ulong	regionhandle
	)

inlinevirtual

Definition at line 439 of file WorldMapModule.cs.

OSD OpenSim.Region.CoreModules.World.WorldMap.WorldMapModule.HandleRemoteMapItemRequest	(	string	path,
		OSD	request,
		string	endpoint
	)

inline

Definition at line 1393 of file WorldMapModule.cs.

virtual void OpenSim.Region.CoreModules.World.WorldMap.WorldMapModule.Initialise ( IConfigSource source )

inlinevirtual

This is called to initialize the region module. For shared modules, this is called exactly once, after creating the single (shared) instance. For non-shared modules, this is called once on each instance, after the instace for the region has been created.

Parameters

source A IConfigSource

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Reimplemented in OpenSim.Region.CoreModules.Hypergrid.HGWorldMapModule.

Definition at line 97 of file WorldMapModule.cs.

void OpenSim.Region.CoreModules.World.WorldMap.WorldMapModule.MapBlockFromGridRegion	(	MapBlockData	block,
		GridRegion	r,
		uint	flag
	)

inline

Implements OpenSim.Region.Framework.Interfaces.IWorldMapModule.

Definition at line 1175 of file WorldMapModule.cs.

void OpenSim.Region.CoreModules.World.WorldMap.WorldMapModule.MapBlockSendThread ( )

inlineprotected

Definition at line 1090 of file WorldMapModule.cs.

string OpenSim.Region.CoreModules.World.WorldMap.WorldMapModule.MapLayerRequest	(	string	request,
		string	path,
		string	param,
		UUID	agentID,
		Caps	caps
	)

inline

Callback for a map layer request

Parameters

request
path
param
agentID
caps

Returns

Definition at line 246 of file WorldMapModule.cs.

Hashtable OpenSim.Region.CoreModules.World.WorldMap.WorldMapModule.OnHTTPGetMapImage ( Hashtable keysvals )

inline

Definition at line 1217 of file WorldMapModule.cs.

Hashtable OpenSim.Region.CoreModules.World.WorldMap.WorldMapModule.OnHTTPThrottled ( Hashtable keysvals )

inline

Definition at line 1207 of file WorldMapModule.cs.

void OpenSim.Region.CoreModules.World.WorldMap.WorldMapModule.OnRegionUp ( GridRegion otherRegion )

inline

Definition at line 1659 of file WorldMapModule.cs.

void OpenSim.Region.CoreModules.World.WorldMap.WorldMapModule.OnRegisterCaps	(	UUID	agentID,
		Caps	caps
	)

inline

Definition at line 222 of file WorldMapModule.cs.

void OpenSim.Region.CoreModules.World.WorldMap.WorldMapModule.process ( )

inline

Processing thread main() loop for doing remote mapitem requests

Definition at line 704 of file WorldMapModule.cs.

virtual void OpenSim.Region.CoreModules.World.WorldMap.WorldMapModule.RegionLoaded ( Scene scene )

inlinevirtual

This will be called once for every scene loaded. In a shared module this will be multiple times in one instance, while a nonshared module instance will only be called once. This method is called after AddRegion has been called in all modules for that scene, providing an opportunity to request another module's interface, or hook an event from another module.

Parameters

scene A Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Reimplemented in OpenSim.Region.CoreModules.Hypergrid.HGWorldMapModule.

Definition at line 146 of file WorldMapModule.cs.

virtual void OpenSim.Region.CoreModules.World.WorldMap.WorldMapModule.RemoveHandlers ( )

inlineprotectedvirtual

Definition at line 204 of file WorldMapModule.cs.

virtual void OpenSim.Region.CoreModules.World.WorldMap.WorldMapModule.RemoveRegion ( Scene scene )

inlinevirtual

This is called whenever a Scene is removed. For shared modules, this can happen several times. For non-shared modules, this happens exactly once, if the scene this instance is associated with is removed.

Parameters

scene A Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Reimplemented in OpenSim.Region.CoreModules.Hypergrid.HGWorldMapModule.

Definition at line 133 of file WorldMapModule.cs.

void OpenSim.Region.CoreModules.World.WorldMap.WorldMapModule.RequestMapBlocks	(	IClientAPI	remoteClient,
		int	minX,
		int	minY,
		int	maxX,
		int	maxY,
		uint	flag
	)

inline

Requests map blocks in area of minX, maxX, minY, MaxY in world cordinates

Parameters

minX
minY
maxX
maxY

Definition at line 1061 of file WorldMapModule.cs.

void OpenSim.Region.CoreModules.World.WorldMap.WorldMapModule.RequestMapItems	(	string	httpserver,
		UUID	id,
		uint	flags,
		uint	EstateID,
		bool	godlike,
		uint	itemtype,
		ulong	regionhandle
	)

inline

Enqueue the MapItem request for remote processing

Parameters

httpserver	blank string, we discover this in the process
id	Agent ID that we are making this request on behalf
flags	passed in from packet
EstateID	passed in from packet
godlike	passed in from packet
itemtype	passed in from packet
regionhandle	Region we're looking up

Definition at line 827 of file WorldMapModule.cs.

Member Data Documentation

volatile bool OpenSim.Region.CoreModules.World.WorldMap.WorldMapModule.m_Enabled = false

protected

Definition at line 82 of file WorldMapModule.cs.

Scene OpenSim.Region.CoreModules.World.WorldMap.WorldMapModule.m_scene

protected

Definition at line 79 of file WorldMapModule.cs.

Property Documentation

virtual string OpenSim.Region.CoreModules.World.WorldMap.WorldMapModule.Name

get

Definition at line 165 of file WorldMapModule.cs.

Type OpenSim.Region.CoreModules.World.WorldMap.WorldMapModule.ReplaceableInterface

get

Definition at line 160 of file WorldMapModule.cs.

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

Region/CoreModules/World/WorldMap/WorldMapModule.cs

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Properties

Detailed Description

Member Function Documentation

Member Data Documentation

Property Documentation