Inheritance diagram for OpenSim.Region.CoreModules.World.Media.Moap.MoapModule:

Collaboration diagram for OpenSim.Region.CoreModules.World.Media.Moap.MoapModule:

Public Member Functions
void	Initialise (IConfigSource configSource)
	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...

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...

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...

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...

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)

void	OnDeregisterCaps (UUID agentID, Caps caps)

MediaEntry	GetMediaEntry (SceneObjectPart part, int face)
	Get the media entry for a given prim face. More...

void	SetMediaEntry (SceneObjectPart part, int face, MediaEntry me)
	Set the media entry on the face of the given part. More...

void	ClearMediaEntry (SceneObjectPart part, int face)
	Clear the media entry from the face of the given part. More...

Protected Member Functions
void	OnSceneObjectPartCopy (SceneObjectPart copy, SceneObjectPart original, bool userExposed)

void	SetPartMediaFlags (SceneObjectPart part, int face, bool flag)
	Set the media flags on the texture face of the given part. More...

string	HandleObjectMediaMessage (string request, string path, string param, IOSHttpRequest httpRequest, IOSHttpResponse httpResponse)
	Sets or gets per face media textures. More...

string	HandleObjectMediaRequest (ObjectMediaRequest omr)
	Handle a fetch request for media textures More...

string	HandleObjectMediaUpdate (string path, ObjectMediaUpdate omu)
	Handle an update of media textures. More...

string	HandleObjectMediaNavigateMessage (string request, string path, string param, IOSHttpRequest httpRequest, IOSHttpResponse httpResponse)
	Received from the viewer if a user has changed the url of a media texture. More...

void	CheckFaceParam (SceneObjectPart part, int face)
	Check that the face number is valid for the given prim. More...

void	UpdateMediaUrl (SceneObjectPart part, UUID updateId)
	Update the media url of the given part More...

bool	CheckUrlAgainstWhitelist (string rawUrl, string[] whitelist)
	Check the given url against the given whitelist. More...

Protected Attributes
bool	m_isEnabled = true
	Is this module enabled? More...

Scene	m_scene
	The scene to which this module is attached More...

Dictionary< string, UUID >	m_omCapUsers = new Dictionary<string, UUID>()
	Track the ObjectMedia capabilities given to users keyed by path More...

Dictionary< UUID, string >	m_omCapUrls = new Dictionary<UUID, string>()
	Track the ObjectMedia capabilities given to users keyed by agent. Lock m_omCapUsers to manipulate. More...

Dictionary< string, UUID >	m_omuCapUsers = new Dictionary<string, UUID>()
	Track the ObjectMediaUpdate capabilities given to users keyed by path More...

Dictionary< UUID, string >	m_omuCapUrls = new Dictionary<UUID, string>()
	Track the ObjectMediaUpdate capabilities given to users keyed by agent. Lock m_omuCapUsers to manipulate More...

Properties
string	Name `[get]`

