Fix 1276602 incorrect uchar pcache import (#129)

* Base Commit

* Updated Documentation with explicit limitations.

* Fixed incorrect Merge

* Add regression Test

* Removed Test as It can't handle Exceptions thrown in Custom Importers

* Fixed value divider

Co-authored-by: Thomas ICHÉ <[email protected]>

Author: 2 people

com.unity.visualeffectgraph/Documentation~/PointCaches.md

@@ -14,6 +14,10 @@ Point cache Assets follow the Open Source [Point Cache](https://github.com/peewe
 
 ![](Images/PointCacheImporter.png)
 
+### Limitations and Caveats
+
+Currently, only the `float` and `uchar` property types are supported by the Importer. Any property of other types will return an error.
+
 ## Point Cache Operator
 
 Point cache Assets can be referenced in a Point Cache Operator so it displays its point count and the list of Attribute Maps contained in the Point Cache Asset. The Number and the Name of the Outputs will dynamically change depending on the Asset set in the settings field.

com.unity.visualeffectgraph/Editor/Utilities/pCache/Importer/PointCacheImporter.cs

@@ -124,15 +124,15 @@ public override void OnImportAsset(AssetImportContext ctx)
                     TextureFormat surfaceFormat = TextureFormat.Alpha8;
                     switch (kvp.Value.PropertyType)
                     {
-                        case "byte":
+                        case "uchar":
                             if (kvp.Value.Size == 1) surfaceFormat = TextureFormat.Alpha8;
                             else surfaceFormat = TextureFormat.RGBA32;
                             break;
                         case "float":
                             if (kvp.Value.Size == 1) surfaceFormat = TextureFormat.RHalf;
                             else surfaceFormat = TextureFormat.RGBAHalf;
                             break;
-                        default: throw new NotImplementedException("Types other than byte/float are not supported yet");
+                        default: throw new NotImplementedException("Types other than uchar/float are not supported yet");
                     }
 
                     Texture2D surface = new Texture2D(width, height, surfaceFormat, false);
@@ -155,13 +155,13 @@ public override void OnImportAsset(AssetImportContext ctx)
                         float val = 0.0f;
                         switch (prop.PropertyType)
                         {
-                            case "byte":
+                            case "uchar":
                                 val = Mathf.Clamp01(((byte)pcache.buckets[idx][i]) / 255.0f);
                                 break;
                             case "float":
                                 val = ((float)pcache.buckets[idx][i]);
                                 break;
-                            default: throw new NotImplementedException("Types other than byte/float are not supported yet");
+                            default: throw new NotImplementedException("Types other than uchar/float are not supported yet");
                         }
 
                         SetPropValue(prop.Index, outValues, prop.OutProperty, val);

com.unity.visualeffectgraph/Editor/Utilities/pCache/PCache.cs

@@ -293,7 +293,9 @@ public void SaveToFile(string filePath, Format format = Format.Binary)
                             var prop = properties[j];
                             switch (prop.Type)
                             {
-                                case "byte":
+                                case "char":
+                                    binaryWriter.Write((sbyte)buckets[j][i]); break;
+                                case "uchar":
                                     binaryWriter.Write((byte)buckets[j][i]); break;
                                 case "short":
                                     binaryWriter.Write((short)buckets[j][i]); break;
@@ -321,7 +323,9 @@ public void SaveToFile(string filePath, Format format = Format.Binary)
                             var prop = properties[j];
                             switch (prop.Type)
                             {
-                                case "byte":
+                                case "char":
+                                    sb.Append(((sbyte)buckets[j][i]).ToString(CultureInfo.InvariantCulture)); break;
+                                case "uchar":
                                     sb.Append(((byte)buckets[j][i]).ToString(CultureInfo.InvariantCulture)); break;
                                 case "short":
                                     sb.Append(((short)buckets[j][i]).ToString(CultureInfo.InvariantCulture)); break;
@@ -448,13 +452,14 @@ public static PCache FromFile(string filename)
                             var prop = data.properties[j];
                             switch (prop.Type)
                             {
-                                case "short": data.buckets[j].Add(binaryReader.ReadInt16()); break;
-                                case "ushort": data.buckets[j].Add(binaryReader.ReadUInt16()); break;
-                                case "int": data.buckets[j].Add(binaryReader.ReadInt32()); break;
-                                case "uint": data.buckets[j].Add(binaryReader.ReadUInt32()); break;
-                                case "byte": data.buckets[j].Add(binaryReader.ReadChar()); break;
-                                case "float": data.buckets[j].Add(binaryReader.ReadSingle()); break;
-                                case "double": data.buckets[j].Add(binaryReader.ReadDouble()); break;
+                                case "short": data.buckets[j].Add(binaryReader.ReadInt16());    break;
+                                case "ushort": data.buckets[j].Add(binaryReader.ReadUInt16());  break;
+                                case "int": data.buckets[j].Add(binaryReader.ReadInt32());      break;
+                                case "uint": data.buckets[j].Add(binaryReader.ReadUInt32());    break;
+                                case "char": data.buckets[j].Add(binaryReader.ReadSByte());     break;
+                                case "uchar": data.buckets[j].Add(binaryReader.ReadByte());     break;
+                                case "float": data.buckets[j].Add(binaryReader.ReadSingle());   break;
+                                case "double": data.buckets[j].Add(binaryReader.ReadDouble());  break;
                             }
                         }
                     }
@@ -486,7 +491,8 @@ public static PCache FromFile(string filename)
                             case "ushort": data.buckets[j].Add(ushort.Parse(elements[j], CultureInfo.InvariantCulture)); break;
                             case "int": data.buckets[j].Add(int.Parse(elements[j], CultureInfo.InvariantCulture)); break;
                             case "uint": data.buckets[j].Add(uint.Parse(elements[j], CultureInfo.InvariantCulture)); break;
-                            case "byte": data.buckets[j].Add(byte.Parse(elements[j], CultureInfo.InvariantCulture)); break;
+                            case "char": data.buckets[j].Add(sbyte.Parse(elements[j], CultureInfo.InvariantCulture)); break;
+                            case "uchar": data.buckets[j].Add(byte.Parse(elements[j], CultureInfo.InvariantCulture)); break;
                             case "float": data.buckets[j].Add(float.Parse(elements[j], CultureInfo.InvariantCulture)); break;
                             case "double": data.buckets[j].Add(double.Parse(elements[j], CultureInfo.InvariantCulture)); break;
                         }
@@ -580,7 +586,8 @@ private static int GetPropertySize(string type)
 
         private static Dictionary<string, int> TypeSize = new Dictionary<string, int>()
         {
-            { "byte", 1 },
+            { "char", 1 },
+            { "uchar", 1 },
             { "short", 2 },
             { "ushort", 2 },
             { "int", 4 },