Maya: Enable publishing render attrib sets (e.g. V-Ray Displacement) with model #1955

davidlatwe · 2021-08-23T13:46:27Z

This close pypeclub/client#137.

Feature

Enable extracting render attribute sets (e.g. V-Ray Displacement) while publishing model, as model representation's metadata. So optionally, lookdev artist could use them while working on the model as for a suggestion (or bootstrap) from modeler.

Workflow

Say a modeler have this scene ready to publish a model. There are some simple shading and displacement sets applied to those meshes.
Modeler published the model, lookdev artist takeover and start to work. Model has been referenced from Loader.
Lookdev artist go to the Scene Inventory tool, trying to apply render attribute sets which has been published with current loaded model, to see if they could help.
Render attribute sets has been imported, now the lookdev artist can play with them however he/she wants. Even delete or rename those sets, and whether or not to publish look with them.

Implementation

In contrast to previous implementation (90d80dc), this refactored workflow doesn't change the content of current representation nor add new representation.

Well actually there are two new representation types (meta.render.ma and meta.render.json) be extracted on model publishing since the render attribute sets are being treated as look, just that there are no Loader plugin for them so they won't be loadable in Loader action menu.

original propose from 90d80dc (outdated info)

⚠️ The following description of this PR is outdated.

What's Changed

A new model family representation was introduced: fried.ma (or fried.mb if project settings maps the file extension to mb).

This new representation will not only save extracted un-shaded, clean model, like the regular model representation does, but also objectSet nodes (e.g. V-Ray Displacement) which holds rendering attributes that are related to the published models.

Noticed that if there isn't any render attrib objectSet is affecting the model in workfile, this new representation won't be generated from version publishing.

Fried model ?

The representation name, fried.*, is try to express the model is not being shaded, however it could be bumpy due to the displacement node that being published with it, or other render attributes like subdiv-level which contributed from other rendering related objectSets.

Caveat

When assigning looks to fried.* model via look-assigner tool. If the look also has it's own render attrib sets like fried model does, sets from look may supersede the model's.
Currently not able to switch into other representation.

Implementation details

Since this feature in essence is like publishing model with it's look but without shading-groups. So to avoid implementing new logic for this feature, the publishing code path is inherited from look family.

Currently only V-Ray is tested, Redshift and Arnold shall be tested in next couple days.

[cuID:yjx9fn]

openpype/hosts/maya/plugins/load/load_reference.py

davidlatwe · 2021-08-23T19:02:52Z

openpype/hosts/maya/plugins/publish/collect_look.py

+ render_set_types = [
+ "VRayDisplacement",
+ ]
+ render_sets = cmds.ls(look_sets, type=render_set_types)
+ if render_sets:
+ history.extend(
+ cmds.listHistory(render_sets,
+ future=False,
+ pruneDagObjects=True)
+ or []
+ )


This part also fixed an issue that I found when publishing regular look with VRay Displacement node that uses texture file.

The resource of file texture node that connected to the displacement node is not being remapped during look extraction, because the file node was not being collected here. Hence the published displacement node still linking to working texture file.

openpype/hosts/maya/plugins/publish/extract_look.py

mkolar · 2021-08-25T11:06:47Z

I'll continue the discussion here to keep in central. I'm wondering if this shouldn't actually be a different family and subset, rather than a representation. We're not exactly exporting the same data, but a fair bit more.

Another option would be to dynamically name the representation with as model{Renderer} which would at least denote what attributes one might expect. Considering this is very tightly locked to particular shading attributes. Ending up with modelArnold, modelVray, modelRedshift sounds quite reasonable to me.

Or simple modelrender

davidlatwe · 2021-08-25T16:48:55Z

edit: this comment is outdated

I'm wondering if this shouldn't actually be a different family and subset, rather than a representation.

🤔 I think that depends on how many subset will be created when publishing from one model instance ?

Here's the bottom line for this feature to be implemented :

must have a clean model
render sets related resources (e.g. maps for displacement) should be re-path and published
the mouse clicking time on loading render model, should be less then loading regular model + look assignment
the render model should be able to switch into another representation without a problem (not yet sufficed ATM)

So with above in mind... 🚀

If only one subset, then it should belong to model family's representation level. As current implementation. Because the amount of that additional render data doesn't worth a subset/family to me.

But if more then one subset could be generated, model + look would be my favorite. What I am thinking is, as an alternative, we still publishing clean model, but also publishing look automatically (by adding one additional switch, maybe name it with_look, on to the model creator instance).

And in loading part, where the real beef is, maybe an auto look assignment plugin could be implemented so the artist could load model + look in one shot, in Loader.

Instead of loading whole render(augmented) model from Loader, *import* those render sets from scene inventory as model's metadata which allow lookDev artist to modify it and optionally publish a look from there.

