The regions included in an OAR file. More...

Collaboration diagram for OpenSim.Region.CoreModules.World.Archiver.DearchiveScenesInfo:

Classes
class	RegionInfo
	One region in the archive. More...

Public Member Functions
	DearchiveScenesInfo ()

void	StartRow ()

void	StartRegion ()

void	SetRegionOriginalID (string id)

void	SetRegionDirectory (string directory)

void	SetRegionSize (Vector3 size)

void	SetSimulatorScenes (Scene rootScene, ArchiveScenesGroup simulatorScenes)
	Sets all the scenes present in the simulator. More...

bool	GetRegionFromPath (string fullPath, out Scene scene, out string relativePath)
	Returns the archived region according to the path of a file in the archive. Also, converts the full path into a path that is relative to the region's directory. More...

string	GetOriginalRegionID (UUID newID)
	Returns the original UUID of a region (from the simulator where the OAR was saved), given the UUID of the scene it was loaded into in the current simulator. More...

List< UUID >	GetLoadedScenes ()
	Returns the scenes that have been (or will be) loaded. More...

int	GetScenesCount ()

Protected Attributes
Dictionary< string, RegionInfo >	m_directory2region = new Dictionary<string, RegionInfo>()
	Maps (Region directory -> region) More...

Dictionary< UUID, RegionInfo >	m_newId2region = new Dictionary<UUID, RegionInfo>()
	Maps (UUID of the scene in the simulator where the region will be loaded -> region) More...

int	m_curY = null

int	m_curX = null

RegionInfo	m_curRegion

Properties
Boolean	MultiRegionFormat `[get, set]`
	Whether this archive uses the multi-region format. More...

int	LoadedCreationDateTime `[get, set]`

string	DefaultOriginalID `[get, set]`

Detailed Description

The regions included in an OAR file.

Definition at line 44 of file DearchiveScenesGroup.cs.

Constructor & Destructor Documentation

OpenSim.Region.CoreModules.World.Archiver.DearchiveScenesInfo.DearchiveScenesInfo ( )

inline

Definition at line 109 of file DearchiveScenesGroup.cs.

Member Function Documentation

List<UUID> OpenSim.Region.CoreModules.World.Archiver.DearchiveScenesInfo.GetLoadedScenes ( )

inline

Returns the scenes that have been (or will be) loaded.

Returns

Definition at line 249 of file DearchiveScenesGroup.cs.

string OpenSim.Region.CoreModules.World.Archiver.DearchiveScenesInfo.GetOriginalRegionID ( UUID newID )

inline

Returns the original UUID of a region (from the simulator where the OAR was saved), given the UUID of the scene it was loaded into in the current simulator.

Parameters

newID

Returns

Definition at line 236 of file DearchiveScenesGroup.cs.

bool OpenSim.Region.CoreModules.World.Archiver.DearchiveScenesInfo.GetRegionFromPath	(	string	fullPath,
		out Scene	scene,
		out string	relativePath
	)

inline

Returns the archived region according to the path of a file in the archive. Also, converts the full path into a path that is relative to the region's directory.

Parameters

fullPath	The path of a file in the archive
scene	The corresponding Scene, or null if none
relativePath	The path relative to the region's directory. (Or the original path, if this file doesn't belong to a region.)

Returns: True: use this file; False: skip it

Definition at line 197 of file DearchiveScenesGroup.cs.

int OpenSim.Region.CoreModules.World.Archiver.DearchiveScenesInfo.GetScenesCount ( )

inline

Definition at line 254 of file DearchiveScenesGroup.cs.

void OpenSim.Region.CoreModules.World.Archiver.DearchiveScenesInfo.SetRegionDirectory ( string directory )

inline

Definition at line 140 of file DearchiveScenesGroup.cs.

void OpenSim.Region.CoreModules.World.Archiver.DearchiveScenesInfo.SetRegionOriginalID ( string id )

inline

Definition at line 129 of file DearchiveScenesGroup.cs.

void OpenSim.Region.CoreModules.World.Archiver.DearchiveScenesInfo.SetRegionSize ( Vector3 size )

inline

Definition at line 149 of file DearchiveScenesGroup.cs.

void OpenSim.Region.CoreModules.World.Archiver.DearchiveScenesInfo.SetSimulatorScenes	(	Scene	rootScene,
		ArchiveScenesGroup	simulatorScenes
	)

inline

Sets all the scenes present in the simulator.

This method matches regions in the archive to scenes in the simulator according to their relative position. We only load regions if there's an existing Scene in the grid location where the region should be loaded.

Parameters

rootScene	The scene where the Load OAR operation was run
simulatorScenes	All the scenes in the simulator

Definition at line 165 of file DearchiveScenesGroup.cs.

void OpenSim.Region.CoreModules.World.Archiver.DearchiveScenesInfo.StartRegion ( )

inline

Definition at line 123 of file DearchiveScenesGroup.cs.

void OpenSim.Region.CoreModules.World.Archiver.DearchiveScenesInfo.StartRow ( )

inline

Definition at line 117 of file DearchiveScenesGroup.cs.

Member Data Documentation

RegionInfo OpenSim.Region.CoreModules.World.Archiver.DearchiveScenesInfo.m_curRegion

protected

Definition at line 106 of file DearchiveScenesGroup.cs.

int OpenSim.Region.CoreModules.World.Archiver.DearchiveScenesInfo.m_curX = null

protected

Definition at line 105 of file DearchiveScenesGroup.cs.

int OpenSim.Region.CoreModules.World.Archiver.DearchiveScenesInfo.m_curY = null

protected

Definition at line 104 of file DearchiveScenesGroup.cs.

Dictionary<string, RegionInfo> OpenSim.Region.CoreModules.World.Archiver.DearchiveScenesInfo.m_directory2region = new Dictionary<string, RegionInfo>()

protected

Maps (Region directory -> region)

Definition at line 93 of file DearchiveScenesGroup.cs.

Dictionary<UUID, RegionInfo> OpenSim.Region.CoreModules.World.Archiver.DearchiveScenesInfo.m_newId2region = new Dictionary<UUID, RegionInfo>()

protected

Maps (UUID of the scene in the simulator where the region will be loaded -> region)

Definition at line 98 of file DearchiveScenesGroup.cs.

Property Documentation

string OpenSim.Region.CoreModules.World.Archiver.DearchiveScenesInfo.DefaultOriginalID

getset

Definition at line 101 of file DearchiveScenesGroup.cs.

int OpenSim.Region.CoreModules.World.Archiver.DearchiveScenesInfo.LoadedCreationDateTime

getset

Definition at line 100 of file DearchiveScenesGroup.cs.

Boolean OpenSim.Region.CoreModules.World.Archiver.DearchiveScenesInfo.MultiRegionFormat

getset

Whether this archive uses the multi-region format.

Definition at line 88 of file DearchiveScenesGroup.cs.

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

Region/CoreModules/World/Archiver/DearchiveScenesGroup.cs

Classes

Public Member Functions

Protected Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation