Class XmlUtils

This class deals with the XML manipulation of scenarios

Inheritance

object

XmlUtils

Namespace: Xareus.Scenarios.Unity.Edition

Assembly: Xareus.Scenarios.Unity.Edition.dll

Syntax

public static class XmlUtils

Fields

EDITOR_XML_COMMENT_ELEMENT_NAME

Declaration

public static readonly string EDITOR_XML_COMMENT_ELEMENT_NAME

Field Value

Type	Description
string

EDITOR_XML_ELEMENT_NAME

Declaration

public static readonly string EDITOR_XML_ELEMENT_NAME

Field Value

Type	Description
string

EDITOR_XML_POSITION_ELEMENT_NAME

Declaration

public static readonly string EDITOR_XML_POSITION_ELEMENT_NAME

Field Value

Type	Description
string

EDITOR_XML_SECTION_ELEMENT_NAME

Declaration

public static readonly string EDITOR_XML_SECTION_ELEMENT_NAME

Field Value

Type	Description
string

EDITOR_XML_VIEW_DATA_ELEMENT_NAME

Declaration

public static readonly string EDITOR_XML_VIEW_DATA_ELEMENT_NAME

Field Value

Type	Description
string

Methods

DragPosition(Extendable, Vector2)

Declaration

public static void DragPosition(Extendable identifiable, Vector2 offset)

Parameters

Type	Name	Description
Extendable	identifiable
Vector2	offset

GetComments(Identifiable)

Fetchs comments stored within an identifiable extented information.

Declaration

public static List<Comment> GetComments(Identifiable identifiable)

Parameters

Type	Name	Description
Identifiable	identifiable

Returns

Type	Description
List<Comment>

GetExtendedInfoElements<T>(Identifiable, string)

Declaration

public static List<T> GetExtendedInfoElements<T>(Identifiable parent, string xmlElementName) where T : Identifiable

Parameters

Type	Name	Description
Identifiable	parent
string	xmlElementName

Returns

Type	Description
List<T>

Type Parameters

Name	Description
T

GetPosition(Extendable)

Gets the position of an identifiable

Declaration

public static Vector2 GetPosition(Extendable extendable)

Parameters

Type	Name	Description
Extendable	extendable

Returns

Type	Description
Vector2

GetSections(Identifiable)

Fetchs sections stored within an identifiable extented information.

Declaration

public static List<Section> GetSections(Identifiable identifiable)

Parameters

Type	Name	Description
Identifiable	identifiable

Returns

Type	Description
List<Section>

GetViewPosition(ComplexSequence)

Gets the view position of a complex sequence.

Declaration

public static Vector2 GetViewPosition(ComplexSequence complexSequence)

Parameters

Type	Name	Description
ComplexSequence	complexSequence

Returns

Type	Description
Vector2

GetViewZoom(ComplexSequence)

Gets the view zoom of a complex sequence.

Declaration

public static float GetViewZoom(ComplexSequence complexSequence)

Parameters

Type	Name	Description
ComplexSequence	complexSequence

Returns

Type	Description
float

RemoveComment(Identifiable, Comment)

Removes the specified comment

Declaration

public static void RemoveComment(Identifiable parent, Comment comment)

Parameters

Type	Name	Description
Identifiable	parent
Comment	comment

RemoveExtendedInfoElement(Identifiable, Identifiable, string)

Removes the first matching comment in the extended info.

Declaration

public static void RemoveExtendedInfoElement(Identifiable parent, Identifiable extensionIdentifiable, string xmlElementName)

Parameters

Type	Name	Description
Identifiable	parent
Identifiable	extensionIdentifiable
string	xmlElementName

RemoveSection(Identifiable, Section)

Removes the specified section

Declaration

public static void RemoveSection(Identifiable parent, Section section)

Parameters

Type	Name	Description
Identifiable	parent
Section	section

SetComment(Identifiable, Comment)

Sets a comment within an identifiable extended informations.

Declaration

public static void SetComment(Identifiable identifiable, Comment comment)

Parameters

Type	Name	Description
Identifiable	identifiable
Comment	comment

SetPosition(Extendable, Vector2)

Sets the position of an extendable element. Enriches datas

Declaration

public static void SetPosition(Extendable extendable, Vector2 position)

Parameters

Type	Name	Description
Extendable	extendable
Vector2	position

SetSection(Identifiable, Section)

Sets a section within an identifiable extended informations.

Declaration

public static void SetSection(Identifiable identifiable, Section section)

Parameters

Type	Name	Description
Identifiable	identifiable
Section	section

SetValue<T>(Extendable, string, string, T)

Sets the value of a parameter in an extendable SEVEN Elements

Declaration

public static void SetValue<T>(Extendable extendable, string XmlNodeName, string XmlAttributeName, T value)

Parameters

Type	Name	Description
Extendable	extendable
string	XmlNodeName
string	XmlAttributeName
T	value

Type Parameters

Name	Description
T

SetViewPosition(ComplexSequence, Vector2)

Sets the view position of a complex sequence. Enriches datas

Declaration

public static void SetViewPosition(ComplexSequence complexSequence, Vector2 position)

Parameters

Type	Name	Description
ComplexSequence	complexSequence
Vector2	position

SetViewZoom(ComplexSequence, float)

Sets the view zoom of a complex sequence. Enriches datas

Declaration

public static void SetViewZoom(ComplexSequence complexSequence, float zoom)

Parameters

Type	Name	Description
ComplexSequence	complexSequence
float	zoom