Page MenuHome
Differential D3000

FBX Exporter: New feature "Export active UV map" to export the active (selected) UV map instead of exporting all UV maps.
Needs ReviewPublic
Actions

Authored by Henrik Berglund (cyaoeu) on Jan 14 2018, 11:39 PM.

Details

Reviewers
Bastien Montagne (mont29)
Campbell Barton (campbellbarton)
Summary

This is a feature to allow exporting the active (selected) UV map instead of exporting all UV maps in the file. Some software (like Substance Painter) at the moment only works with a single UV map and if you had several UV maps you wanted to use you would need to create a copy of the mesh, remove one UV map, make another copy of the original mesh, remove the other UV map and so on. This gets worse the more UV maps you have.

This patch attempts to solve this by adding an option (boolean) for enabling the feature of exporting the active UV map. That way you can keep your original mesh and just export it twice (after changing the active UV map) and this way it's a non destructive action, or at least saves you the trouble of copying your mesh a bunch of times and removing the UV maps.

This was made to improve the workflow for exporting a mesh with a single specified UV map for texture creation purposes, but could also be used for any other time you need to export a mesh with a single specific UV map.

Diff Detail

Repository
rBA Blender Add-ons
Branch
fbx_export_specify_exported_uvmap
Build Status
Buildable 1084
Build 1084: arc lint + arc unit

Event Timeline

Henrik Berglund (cyaoeu) created this revision.Jan 14 2018, 11:39 PM
Henrik Berglund (cyaoeu) updated this revision to Diff 9821.Jan 16 2018, 12:01 AM
  • Fix for wrong version.

    Accidently used wrong version of .py files (did make update but forgot to copy files to the actual testing build)
Henrik Berglund (cyaoeu) updated this revision to Diff 9822.EditedJan 16 2018, 12:08 AM
  • Remove uneccessary newline.
Harbormaster completed remote builds in B1084: Diff 9822.Jan 16 2018, 12:08 AM
Henrik Berglund (cyaoeu) edited the summary of this revision. (Show Details)Jan 16 2018, 12:25 AM
Henrik Berglund (cyaoeu) updated this revision to Diff 9823.Jan 16 2018, 12:28 AM
  • Put the new stuff on a new line so it's more obvious that it's new.
Harbormaster completed remote builds in B1085: Diff 9823.Jan 16 2018, 12:28 AM
Henrik Berglund (cyaoeu) updated this revision to Diff 9824.Jan 16 2018, 12:30 AM
  • ... in all files.
Henrik Berglund (cyaoeu) updated this revision to Diff 9825.Jan 16 2018, 12:32 AM
  • Add space so it looks like the rest of the code.
Harbormaster completed remote builds in B1087: Diff 9825.Jan 16 2018, 12:32 AM
Campbell Barton (campbellbarton) added a comment.EditedJan 16 2018, 12:51 AM

Using an index won't work well for multiple objects.
Why not have an option to export only the active map index? - mesh.uv_layers.active_index

Henrik Berglund (cyaoeu) added a comment.Jan 16 2018, 12:49 PM
In D3000#71125, @Campbell Barton (campbellbarton) wrote:

Using an index won't work well for multiple objects.
Why not have an option to export only the active map index? - mesh.uv_layers.active_index

Oh yeah, didn't really think of that. Technically it would work as long as they had the same amount of UV maps per object. But yeah it probably shouldn't stop working if you've got objects that don't have the UV map with a certain index.

That being said with this method you would no longer be able to specify the UV map you want to export within the FBX exporter menu directly and this means you would need to change the UV map yourself for all objects. Without scripting this is kind of annoying because you cannot alt+click a UV map in order to make that the active index for all objects. It is possible when clicking the camera icon (active render) so I'm wondering if this is by design or a bug that you can't do it when alt+clicking the UV map name instead? If alt+clicking a map changed the active index for all objects I would have no problem with your suggestion.

Henrik Berglund (cyaoeu) updated this revision to Diff 9828.Jan 16 2018, 1:35 PM
  • Temporary fix for UV map index range errors with multiple objects.

    Use last UV map index that exists for that mesh if the given index returns an IndexError.
