OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Classes | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Properties | List of all members
OpenSim.Region.CoreModules.World.Archiver.ArchiveReadRequest Class Reference

Handles an individual archive read request More...

Collaboration diagram for OpenSim.Region.CoreModules.World.Archiver.ArchiveReadRequest:
Collaboration graph
[legend]

Public Member Functions

 ArchiveReadRequest (Scene scene, string loadPath, Guid requestId, Dictionary< string, object > options)
 
 ArchiveReadRequest (Scene scene, Stream loadStream, Guid requestId, Dictionary< string, object > options)
 
void DearchiveRegion ()
 Dearchive the region embodied in this request. More...
 
DearchiveScenesInfo LoadControlFile (string path, byte[] data, DearchiveScenesInfo dearchivedScenes)
 Load oar control file More...
 

Static Public Attributes

static int MAX_MAJOR_VERSION = 1
 The maximum major version of OAR that we can read. Minor versions shouldn't need a max number since version bumps here should be compatible. More...
 

Protected Member Functions

void LoadObjects (Scene scene, List< string > serialisedSceneObjects, List< SceneObjectGroup > sceneObjects)
 Load serialized scene objects. More...
 
void LoadParcels (Scene scene, List< string > serialisedParcels)
 Load serialized parcels. More...
 

Protected Attributes

string m_loadPath
 
Scene m_rootScene
 
Stream m_loadStream
 
Guid m_requestId
 
string m_errorMessage
 
bool m_merge
 
bool m_forceTerrain
 
bool m_forceParcels
 
bool m_skipAssets
 
Vector3 m_displacement = Vector3.Zero
 
float m_rotation = 0f
 
Vector3 m_incomingRegionSize = new Vector3(256f, 256f, float.MaxValue)
 
Vector3 m_rotationCenter = new Vector3(128f, 128f, 0f)
 
Vector3 m_boundingOrigin = Vector3.Zero
 
Vector3 m_boundingSize = new Vector3(Constants.MaximumRegionSize, Constants.MaximumRegionSize, float.MaxValue)
 
bool m_noObjects = false
 
bool m_boundingBox = false
 
bool m_debug = false
 

Properties

bool ControlFileLoaded [get, set]
 Has the control file been loaded for this archive? More...
 

Detailed Description

Handles an individual archive read request

Definition at line 55 of file ArchiveReadRequest.cs.

Constructor & Destructor Documentation

OpenSim.Region.CoreModules.World.Archiver.ArchiveReadRequest.ArchiveReadRequest ( Scene  scene,
string  loadPath,
Guid  requestId,
Dictionary< string, object >  options 
)
inline

Definition at line 183 of file ArchiveReadRequest.cs.

OpenSim.Region.CoreModules.World.Archiver.ArchiveReadRequest.ArchiveReadRequest ( Scene  scene,
Stream  loadStream,
Guid  requestId,
Dictionary< string, object >  options 
)
inline

Definition at line 266 of file ArchiveReadRequest.cs.

Member Function Documentation

void OpenSim.Region.CoreModules.World.Archiver.ArchiveReadRequest.DearchiveRegion ( )
inline

Dearchive the region embodied in this request.

Definition at line 287 of file ArchiveReadRequest.cs.

DearchiveScenesInfo OpenSim.Region.CoreModules.World.Archiver.ArchiveReadRequest.LoadControlFile ( string  path,
byte[]  data,
DearchiveScenesInfo  dearchivedScenes 
)
inline

Load oar control file

Parameters
path
data
dearchivedScenes

Definition at line 1110 of file ArchiveReadRequest.cs.

void OpenSim.Region.CoreModules.World.Archiver.ArchiveReadRequest.LoadObjects ( Scene  scene,
List< string >  serialisedSceneObjects,
List< SceneObjectGroup sceneObjects 
)
inlineprotected

Load serialized scene objects.

Definition at line 524 of file ArchiveReadRequest.cs.

void OpenSim.Region.CoreModules.World.Archiver.ArchiveReadRequest.LoadParcels ( Scene  scene,
List< string >  serialisedParcels 
)
inlineprotected

Load serialized parcels.

Parameters
scene
serialisedParcels

Definition at line 722 of file ArchiveReadRequest.cs.

Member Data Documentation

bool OpenSim.Region.CoreModules.World.Archiver.ArchiveReadRequest.m_boundingBox = false
protected

Definition at line 151 of file ArchiveReadRequest.cs.

