Include profile when making a mod

- Since the profile may now specify how mesh data needs to be packed into vertex buffers, it will be needed in the mod file
- The profile is optional since many older mods won't have it and don't need it (but newer mods may require it)
- Change SnapshotProfile format into something more easily deserialized without a lot of manual code
- Same for SnapMeta

Author: jmquigs

MMLaunch/ModUtil.fs

@@ -39,6 +39,7 @@ module ModUtil =
         Ref: string
         ModType: string // subtype of the mod (gpureplacement, etc)
         MeshPath: string
+        Profile: ModelMod.SnapshotProfile.Profile
     }
 
     let getOutputPath modRoot modName = Path.GetFullPath(Path.Combine(modRoot, modName))
@@ -199,6 +200,17 @@ mods:"""
                 sr.Serialize(sw, refObj) 
                 refYamlFile
 
+            // look for a snapshot meta file which may contain information about what profile was used
+            let metaFile = Path.Combine(snapSrcDir, srcBasename + "_Meta.yaml")
+            let snapProfile = 
+                if File.Exists(metaFile) then 
+                    let sd = new Deserializer()
+                    use f = File.OpenText(metaFile);
+                    let p = sd.Deserialize<ModelMod.Snapshot.SnapMeta>(f)
+                    p.Profile
+                else 
+                    ModelMod.SnapshotProfile.EmptyProfile
+
             // generate mod yaml 
             let modYamlFile = 
                 let modYamlFile = Path.Combine(modOutDir, modBasename + ".yaml")
@@ -207,6 +219,7 @@ mods:"""
                     ModType = "GPUReplacement"
                     Ref = refBasename
                     MeshPath = Path.GetFileName(modMMObjFile)
+                    Profile = snapProfile
                 }
                 let sr = new Serializer()
                 use sw = new StreamWriter(modYamlFile)

MMManaged/MeshTransform.fs

@@ -169,47 +169,47 @@ module MeshTransform =
     /// to change the order in which they are applied (see buildInvocation,buildReverseInvocation).
     /// This function operates on spatial mesh data (positions and normals).
     // NOTE: this implementation has some good points, but I'm sure it could be done more simply.
-    let private applyMeshTransformsInternal (xforms:string list) (invokeBuilder) (mesh:Mesh) =
-        if xforms.IsEmpty then
+    let private applyMeshTransformsInternal (xforms:string array) (invokeBuilder) (mesh:Mesh) =
+        if xforms.Length = 0 then
             mesh
         else
             // helper function to allow the mesh to be passed to parseXformFunc
             let getMeshXformFunc xname = parseVec3XformFunc false mesh xname
 
             // convert all the names (and arguments) into functions
-            let funcs = xforms |> List.map getMeshXformFunc
+            let funcs = xforms |> Array.map getMeshXformFunc
             // reduce to apply the functions in order with a single function
             let compositeTransform = funcs |> Seq.map invokeBuilder |> Seq.reduce (>>)
 
             let mesh = MeshUtil.applyPositionTransformation compositeTransform mesh
 
             // also need to do normals
             let getMeshXformFunc xname = parseVec3XformFunc true mesh xname
-            let funcs = xforms |> List.map getMeshXformFunc
+            let funcs = xforms |> Array.map getMeshXformFunc
             let compositeTransform = funcs |> Seq.map invokeBuilder |> Seq.reduce (>>)
             let mesh = MeshUtil.applyNormalTransformation compositeTransform mesh
             mesh
 
     /// As for applyMeshTransformsInternal, but for uv coordinates.
-    let private applyUVTransformsInternal (uv_xforms:string list) (invokeBuilder) (mesh:Mesh) =
-        if uv_xforms.IsEmpty then
+    let private applyUVTransformsInternal (uv_xforms:string []) (invokeBuilder) (mesh:Mesh) =
+        if uv_xforms.Length = 0 then
             mesh
         else
             let getMeshXformFunc xname = parseVec2XformFunc false mesh xname
-            let funcs = uv_xforms |> List.map getMeshXformFunc
+            let funcs = uv_xforms |> Array.map getMeshXformFunc
             let compositeTransform = funcs |> Seq.map invokeBuilder |> Seq.reduce (>>)
 
             let mesh = MeshUtil.applyUVTransformation compositeTransform mesh
             mesh
 
     /// Apply the specified list of transforms to the mesh.
-    let applyMeshTransforms (xforms:string list) (uvXforms:string list) (mesh:Mesh) =
+    let applyMeshTransforms (xforms:string []) (uvXforms:string []) (mesh:Mesh) =
         let mesh = applyMeshTransformsInternal xforms buildInvocation mesh
         let mesh = applyUVTransformsInternal uvXforms buildInvocation mesh
         mesh
 
     /// Reverse each supplied transform, then apply them to the mesh.