Campbell Barton (campbellbarton) added a comment.Jan 17 2018, 12:00 AM
In D3000#71145, @Henrik Berglund (cyaoeu) wrote:
In D3000#71125, @Campbell Barton (campbellbarton) wrote:

Using an index won't work well for multiple objects.
Why not have an option to export only the active map index? - mesh.uv_layers.active_index

Oh yeah, didn't really think of that. Technically it would work as long as they had the same amount of UV maps per object. But yeah it probably shouldn't stop working if you've got objects that don't have the UV map with a certain index.

That being said with this method you would no longer be able to specify the UV map you want to export within the FBX exporter menu directly and this means you would need to change the UV map yourself for all objects. Without scripting this is kind of annoying because you cannot alt+click a UV map in order to make that the active index for all objects. It is possible when clicking the camera icon (active render) so I'm wondering if this is by design or a bug that you can't do it when alt+clicking the UV map name instead? If alt+clicking a map changed the active index for all objects I would have no problem with your suggestion.

Think using the index like this isn't a good workflow since it assumes all your meshes UV layers are aligned.

Did you report this problem to Substance Painter? Maybe it's best they resolve on their end.

If a single UV is being exported I think it's quite reasonable to export the active / render UV layer.
If we need a way to set this on all meshes at once, then it can be added.

How to other programs that support multiple UV's handle this?

Henrik Berglund (cyaoeu) added a comment.Jan 17 2018, 12:50 AM
In D3000#71158, @Campbell Barton (campbellbarton) wrote:
In D3000#71145, @Henrik Berglund (cyaoeu) wrote:
In D3000#71125, @Campbell Barton (campbellbarton) wrote:

Using an index won't work well for multiple objects.
Why not have an option to export only the active map index? - mesh.uv_layers.active_index

Oh yeah, didn't really think of that. Technically it would work as long as they had the same amount of UV maps per object. But yeah it probably shouldn't stop working if you've got objects that don't have the UV map with a certain index.

That being said with this method you would no longer be able to specify the UV map you want to export within the FBX exporter menu directly and this means you would need to change the UV map yourself for all objects. Without scripting this is kind of annoying because you cannot alt+click a UV map in order to make that the active index for all objects. It is possible when clicking the camera icon (active render) so I'm wondering if this is by design or a bug that you can't do it when alt+clicking the UV map name instead? If alt+clicking a map changed the active index for all objects I would have no problem with your suggestion.

Think using the index like this isn't a good workflow since it assumes all your meshes UV layers are aligned.

Did you report this problem to Substance Painter? Maybe it's best they resolve on their end.

If a single UV is being exported I think it's quite reasonable to export the active / render UV layer.
If we need a way to set this on all meshes at once, then it can be added.

How to other programs that support multiple UV's handle this?

I haven't reported it personally but it's been a feature request over there since 2016. I don't really think getting the UV by index is a problem with the alignment because if they're not aligned they will screw up things when finally exported to a game engine anyway. Not aligning the UVs shouldn't happen too often and if it does you can fix it by creating a copy, renaming the UV map and joining it to your mesh again.

Then again I agree that it's reasonable to export the active UV layer if there's a way to easily select one for multiple meshes. It would save space in the UI too. I don't know how to add this though, I looked through the code for the ALLSELECT stuff but I didn't really understand it, I don't know C. I did notice that alt+click doesn't work for any of those UI elements though, like UV maps, vertex groups and vertex colors.

Henrik Berglund (cyaoeu) updated this revision to Diff 9886.Jan 26 2018, 7:13 PM

Changed behavior to export the active (selected) UV map as per Campbell's suggestion.

  • Changed behavior to export the active (selected) UV map as per
  • Fix prop in UI.
  • Fix typo.
  • Fix wrong prop in if statement.
  • Fix missing space in description.

    The new code being an if statement before the old code (now in an else: statement) looks a bit ugly, not sure how to fix. Also there's still the problem of users not being able to "batch change" the active UV map without using scripting.
Harbormaster completed remote builds in B1124: Diff 9886.Jan 26 2018, 7:13 PM
Henrik Berglund (cyaoeu) retitled this revision from FBX Exporter: New feature "Specify single exported UV map" to specify a single UV map index that will be exported instead of exporting all UV maps. to FBX Exporter: New feature "Export active UV map" to export the active (selected) UV map instead of exporting all UV maps..Jan 26 2018, 7:20 PM
Henrik Berglund (cyaoeu) edited the summary of this revision. (Show Details)
Campbell Barton (campbellbarton) added inline comments.Jan 27 2018, 10:43 AM
io_scene_fbx/__init__.py
51

