OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Properties | Events | List of all members
OpenSim.Region.Framework.Scenes.SceneManager Class Reference

Manager for adding, closing and restarting scenes. More...

Public Member Functions

 SceneManager ()
 
void Close ()
 
void Close (Scene cscene)
 
void Add (Scene scene)
 
void HandleRestart (RegionInfo rdata)
 
void SendSimOnlineNotification (ulong regionHandle)
 
void SaveCurrentSceneToXml (string filename)
 Save the prims in the current scene to an xml file in OpenSimulator's original 'xml' format More...
 
void LoadCurrentSceneFromXml (string filename, bool generateNewIDs, Vector3 loadOffset)
 Load an xml file of prims in OpenSimulator's original 'xml' file format to the current scene More...
 
void SaveCurrentSceneToXml2 (string filename)
 Save the prims in the current scene to an xml file in OpenSimulator's current 'xml2' format More...
 
void SaveNamedPrimsToXml2 (string primName, string filename)
 
void LoadCurrentSceneFromXml2 (string filename)
 Load an xml file of prims in OpenSimulator's current 'xml2' file format to the current scene More...
 
void SaveCurrentSceneToArchive (string[] cmdparams)
 Save the current scene to an OpenSimulator archive. This archive will eventually include the prim's assets as well as the details of the prims themselves. More...
 
void LoadArchiveToCurrentScene (string[] cmdparams)
 Load an OpenSim archive into the current scene. This will load both the shapes of the prims and upload their assets to the asset service. More...
 
string SaveCurrentSceneMapToXmlString ()
 
void LoadCurrenSceneMapFromXmlString (string mapData)
 
void SendCommandToPluginModules (string[] cmdparams)
 
void SetBypassPermissionsOnCurrentScene (bool bypassPermissions)
 
void ForEachSelectedScene (Action< Scene > func)
 
void RestartCurrentScene ()
 
void BackupCurrentScene ()
 
bool TrySetCurrentScene (string regionName)
 
bool TrySetCurrentScene (UUID regionID)
 
bool TryGetScene (string regionName, out Scene scene)
 
bool TryGetScene (UUID regionID, out Scene scene)
 
bool TryGetScene (uint locX, uint locY, out Scene scene)
 
bool TryGetScene (IPEndPoint ipEndPoint, out Scene scene)
 
List< ScenePresenceGetCurrentSceneAvatars ()
 
List< ScenePresenceGetCurrentScenePresences ()
 
RegionInfo GetRegionInfo (UUID regionID)
 
void ForceCurrentSceneClientUpdate ()
 
void HandleEditCommandOnCurrentScene (string[] cmdparams)
 
bool TryGetScenePresence (UUID avatarId, out ScenePresence avatar)
 
bool TryGetRootScenePresence (UUID avatarId, out ScenePresence avatar)
 
void CloseScene (Scene scene)
 
bool TryGetAvatarByName (string avatarName, out ScenePresence avatar)
 
bool TryGetRootScenePresenceByName (string firstName, string lastName, out ScenePresence sp)
 
void ForEachScene (Action< Scene > action)
 

Properties

bool AllRegionsReady [get, set]
 Are all regions ready for use? More...
 
static SceneManager Instance [get]
 
List< SceneScenes [get]
 
Scene CurrentScene [get, set]
 Scene selected from the console. More...
 
Scene CurrentOrFirstScene [get]
 

Events

RestartSim OnRestartSim
 
Action< SceneManagerOnRegionsReadyStatusChange
 Fired when either all regions are ready for use or at least one region has become unready for use where previously all regions were ready. More...
 

Detailed Description

Manager for adding, closing and restarting scenes.

Definition at line 44 of file SceneManager.cs.

Constructor & Destructor Documentation

OpenSim.Region.Framework.Scenes.SceneManager.SceneManager ( )
inline

Definition at line 135 of file SceneManager.cs.

Member Function Documentation

void OpenSim.Region.Framework.Scenes.SceneManager.Add ( Scene  scene)
inline

Definition at line 163 of file SceneManager.cs.

void OpenSim.Region.Framework.Scenes.SceneManager.BackupCurrentScene ( )
inline

Definition at line 336 of file SceneManager.cs.

