Merge pull request #1 from vpenades/master

WIP: Refactoring loader API

Author: xfischer

src/SharpGLTF.Core/Memory/MemoryAccessor.cs

@@ -198,7 +198,7 @@ public static MemoryAccessInfo[] Slice(MemoryAccessInfo[] attributes, int start,
 
         #endregion
 
-        #region types
+        #region nested types
 
         private static int _GetSortingScore(string attribute)
         {

src/SharpGLTF.Core/Schema2/gltf.Accessors.cs

@@ -456,7 +456,7 @@ internal void ValidateNormals(Validation.ValidationContext result)
 
             for (int i = 0; i < normals.Count; ++i)
             {
-                if (result.TryFixUnitLength(i, normals[i]))
+                if (result.TryFixUnitLengthOrError(i, normals[i]))
                 {
                     normals[i] = normals[i].SanitizeNormal();
                 }
@@ -476,7 +476,7 @@ internal void ValidateTangents(Validation.ValidationContext result)
 
             for (int i = 0; i < tangents.Count; ++i)
             {
-                if (result.TryFixTangent(i, tangents[i]))
+                if (result.TryFixTangentOrError(i, tangents[i]))
                 {
                     tangents[i] = tangents[i].SanitizeTangent();
                 }
@@ -523,7 +523,7 @@ internal void ValidateMatrices(Validation.ValidationContext result)
         {
             result = result.GetContext(this);
 
-            SourceBufferView.ValidateBufferUsageData(result);
+            SourceBufferView.ValidateBufferUsagePlainData(result);
             result.CheckLinkMustBeAnyOf(nameof(Dimensions), Dimensions, DimensionType.MAT4);
 
             var matrices = this.AsMatrix4x4Array();
@@ -536,13 +536,13 @@ internal void ValidateMatrices(Validation.ValidationContext result)
 
         internal void ValidateAnimationInput(Validation.ValidationContext result)
         {
-            SourceBufferView.ValidateBufferUsageData(result);
+            SourceBufferView.ValidateBufferUsagePlainData(result);
             result.CheckLinkMustBeAnyOf(nameof(Dimensions), Dimensions, DimensionType.SCALAR);
         }
 
         internal void ValidateAnimationOutput(Validation.ValidationContext result)
         {
-            SourceBufferView.ValidateBufferUsageData(result);
+            SourceBufferView.ValidateBufferUsagePlainData(result);
             result.CheckLinkMustBeAnyOf(nameof(Dimensions), Dimensions, DimensionType.SCALAR, DimensionType.VEC3, DimensionType.VEC4);
         }
 

src/SharpGLTF.Core/Schema2/gltf.Buffer.cs

@@ -44,18 +44,18 @@ internal Buffer(Byte[] content)
         const string EMBEDDEDOCTETSTREAM = "data:application/octet-stream;base64,";
         const string EMBEDDEDGLTFBUFFER = "data:application/gltf-buffer;base64,";
 
-        internal void _ResolveUri(AssetReader satelliteReferenceSolver)
+        internal void _ResolveUri(ReadContext context)
         {
-            _Content = _LoadBinaryBufferUnchecked(_uri, satelliteReferenceSolver);
+            _Content = _LoadBinaryBufferUnchecked(_uri, context);
 
             _uri = null; // When _Data is not empty, clear URI
         }
 
-        private static Byte[] _LoadBinaryBufferUnchecked(string uri, AssetReader satelliteReferenceSolver)
+        private static Byte[] _LoadBinaryBufferUnchecked(string uri, ReadContext context)
         {
             return uri._TryParseBase64Unchecked(EMBEDDEDGLTFBUFFER)
                 ?? uri._TryParseBase64Unchecked(EMBEDDEDOCTETSTREAM)
-                ?? satelliteReferenceSolver.Invoke(uri).ToArray();
+                ?? context.ReadBytes(uri).ToArray();
         }
 
         #endregion

src/SharpGLTF.Core/Schema2/gltf.BufferView.cs

@@ -201,6 +201,8 @@ internal static void CheckAccess(Validation.ValidationContext result, BufferView
             if (bv.IsIndexBuffer)
             {
                 if (dim != DimensionType.SCALAR) result.AddLinkError(("BufferView", bv.LogicalIndex), $"is an IndexBuffer, but accessor dimensions is: {dim}");
+
+                // TODO: these could by fixed by replacing BYTE by UBYTE, SHORT by USHORT, etc
                 if (enc == EncodingType.BYTE)    result.AddLinkError(("BufferView", bv.LogicalIndex), $"is an IndexBuffer, but accessor encoding is (s)byte");
                 if (enc == EncodingType.SHORT)   result.AddLinkError(("BufferView", bv.LogicalIndex), $"is an IndexBuffer, but accessor encoding is (s)short");
                 if (enc == EncodingType.FLOAT)   result.AddLinkError(("BufferView", bv.LogicalIndex), $"is an IndexBuffer, but accessor encoding is float");
@@ -264,11 +266,11 @@ internal void ValidateBufferUsageGPU(Validation.ValidationContext result, Buffer
             result.AddLinkError("Device Buffer Target", $"is set as {this._target.Value}. But an accessor wants to use it as '{usingMode}'.");
         }
 
-        internal void ValidateBufferUsageData(Validation.ValidationContext result)
+        internal void ValidateBufferUsagePlainData(Validation.ValidationContext result)
         {
             if (this._byteStride.HasValue)
             {
-                if (result.TryFixLink("BufferView", "Unexpected ByteStride found. Expected null"))
+                if (result.TryFixLinkOrError("BufferView", "Unexpected ByteStride found. Expected null"))
                 {
                     this._byteStride = null;
                 }
@@ -278,7 +280,7 @@ internal void ValidateBufferUsageData(Validation.ValidationContext result)
 
             if (!this._target.HasValue) return;
 
-            if (result.TryFixLink("Device Buffer Target", $"is set as {this._target.Value}. But an accessor wants to use it as a plain data buffer."))
+            if (result.TryFixLinkOrError("Device Buffer Target", $"is set as {this._target.Value}. But an accessor wants to use it as a plain data buffer."))
             {
                 this._target = null;
             }

src/SharpGLTF.Core/Schema2/gltf.Images.cs

@@ -101,6 +101,16 @@ public string FileExtension
 
         internal int _SourceBufferViewIndex => _bufferView.AsValue(-1);
 
+        internal bool _HasContent
+        {
+            get
+            {
+                if (_bufferView != null) return true;
+                if (_SatelliteImageContent != null) return true;
+                return false;
+            }
+        }
+
         #endregion
 
         #region API
@@ -168,9 +178,8 @@ public void SetSatelliteContent(Byte[] content)
 
             if (imageType == null) throw new ArgumentException($"{nameof(content)} must be a PNG, JPG, DDS or WEBP image", nameof(content));
 
-            this._uri = null;
-            this._mimeType = null;
-            this._bufferView = null;
+            _DiscardContent();
+
             this._SatelliteImageContent = content;
         }
 
@@ -196,24 +205,34 @@ public void TransferToInternalBuffer()
 
         #region binary read
 
-        internal void _ResolveUri(AssetReader externalReferenceSolver)
+        internal void _ResolveUri(ReadContext context)
         {
             if (!String.IsNullOrWhiteSpace(_uri))
             {
-                _SatelliteImageContent = _LoadImageUnchecked(externalReferenceSolver, _uri);
+                var data = _LoadImageUnchecked(context, _uri);
+
+                _SatelliteImageContent = data;
                 _uri = null;
                 _mimeType = null;
             }
         }
 
-        private static Byte[] _LoadImageUnchecked(AssetReader externalReferenceSolver, string uri)
+        private static Byte[] _LoadImageUnchecked(ReadContext context, string uri)
         {
             return uri._TryParseBase64Unchecked(EMBEDDED_GLTF_BUFFER)
                 ?? uri._TryParseBase64Unchecked(EMBEDDED_OCTET_STREAM)
                 ?? uri._TryParseBase64Unchecked(EMBEDDED_JPEG_BUFFER)
                 ?? uri._TryParseBase64Unchecked(EMBEDDED_PNG_BUFFER)
                 ?? uri._TryParseBase64Unchecked(EMBEDDED_DDS_BUFFER)
-                ?? externalReferenceSolver.Invoke(uri).ToArray();
+                ?? context.ReadBytes(uri).ToArray();
+        }
+
+        internal void _DiscardContent()
+        {
+            this._uri = null;
+            this._mimeType = null;
+            this._bufferView = null;
+            this._SatelliteImageContent = null;
         }
 
         #endregion

src/SharpGLTF.Core/Schema2/gltf.Root.cs

@@ -54,13 +54,15 @@ internal ModelRoot()
         public ModelRoot DeepClone()
         {
             var dict = new Dictionary<string, ArraySegment<Byte>>();
-            var settings = WriteSettings.ForDeepClone(dict);
+            var settings = WriteContext.ForDeepClone(dict);
 
             System.Diagnostics.Debug.Assert(settings._NoCloneWatchdog, "invalid clone settings");
 
             this.Write(settings, "deepclone");
 
-            return ModelRoot.ReadFromDictionary(dict, "deepclone.gltf");
+            var context = ReadContext.CreateFromDictionary(dict);
+            context.Validation = Validation.ValidationMode.Strict;
+            return context._ReadFromDictionary("deepclone.gltf");
         }
 
         #endregion