OpenSim::Region::Environment::Modules::World::Archiver::ArchiveWriteRequestPreparation Class Reference

Prepare to write out an archive. More...

List of all members.

Public Member Functions
	ArchiveWriteRequestPreparation (Scene scene, string savePath)
	Constructor.
void	AssetRequestCallback (UUID assetID, AssetBase asset)
	The callback made when we request the asset for an object from the asset service.
void	ArchiveRegion ()
Protected Member Functions
AssetBase	GetAsset (UUID uuid)
	Get an asset synchronously, potentially using an asynchronous callback. If the asynchronous callback is used, we will wait for it to complete.
void	GetScriptAssetUuids (UUID scriptUuid, IDictionary< UUID, int > assetUuids)
	Record the asset uuids embedded within the given script.
void	GetWearableAssetUuids (UUID wearableAssetUuid, IDictionary< UUID, int > assetUuids)
	Record the uuids referenced by the given wearable asset.
void	GetSceneObjectAssetUuids (UUID sceneObjectUuid, IDictionary< UUID, int > assetUuids)
	Get all the asset uuids associated with a given object. This includes both those directly associated with it (e.g. face textures) and recursively, those of items within it's inventory (e.g. objects contained within this object).
void	GetSceneObjectAssetUuids (SceneObjectGroup sceneObject, IDictionary< UUID, int > assetUuids)
	Get all the asset uuids associated with a given object. This includes both those directly associated with it (e.g. face textures) and recursively, those of items within it's inventory (e.g. objects contained within this object).
Protected Attributes
Scene	m_scene
string	m_savePath
AssetBase	m_requestedObjectAsset
	Used as a temporary store of an asset which represents an object. This can be a null if no appropriate asset was found by the asset service.
bool	m_waitingForObjectAsset
	Signal whether we are currently waiting for the asset service to deliver an asset.

---

Detailed Description

Prepare to write out an archive.

---

Constructor & Destructor Documentation

OpenSim::Region::Environment::Modules::World::Archiver::ArchiveWriteRequestPreparation::ArchiveWriteRequestPreparation	(	Scene	scene,
		string	savePath
	)			[inline]

Constructor.

---

Member Function Documentation

void OpenSim::Region::Environment::Modules::World::Archiver::ArchiveWriteRequestPreparation::AssetRequestCallback	(	UUID	assetID,
		AssetBase	asset
	)			[inline]

The callback made when we request the asset for an object from the asset service.

AssetBase OpenSim::Region::Environment::Modules::World::Archiver::ArchiveWriteRequestPreparation::GetAsset

(

UUID

uuid

)

[inline, protected]

Get an asset synchronously, potentially using an asynchronous callback. If the asynchronous callback is used, we will wait for it to complete.

Parameters:

uuid

Returns:

void OpenSim::Region::Environment::Modules::World::Archiver::ArchiveWriteRequestPreparation::GetScriptAssetUuids	(	UUID	scriptUuid,
		IDictionary< UUID, int >	assetUuids
	)			[inline, protected]

Record the asset uuids embedded within the given script.

Parameters:

	scriptUuid
	assetUuids	Dictionary in which to record the references

void OpenSim::Region::Environment::Modules::World::Archiver::ArchiveWriteRequestPreparation::GetWearableAssetUuids	(	UUID	wearableAssetUuid,
		IDictionary< UUID, int >	assetUuids
	)			[inline, protected]

Record the uuids referenced by the given wearable asset.

Parameters:

	wearableAssetUuid
	assetUuids	Dictionary in which to record the references

void OpenSim::Region::Environment::Modules::World::Archiver::ArchiveWriteRequestPreparation::GetSceneObjectAssetUuids	(	UUID	sceneObjectUuid,
		IDictionary< UUID, int >	assetUuids
	)			[inline, protected]

Get all the asset uuids associated with a given object. This includes both those directly associated with it (e.g. face textures) and recursively, those of items within it's inventory (e.g. objects contained within this object).

Parameters:

	sceneObject
	assetUuids

void OpenSim::Region::Environment::Modules::World::Archiver::ArchiveWriteRequestPreparation::GetSceneObjectAssetUuids	(	SceneObjectGroup	sceneObject,
		IDictionary< UUID, int >	assetUuids
	)			[inline, protected]

Get all the asset uuids associated with a given object. This includes both those directly associated with it (e.g. face textures) and recursively, those of items within it's inventory (e.g. objects contained within this object).

Parameters:

	sceneObject
	assetUuids

void OpenSim::Region::Environment::Modules::World::Archiver::ArchiveWriteRequestPreparation::ArchiveRegion

(

)

[inline]

---

Member Data Documentation

Scene OpenSim::Region::Environment::Modules::World::Archiver::ArchiveWriteRequestPreparation::m_scene [protected]

string OpenSim::Region::Environment::Modules::World::Archiver::ArchiveWriteRequestPreparation::m_savePath [protected]

AssetBase OpenSim::Region::Environment::Modules::World::Archiver::ArchiveWriteRequestPreparation::m_requestedObjectAsset [protected]

Used as a temporary store of an asset which represents an object. This can be a null if no appropriate asset was found by the asset service.

bool OpenSim::Region::Environment::Modules::World::Archiver::ArchiveWriteRequestPreparation::m_waitingForObjectAsset [protected]

Signal whether we are currently waiting for the asset service to deliver an asset.

---

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

• /home/sdague/opensim-docs/OpenSim/Region/Environment/Modules/World/Archiver/ArchiveWriteRequestPreparation.cs

---