void OpenSim.Region.Framework.Scenes.SceneManager.Close ( )
inline

Definition at line 141 of file SceneManager.cs.

void OpenSim.Region.Framework.Scenes.SceneManager.Close ( Scene  cscene)
inline

Definition at line 156 of file SceneManager.cs.

void OpenSim.Region.Framework.Scenes.SceneManager.CloseScene ( Scene  scene)
inline

Definition at line 506 of file SceneManager.cs.

void OpenSim.Region.Framework.Scenes.SceneManager.ForceCurrentSceneClientUpdate ( )
inline

Definition at line 466 of file SceneManager.cs.

void OpenSim.Region.Framework.Scenes.SceneManager.ForEachScene ( Action< Scene action)
inline

Definition at line 543 of file SceneManager.cs.

void OpenSim.Region.Framework.Scenes.SceneManager.ForEachSelectedScene ( Action< Scene func)
inline

Definition at line 323 of file SceneManager.cs.

List<ScenePresence> OpenSim.Region.Framework.Scenes.SceneManager.GetCurrentSceneAvatars ( )
inline

Definition at line 423 of file SceneManager.cs.

List<ScenePresence> OpenSim.Region.Framework.Scenes.SceneManager.GetCurrentScenePresences ( )
inline

Definition at line 440 of file SceneManager.cs.

RegionInfo OpenSim.Region.Framework.Scenes.SceneManager.GetRegionInfo ( UUID  regionID)
inline

Definition at line 455 of file SceneManager.cs.

void OpenSim.Region.Framework.Scenes.SceneManager.HandleEditCommandOnCurrentScene ( string[]  cmdparams)
inline

Definition at line 471 of file SceneManager.cs.

void OpenSim.Region.Framework.Scenes.SceneManager.HandleRestart ( RegionInfo  rdata)
inline

Definition at line 172 of file SceneManager.cs.

void OpenSim.Region.Framework.Scenes.SceneManager.LoadArchiveToCurrentScene ( string[]  cmdparams)
inline

Load an OpenSim archive into the current scene. This will load both the shapes of the prims and upload their assets to the asset service.

Parameters
cmdparams

Definition at line 296 of file SceneManager.cs.

void OpenSim.Region.Framework.Scenes.SceneManager.LoadCurrenSceneMapFromXmlString ( string  mapData)
inline

Definition at line 308 of file SceneManager.cs.

void OpenSim.Region.Framework.Scenes.SceneManager.LoadCurrentSceneFromXml ( string  filename,
bool  generateNewIDs,
Vector3  loadOffset 
)
inline

Load an xml file of prims in OpenSimulator's original 'xml' file format to the current scene

Parameters
filename
generateNewIDs
loadOffset

Definition at line 244 of file SceneManager.cs.

void OpenSim.Region.Framework.Scenes.SceneManager.LoadCurrentSceneFromXml2 ( string  filename)
inline

Load an xml file of prims in OpenSimulator's current 'xml2' file format to the current scene

Definition at line 272 of file SceneManager.cs.

void OpenSim.Region.Framework.Scenes.SceneManager.RestartCurrentScene ( )
inline

Definition at line 331 of file SceneManager.cs.

string OpenSim.Region.Framework.Scenes.SceneManager.SaveCurrentSceneMapToXmlString ( )
inline

Definition at line 303 of file SceneManager.cs.

void OpenSim.Region.Framework.Scenes.SceneManager.SaveCurrentSceneToArchive ( string[]  cmdparams)
inline

Save the current scene to an OpenSimulator archive. This archive will eventually include the prim's assets as well as the details of the prims themselves.

Parameters
cmdparams

Definition at line 284 of file SceneManager.cs.

void OpenSim.Region.Framework.Scenes.SceneManager.SaveCurrentSceneToXml ( string  filename)
inline

Save the prims in the current scene to an xml file in OpenSimulator's original 'xml' format

Parameters
filename

Definition at line 231 of file SceneManager.cs.

void OpenSim.Region.Framework.Scenes.SceneManager.SaveCurrentSceneToXml2 ( string  filename)
inline

Save the prims in the current scene to an xml file in OpenSimulator's current 'xml2' format

Parameters
filename

Definition at line 255 of file SceneManager.cs.

