Transcribe FBX Custom Properties to into a glTF extras object

facebookincubator / FBX2glTF

A command-line tool for the conversion of 3D model assets on the FBX file format to the glTF file format.

Other

2.1k stars 332 forks source link

Transcribe FBX Custom Properties to into a glTF extras object #130

Closed zellski closed 6 years ago

zellski commented 6 years ago

FBX allows for custom, typed key/value properties on any FbxObject. Most of these could be mapped to a glTF object, and there they could be transcribed into extras fields, perhaps something like:

"nodes": [{
  "name": "RootNode",
  "children": [ 1 ],
  "extras": {
    "fromFBX": {
      "userProperties": {
        "myCustomProperty": {
          "value": "13",
          "type": "FbxUShortDT"
        }
      }
    }
  }
}, { ... }]

where we just picked a node as an example; could be just about any glTF object. The type names are taken from here and further reading on properties can be found here.

EscapeZero commented 6 years ago

I have this done*, just doing a little more testing before I submit.

not supporting animation or complex types such as time, date-time, enum. all float values get turned into double but preserve original "type".

zellski commented 6 years ago

Great news! Quick work. I haven't seen the code yet obviously, but:

If the output in the glTF is at all verbose, let's make it an opt-in command line switch.
I have another refactor on the way; you can see its current diff against trunk here. If you think that's going to cause a lot of merge conflicts, let's make sure you get yours in first so you don't have to figure out all the little things I changed all over the place.

EscapeZero commented 6 years ago

Output looks like this:

"fromFBX": {
    "userProperties": {
        "currentUVSet": {
            "type": "eFbxString",
            "value": "map1"
        },
        "fidId": {
            "type": "eFbxInt",
            "value": 131
        },
        "blah": {
            "type": "eFbxBool",
            "value": 0
        },
        "ftest": {
            "type": "eFbxDouble",
            "value": 1.33333
        },
        "ded": {
            "type": "eFbxDouble3",
            "value": [
                0.0,
                0.0,
                0.0
            ]
        }
    }
}

currentUVSet only "garbage" I have found so to speak. Maya adds that to every mesh I believe.

zellski commented 6 years ago

Many thanks for the pull! I will wrap it in --user-properties (and --no-user-properties), and I think the default should be 'on'. It's possible someone out there will get cranky that behaviour changes from minor version to minor version, but this is just metadata, it has no effect on the model itself... and we're in beta. So I feel pretty okay with that.