Type	ReplaceableInterface `[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 56 of file MoapModule.cs.

Member Function Documentation

void OpenSim.Region.CoreModules.World.Media.Moap.MoapModule.AddRegion ( Scene scene )

inline

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.

Definition at line 103 of file MoapModule.cs.

void OpenSim.Region.CoreModules.World.Media.Moap.MoapModule.CheckFaceParam	(	SceneObjectPart	part,
		int	face
	)

inlineprotected

Check that the face number is valid for the given prim.

Parameters

part
face

Definition at line 554 of file MoapModule.cs.

bool OpenSim.Region.CoreModules.World.Media.Moap.MoapModule.CheckUrlAgainstWhitelist	(	string	rawUrl,
		string[]	whitelist
	)

inlineprotected

Check the given url against the given whitelist.

Parameters

rawUrl
whitelist

Returns: true if the url matches an entry on the whitelist, false otherwise

Definition at line 596 of file MoapModule.cs.

void OpenSim.Region.CoreModules.World.Media.Moap.MoapModule.ClearMediaEntry	(	SceneObjectPart	part,
		int	face
	)

inline

Clear the media entry from the face of the given part.

Parameters

part
face

Implements OpenSim.Region.Framework.Interfaces.IMoapModule.

Definition at line 268 of file MoapModule.cs.

void OpenSim.Region.CoreModules.World.Media.Moap.MoapModule.Close ( )

inline

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 124 of file MoapModule.cs.

MediaEntry OpenSim.Region.CoreModules.World.Media.Moap.MoapModule.GetMediaEntry	(	SceneObjectPart	part,
		int	face
	)

inline

Get the media entry for a given prim face.

A copy of the media entry is returned rather than the original, so this can be altered at will without affecting the original settings.

Parameters

part
face

Returns

Implements OpenSim.Region.Framework.Interfaces.IMoapModule.

Definition at line 205 of file MoapModule.cs.

string OpenSim.Region.CoreModules.World.Media.Moap.MoapModule.HandleObjectMediaMessage	(	string	request,
		string	path,
		string	param,
		IOSHttpRequest	httpRequest,
		IOSHttpResponse	httpResponse
	)

inlineprotected

Sets or gets per face media textures.

Parameters

request
path
param
httpRequest
httpResponse

Returns

Definition at line 299 of file MoapModule.cs.

string OpenSim.Region.CoreModules.World.Media.Moap.MoapModule.HandleObjectMediaNavigateMessage	(	string	request,
		string	path,
		string	param,
		IOSHttpRequest	httpRequest,
		IOSHttpResponse	httpResponse
	)

inlineprotected

Received from the viewer if a user has changed the url of a media texture.

Parameters

request

path

param

httpRequest

/param>

Parameters

httpResponse

/param>

Returns

Definition at line 480 of file MoapModule.cs.

string OpenSim.Region.CoreModules.World.Media.Moap.MoapModule.HandleObjectMediaRequest ( ObjectMediaRequest omr )

inlineprotected

Handle a fetch request for media textures

Parameters

omr

Returns

Definition at line 324 of file MoapModule.cs.

string OpenSim.Region.CoreModules.World.Media.Moap.MoapModule.HandleObjectMediaUpdate	(	string	path,
		ObjectMediaUpdate	omu
	)

inlineprotected

Handle an update of media textures.

Parameters

path	Path on which this request was made
omu	/param> Returns

Definition at line 363 of file MoapModule.cs.

Here is the call graph for this function:

void OpenSim.Region.CoreModules.World.Media.Moap.MoapModule.Initialise ( IConfigSource source )

inline

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.

Definition at line 93 of file MoapModule.cs.

void OpenSim.Region.CoreModules.World.Media.Moap.MoapModule.OnDeregisterCaps	(	UUID	agentID,
		Caps	caps
	)

inline

Definition at line 168 of file MoapModule.cs.

void OpenSim.Region.CoreModules.World.Media.Moap.MoapModule.OnRegisterCaps	(	UUID	agentID,
		Caps	caps
	)

inline

Definition at line 134 of file MoapModule.cs.

void OpenSim.Region.CoreModules.World.Media.Moap.MoapModule.OnSceneObjectPartCopy	(	SceneObjectPart	copy,
		SceneObjectPart	original,
		bool	userExposed
	)

inlineprotected

Definition at line 185 of file MoapModule.cs.

void OpenSim.Region.CoreModules.World.Media.Moap.MoapModule.RegionLoaded ( Scene scene )

inline

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.

Definition at line 114 of file MoapModule.cs.

void OpenSim.Region.CoreModules.World.Media.Moap.MoapModule.RemoveRegion ( Scene scene )

inline

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.

Definition at line 112 of file MoapModule.cs.

void OpenSim.Region.CoreModules.World.Media.Moap.MoapModule.SetMediaEntry	(	SceneObjectPart	part,
		int	face,
		MediaEntry	me
	)

inline

Set the media entry on the face of the given part.

Parameters

part

/param>

Parameters

face
me	If null, then the media entry is cleared.

Implements OpenSim.Region.Framework.Interfaces.IMoapModule.

Definition at line 238 of file MoapModule.cs.

void OpenSim.Region.CoreModules.World.Media.Moap.MoapModule.SetPartMediaFlags	(	SceneObjectPart	part,
		int	face,
		bool	flag
	)

inlineprotected

Set the media flags on the texture face of the given part.

The fact that we need a separate function to do what should be a simple one line operation is BUTT UGLY.

Parameters

part
face
flag

Definition at line 282 of file MoapModule.cs.

void OpenSim.Region.CoreModules.World.Media.Moap.MoapModule.UpdateMediaUrl	(	SceneObjectPart	part,
		UUID	updateId
	)

inlineprotected

Update the media url of the given part

Parameters

part
updateId	The id to attach to this update. Normally, this is the user that changed the texture

Definition at line 573 of file MoapModule.cs.

Member Data Documentation

bool OpenSim.Region.CoreModules.World.Media.Moap.MoapModule.m_isEnabled = true

protected

Is this module enabled?

Definition at line 66 of file MoapModule.cs.

Dictionary<UUID, string> OpenSim.Region.CoreModules.World.Media.Moap.MoapModule.m_omCapUrls = new Dictionary<UUID, string>()

protected

Track the ObjectMedia capabilities given to users keyed by agent. Lock m_omCapUsers to manipulate.

Definition at line 81 of file MoapModule.cs.

Dictionary<string, UUID> OpenSim.Region.CoreModules.World.Media.Moap.MoapModule.m_omCapUsers = new Dictionary<string, UUID>()

protected

Track the ObjectMedia capabilities given to users keyed by path

Definition at line 76 of file MoapModule.cs.

Dictionary<UUID, string> OpenSim.Region.CoreModules.World.Media.Moap.MoapModule.m_omuCapUrls = new Dictionary<UUID, string>()

protected

Track the ObjectMediaUpdate capabilities given to users keyed by agent. Lock m_omuCapUsers to manipulate

Definition at line 91 of file MoapModule.cs.

Dictionary<string, UUID> OpenSim.Region.CoreModules.World.Media.Moap.MoapModule.m_omuCapUsers = new Dictionary<string, UUID>()

protected

Track the ObjectMediaUpdate capabilities given to users keyed by path

Definition at line 86 of file MoapModule.cs.

Scene OpenSim.Region.CoreModules.World.Media.Moap.MoapModule.m_scene

protected

The scene to which this module is attached

Definition at line 71 of file MoapModule.cs.

Property Documentation

string OpenSim.Region.CoreModules.World.Media.Moap.MoapModule.Name

get

Definition at line 60 of file MoapModule.cs.

Type OpenSim.Region.CoreModules.World.Media.Moap.MoapModule.ReplaceableInterface

get

Definition at line 61 of file MoapModule.cs.

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

Region/CoreModules/World/Media/Moap/MoapModule.cs

Public Member Functions

Protected Member Functions

Protected Attributes

Properties

Detailed Description

Member Function Documentation

Member Data Documentation

Property Documentation