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

Public Member Functions

 J2KDecoderModule ()
 
void Initialise (IConfigSource source)
 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 PostInitialise ()
 This is called exactly once after all the shared region-modules have been instanciated and IRegionModuleBase.Initialised. More...
 
void Close ()
 This is the inverse to Initialise. After a Close(), this instance won't be usable anymore. 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 BeginDecode (UUID assetID, byte[] j2kData, DecodedCallback callback)
 
bool Decode (UUID assetID, byte[] j2kData)
 Provides a synchronous decode so that caller can be assured that this executes before the next line More...
 
bool Decode (UUID assetID, byte[] j2kData, out OpenJPEG.J2KLayerInfo[] layers, out int components)
 Provides a synchronous decode so that caller can be assured that this executes before the next line More...
 
Image DecodeToImage (byte[] j2kData)
 Provides a synchronous decode direct to an image object 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 51 of file J2KDecoderModule.cs.

Constructor & Destructor Documentation

OpenSim.Region.CoreModules.Agent.TextureSender.J2KDecoderModule.J2KDecoderModule ( )
inline

Definition at line 81 of file J2KDecoderModule.cs.

Member Function Documentation

void OpenSim.Region.CoreModules.Agent.TextureSender.J2KDecoderModule.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 94 of file J2KDecoderModule.cs.

void OpenSim.Region.CoreModules.Agent.TextureSender.J2KDecoderModule.BeginDecode ( UUID  assetID,
byte[]  j2kData,
DecodedCallback  callback 
)
inline
void OpenSim.Region.CoreModules.Agent.TextureSender.J2KDecoderModule.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 116 of file J2KDecoderModule.cs.

bool OpenSim.Region.CoreModules.Agent.TextureSender.J2KDecoderModule.Decode ( UUID  assetID,
byte[]  j2kData 
)
inline

Provides a synchronous decode so that caller can be assured that this executes before the next line

Parameters
assetID
j2kData
Returns
true if decode was successful. false otherwise.

Implements OpenSim.Region.Framework.Interfaces.IJ2KDecoder.

Definition at line 174 of file J2KDecoderModule.cs.

bool OpenSim.Region.CoreModules.Agent.TextureSender.J2KDecoderModule.Decode ( UUID  assetID,
byte[]  j2kData,
out OpenJPEG.J2KLayerInfo[]  layers,
out int  components 
)
inline

Provides a synchronous decode so that caller can be assured that this executes before the next line

Parameters
assetID
j2kData
layerslayer data
componentsnumber of components
Returns
true if decode was successful. false otherwise.

Implements OpenSim.Region.Framework.Interfaces.IJ2KDecoder.

Definition at line 181 of file J2KDecoderModule.cs.

Image OpenSim.Region.CoreModules.Agent.TextureSender.J2KDecoderModule.DecodeToImage ( byte[]  j2kData)
inline

Provides a synchronous decode direct to an image object

Parameters
j2kData
Returns
decoded image or 'null' of unsuccessful

Implements OpenSim.Region.Framework.Interfaces.IJ2KDecoder.

Definition at line 186 of file J2KDecoderModule.cs.

void OpenSim.Region.CoreModules.Agent.TextureSender.J2KDecoderModule.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 85 of file J2KDecoderModule.cs.

void OpenSim.Region.CoreModules.Agent.TextureSender.J2KDecoderModule.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 112 of file J2KDecoderModule.cs.

void OpenSim.Region.CoreModules.Agent.TextureSender.J2KDecoderModule.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 120 of file J2KDecoderModule.cs.

void OpenSim.Region.CoreModules.Agent.TextureSender.J2KDecoderModule.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 106 of file J2KDecoderModule.cs.

Property Documentation

string OpenSim.Region.CoreModules.Agent.TextureSender.J2KDecoderModule.Name
get

Definition at line 79 of file J2KDecoderModule.cs.

Type OpenSim.Region.CoreModules.Agent.TextureSender.J2KDecoderModule.ReplaceableInterface
get

Definition at line 125 of file J2KDecoderModule.cs.


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