|
static private ReadObject ( string FileName, System Encoding, |
||
| FileName | string | The text file to load the animated object from. Must be an absolute file name. |
| Encoding | System | The encoding the file is saved in. If the file uses a byte order mark, the encoding indicated by the byte order mark is used and the Encoding parameter is ignored. |
| LoadMode | The texture load mode. | |
| return | ||
/// <summary>Attempts to load and parse the current train's panel configuration file.</summary>
/// <param name="TrainPath">The absolute on-disk path to the train folder.</param>
/// <param name="Encoding">The automatically detected or manually set encoding of the panel configuration file.</param>
/// <param name="Train">The base train on which to apply the panel configuration.</param>
internal static void ParsePanelConfig(string TrainPath, System.Text.Encoding Encoding, TrainManager.Train Train)
{
string File = OpenBveApi.Path.CombineFile(TrainPath, "panel.animated");
if (System.IO.File.Exists(File))
{
Program.AppendToLogFile("Loading train panel: " + File);
ObjectManager.AnimatedObjectCollection a = AnimatedObjectParser.ReadObject(File, Encoding, ObjectManager.ObjectLoadMode.DontAllowUnloadOfTextures);
try
{
for (int i = 0; i < a.Objects.Length; i++)
{
a.Objects[i].ObjectIndex = ObjectManager.CreateDynamicObject();
}
Train.Cars[Train.DriverCar].CarSections[0].Elements = a.Objects;
Train.Cars[Train.DriverCar].CameraRestrictionMode = World.CameraRestrictionMode.NotAvailable;
World.CameraRestriction = World.CameraRestrictionMode.NotAvailable;
World.UpdateViewingDistances();
}
catch
{
var currentError = Interface.GetInterfaceString("error_critical_file");
currentError = currentError.Replace("[file]", "panel.animated");
MessageBox.Show(currentError, Application.ProductName, MessageBoxButtons.OK, MessageBoxIcon.Hand);
Program.RestartArguments = " ";
Loading.Cancel = true;
}
}
else
{
var Panel2 = false;
try
{
File = OpenBveApi.Path.CombineFile(TrainPath, "panel2.cfg");
if (System.IO.File.Exists(File))
{
Program.AppendToLogFile("Loading train panel: " + File);
Panel2 = true;
Panel2CfgParser.ParsePanel2Config("panel2.cfg", TrainPath, Encoding, Train, Train.DriverCar);
Train.Cars[Train.DriverCar].CameraRestrictionMode = World.CameraRestrictionMode.On;
World.CameraRestriction = World.CameraRestrictionMode.On;
}
else
{
File = OpenBveApi.Path.CombineFile(TrainPath, "panel.cfg");
if (System.IO.File.Exists(File))
{
Program.AppendToLogFile("Loading train panel: " + File);
PanelCfgParser.ParsePanelConfig(TrainPath, Encoding, Train);
Train.Cars[Train.DriverCar].CameraRestrictionMode = World.CameraRestrictionMode.On;
World.CameraRestriction = World.CameraRestrictionMode.On;
}
else
{
World.CameraRestriction = World.CameraRestrictionMode.NotAvailable;
}
}
}
catch
{
var currentError = Interface.GetInterfaceString("errors_critical_file");
currentError = currentError.Replace("[file]", Panel2 == true ? "panel2.cfg" : "panel.cfg");
MessageBox.Show(currentError, Application.ProductName, MessageBoxButtons.OK, MessageBoxIcon.Hand);
Program.RestartArguments = " ";
Loading.Cancel = true;
}
}
}
/// <summary>Attempts to load and parse the current train's panel configuration file.</summary>
/// <param name="TrainPath">The absolute on-disk path to the train folder.</param>
/// <param name="Encoding">The automatically detected or manually set encoding of the panel configuration file.</param>
/// <param name="Train">The base train on which to apply the panel configuration.</param>
internal static void ParsePanelConfig(string TrainPath, System.Text.Encoding Encoding, Train Train)
{
Train.Cars[Train.DriverCar].CarSections = new CarSection[1];
Train.Cars[Train.DriverCar].CarSections[0] = new CarSection
{
Groups = new ElementsGroup[1]
};
Train.Cars[Train.DriverCar].CarSections[0].Groups[0] = new ElementsGroup
{
Elements = new ObjectManager.AnimatedObject[] { },
Overlay = true
};
string File = OpenBveApi.Path.CombineFile(TrainPath, "panel.xml");
if (!System.IO.File.Exists(File))
{
//Try animated variant too
File = OpenBveApi.Path.CombineFile(TrainPath, "panel.animated.xml");
}
if (System.IO.File.Exists(File))
{
Program.FileSystem.AppendToLogFile("Loading train panel: " + File);
try
{
/*
* First load the XML. We use this to determine
* whether this is a 2D or a 3D animated panel
*/
XDocument CurrentXML = XDocument.Load(File, LoadOptions.SetLineInfo);
// Check for null
if (CurrentXML.Root != null)
{
IEnumerable <XElement> DocumentElements = CurrentXML.Root.Elements("PanelAnimated");
if (DocumentElements.Any())
{
PanelAnimatedXmlParser.ParsePanelAnimatedXml(System.IO.Path.GetFileName(File), TrainPath, Train, Train.DriverCar);
Train.Cars[Train.DriverCar].CameraRestrictionMode = Camera.RestrictionMode.NotAvailable;
World.CameraRestriction = Camera.RestrictionMode.NotAvailable;
}
DocumentElements = CurrentXML.Root.Elements("Panel");
if (DocumentElements.Any())
{
PanelXmlParser.ParsePanelXml(System.IO.Path.GetFileName(File), TrainPath, Train, Train.DriverCar);
Train.Cars[Train.DriverCar].CameraRestrictionMode = Camera.RestrictionMode.On;
World.CameraRestriction = Camera.RestrictionMode.On;
}
}
}
catch
{
var currentError = Translations.GetInterfaceString("errors_critical_file");
currentError = currentError.Replace("[file]", "panel.xml");
MessageBox.Show(currentError, Application.ProductName, MessageBoxButtons.OK, MessageBoxIcon.Hand);
Program.RestartArguments = " ";
Loading.Cancel = true;
return;
}
if (Train.Cars[Train.DriverCar].CarSections[0].Groups[0].Elements.Any())
{
World.UpdateViewingDistances();
return;
}
Interface.AddMessage(MessageType.Error, false, "The panel.xml file " + File + " failed to load. Falling back to legacy panel.");
}
else
{
File = OpenBveApi.Path.CombineFile(TrainPath, "panel.animated");
if (System.IO.File.Exists(File))
{
Program.FileSystem.AppendToLogFile("Loading train panel: " + File);
if (System.IO.File.Exists(OpenBveApi.Path.CombineFile(TrainPath, "panel2.cfg")) || System.IO.File.Exists(OpenBveApi.Path.CombineFile(TrainPath, "panel.cfg")))
{
Program.FileSystem.AppendToLogFile("INFO: This train contains both a 2D and a 3D panel. The 3D panel will always take precedence");
}
ObjectManager.AnimatedObjectCollection a = AnimatedObjectParser.ReadObject(File, Encoding);
if (a != null)
{
//HACK: If a == null , loading our animated object completely failed (Missing objects?). Fallback to trying the panel2.cfg
try
{
for (int i = 0; i < a.Objects.Length; i++)
{
a.Objects[i].ObjectIndex = ObjectManager.CreateDynamicObject();
}
Train.Cars[Train.DriverCar].CarSections[0].Groups[0].Elements = a.Objects;
Train.Cars[Train.DriverCar].CameraRestrictionMode = Camera.RestrictionMode.NotAvailable;
World.CameraRestriction = Camera.RestrictionMode.NotAvailable;
World.UpdateViewingDistances();
return;
}
catch
{
var currentError = Translations.GetInterfaceString("errors_critical_file");
currentError = currentError.Replace("[file]", "panel.animated");
MessageBox.Show(currentError, Application.ProductName, MessageBoxButtons.OK, MessageBoxIcon.Hand);
Program.RestartArguments = " ";
Loading.Cancel = true;
return;
}
}
Interface.AddMessage(MessageType.Error, false, "The panel.animated file " + File + " failed to load. Falling back to 2D panel.");
}
}
var Panel2 = false;
try
{
File = OpenBveApi.Path.CombineFile(TrainPath, "panel2.cfg");
if (System.IO.File.Exists(File))
{
Program.FileSystem.AppendToLogFile("Loading train panel: " + File);
Panel2 = true;
Panel2CfgParser.ParsePanel2Config("panel2.cfg", TrainPath, Encoding, Train, Train.DriverCar);
Train.Cars[Train.DriverCar].CameraRestrictionMode = Camera.RestrictionMode.On;
World.CameraRestriction = Camera.RestrictionMode.On;
}
else
{
File = OpenBveApi.Path.CombineFile(TrainPath, "panel.cfg");
if (System.IO.File.Exists(File))
{
Program.FileSystem.AppendToLogFile("Loading train panel: " + File);
PanelCfgParser.ParsePanelConfig(TrainPath, Encoding, Train);
Train.Cars[Train.DriverCar].CameraRestrictionMode = Camera.RestrictionMode.On;
World.CameraRestriction = Camera.RestrictionMode.On;
}
else
{
World.CameraRestriction = Camera.RestrictionMode.NotAvailable;
}
}
}
catch
{
var currentError = Translations.GetInterfaceString("errors_critical_file");
currentError = currentError.Replace("[file]", Panel2 ? "panel2.cfg" : "panel.cfg");
MessageBox.Show(currentError, Application.ProductName, MessageBoxButtons.OK, MessageBoxIcon.Hand);
Program.RestartArguments = " ";
Loading.Cancel = true;
}
}
/// <summary>Loads an object</summary>
/// <param name="FileName">The file to load</param>
/// <param name="Encoding">The text endcoding of the base file (Used if the encoding cannot be auto-detected)</param>
/// <param name="PreserveVertices">Whether object should be optimized to remove duplicate vertices</param>
/// <returns>The new object, or a null reference if loading fails</returns>
/*
* Notes for refactoring:
* * Unused vertices must only be preserved in deformable objects (e.g. Crack and Form)
* * TODO / BUG: No detection of actual file contents, which will make all parsers barf
*/
internal static UnifiedObject LoadObject(string FileName, Encoding Encoding, bool PreserveVertices)
{
if (String.IsNullOrEmpty(FileName))
{
return(null);
}
#if !DEBUG
try {
#endif
if (!System.IO.Path.HasExtension(FileName))
{
while (true)
{
var f = OpenBveApi.Path.CombineFile(System.IO.Path.GetDirectoryName(FileName), System.IO.Path.GetFileName(FileName) + ".x");
if (System.IO.File.Exists(f))
{
FileName = f;
break;
}
f = OpenBveApi.Path.CombineFile(System.IO.Path.GetDirectoryName(FileName), System.IO.Path.GetFileName(FileName) + ".csv");
if (System.IO.File.Exists(f))
{
FileName = f;
break;
}
f = OpenBveApi.Path.CombineFile(System.IO.Path.GetDirectoryName(FileName), System.IO.Path.GetFileName(FileName) + ".b3d");
if (System.IO.File.Exists(f))
{
FileName = f;
break;
}
f = OpenBveApi.Path.CombineFile(System.IO.Path.GetDirectoryName(FileName), System.IO.Path.GetFileName(FileName) + ".xml");
if (System.IO.File.Exists(f))
{
FileName = f;
break;
}
f = OpenBveApi.Path.CombineFile(System.IO.Path.GetDirectoryName(FileName), System.IO.Path.GetFileName(FileName) + ".l3dgrp");
if (System.IO.File.Exists(f))
{
FileName = f;
break;
}
f = OpenBveApi.Path.CombineFile(System.IO.Path.GetDirectoryName(FileName), System.IO.Path.GetFileName(FileName) + ".l3dobj");
if (System.IO.File.Exists(f))
{
FileName = f;
break;
}
}
}
UnifiedObject Result;
TextEncoding.Encoding newEncoding = TextEncoding.GetEncodingFromFile(FileName);
if (newEncoding != TextEncoding.Encoding.Unknown)
{
switch (newEncoding)
{
case TextEncoding.Encoding.Utf7:
Encoding = System.Text.Encoding.UTF7;
break;
case TextEncoding.Encoding.Utf8:
Encoding = System.Text.Encoding.UTF8;
break;
case TextEncoding.Encoding.Utf16Le:
Encoding = System.Text.Encoding.Unicode;
break;
case TextEncoding.Encoding.Utf16Be:
Encoding = System.Text.Encoding.BigEndianUnicode;
break;
case TextEncoding.Encoding.Utf32Le:
Encoding = System.Text.Encoding.UTF32;
break;
case TextEncoding.Encoding.Utf32Be:
Encoding = System.Text.Encoding.GetEncoding(12001);
break;
case TextEncoding.Encoding.Shift_JIS:
Encoding = System.Text.Encoding.GetEncoding(932);
break;
case TextEncoding.Encoding.Windows1252:
Encoding = System.Text.Encoding.GetEncoding(1252);
break;
case TextEncoding.Encoding.Big5:
Encoding = System.Text.Encoding.GetEncoding(950);
break;
case TextEncoding.Encoding.EUC_KR:
Encoding = System.Text.Encoding.GetEncoding(949);
break;
}
}
string e = System.IO.Path.GetExtension(FileName);
if (e == null)
{
Interface.AddMessage(MessageType.Error, false, "The file " + FileName + " does not have a recognised extension.");
return(null);
}
switch (e.ToLowerInvariant())
{
case ".csv":
case ".b3d":
case ".x":
case ".obj":
Program.CurrentHost.LoadObject(FileName, Encoding, out Result);
break;
case ".animated":
Result = AnimatedObjectParser.ReadObject(FileName, Encoding);
break;
case ".xml":
Result = XMLParser.ReadObject(FileName, Encoding);
break;
case ".l3dgrp":
Result = Ls3DGrpParser.ReadObject(FileName, Encoding, new Vector3());
break;
case ".l3dobj":
Result = Ls3DObjectParser.ReadObject(FileName, new Vector3());
break;
case ".s":
Result = MsTsShapeParser.ReadObject(FileName);
break;
default:
Interface.AddMessage(MessageType.Error, false, "The file extension is not supported: " + FileName);
return(null);
}
if (Result != null)
{
Result.OptimizeObject(PreserveVertices, Interface.CurrentOptions.ObjectOptimizationBasicThreshold, Interface.CurrentOptions.ObjectOptimizationVertexCulling);
}
return(Result);
#if !DEBUG
}
catch (Exception ex) {
Interface.AddMessage(MessageType.Error, true, "An unexpected error occured (" + ex.Message + ") while attempting to load the file " + FileName);
return(null);
}
#endif
}
/// <summary>Attempts to load and parse the current train's panel configuration file.</summary>
/// <param name="TrainPath">The absolute on-disk path to the train folder.</param>
/// <param name="Encoding">The automatically detected or manually set encoding of the panel configuration file.</param>
/// <param name="Train">The base train on which to apply the panel configuration.</param>
internal static void ParsePanelConfig(string TrainPath, System.Text.Encoding Encoding, Train Train)
{
Train.Cars[Train.DriverCar].CarSections = new CarSection[1];
Train.Cars[Train.DriverCar].CarSections[0] = new CarSection
{
Elements = new ObjectManager.AnimatedObject[] { },
Overlay = true
};
string File = OpenBveApi.Path.CombineFile(TrainPath, "panel.animated");
if (System.IO.File.Exists(File))
{
Program.FileSystem.AppendToLogFile("Loading train panel: " + File);
if (System.IO.File.Exists(OpenBveApi.Path.CombineFile(TrainPath, "panel2.cfg")) || System.IO.File.Exists(OpenBveApi.Path.CombineFile(TrainPath, "panel.cfg")))
{
Program.FileSystem.AppendToLogFile("INFO: This train contains both a 2D and a 3D panel. The 3D panel will always take precedence");
}
ObjectManager.AnimatedObjectCollection a = AnimatedObjectParser.ReadObject(File, Encoding);
if (a != null)
{
//HACK: If a == null , loading our animated object completely failed (Missing objects?). Fallback to trying the panel2.cfg
try
{
for (int i = 0; i < a.Objects.Length; i++)
{
a.Objects[i].ObjectIndex = ObjectManager.CreateDynamicObject();
}
Train.Cars[Train.DriverCar].CarSections[0].Elements = a.Objects;
Train.Cars[Train.DriverCar].CameraRestrictionMode = Camera.RestrictionMode.NotAvailable;
World.CameraRestriction = Camera.RestrictionMode.NotAvailable;
World.UpdateViewingDistances();
return;
}
catch
{
var currentError = Translations.GetInterfaceString("errors_critical_file");
currentError = currentError.Replace("[file]", "panel.animated");
MessageBox.Show(currentError, Application.ProductName, MessageBoxButtons.OK, MessageBoxIcon.Hand);
Program.RestartArguments = " ";
Loading.Cancel = true;
return;
}
}
Interface.AddMessage(MessageType.Error, false, "The panel.animated file " + File + " failed to load. Falling back to 2D panel.");
}
var Panel2 = false;
try
{
File = OpenBveApi.Path.CombineFile(TrainPath, "panel2.cfg");
if (System.IO.File.Exists(File))
{
Program.FileSystem.AppendToLogFile("Loading train panel: " + File);
Panel2 = true;
Panel2CfgParser.ParsePanel2Config("panel2.cfg", TrainPath, Encoding, Train, Train.DriverCar);
Train.Cars[Train.DriverCar].CameraRestrictionMode = Camera.RestrictionMode.On;
World.CameraRestriction = Camera.RestrictionMode.On;
}
else
{
File = OpenBveApi.Path.CombineFile(TrainPath, "panel.cfg");
if (System.IO.File.Exists(File))
{
Program.FileSystem.AppendToLogFile("Loading train panel: " + File);
PanelCfgParser.ParsePanelConfig(TrainPath, Encoding, Train);
Train.Cars[Train.DriverCar].CameraRestrictionMode = Camera.RestrictionMode.On;
World.CameraRestriction = Camera.RestrictionMode.On;
}
else
{
World.CameraRestriction = Camera.RestrictionMode.NotAvailable;
}
}
}
catch
{
var currentError = Translations.GetInterfaceString("errors_critical_file");
currentError = currentError.Replace("[file]", Panel2 == true ? "panel2.cfg" : "panel.cfg");
MessageBox.Show(currentError, Application.ProductName, MessageBoxButtons.OK, MessageBoxIcon.Hand);
Program.RestartArguments = " ";
Loading.Cancel = true;
}
}