XML Schema Definition des ls3-Dateiformats

Hier entsteht eine XSD-Datei des ls3-Dateiformats - work in progress! Status: Die XSD ist so weit entwickelt, dass gängige in der Praxis aufgetretene Strukturfehler in ls3-Dateien damit aufgedeckt werden können. Die schriftliche Dokumentation ist noch unvollständig. Auf die exakte Abbildung komplexer Datentypen wie TDateTime oder den Enums wurde verzichtet. Es wurden noch nicht bei allen Deklarationen die exakten Grenzen des Zusi-3D-Editors (der für das Dateiformat die Referenzimplementierung darstellt) ausgetestet. Der Editor dürfte beispielsweise irgendwann Fehlermeldungen werfen, wenn man ihm tatsächlich eine unbounded Anzahl von Faces zu verdauen gibt.

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
	<xs:annotation>
		<xs:documentation xml:lang="de">
			XML Schema Definition für das ls3-Datenformat des Zugsimulators Zusi 3 von Carsten Hölscher. Elemente und Attribute, die als veraltet gelten und von der Referenzimplementation (Zusi3DEditor.exe) zwar noch gelesen werden können, aber nicht mehr geschrieben werden, sind nicht alle in diesem Schema enthalten.

			Allgemeine Hinweise zu Zusi-XML-Datenformaten:

			Bei Attributen existiert für jeden Typ ein Standardwert, der verwendet wird, wenn das Attribut nicht vorhanden ist. Es folgt daraus, dass das Attribut auch beim Schreiben weggelassen werden kann, wenn sein Wert dem Standardwert entspricht. Zusi macht das konsequent so. Der Standardwert ist
			- bei Ganzzahlen (integer, integer 64 bit, integer enum, bool) der Wert 0.
			- bei Gleitkommazahlen (single) der Wert 0.0.
			- bei Zeichenketten (string) die leere Zeichenkette.
			- bei Farben (D3DColor) die Farbe R=G=B=A=0.
			- bei Datums-/Zeitangaben (date,time) der 30. Dezember 1899, 00:00:00.

			Dateipfade (<Datei Dateiname="..."> sind entweder
			- Pfade relativ zum Zusi-Datenverzeichnis (RollingStock\Deutschland\Lok.ls3), wobei ein führender Backslash erlaubt ist und ignoriert wird, oder
			- wenn sie keinen Backslash enthalten, Dateien im selben Verzeichnis wie die Datei, in der der Pfad steht.
			Insbesondere können Dateien, die auf einem anderen Laufwerk als das Zusi-Datenverzeichnis liegen, nicht referenziert werden.

			Programmseitig generierte XML-Dateien, die UTF-8-kodiert sind, sollten eine Byte Order Mark (0xEF,0xBB,0xBF) am Anfang enthalten, damit Texteditoren sie zuverlässig als UTF-8 erkennen.
		</xs:documentation>
	</xs:annotation>
	<xs:element name="Zusi">
		<xs:complexType>
			<xs:sequence>
				<xs:element ref="Info"/>
				<xs:element ref="Landschaft"/>
			</xs:sequence>
		</xs:complexType>
	</xs:element>
	<xs:element name="Info">
		<xs:complexType>
			<xs:sequence>
				<xs:element ref="AutorEintrag"/>
			</xs:sequence>
			<xs:attribute name="Beschreibung" type="xs:string"/>
			<xs:attribute name="DateiKategorie" type="xs:string"/>
			<xs:attribute name="DateiTyp" type="xs:string"/>
			<xs:attribute name="EinsatzAb"/> <!-- Datentyp TDateTime -->
			<xs:attribute name="EinsatzBis"/> <!-- Datentyp TDateTime -->
			<xs:attribute name="MinVersion" type="xs:string"/>
			<xs:attribute name="ObjektID" type="xs:int"/>
			<xs:attribute name="Version" type="xs:string"/>
		</xs:complexType>
	</xs:element>
	<xs:element name="AutorEintrag">
		<xs:annotation>
			<xs:documentation xml:lang="de">
				AutorID steht für eine durch die Firma Hölscher vergebene Autoren-ID. Autor-IDs mit negativen Werten werden an Programme vergeben, die selbstständig ohne großen menschlichen Input Zusi-Inhalte generieren.
			</xs:documentation>
		</xs:annotation>
		<xs:complexType>
			<xs:attribute name="AutorAufwand" type="xs:float"/>
			<xs:attribute name="AutorBeschreibung" type="xs:string"/>
			<xs:attribute name="AutorEmail" type="xs:string"/>
			<xs:attribute name="AutorID" type="xs:int"/>
			<xs:attribute name="AutorLizenz"/> <!--Datentyp integer enum -->
			<xs:attribute name="AutorName" type="xs:string"/>
		</xs:complexType>
	</xs:element>
	<xs:element name="Landschaft">
		<xs:complexType>
			<xs:sequence>
				<xs:element ref="Verknuepfte" minOccurs="0" maxOccurs="unbounded"/>
				<xs:element ref="lsb" minOccurs="0" maxOccurs="1"/>
				<xs:element ref="SubSet" minOccurs="0" maxOccurs="unbounded"/>
				<xs:element ref="Ankerpunkt" minOccurs="0" maxOccurs="unbounded"/>
				<xs:element ref="Animation" minOccurs="0" maxOccurs="unbounded"/>
				<xs:element ref="LandschaftSound" minOccurs="0" maxOccurs="unbounded"/>
				<xs:element ref="MeshAnimation" minOccurs="0" maxOccurs="unbounded"/>
				<xs:element ref="VerknAnimation" minOccurs="0" maxOccurs="unbounded"/>
			</xs:sequence>
		</xs:complexType>
	</xs:element>
	<xs:element name="Verknuepfte">
		<xs:complexType>
			<xs:sequence>
				<xs:element ref="Datei"/>
				<xs:element ref="p"/>
				<xs:element ref="phi"/>
				<xs:element ref="sk"/>
			</xs:sequence>
			<xs:attribute name="BoundingR" type="xs:float"/>
			<xs:attribute name="Flags" type="xs:long"/>
			<xs:attribute name="GruppenName" type="xs:string"/>
			<xs:attribute name="Helligkeit" type="xs:float"/>
			<xs:attribute name="LODbit" type="xs:int"/>
			<xs:attribute name="SichtbarAb" type="xs:float"/>
			<xs:attribute name="SichtbarBis" type="xs:float"/>
			<xs:attribute name="Vorlade" type="xs:float"/>
		</xs:complexType>
	</xs:element>
	<xs:element name="sk">
		<xs:annotation>
			<xs:documentation xml:lang="de">
				Das sk-Element regelt die Skalierung der verknüpften ls3-Datei entlang der drei Achsen.
				Bei den drei Attributen X, Y und Z führen sowohl die Werte 0 als auch 1 zu einem auf 100 % Größe skalierten Objekt. Bei allen anderen Werten wird das Objekt um den angegebenen Faktor skaliert.
			</xs:documentation>
		</xs:annotation>
		<xs:complexType>
			<xs:attribute name="X" type="xs:float" default="0"/>
			<xs:attribute name="Y" type="xs:float" default="0"/>
			<xs:attribute name="Z" type="xs:float" default="0"/>
		</xs:complexType>
	</xs:element>
	<xs:element name="lsb">
		<xs:annotation>
			<xs:documentation xml:lang="de">
				Wenn das lsb-Element vorhanden ist, dann liegen die Vertex- und Face-Daten dieser ls3-Datei ausschließlich in Form einer lsb-Datei vor. Die SubSet-Elemente enthalten dann keine Elemente vom Typ Vertex oder Face.
				Das Dateiname-Attribut gibt den Pfad zur lsb-Datei an. Es ist "required", weil die Zusi-Dateiverwaltung sonst bei Export- und Prüfvorgängen die lsb-Datei nicht als zur ls3-Datei zugehörig identifiziert. Simulator und 3D-Editor ignorieren dieses Attribut und laden zu einer Datei 'Dateiname.ls3' immer die lsb-Datei 'Dateiname.lsb' im selben Verzeichnis.
				Wenn das NurInfo-Attribut = 1 ist, dann bedeutet dies, dass keine Warnmeldung erzeugt werden soll, wenn die angegebene Datei fehlt. Dies ist im Kontext von lsb-Dateien normalerweise nicht sinnvoll.
			</xs:documentation>
		</xs:annotation>
		<xs:complexType>
			<xs:attribute name="Dateiname" type="xs:string" use="required"/>
			<xs:attribute name="NurInfo" type="xs:boolean"/>
		</xs:complexType>
	</xs:element>
	<xs:element name="SubSet">
		<xs:annotation>
			<xs:documentation xml:lang="de">
				Für Farbangaben gibt es aus historischen Gründen zwei Formate. 
				Die Attribute C, CA und E sind veraltet und wurden durch Cd, Ca und Ce ersetzt.
				Die Farbe wurde in C, CA und E als String "0AABBGGRR" kodiert.
				In den neuen Attributen Cd, Ca und Ce wird die Farbe als String "AARRGGBB" kodiert.
				RR/GG/BB/AA steht für die zweistellige Hexadezimalrepräsentation des Rot-/Grün-/Blau-/Alpha-Farbanteils als Zahl zwischen 0 und 255.
			</xs:documentation>
		</xs:annotation>
		<xs:complexType>
			<xs:sequence>
				<xs:element ref="RenderFlags" minOccurs="0" maxOccurs="1"/>
				<xs:element ref="Textur" minOccurs="0" maxOccurs="2"/>
				<xs:element ref="Vertex" minOccurs="0" maxOccurs="65536"/>
				<xs:element ref="Face" minOccurs="0" maxOccurs="unbounded"/>
			</xs:sequence>
			<xs:attribute name="BeleuchtungTyp" type="xs:int"/>
			<xs:attribute name="Blink" type="xs:float"/>
			<xs:attribute name="Ca" type="xs:hexBinary"/> <!-- Datentyp D3DColor -->
			<xs:attribute name="Cd" type="xs:hexBinary"/> <!-- Datentyp D3DColor -->
			<xs:attribute name="Ce" type="xs:hexBinary"/> <!-- Datentyp D3DColor -->

			<xs:attribute name="C" type="xs:hexBinary"/> 
			<xs:attribute name="CA" type="xs:hexBinary"/> 
			<xs:attribute name="E" type="xs:hexBinary"/> 

			<xs:attribute name="DoppeltRendern" type="xs:boolean"/>
			<xs:attribute name="GruppenName" type="xs:string"/>
			<xs:attribute name="MeshI" type="xs:int"/>
			<xs:attribute name="MeshV" type="xs:int"/>
			<xs:attribute name="MeterProTex" type="xs:float"/>
			<xs:attribute name="MeterProTex2" type="xs:float"/>
			<xs:attribute name="NachtEinstellung" type="xs:int"/>
			<xs:attribute name="Nachtumschaltung" type="xs:float"/>
			<xs:attribute name="TypGF"/> <!-- Datentyp integer enum -->
			<xs:attribute name="TypLs3"/> <!-- Datentyp integer enum -->
			<xs:attribute name="Zwangshelligkeit" type="xs:float"/>
			<xs:attribute name="zBias" type="xs:int"/>
			<xs:attribute name="zZoom" type="xs:float"/>
		</xs:complexType>
	</xs:element>
	<xs:element name="RenderFlags">       
		<xs:annotation>
			<xs:documentation xml:lang="de">
				Aus Gründen der 3D-Performance soll im RenderFlags-Element in der Regel nur das Attribut TexVoreinstellung spezifiziert werden. Dadurch werden in der Referenzimplementation jeweils performanceoptimierte Voreinstellungen für die Unterelemente und Unterattribute des RenderFlags-Elements geladen.
				Werte für das Attribut TexVoreinstellung:
				0: Individuell - die RenderFlags müssen über die sonstigen Attribute des RenderFlags-Elements sowie die Elemente SubSetTexFlags, SubSetTexFlags2, SubSetTexFlags3 spezifiziert werden
				1: Standard, eine Textur
				2: Standard, eine Textur, Volltransparenz
				3: Tex. 1 Standard, Tex. 2 transparent
				4: Standard, eine Textur, Halbtransparenz
				5: Tex. 1 Standard, Tex. 2 transparent/leuchtend
				6: Signalblende (durchleuchtet)
				7: Signallampe dimmbar (mit Halbtransparenz)
				8: Halbtransparenz für Laub-ähnliche Strukturen
				9: Überlagertes Fenster, tagsüber ausdimmend
				10: Überlagertes Fenster, tagsüber ausschaltend
				11: Nebelwand
			</xs:documentation>
		</xs:annotation>
		<xs:complexType>
			<xs:sequence>
				<xs:element ref="SubSetTexFlags" minOccurs="0" maxOccurs="1"/>
				<xs:element ref="SubSetTexFlags2" minOccurs="0" maxOccurs="1"/>
				<xs:element ref="SubSetTexFlags3" minOccurs="0" maxOccurs="1"/>
			</xs:sequence>
			<xs:attribute name="ALPHABLENDENABLE" type="xs:boolean"/>
			<xs:attribute name="ALPHAREF" type="xs:int"/>
			<xs:attribute name="ALPHATESTENABLE" type="xs:boolean"/>
			<xs:attribute name="DESTBLEND"/> <!-- Datentyp integer enum -->
			<xs:attribute name="SHADEMODE"/> <!-- Datentyp integer enum -->
			<xs:attribute name="SRCBLEND"/> <!-- Datentyp integer enum -->
			<xs:attribute name="TexVoreinstellung" type="xs:int"/>
		</xs:complexType>
	</xs:element>
	<xs:element name="SubSetTexFlags">
		<xs:complexType>
			<xs:attribute name="ALPHAARG0"/> <!-- Datentyp integer enum -->
			<xs:attribute name="ALPHAARG1"/> <!-- Datentyp integer enum -->
			<xs:attribute name="ALPHAARG2"/> <!-- Datentyp integer enum -->
			<xs:attribute name="ALPHAOP"/> <!-- Datentyp integer enum -->
			<xs:attribute name="COLORARG0"/> <!-- Datentyp integer enum -->
			<xs:attribute name="COLORARG1"/> <!-- Datentyp integer enum -->
			<xs:attribute name="COLORARG2"/> <!-- Datentyp integer enum -->
			<xs:attribute name="COLOROP"/> <!-- Datentyp integer enum -->
			<xs:attribute name="MAGFILTER"/> <!-- Datentyp integer enum -->
			<xs:attribute name="MINFILTER"/> <!-- Datentyp integer enum -->
			<xs:attribute name="RESULTARG"/> <!-- Datentyp integer enum -->
		</xs:complexType>
	</xs:element>
	<xs:element name="SubSetTexFlags2">
		<xs:complexType>
			<xs:attribute name="ALPHAARG0"/> <!-- Datentyp integer enum -->
			<xs:attribute name="ALPHAARG1"/> <!-- Datentyp integer enum -->
			<xs:attribute name="ALPHAARG2"/> <!-- Datentyp integer enum -->
			<xs:attribute name="ALPHAOP"/> <!-- Datentyp integer enum -->
			<xs:attribute name="COLORARG0"/> <!-- Datentyp integer enum -->
			<xs:attribute name="COLORARG1"/> <!-- Datentyp integer enum -->
			<xs:attribute name="COLORARG2"/> <!-- Datentyp integer enum -->
			<xs:attribute name="COLOROP"/> <!-- Datentyp integer enum -->
			<xs:attribute name="MAGFILTER"/> <!-- Datentyp integer enum -->
			<xs:attribute name="MINFILTER"/> <!-- Datentyp integer enum -->
			<xs:attribute name="RESULTARG"/> <!-- Datentyp integer enum -->
		</xs:complexType>
	</xs:element>
	<xs:element name="SubSetTexFlags3">
		<xs:complexType>
			<xs:attribute name="ALPHAARG0"/> <!-- Datentyp integer enum -->
			<xs:attribute name="ALPHAARG1"/> <!-- Datentyp integer enum -->
			<xs:attribute name="ALPHAARG2"/> <!-- Datentyp integer enum -->
			<xs:attribute name="ALPHAOP"/> <!-- Datentyp integer enum -->
			<xs:attribute name="COLORARG0"/> <!-- Datentyp integer enum -->
			<xs:attribute name="COLORARG1"/> <!-- Datentyp integer enum -->
			<xs:attribute name="COLORARG2"/> <!-- Datentyp integer enum -->
			<xs:attribute name="COLOROP"/> <!-- Datentyp integer enum -->
			<xs:attribute name="MAGFILTER"/> <!-- Datentyp integer enum -->
			<xs:attribute name="MINFILTER"/> <!-- Datentyp integer enum -->
			<xs:attribute name="RESULTARG"/> <!-- Datentyp integer enum -->
		</xs:complexType>
	</xs:element>
	<xs:element name="Textur">
		<xs:complexType>
			<xs:sequence>
				<xs:element ref="Datei"/>
			</xs:sequence>
			<xs:attribute name="AnzahlMipMapLevel" type="xs:int"/>
			<xs:attribute name="TransparentFarbe" type="xs:hexBinary"/> <!-- Datentyp D3DColor -->
			<xs:attribute name="TransparentModus"/> <!-- Datentyp integer enum -->
		</xs:complexType>
	</xs:element>
	<xs:element name="Vertex">
		<xs:complexType>
			<xs:sequence>
				<xs:element ref="p"/>
				<xs:element ref="n"/>
			</xs:sequence>
			<xs:attribute name="U" type="xs:float"/>
			<xs:attribute name="U2" type="xs:float"/>
			<xs:attribute name="V" type="xs:float"/>
			<xs:attribute name="V2" type="xs:float"/>
		</xs:complexType>
	</xs:element>
	<xs:element name="n">
		<xs:complexType>
			<xs:attribute name="X" type="xs:float"/>
			<xs:attribute name="Y" type="xs:float"/>
			<xs:attribute name="Z" type="xs:float"/>
		</xs:complexType>
	</xs:element>
	<xs:element name="Face">
		<xs:complexType>
			<xs:attribute name="i" type="xs:string"/>
		</xs:complexType>
	</xs:element>
	<xs:element name="Ankerpunkt">
		<xs:complexType>
			<xs:sequence>
				<xs:element ref="p" minOccurs="1" maxOccurs="1"/>
				<xs:element ref="phi" minOccurs="1" maxOccurs="1"/>
				<xs:element ref="Datei" minOccurs="0" maxOccurs="unbounded"/>
			</xs:sequence>
			<xs:attribute name="AnkerKat"/> <!-- Datentyp integer enum -->
			<xs:attribute name="AnkerTyp"/> <!-- Datentyp integer enum -->
			<xs:attribute name="Beschreibung" type="xs:string"/>
		</xs:complexType>
	</xs:element>
	<xs:element name="Animation">
		<xs:complexType>
			<xs:sequence>
				<xs:element ref="AniNrs"/>
			</xs:sequence>
			<xs:attribute name="AniBeschreibung" type="xs:string"/>
			<xs:attribute name="AniID"/> <!-- Datentyp integer enum -->
			<xs:attribute name="AniLoopen" type="xs:boolean"/>
		</xs:complexType>
	</xs:element>
	<xs:element name="AniNrs">
		<xs:complexType>
			<xs:attribute name="AniNr" type="xs:int"/>
		</xs:complexType>
	</xs:element>
	<xs:element name="MeshAnimation">
		<xs:complexType>
			<xs:complexContent>
				<xs:extension base="AniPunkt">
					<xs:attribute name="AniGeschw" type="xs:float"/>
					<xs:attribute name="AniIndex" type="xs:int"/>
					<xs:attribute name="AniNr" type="xs:int"/>
				</xs:extension>
			</xs:complexContent>
		</xs:complexType>
	</xs:element>
	<xs:element name="VerknAnimation">
		<xs:complexType>
			<xs:complexContent>
				<xs:extension base="AniPunkt">
					<xs:attribute name="AniGeschw" type="xs:float"/>
					<xs:attribute name="AniIndex" type="xs:int"/>
					<xs:attribute name="AniNr" type="xs:int"/>
				</xs:extension>
			</xs:complexContent>
		</xs:complexType>
	</xs:element>
	<xs:element name="Datei">
		<xs:complexType>
			<xs:attribute name="Dateiname" type="xs:string"/>
			<xs:attribute name="NurInfo" type="xs:boolean"/>
		</xs:complexType>
	</xs:element>
	<xs:element name="p">
		<xs:complexType>
			<xs:attribute name="X" type="xs:float"/>
			<xs:attribute name="Y" type="xs:float"/>
			<xs:attribute name="Z" type="xs:float"/>
		</xs:complexType>
	</xs:element>
	<xs:element name="phi">
		<xs:complexType>
			<xs:attribute name="X" type="xs:float"/>
			<xs:attribute name="Y" type="xs:float"/>
			<xs:attribute name="Z" type="xs:float"/>
		</xs:complexType>
	</xs:element>
	<xs:element name="LandschaftSound">
		<xs:complexType>
			<xs:sequence>
				<xs:element ref="Sound" minOccurs="1" maxOccurs="1"/>
				<xs:element ref="Abhaengigkeit" minOccurs="0" maxOccurs="unbounded"/>
			</xs:sequence>
		</xs:complexType>
	</xs:element>
	<xs:element name="Sound">
		<xs:complexType>
			<xs:sequence>
				<xs:element ref="Datei" minOccurs="1" maxOccurs="1"/>
			</xs:sequence>
			<xs:attribute name="Autostart" type="xs:boolean"/>
			<xs:attribute name="GeschwAendern" type="xs:boolean"/>
			<xs:attribute name="Lautstaerke" type="xs:float"/>
			<xs:attribute name="Loop" type="xs:boolean"/>
			<xs:attribute name="MaxRadius" type="xs:float"/>
			<xs:attribute name="MinRadius" type="xs:float"/>
			<xs:attribute name="PosAnlauf" type="xs:int"/>
			<xs:attribute name="PosAuslauf" type="xs:int"/>
			<xs:attribute name="dreiD" type="xs:boolean"/>
		</xs:complexType>
	</xs:element>
	<xs:element name="Abhaengigkeit">
		<xs:complexType>
			<xs:sequence>
				<xs:element ref="Kennfeld"/>
			</xs:sequence>
			<xs:attribute name="LautstaerkeAbh" type="xs:boolean"/>
			<xs:attribute name="PhysikGroesse"/> <!-- Datentyp integer enum -->
			<xs:attribute name="SoundGeschwAbh" type="xs:boolean"/>
			<xs:attribute name="SoundOperator"/> <!-- Datentyp integer enum -->
			<xs:attribute name="Trigger"/> <!-- Datentyp integer enum -->
			<xs:attribute name="TriggerGrenze" type="xs:float"/>
		</xs:complexType>
	</xs:element>
	<xs:element name="Kennfeld">
		<xs:complexType>
			<xs:sequence>
				<xs:element ref="Pkt"/>
				<xs:element ref="Stufe"/>
			</xs:sequence>
			<xs:attribute name="Beschreibung" type="xs:string"/>
			<xs:attribute name="xText" type="xs:string"/>
			<xs:attribute name="yText" type="xs:string"/>
		</xs:complexType>
	</xs:element>
	<xs:element name="Pkt">
		<xs:complexType>
			<xs:attribute name="PktX" type="xs:float"/>
			<xs:attribute name="PktY" type="xs:float"/>
		</xs:complexType>
	</xs:element>
	<xs:element name="Stufe">
		<xs:complexType>
			<xs:attribute name="StufenWert" type="xs:float"/>
		</xs:complexType>
	</xs:element>
	<xs:complexType name="AniPunkt">
		<xs:sequence>
			<xs:element ref="AniPunkt"/>
		</xs:sequence>
	</xs:complexType>
	<xs:element name="AniPunkt">
		<xs:complexType>
			<xs:sequence>
				<xs:element ref="p"/>
				<xs:element ref="q"/>
			</xs:sequence>
			<xs:attribute name="AniDimmung" type="xs:float"/>
			<xs:attribute name="AniZeit" type="xs:float"/>
		</xs:complexType>
	</xs:element>
	<xs:element name="q">
		<xs:complexType>
			<xs:attribute name="W" type="xs:float"/>
			<xs:attribute name="X" type="xs:float"/>
			<xs:attribute name="Y" type="xs:float"/>
			<xs:attribute name="Z" type="xs:float"/>
		</xs:complexType>
	</xs:element>
</xs:schema>