davidlatwe · 2021-09-08T16:16:59Z

Okay, I have refactored and updated the top description for this new implementation. 🚀

mkolar · 2021-09-16T15:51:49Z

@antirotor could you please review this when you find some time?

davidlatwe · 2021-09-16T18:31:56Z

Following set types are also included in latest commit :

VRayLightMesh
VRayObjectProperties
RedshiftObjectId
RedshiftMeshParameters

antirotor · 2021-09-23T16:47:41Z

I've found somethings wrong, probably even with the original look extractor:

It seems that once I have my workfile as Maya Binary, it doesn't want to save it as Maya ASCII as we are forcing it by scene_type = "meta.render.ma"

Shouldn't it get its format from project_settings/maya/ext_mapping in settings?

davidlatwe · 2021-09-23T17:19:11Z

@antirotor Ah yes, I have that fixed in previous implementation (9f11165) but reverted and didn't add back.
Will add that fix back in.

davidlatwe · 2021-09-23T18:37:49Z

After da7dda6, original look extractor and the model render set extractor both able to respect studio scene type config.

antirotor

Works perfectly! 👍🏻

allow publishing model with render sets

90d80dc

davidlatwe requested review from iLLiCiTiT and antirotor August 23, 2021 13:46

davidlatwe added 3 commits August 24, 2021 01:49

fix linter

d9b5242

update doc string

6b27601

remove duplicated code

9f11165

davidlatwe commented Aug 23, 2021

View reviewed changes

openpype/hosts/maya/plugins/load/load_reference.py Outdated Show resolved Hide resolved

davidlatwe commented Aug 23, 2021

View reviewed changes

openpype/hosts/maya/plugins/publish/extract_look.py Outdated Show resolved Hide resolved

davidlatwe added sponsored Client endorsed or requested type: feature Larger, user affecting changes and completely new things host: Maya labels Aug 23, 2021

davidlatwe added 3 commits September 8, 2021 05:57

refactor, publishing render sets as model metadata

7eed3da

Instead of loading whole render(augmented) model from Loader, *import* those render sets from scene inventory as model's metadata which allow lookDev artist to modify it and optionally publish a look from there.

fix linter

84ca6a5

fix linter

316ee85

mkolar assigned davidlatwe Sep 16, 2021

davidlatwe added 2 commits September 17, 2021 02:27

modelrender-sets add vray light-mesh, obj-properties

f96555d

modelrender-sets add redshift object-id, mesh-parameters

da3d4d0

read studio scene type config on extracting look

da7dda6

antirotor approved these changes Sep 24, 2021

View reviewed changes

mkolar merged commit bf39741 into ynput:develop Sep 24, 2021

davidlatwe deleted the feature/maya-publish-augmented-model branch September 24, 2021 13:17

davidlatwe mentioned this pull request Oct 14, 2021

Maya: fix model publishing #2130

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Maya: Enable publishing render attrib sets (e.g. V-Ray Displacement) with model #1955

Maya: Enable publishing render attrib sets (e.g. V-Ray Displacement) with model #1955

davidlatwe commented Aug 23, 2021 •

edited

Loading

davidlatwe Aug 23, 2021 •

edited

Loading

mkolar commented Aug 25, 2021 •

edited

Loading

davidlatwe commented Aug 25, 2021 •

edited

Loading

davidlatwe commented Sep 8, 2021

mkolar commented Sep 16, 2021

davidlatwe commented Sep 16, 2021

antirotor commented Sep 23, 2021

davidlatwe commented Sep 23, 2021

davidlatwe commented Sep 23, 2021

antirotor left a comment

Maya: Enable publishing render attrib sets (e.g. V-Ray Displacement) with model #1955

Maya: Enable publishing render attrib sets (e.g. V-Ray Displacement) with model #1955

Conversation

davidlatwe commented Aug 23, 2021 • edited Loading

Feature

Workflow

Implementation

⚠️ The following description of this PR is outdated.

What's Changed

Fried model ?

Caveat

Implementation details

davidlatwe Aug 23, 2021 • edited Loading

Choose a reason for hiding this comment

mkolar commented Aug 25, 2021 • edited Loading

davidlatwe commented Aug 25, 2021 • edited Loading

davidlatwe commented Sep 8, 2021

mkolar commented Sep 16, 2021

davidlatwe commented Sep 16, 2021

antirotor commented Sep 23, 2021

davidlatwe commented Sep 23, 2021

davidlatwe commented Sep 23, 2021

antirotor left a comment

Choose a reason for hiding this comment

davidlatwe commented Aug 23, 2021 •

edited

Loading

davidlatwe Aug 23, 2021 •

edited

Loading

mkolar commented Aug 25, 2021 •

edited

Loading

davidlatwe commented Aug 25, 2021 •

edited

Loading