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

Serialize and deserialize scene objects. More...

Public Member Functions

delegate bool SceneObjectModifier (SceneObjectGroup sog)
 Modifies a SceneObjectGroup. More...
 

Static Public Member Functions

static SceneObjectGroup FromOriginalXmlFormat (string xmlData)
 Deserialize a scene object from the original xml format More...
 
static SceneObjectGroup FromOriginalXmlFormat (XmlReader reader)
 Deserialize a scene object from the original xml format More...
 
static string ToOriginalXmlFormat (SceneObjectGroup sceneObject)
 Serialize a scene object to the original xml format More...
 
static string ToOriginalXmlFormat (SceneObjectGroup sceneObject, bool doScriptStates)
 Serialize a scene object to the original xml format More...
 
static void ToOriginalXmlFormat (SceneObjectGroup sceneObject, XmlTextWriter writer, bool doScriptStates)
 Serialize a scene object to the original xml format More...
 
static string ToOriginalXmlFormat (SceneObjectGroup sceneObject, string scriptedState)
 
static void ToOriginalXmlFormat (SceneObjectGroup sceneObject, XmlTextWriter writer, bool doScriptStates, bool noRootElement)
 Serialize a scene object to the original xml format More...
 
static SceneObjectGroup FromXml2Format (string xmlData)
 
static string ToXml2Format (SceneObjectGroup sceneObject)
 Serialize a scene object to the 'xml2' format. More...
 
static byte[] ModifySerializedObject (UUID assetId, byte[] data, SceneObjectModifier modifier)
 Modifies an object by deserializing it; applying 'modifier' to each SceneObjectGroup; and reserializing. More...
 
static void SOGToXml2 (XmlTextWriter writer, SceneObjectGroup sog, Dictionary< string, object >options)
 
static void SOPToXml2 (XmlTextWriter writer, SceneObjectPart sop, Dictionary< string, object > options)
 
static void WriteTaskInventory (XmlTextWriter writer, TaskInventoryDictionary tinv, Dictionary< string, object > options, Scene scene)
 
static void WriteShape (XmlTextWriter writer, PrimitiveBaseShape shp, Dictionary< string, object > options)
 
static SceneObjectPart Xml2ToSOP (XmlReader reader)
 
static TaskInventoryDictionary ReadTaskInventory (XmlReader reader, string name)
 
static PrimitiveBaseShape ReadShape (XmlReader reader, string name, out List< string > errorNodeNames, SceneObjectPart obj)
 Read a shape from xml input More...
 

Static Protected Member Functions

static void ToXmlFormat (SceneObjectPart part, XmlTextWriter writer)
 

Detailed Description

Serialize and deserialize scene objects.

This should really be in OpenSim.Framework.Serialization but this would mean circular dependency problems right now - hopefully this isn't forever.

Definition at line 50 of file SceneObjectSerializer.cs.

Member Function Documentation

static SceneObjectGroup OpenSim.Region.Framework.Scenes.Serialization.SceneObjectSerializer.FromOriginalXmlFormat ( string  xmlData)
inlinestatic

Deserialize a scene object from the original xml format

Parameters
xmlData
Returns
The scene object deserialized. Null on failure.

Definition at line 61 of file SceneObjectSerializer.cs.

static SceneObjectGroup OpenSim.Region.Framework.Scenes.Serialization.SceneObjectSerializer.FromOriginalXmlFormat ( XmlReader  reader)
inlinestatic

Deserialize a scene object from the original xml format

Parameters
xmlData
Returns
The scene object deserialized. Null on failure.

Definition at line 86 of file SceneObjectSerializer.cs.

Here is the call graph for this function:

static SceneObjectGroup OpenSim.Region.Framework.Scenes.Serialization.SceneObjectSerializer.FromXml2Format ( string  xmlData)
inlinestatic

Definition at line 227 of file SceneObjectSerializer.cs.

Here is the call graph for this function:

static byte [] OpenSim.Region.Framework.Scenes.Serialization.SceneObjectSerializer.ModifySerializedObject ( UUID  assetId,
byte[]  data,
SceneObjectModifier  modifier 
)
inlinestatic

Modifies an object by deserializing it; applying 'modifier' to each SceneObjectGroup; and reserializing.

Parameters
assetIdThe object's UUID
dataSerialized data
modifierThe function to run on each SceneObjectGroup
Returns
The new serialized object's data, or null if an error occurred

Definition at line 324 of file SceneObjectSerializer.cs.

Here is the call graph for this function:

static PrimitiveBaseShape OpenSim.Region.Framework.Scenes.Serialization.SceneObjectSerializer.ReadShape ( XmlReader  reader,
string  name,
out List< string >  errorNodeNames,
SceneObjectPart  obj 
)
inlinestatic

Read a shape from xml input