void OpenSim.Region.Framework.Scenes.SceneManager.SaveNamedPrimsToXml2 ( string  primName,
string  filename 
)
inline

Definition at line 262 of file SceneManager.cs.

void OpenSim.Region.Framework.Scenes.SceneManager.SendCommandToPluginModules ( string[]  cmdparams)
inline

Definition at line 313 of file SceneManager.cs.

void OpenSim.Region.Framework.Scenes.SceneManager.SendSimOnlineNotification ( ulong  regionHandle)
inline

Definition at line 197 of file SceneManager.cs.

void OpenSim.Region.Framework.Scenes.SceneManager.SetBypassPermissionsOnCurrentScene ( bool  bypassPermissions)
inline

Definition at line 318 of file SceneManager.cs.

bool OpenSim.Region.Framework.Scenes.SceneManager.TryGetAvatarByName ( string  avatarName,
out ScenePresence  avatar 
)
inline

Definition at line 514 of file SceneManager.cs.

Here is the call graph for this function:

bool OpenSim.Region.Framework.Scenes.SceneManager.TryGetRootScenePresence ( UUID  avatarId,
out ScenePresence  avatar 
)
inline

Definition at line 491 of file SceneManager.cs.

bool OpenSim.Region.Framework.Scenes.SceneManager.TryGetRootScenePresenceByName ( string  firstName,
string  lastName,
out ScenePresence  sp 
)
inline

Definition at line 529 of file SceneManager.cs.

bool OpenSim.Region.Framework.Scenes.SceneManager.TryGetScene ( string  regionName,
out Scene  scene 
)
inline

Definition at line 379 of file SceneManager.cs.

Here is the caller graph for this function:

bool OpenSim.Region.Framework.Scenes.SceneManager.TryGetScene ( UUID  regionID,
out Scene  scene 
)
inline

Definition at line 384 of file SceneManager.cs.

bool OpenSim.Region.Framework.Scenes.SceneManager.TryGetScene ( uint  locX,
uint  locY,
out Scene  scene 
)
inline

Definition at line 389 of file SceneManager.cs.

bool OpenSim.Region.Framework.Scenes.SceneManager.TryGetScene ( IPEndPoint  ipEndPoint,
out Scene  scene 
)
inline

Definition at line 406 of file SceneManager.cs.

bool OpenSim.Region.Framework.Scenes.SceneManager.TryGetScenePresence ( UUID  avatarId,
out ScenePresence  avatar 
)
inline

Definition at line 476 of file SceneManager.cs.

Here is the call graph for this function:

bool OpenSim.Region.Framework.Scenes.SceneManager.TrySetCurrentScene ( string  regionName)
inline

Definition at line 341 of file SceneManager.cs.

Here is the caller graph for this function:

bool OpenSim.Region.Framework.Scenes.SceneManager.TrySetCurrentScene ( UUID  regionID)
inline

Definition at line 364 of file SceneManager.cs.

Property Documentation

bool OpenSim.Region.Framework.Scenes.SceneManager.AllRegionsReady
getset

Are all regions ready for use?

Definition at line 60 of file SceneManager.cs.

Scene OpenSim.Region.Framework.Scenes.SceneManager.CurrentOrFirstScene
get

Definition at line 118 of file SceneManager.cs.

Scene OpenSim.Region.Framework.Scenes.SceneManager.CurrentScene
getset

Scene selected from the console.

If null, then all scenes are considered selected (signalled as "Root" on the console).

Definition at line 115 of file SceneManager.cs.

SceneManager OpenSim.Region.Framework.Scenes.SceneManager.Instance
staticget

Definition at line 94 of file SceneManager.cs.

List<Scene> OpenSim.Region.Framework.Scenes.SceneManager.Scenes
get

Definition at line 105 of file SceneManager.cs.

Event Documentation

Action<SceneManager> OpenSim.Region.Framework.Scenes.SceneManager.OnRegionsReadyStatusChange

Fired when either all regions are ready for use or at least one region has become unready for use where previously all regions were ready.

Definition at line 54 of file SceneManager.cs.

RestartSim OpenSim.Region.Framework.Scenes.SceneManager.OnRestartSim

Definition at line 48 of file SceneManager.cs.


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