-    let reverseMeshTransforms (xforms:string list) (uvXforms:string list) (mesh:Mesh) =
-        let mesh = applyMeshTransformsInternal (List.rev xforms) buildReverseInvocation mesh
-        let mesh = applyUVTransformsInternal (List.rev uvXforms) buildReverseInvocation mesh
+    let reverseMeshTransforms (xforms:string []) (uvXforms:string []) (mesh:Mesh) =
+        let mesh = applyMeshTransformsInternal (Array.rev xforms) buildReverseInvocation mesh
+        let mesh = applyUVTransformsInternal (Array.rev uvXforms) buildReverseInvocation mesh
         mesh

MMManaged/ModDB.fs

@@ -96,7 +96,7 @@ module ModDB =
         let mesh = MeshUtil.readFrom(path, modType, flags)
         if flags.ReverseTransform &&
             (mesh.AppliedPositionTransforms.Length > 0 || mesh.AppliedUVTransforms.Length > 0) then
-            let mesh = MeshTransform.reverseMeshTransforms (List.ofArray mesh.AppliedPositionTransforms) (List.ofArray mesh.AppliedUVTransforms) mesh
+            let mesh = MeshTransform.reverseMeshTransforms (mesh.AppliedPositionTransforms) (mesh.AppliedUVTransforms) mesh
             // clear out applied transforms, since they have been reversed.
             { mesh with AppliedPositionTransforms = [||]; AppliedUVTransforms = [||] }
         else

MMManaged/Snapshot.fs

@@ -118,9 +118,18 @@ module Snapshot =
         BlendWeight: float32 * float32 * float32 * float32 -> unit
     }
 
-    type SnapMeta(profile:SnapshotProfile.Profile) = 
-        member x.Profile with get() = profile
-        member x.Context with get() = CoreState.Context
+    type SnapMeta() = 
+        let mutable profile:SnapshotProfile.Profile = SnapshotProfile.EmptyProfile
+        let mutable context:string = ""
+
+        static member Create(profile):SnapMeta = 
+            let p = SnapMeta()
+            p.Profile <- profile
+            p.Context <- CoreState.Context
+            p
+
+        member x.Profile with get() = profile and set v = profile <- v
+        member x.Context with get() = context and set v = context <- v
 
     /// Reads a vertex element.  Uses the read output functions to pipe the data to an appropriate handler
     /// function, depending on the type.
@@ -795,8 +804,8 @@ module Snapshot =
                 BlendWeights = blendWeights.ToArray()
                 Declaration = None
                 BinaryVertexData = None
-                AppliedPositionTransforms = Array.ofList appliedPosTransforms
-                AppliedUVTransforms = Array.ofList appliedUVTransforms
+                AppliedPositionTransforms = appliedPosTransforms.ToArray()
+                AppliedUVTransforms = appliedUVTransforms.ToArray()
                 Tex0Path = texName 0
                 Tex1Path = texName 1
                 Tex2Path = texName 2
@@ -806,7 +815,7 @@ module Snapshot =
             }
 
             // apply tranforms
-            let mesh = MeshTransform.applyMeshTransforms appliedPosTransforms appliedUVTransforms mesh
+            let mesh = MeshTransform.applyMeshTransforms (appliedPosTransforms.ToArray()) (appliedUVTransforms.ToArray()) mesh
 
             // write mesh
             let meshfile = sprintf "%s.mmobj" sbasename
@@ -858,7 +867,7 @@ module Snapshot =
             let metaFile = Path.Combine(baseDir, (sprintf "%s_Meta.yaml" sbasename))
             let serializer = Serializer()
             let sw = new StringWriter();
-            serializer.Serialize(sw, SnapMeta(snapProfile))
+            serializer.Serialize(sw, SnapMeta.Create(snapProfile))
             File.WriteAllText(metaFile, (sw.ToString()))
 
             log.Info "Wrote snapshot %d to %s" snapshotNum.Value baseDir

MMManaged/SnapshotProfile.fs

@@ -17,28 +17,35 @@ open System.IO
 module SnapshotProfile =
     let private log = Logging.getLogger("SnapshotProfile")
 
