Merge pull request #38 from DomCR/obj-reader

Obj Reader

Author: DomCR

.gitignore

@@ -360,3 +360,5 @@ MigrationBackup/
 !MeshIO.OBJ
 /local
 /src/Tests/outFiles
+!src/Tests/inFiles/obj/
+!src/Tests/inFiles/obj/*.obj

README.md

@@ -30,6 +30,13 @@ For more [information](https://github.com/DomCR/MeshIO/tree/master/src/MeshIO.ST
 
 For more [information](https://github.com/DomCR/MeshIO/tree/master/src/MeshIO.GLTF).
 
+### MeshIO.OBJ
+
+- Read Wavefront OBJ files
+
+For more [information](https://github.com/DomCR/MeshIO/tree/master/src/MeshIO.OBJ).
+
+
 Contributing
 ------------
 

src/CSUtilities

@@ -10,28 +10,17 @@ public class FbxReader : ReaderBase
 	{
 		public FbxReaderOptions Options { get; } = new FbxReaderOptions();
 
-		private Stream _stream;
-
 		/// <summary>
 		/// Initializes a new instance of the <see cref="FbxReader"/> class for the specified file.
 		/// </summary>
-		/// <param name="path">The complete file path to read to.</param>
-		public FbxReader(string path) : this(File.OpenRead(path)) { }
+		/// <param name="path">The complete file path to read from</param>
+		public FbxReader(string path) : base(File.OpenRead(path)) { }
 
 		/// <summary>
 		/// Initializes a new instance of the <see cref="FbxReader"/> class for the specified stream.
 		/// </summary>
-		/// <param name="stream">The stream to write to.</param>
-		public FbxReader(Stream stream)
-		{
-			if (stream == null)
-				throw new ArgumentNullException(nameof(stream));
-
-			if (!stream.CanSeek)
-				throw new ArgumentException("The stream must support seeking. Try reading the data into a buffer first");
-
-			this._stream = stream;
-		}
+		/// <param name="stream">The stream to read from</param>
+		public FbxReader(Stream stream) : base(stream) { }
 
 		/// <summary>
 		/// Read a fbx file into an scene
@@ -76,7 +65,7 @@ public FbxRootNode Parse()
 		/// <summary>
 		/// Read the FBX file
 		/// </summary>
-		public Scene Read()
+		public override Scene Read()
 		{
 			FbxRootNode root = this.Parse();
 			var reader = FbxFileBuilderBase.Create(root, this.Options);
@@ -85,12 +74,6 @@ public Scene Read()
 			return reader.Read();
 		}
 
-		/// <inheritdoc/>
-		public override void Dispose()
-		{
-			_stream.Dispose();
-		}
-
 		private static IFbxParser getParser(Stream stream, FbxReaderOptions options)
 		{
 			IFbxParser parser = null;

src/MeshIO.FBX/FbxReader.cs

@@ -137,10 +137,10 @@ private void readPolygons()
 
 		protected List<Polygon> mapPolygons(int[] arr)
 		{
-			List<Polygon> Polygons = new List<Polygon>();
+			List<Polygon> polygons = new List<Polygon>();
 
 			if (arr == null)
-				return Polygons;
+				return polygons;
 
 			//Check if the arr are faces or quads
 			if (arr[2] < 0)
@@ -153,7 +153,7 @@ protected List<Polygon> mapPolygons(int[] arr)
 						//Substract a unit to the last
 						Math.Abs(arr[i]) - 1);
 
-					Polygons.Add(tmp);
+					polygons.Add(tmp);
 				}
 			}
 			//Quads
@@ -168,11 +168,11 @@ protected List<Polygon> mapPolygons(int[] arr)
 						//Substract a unit to the last
 						Math.Abs(arr[i]) - 1);
 
-					Polygons.Add(tmp);
+					polygons.Add(tmp);
 				}
 			}
 
-			return Polygons;
+			return polygons;
 		}
 
 		protected int[] polygonsArray(Mesh mesh)

src/MeshIO.FBX/Templates/FbxMeshTemplate.cs

@@ -13,47 +13,42 @@ public class GltfReader : ReaderBase
 	{
 		private GlbHeader _header;
 		private GltfRoot _root;
-		private readonly StreamIO _stream;
 		private StreamIO _binaryStream;
 
+		private readonly StreamIO _streamIO;
+
 		public GltfReader(string path) : this(new FileStream(path, FileMode.Open)) { }
 
-		public GltfReader(Stream stream)
+		public GltfReader(Stream stream) : base(stream) 
 		{
-			if (stream == null)
-				throw new ArgumentNullException(nameof(stream));
-
-			if (!stream.CanSeek)
-				throw new ArgumentException("The stream must support seeking. Try reading the data into a buffer first");
-
-			this._stream = new StreamIO(stream);
+			this._streamIO = new StreamIO(this._stream);
 		}
 
 		/// <summary>
 		/// Read the GLTF file
 		/// </summary>
-		public Scene Read()
+		public override Scene Read()
 		{
 			//The 12-byte header consists of three 4-byte entries:
 			this._header = new GlbHeader();
 			//magic equals 0x46546C67. It is ASCII string glTF, and can be used to identify data as Binary glTF.
-			this._header.Magic = this._stream.ReadUInt<LittleEndianConverter>();
+			this._header.Magic = this._streamIO.ReadUInt<LittleEndianConverter>();
 			//version indicates the version of the Binary glTF container format. This specification defines version 2.
-			this._header.Version = this._stream.ReadUInt<LittleEndianConverter>();
+			this._header.Version = this._streamIO.ReadUInt<LittleEndianConverter>();
 			//length is the total length of the Binary glTF, including Header and all Chunks, in bytes.
-			this._header.Length = this._stream.ReadUInt<LittleEndianConverter>();
+			this._header.Length = this._streamIO.ReadUInt<LittleEndianConverter>();
 
 			if (this._header.Version != 2)
 				throw new NotSupportedException($"Version {this._header.Version} not supported");
 
 			//Chunk 0 Json
-			uint jsonChunkLength = this._stream.ReadUInt<LittleEndianConverter>();
-			string jsonChunkType = this._stream.ReadString(4);
+			uint jsonChunkLength = this._streamIO.ReadUInt<LittleEndianConverter>();
+			string jsonChunkType = this._streamIO.ReadString(4);
 
 			if (jsonChunkType != "JSON")
-				throw new GltfReaderException("Chunk type does not match", this._stream.Position);
+				throw new GltfReaderException("Chunk type does not match", this._streamIO.Position);
 
-			string json = this._stream.ReadString((int)jsonChunkLength);
+			string json = this._streamIO.ReadString((int)jsonChunkLength);
 
 #if NETFRAMEWORK || NETSTANDARD
 			_root = Newtonsoft.Json.JsonConvert.DeserializeObject<GltfRoot>(json);
@@ -62,14 +57,14 @@ public Scene Read()
 #endif
 
 			//Chunk 1 bin
-			uint binChunkLength = this._stream.ReadUInt<LittleEndianConverter>();
-			string binChunkType = this._stream.ReadString(4);
+			uint binChunkLength = this._streamIO.ReadUInt<LittleEndianConverter>();
+			string binChunkType = this._streamIO.ReadString(4);
 
 			//Check the chunk type
 			if (binChunkType != "BIN\0")
-				throw new GltfReaderException("Chunk type does not match", this._stream.Position);
+				throw new GltfReaderException("Chunk type does not match", this._streamIO.Position);
 
-			byte[] binChunk = this._stream.ReadBytes((int)binChunkLength);
+			byte[] binChunk = this._streamIO.ReadBytes((int)binChunkLength);
 			this._binaryStream = new StreamIO(binChunk);
 
 			var reader = GltfBinaryReaderBase.GetBynaryReader((int)this._header.Version, this._root, binChunk);
@@ -81,7 +76,6 @@ public Scene Read()
 		/// <inheritdoc/>
 		public override void Dispose()
 		{
-			this._stream.Dispose();
 			this._binaryStream?.Dispose();
 		}
 	}

src/MeshIO.GLTF/GltfReader.cs

@@ -0,0 +1,27 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+	<PropertyGroup>
+		<TargetFramework>net6.0</TargetFramework>
+		<IsPackable>false</IsPackable>
+	</PropertyGroup>
+
+	<ItemGroup>
+		<PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.11.0" />
+		<PackageReference Include="xunit" Version="2.4.1" />
+		<PackageReference Include="xunit.runner.visualstudio" Version="2.4.3">
+			<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+			<PrivateAssets>all</PrivateAssets>
+		</PackageReference>
+		<PackageReference Include="coverlet.collector" Version="3.1.0">
+			<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+			<PrivateAssets>all</PrivateAssets>
+		</PackageReference>
+	</ItemGroup>
+
+	<ItemGroup>
+		<ProjectReference Include="..\MeshIO.OBJ\MeshIO.OBJ.csproj" />
+	</ItemGroup>
+
+	<Import Project="..\MeshIO.Tests.Shared\MeshIO.Tests.Shared.projitems" Label="Shared" />
+
+</Project>

src/MeshIO.OBJ.Tests/MeshIO.OBJ.Tests.csproj

@@ -0,0 +1,38 @@
+using MeshIO.Tests.Shared;
+using System.IO;
+using Xunit;
+using Xunit.Abstractions;
+
+namespace MeshIO.OBJ.Tests
+{
+	public class ObjReaderTest : IOTestsBase
+	{
+		public static readonly TheoryData<string> Files;
+
+		static ObjReaderTest()
+		{
+			Files = new TheoryData<string>();
+			foreach (string file in Directory.GetFiles(FolderPath.InFilesObj, "*.obj"))
+			{
+				Files.Add(file);
+			}
+		}
+
+		public ObjReaderTest(ITestOutputHelper output) : base(output) { }
+
+		[Theory]
+		[MemberData(nameof(Files))]
+		public void ReadTest(string test)
+		{
+			Scene scene = null;
+			using (ObjReader reader = new ObjReader(test))
+			{
+				reader.OnNotification += this.onNotification;
+				scene = reader.Read();
+			}
+
+			Assert.NotNull(scene);
+			Assert.NotEmpty(scene.RootNode.Nodes);
+		}
+	}
+}

src/MeshIO.OBJ.Tests/ObjReaderTest.cs

@@ -2,6 +2,9 @@
 
 	<PropertyGroup>
 		<TargetFrameworks>net6.0;net5.0;net48;netstandard2.1</TargetFrameworks>
+		<PackageId>MeshIO.OBJ</PackageId>
+		<PackageTags>C# 3D obj</PackageTags>
+		<Description>MeshIO module for obj format.</Description>
 	</PropertyGroup>
 
 	<ItemGroup>

src/MeshIO.OBJ/MeshIO.OBJ.csproj

@@ -0,0 +1,52 @@
+using CSMath;
+using System.Collections.Generic;
+
+namespace MeshIO.OBJ
+{
+	internal class ObjData
+	{
+		public ObjTemplate Current { get; private set; }
+
+		public ObjTemplate Placeholder { get; private set; }
+
+		public List<ObjTemplate> Templates { get; private set; } = [];
+
+		public ObjData()
+		{
+			Placeholder = new ObjTemplate(string.Empty);
+		}
+
+		public void CreateIndexer(string line)
+		{
+			this.MoveNext();
+
+			this.Current = new ObjTemplate(line);
+		}
+
+		public void MoveNext()
+		{
+			if (this.Current == null)
+			{
+				return;
+			}
+
+			this.Current.Vertices.AddRange(this.Placeholder.Vertices);
+			this.Current.Normals.AddRange(this.Placeholder.Normals);
+			this.Current.UVs.AddRange(this.Placeholder.UVs);
+
+			this.Current.MeshPolygons.AddRange(this.Placeholder.MeshPolygons);
+			this.Current.TexturePolygons.AddRange(this.Placeholder.TexturePolygons);
+			this.Current.NormalPolygons.AddRange(this.Placeholder.NormalPolygons);
+
+			this.Templates.Add(this.Current);
+
+			this.Placeholder.Vertices.Clear();
+			this.Placeholder.Normals.Clear();
+			this.Placeholder.UVs.Clear();
+
+			this.Placeholder.MeshPolygons.Clear();
+			this.Placeholder.TexturePolygons.Clear();
+			this.Placeholder.NormalPolygons.Clear();
+		}
+	}
+}