OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Properties | List of all members
OpenSim.Region.CoreModules.Scripting.VectorRender.VectorRenderModule Class Reference
Inheritance diagram for OpenSim.Region.CoreModules.Scripting.VectorRender.VectorRenderModule:
Inheritance graph
[legend]
Collaboration diagram for OpenSim.Region.CoreModules.Scripting.VectorRender.VectorRenderModule:
Collaboration graph
[legend]

Public Member Functions

 VectorRenderModule ()
 
string GetContentType ()
 
string GetName ()
 
bool SupportsAsynchronous ()
 
IDynamicTexture ConvertUrl (string url, string extraParams)
 
IDynamicTexture ConvertData (string bodyData, string extraParams)
 
bool AsyncConvertUrl (UUID id, string url, string extraParams)
 
bool AsyncConvertData (UUID id, string bodyData, string extraParams)
 
void GetDrawStringSize (string text, string fontName, int fontSize, out double xSize, out double ySize)
 
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...
 
void PostInitialise ()
 This is called exactly once after all the shared region-modules have been instanciated and IRegionModuleBase.Initialised. 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 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 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 Close ()
 This is the inverse to Initialise. After a Close(), this instance won't be usable anymore. 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 50 of file VectorRenderModule.cs.

Constructor & Destructor Documentation

OpenSim.Region.CoreModules.Scripting.VectorRender.VectorRenderModule.VectorRenderModule ( )
inline

Definition at line 65 of file VectorRenderModule.cs.

Member Function Documentation

void OpenSim.Region.CoreModules.Scripting.VectorRender.VectorRenderModule.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
sceneA Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 163 of file VectorRenderModule.cs.

bool OpenSim.Region.CoreModules.Scripting.VectorRender.VectorRenderModule.AsyncConvertData ( UUID  id,
string  bodyData,
string  extraParams 
)
inline
bool OpenSim.Region.CoreModules.Scripting.VectorRender.VectorRenderModule.AsyncConvertUrl ( UUID  id,
string  url,
string  extraParams 
)
inline
void OpenSim.Region.CoreModules.Scripting.VectorRender.VectorRenderModule.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 187 of file VectorRenderModule.cs.

IDynamicTexture OpenSim.Region.CoreModules.Scripting.VectorRender.VectorRenderModule.ConvertData ( string  bodyData,
string  extraParams 
)
inline
IDynamicTexture OpenSim.Region.CoreModules.Scripting.VectorRender.VectorRenderModule.ConvertUrl ( string  url,
string  extraParams 
)
inline
string OpenSim.Region.CoreModules.Scripting.VectorRender.VectorRenderModule.GetContentType ( )
inline
void OpenSim.Region.CoreModules.Scripting.VectorRender.VectorRenderModule.GetDrawStringSize ( string  text,
string  fontName,
int  fontSize,
out double  xSize,
out double  ySize 
)
inline
string OpenSim.Region.CoreModules.Scripting.VectorRender.VectorRenderModule.GetName ( )
inline
void OpenSim.Region.CoreModules.Scripting.VectorRender.VectorRenderModule.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
sourceA IConfigSource

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 144 of file VectorRenderModule.cs.

void OpenSim.Region.CoreModules.Scripting.VectorRender.VectorRenderModule.PostInitialise ( )
inline

This is called exactly once after all the shared region-modules have been instanciated and IRegionModuleBase.Initialised.

Implements OpenSim.Region.Framework.Interfaces.ISharedRegionModule.

Definition at line 159 of file VectorRenderModule.cs.

void OpenSim.Region.CoreModules.Scripting.VectorRender.VectorRenderModule.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
sceneA Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 171 of file VectorRenderModule.cs.

void OpenSim.Region.CoreModules.Scripting.VectorRender.VectorRenderModule.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
sceneA Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 183 of file VectorRenderModule.cs.

bool OpenSim.Region.CoreModules.Scripting.VectorRender.VectorRenderModule.SupportsAsynchronous ( )
inline

Property Documentation

string OpenSim.Region.CoreModules.Scripting.VectorRender.VectorRenderModule.Name
get

Definition at line 192 of file VectorRenderModule.cs.

Type OpenSim.Region.CoreModules.Scripting.VectorRender.VectorRenderModule.ReplaceableInterface
get

Definition at line 197 of file VectorRenderModule.cs.


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