-    type Profile(name,posX,uvX,flipTangent,vecEncoding:string) =
-        let vecEncoding = vecEncoding.Trim()
-        let isPacked = vecEncoding.ToLowerInvariant() = "packed"
-        let isOcta = vecEncoding.ToLowerInvariant() = "octa"
-
-        do 
-            if vecEncoding = "" && not isPacked && not isOcta then 
-                log.Warn "Illegal vector encoding for specified profile %A: %A" name vecEncoding
-
-        member x.Name with get() = name
-        member x.PosXForm with get() = posX
-        member x.UVXForm with get() = uvX
-        member x.FlipTang with get() = flipTangent
-        member x.VecEncoding with get() = vecEncoding
-
-        member x.IsPackedVec() = isPacked
-        member x.IsOctaVec() = isOcta
+    type Profile() =
+        let mutable name:string = "";
+        let mutable posX:ResizeArray<String> = new ResizeArray<string>();
+        let mutable uvX:ResizeArray<String> = new ResizeArray<string>();
+        let mutable flipTangent:bool = false;
+        let mutable vecEncoding:string = "";
+
+        static member Create(name,posX,uvX,flipTangent,vecEncoding:string):Profile = 
+            let p = new Profile()
+            p.Name <- name
+            p.PosXForm <- posX 
+            p.UVXForm <- uvX
+            p.FlipTang <- flipTangent
+            p.VecEncoding <- vecEncoding
+            p
+
+        member x.Name with get() = name and set v = name <- v
+        member x.PosXForm with get() = posX and set v = posX <- v 
+        member x.UVXForm with get() = uvX and set v = uvX <- v
+        member x.FlipTang with get() = flipTangent and set v = flipTangent <- v
+        member x.VecEncoding with get() = vecEncoding and set v = vecEncoding <- v
+
+        member x.IsPackedVec() = vecEncoding.Trim().ToLowerInvariant() = "packed"
+        member x.IsOctaVec() = vecEncoding.Trim().ToLowerInvariant() = "octa"
 
         override x.ToString() =
             sprintf "[SnapshotProfile: %s; pos: %A; uv: %A, fliptangent: %A, vecencoding: %A]" name posX uvX flipTangent vecEncoding
 
-    let EmptyProfile = Profile("",[],[],false,"")
+    let EmptyProfile = Profile.Create("",new ResizeArray<string>(),new ResizeArray<string>(),false,"")
 
     /// This profile should always exist in SnapshotProfiles.yaml.
     /// If it does not, new game profiles will be created with an empty snapshot profile (not an error, but not desirable either)
@@ -62,13 +69,13 @@ module SnapshotProfile =
                         let pname = p.Key |> Yaml.toString
                         let pvals = p.Value |> Yaml.toMapping "expected a mapping"
 
-                        let getStrList def key =
+                        let getStrArray def key =
                             pvals
                             |> Yaml.getOptionalValue key
                             |> Yaml.toOptionalSequence
                             |> function
                                 | None -> def
-                                | Some s -> s |> Seq.map Yaml.toString |> List.ofSeq
+                                | Some s -> s |> Seq.map Yaml.toString |> Array.ofSeq |> fun a -> new ResizeArray<string>(a)
 
                         let getBool def key = 
                             pvals 
@@ -87,12 +94,12 @@ module SnapshotProfile =
                                 | Some s -> s
 
 
-                        let posX = getStrList [] "pos"
-                        let uvX = getStrList [] "uv"
+                        let posX = getStrArray (new ResizeArray<string>()) "pos"
+                        let uvX = getStrArray (new ResizeArray<string>()) "uv"
                         let flipTang = getBool false "flipTangent"
                         let vecEncoding = getString "" "vecEncoding"
 
-                        profiles.Add(pname,Profile(pname,posX,uvX,flipTang,vecEncoding))
+                        profiles.Add(pname,Profile.Create(pname,posX,uvX,flipTang,vecEncoding))
             )
         profiles.ToArray() |> Map.ofArray
 

MMView/MMView.fsproj

@@ -10,7 +10,7 @@
     <RootNamespace>MeshView</RootNamespace>
     <AssemblyName>MeshView</AssemblyName>
     <TargetFrameworkVersion>v4.5</TargetFrameworkVersion>
-    <AutoGenerateBindingRedirects>false</AutoGenerateBindingRedirects>
+    <AutoGenerateBindingRedirects>true</AutoGenerateBindingRedirects>
     <TargetFSharpCoreVersion>4.6.0.0</TargetFSharpCoreVersion>
     <Name>MMView</Name>
   </PropertyGroup>

Test.MMManaged/TestMeshTransform.fs

@@ -23,7 +23,7 @@ let ``MeshTransform: basic rotation``() =
 [<Test>]
 let ``MeshTransform: go ape with the monolith``() =
     // this test is too big, but it does exercise the majority of the transforming code, at least
-    let nm = monolith |> MeshTransform.applyMeshTransforms ["rot x 90"; "rot z 45"; "scale 0.5"] []
+    let nm = monolith |> MeshTransform.applyMeshTransforms [|"rot x 90"; "rot z 45"; "scale 0.5"|] [||]
 
     // for visual debugging:
     //MeshUtil.WriteObj nm (Path.Combine(Util.TestDataDir, "monolith.OUT.mmobj"))