OpenSim.Region.CoreModules.World.Archiver.ArchiveScenesGroup Class Reference

A group of regions arranged in a rectangle, possibly with holes. More...

Public Member Functions
	ArchiveScenesGroup ()
void	AddScene (Scene scene)
void	CalcSceneLocations ()
	Called after all the scenes have been added. Performs calculations that require knowledge of all the scenes. More...
string	GetRegionDir (UUID regionID)
	Returns the subdirectory where the region is stored. More...
void	ForEachScene (Action< Scene > action)
	Performs an action on all the scenes in this order: rows from South to North, and within each row West to East. More...
bool	TryGetScene (Point location, out Scene scene)
	Returns the scene at position 'location'. More...

Protected Attributes
Dictionary< UUID, string >	m_regionDirs
	The subdirectory where each region is stored in the archive. More...

Properties
SortedDictionary< uint, SortedDictionary< uint, Scene > >	Regions [get, set]
	All the regions. The outer dictionary contains rows (key: Y coordinate). The inner dictionaries contain each row's regions (key: X coordinate). More...
Rectangle	Rect [get, set]
	The grid coordinates of the regions' bounding box. More...

Detailed Description

A group of regions arranged in a rectangle, possibly with holes.

The regions usually (but not necessarily) belong to an archive file, in which case we store additional information used to create the archive (e.g., each region's directory within the archive).

Definition at line 46 of file ArchiveScenesGroup.cs.

Constructor & Destructor Documentation

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

inline

Definition at line 65 of file ArchiveScenesGroup.cs.

Member Function Documentation

void OpenSim.Region.CoreModules.World.Archiver.ArchiveScenesGroup.AddScene ( Scene  scene )

inline

Definition at line 72 of file ArchiveScenesGroup.cs.

void OpenSim.Region.CoreModules.World.Archiver.ArchiveScenesGroup.CalcSceneLocations ( )

inline

Called after all the scenes have been added. Performs calculations that require knowledge of all the scenes.

Definition at line 91 of file ArchiveScenesGroup.cs.

void OpenSim.Region.CoreModules.World.Archiver.ArchiveScenesGroup.ForEachScene ( Action< Scene >  action )

inline

Performs an action on all the scenes in this order: rows from South to North, and within each row West to East.

Parameters

action

Definition at line 145 of file ArchiveScenesGroup.cs.

string OpenSim.Region.CoreModules.World.Archiver.ArchiveScenesGroup.GetRegionDir ( UUID  regionID )

inline

Returns the subdirectory where the region is stored.

Parameters

regionID

Returns

Definition at line 135 of file ArchiveScenesGroup.cs.

bool OpenSim.Region.CoreModules.World.Archiver.ArchiveScenesGroup.TryGetScene ( Point  location, out Scene  scene  )

inline

Returns the scene at position 'location'.

Parameters

location	A location in the grid
scene	The scene at this location

Returns

Whether the scene was found

Definition at line 162 of file ArchiveScenesGroup.cs.

Member Data Documentation

Dictionary<UUID, string> OpenSim.Region.CoreModules.World.Archiver.ArchiveScenesGroup.m_regionDirs

protected

The subdirectory where each region is stored in the archive.

Definition at line 57 of file ArchiveScenesGroup.cs.

Property Documentation

Rectangle OpenSim.Region.CoreModules.World.Archiver.ArchiveScenesGroup.Rect

getset

The grid coordinates of the regions' bounding box.

Definition at line 62 of file ArchiveScenesGroup.cs.

SortedDictionary<uint, SortedDictionary<uint, Scene> > OpenSim.Region.CoreModules.World.Archiver.ArchiveScenesGroup.Regions

getset

All the regions. The outer dictionary contains rows (key: Y coordinate). The inner dictionaries contain each row's regions (key: X coordinate).

Definition at line 52 of file ArchiveScenesGroup.cs.

---

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

• Region/CoreModules/World/Archiver/ArchiveScenesGroup.cs