Vector3 OpenSim.Region.CoreModules.World.Archiver.ArchiveReadRequest.m_boundingOrigin = Vector3.Zero
protected

Corner 1 of a bounding cuboid which specifies which objects we load from the oar

Definition at line 143 of file ArchiveReadRequest.cs.

Vector3 OpenSim.Region.CoreModules.World.Archiver.ArchiveReadRequest.m_boundingSize = new Vector3(Constants.MaximumRegionSize, Constants.MaximumRegionSize, float.MaxValue)
protected

Size of a bounding cuboid which specifies which objects we load from the oar

Definition at line 148 of file ArchiveReadRequest.cs.

bool OpenSim.Region.CoreModules.World.Archiver.ArchiveReadRequest.m_debug = false
protected

Definition at line 152 of file ArchiveReadRequest.cs.

Vector3 OpenSim.Region.CoreModules.World.Archiver.ArchiveReadRequest.m_displacement = Vector3.Zero
protected

Displacement added to each object as it is added to the world

Definition at line 123 of file ArchiveReadRequest.cs.

string OpenSim.Region.CoreModules.World.Archiver.ArchiveReadRequest.m_errorMessage
protected

Definition at line 97 of file ArchiveReadRequest.cs.

bool OpenSim.Region.CoreModules.World.Archiver.ArchiveReadRequest.m_forceParcels
protected

If true, force the loading of parcels from the oar file

Definition at line 113 of file ArchiveReadRequest.cs.

bool OpenSim.Region.CoreModules.World.Archiver.ArchiveReadRequest.m_forceTerrain
protected

If true, force the loading of terrain from the oar file

Definition at line 108 of file ArchiveReadRequest.cs.

Vector3 OpenSim.Region.CoreModules.World.Archiver.ArchiveReadRequest.m_incomingRegionSize = new Vector3(256f, 256f, float.MaxValue)
protected

original oar region size. not using Constants.RegionSize

Definition at line 133 of file ArchiveReadRequest.cs.

string OpenSim.Region.CoreModules.World.Archiver.ArchiveReadRequest.m_loadPath
protected

Definition at line 93 of file ArchiveReadRequest.cs.

Stream OpenSim.Region.CoreModules.World.Archiver.ArchiveReadRequest.m_loadStream
protected

Definition at line 95 of file ArchiveReadRequest.cs.

bool OpenSim.Region.CoreModules.World.Archiver.ArchiveReadRequest.m_merge
protected

Should the archive being loaded be merged with what is already on the region? Merging usually suppresses terrain and parcel loading

Definition at line 103 of file ArchiveReadRequest.cs.

bool OpenSim.Region.CoreModules.World.Archiver.ArchiveReadRequest.m_noObjects = false
protected

Definition at line 150 of file ArchiveReadRequest.cs.

Guid OpenSim.Region.CoreModules.World.Archiver.ArchiveReadRequest.m_requestId
protected

Definition at line 96 of file ArchiveReadRequest.cs.

Scene OpenSim.Region.CoreModules.World.Archiver.ArchiveReadRequest.m_rootScene
protected

Definition at line 94 of file ArchiveReadRequest.cs.

float OpenSim.Region.CoreModules.World.Archiver.ArchiveReadRequest.m_rotation = 0f
protected

Rotation (in radians) to apply to the objects as they are loaded.

Definition at line 128 of file ArchiveReadRequest.cs.

Vector3 OpenSim.Region.CoreModules.World.Archiver.ArchiveReadRequest.m_rotationCenter = new Vector3(128f, 128f, 0f)
protected

Center around which to apply the rotation relative to the original oar position

Definition at line 138 of file ArchiveReadRequest.cs.

bool OpenSim.Region.CoreModules.World.Archiver.ArchiveReadRequest.m_skipAssets
protected

Should we ignore any assets when reloading the archive?

Definition at line 118 of file ArchiveReadRequest.cs.

int OpenSim.Region.CoreModules.World.Archiver.ArchiveReadRequest.MAX_MAJOR_VERSION = 1
static

The maximum major version of OAR that we can read. Minor versions shouldn't need a max number since version bumps here should be compatible.

Definition at line 86 of file ArchiveReadRequest.cs.

Property Documentation

bool OpenSim.Region.CoreModules.World.Archiver.ArchiveReadRequest.ControlFileLoaded
getset

Has the control file been loaded for this archive?

Definition at line 91 of file ArchiveReadRequest.cs.


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