Parameters
reader
nameThe name of the xml element containing the shape
errorsa list containing the failing node names. If no failures then null.
Returns
The shape parsed

Definition at line 1772 of file SceneObjectSerializer.cs.

static TaskInventoryDictionary OpenSim.Region.Framework.Scenes.Serialization.SceneObjectSerializer.ReadTaskInventory ( XmlReader  reader,
string  name 
)
inlinestatic

Definition at line 1737 of file SceneObjectSerializer.cs.

delegate bool OpenSim.Region.Framework.Scenes.Serialization.SceneObjectSerializer.SceneObjectModifier ( SceneObjectGroup  sog)

Modifies a SceneObjectGroup.

Parameters
sogThe object
Returns
Whether the object was actually modified
static void OpenSim.Region.Framework.Scenes.Serialization.SceneObjectSerializer.SOGToXml2 ( XmlTextWriter  writer,
SceneObjectGroup  sog,
Dictionary< string, object >  options 
)
inlinestatic

Definition at line 1348 of file SceneObjectSerializer.cs.

static void OpenSim.Region.Framework.Scenes.Serialization.SceneObjectSerializer.SOPToXml2 ( XmlTextWriter  writer,
SceneObjectPart  sop,
Dictionary< string, object >  options 
)
inlinestatic

Definition at line 1375 of file SceneObjectSerializer.cs.

Here is the call graph for this function:

static string OpenSim.Region.Framework.Scenes.Serialization.SceneObjectSerializer.ToOriginalXmlFormat ( SceneObjectGroup  sceneObject)
inlinestatic

Serialize a scene object to the original xml format

Parameters
sceneObject
Returns

Definition at line 126 of file SceneObjectSerializer.cs.

Here is the caller graph for this function:

static string OpenSim.Region.Framework.Scenes.Serialization.SceneObjectSerializer.ToOriginalXmlFormat ( SceneObjectGroup  sceneObject,
bool  doScriptStates 
)
inlinestatic

Serialize a scene object to the original xml format

Parameters
sceneObject
doScriptStatesControl whether script states are also serialized.
Returns

Definition at line 137 of file SceneObjectSerializer.cs.

static void OpenSim.Region.Framework.Scenes.Serialization.SceneObjectSerializer.ToOriginalXmlFormat ( SceneObjectGroup  sceneObject,
XmlTextWriter  writer,
bool  doScriptStates 
)
inlinestatic

Serialize a scene object to the original xml format

Parameters
sceneObject
Returns

Definition at line 155 of file SceneObjectSerializer.cs.

static string OpenSim.Region.Framework.Scenes.Serialization.SceneObjectSerializer.ToOriginalXmlFormat ( SceneObjectGroup  sceneObject,
string  scriptedState 
)
inlinestatic

Definition at line 160 of file SceneObjectSerializer.cs.

static void OpenSim.Region.Framework.Scenes.Serialization.SceneObjectSerializer.ToOriginalXmlFormat ( SceneObjectGroup  sceneObject,
XmlTextWriter  writer,
bool  doScriptStates,
bool  noRootElement 
)
inlinestatic

Serialize a scene object to the original xml format

Parameters
sceneObject
writer
noRootElementIf false, don't write the enclosing SceneObjectGroup element
Returns

Definition at line 185 of file SceneObjectSerializer.cs.

static string OpenSim.Region.Framework.Scenes.Serialization.SceneObjectSerializer.ToXml2Format ( SceneObjectGroup  sceneObject)
inlinestatic

Serialize a scene object to the 'xml2' format.

Parameters
sceneObject
Returns

Definition at line 297 of file SceneObjectSerializer.cs.

Here is the caller graph for this function:

static void OpenSim.Region.Framework.Scenes.Serialization.SceneObjectSerializer.ToXmlFormat ( SceneObjectPart  part,
XmlTextWriter  writer 
)
inlinestaticprotected

Definition at line 222 of file SceneObjectSerializer.cs.

static void OpenSim.Region.Framework.Scenes.Serialization.SceneObjectSerializer.WriteShape ( XmlTextWriter  writer,
PrimitiveBaseShape  shp,
Dictionary< string, object >  options 
)
inlinestatic

Definition at line 1630 of file SceneObjectSerializer.cs.

static void OpenSim.Region.Framework.Scenes.Serialization.SceneObjectSerializer.WriteTaskInventory ( XmlTextWriter  writer,
TaskInventoryDictionary  tinv,
Dictionary< string, object >  options,
Scene  scene 
)
inlinestatic

Definition at line 1566 of file SceneObjectSerializer.cs.

static SceneObjectPart OpenSim.Region.Framework.Scenes.Serialization.SceneObjectSerializer.Xml2ToSOP ( XmlReader  reader)
inlinestatic

Definition at line 1713 of file SceneObjectSerializer.cs.


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