Not needed.

io_scene_fbx/export_fbx_bin.py
1128–1130

This can be done without copy-pasting UV exporting block.

eg:

for uvindex, uvlayer in enumerate(
    me.uv_layers if not scene_data.settings.export_active_uvmap else 
    (me.uv_layers.active,)
):

Probably neater to assign a variable, but you see the difference.

Henrik Berglund (cyaoeu) updated this revision to Diff 9927.Feb 3 2018, 2:56 AM
Update. Hopefully nothing went wrong...



    

  • Remove no longer used IntProperty import.
    • 

  • Remove code duplication by adding uv_enumerate function that either
    • 

  • Remove unneccesary comment.
    • 

Henrik Berglund (cyaoeu) updated this revision to Diff 9928.Feb 3 2018, 3:00 AM
    

  • Remove whitespace.
    • 

Henrik Berglund (cyaoeu) updated this revision to Diff 9929.Feb 3 2018, 3:02 AM
    

  • Remove more whitespace.
    • 

Henrik Berglund (cyaoeu) marked 2 inline comments as done.Feb 3 2018, 3:05 AM
Added function that replaces enumerate(), by default mimics enumerate but when export_active_uvmap is true it returns the active uv layer index and active uv map instead. Keeps the code the same which looks nicer.
Campbell Barton (campbellbarton) added a comment.Feb 4 2018, 12:57 AM
With some edits, patch seems OK,



Even so its a bit arbitrary - why not another option only to export active vertex color layers too?

(We could have a single option to use active UV's and Colors).






@Bastien Montagne (mont29), what do you think?
io_scene_fbx/__init__.py


361
Name isn't good, sounds like you dont get active UV map if it's disabled.



Maybe call "Only Active UV Map" or "Single UV Map"


io_scene_fbx/export_fbx_bin.py


824–829
If the function is defined on execution, better define two functions, based on scene_data.settings.export_active_uvmap setting.
Henrik Berglund (cyaoeu) added a comment.Feb 4 2018, 1:57 AM


In D3000#71880, @Campbell Barton (campbellbarton) wrote:


With some edits, patch seems OK,



Even so its a bit arbitrary - why not another option only to export active vertex color layers too?

(We could have a single option to use active UV's and Colors).






@Bastien Montagne (mont29), what do you think?





Yes, "only active UV map" is better. I personally didn't use multiple vertex color layers for texturing but yes it sounds like it could be useful, that way you could do a different ID map bake (from vertex colors) on your other UV layer, or a single UV map with several vertex color layers (exported one at a time) for different material setups. I will look into adding the vertex color part.



Also I don't really understand the second comment regarding multiple functions.
Henrik Berglund (cyaoeu) updated this revision to Diff 9945.Feb 4 2018, 8:02 PM
    

  • Change name to "Only...", add active vertex color layer to export.
    • 

Henrik Berglund (cyaoeu) updated this revision to Diff 9946.Feb 4 2018, 8:06 PM
    

  • Remove whitespace.
    • 

Henrik Berglund (cyaoeu) updated this revision to Diff 9957.Feb 5 2018, 3:42 PM
    

  • Fix mistake in tspace argument.
    • 

Henrik Berglund (cyaoeu) marked an inline comment as done.Feb 5 2018, 3:43 PM
Simeon Conzendorf (noemis) added a subscriber: Simeon Conzendorf (noemis).Jan 8 2020, 2:00 PM
Any updates on this topic?



Another feature "in review" which I'd need but it seem never got into master. I also need to specify, which UV Map Layout is used for export. Like I'd also like to have the option to choose which material output branch is used for export.
Revision Contents
Changeset List
PathSize
io_scene_fbx/
17 lines
69 lines
2 lines
Diff 9822
View Options
io_scene_fbx/__init__.py
Loading...
View Options
io_scene_fbx/export_fbx_bin.py
Loading...
View Options
io_scene_fbx/fbx_utils.py
Loading...