Build shot structure from the database

[antirotor]

Note

This is port of ynput/ayon-core#25 from ayon-core. For comments and review notes, please have a look at the conversation in the original PR.

Changelog Description

Added a button to build the shot structure as sequences from the database.
Also fixes the folder entity issue which is also implemented : #14

OpenPype PR linked to ynput/OpenPype#6168

[LiborBatek]

Im getting error when triggering the build sequence action as follows

LogPython: Error: Traceback (most recent call last):
LogPython: Error:   File "C:\Users\lbate\AppData\Local\Ynput\AYON\addons\unreal_0.2.2-dev.1\ayon_unreal\api\hierarchy.py", line 287, in <lambda>
LogPython: Error:     lambda: _on_confirm_clicked(folder_selector, sequence_path, project)
LogPython: Error:             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
LogPython: Error:   File "C:\Users\lbate\AppData\Local\Ynput\AYON\addons\unreal_0.2.2-dev.1\ayon_unreal\api\hierarchy.py", line 252, in _on_confirm_clicked
LogPython: Error:     _create_sequence(
LogPython: Error:   File "C:\Users\lbate\AppData\Local\Ynput\AYON\addons\unreal_0.2.2-dev.1\ayon_unreal\api\hierarchy.py", line 172, in _create_sequence
LogPython: Error:     _create_sequence(
LogPython: Error:   File "C:\Users\lbate\AppData\Local\Ynput\AYON\addons\unreal_0.2.2-dev.1\ayon_unreal\api\hierarchy.py", line 164, in _create_sequence
LogPython: Error:     sequence, frame_range = generate_sequence(name, hierarchy_dir)
LogPython: Error:                             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
LogPython: Error:   File "C:\Users\lbate\AppData\Local\Ynput\AYON\addons\unreal_0.2.2-dev.1\ayon_unreal\api\pipeline.py", line 633, in generate_sequence
LogPython: Error:     fps = folder_entity["attrib"].get("fps") or 30.0
LogPython: Error:           ~~~~~~~~~~~~~^^^^^^^^^^
LogPython: Error: TypeError: 'NoneType' object is not subscriptable

I have triggered it on top most folder (as starting point), here is my ayon project with that hierarchy selected and shots inside...

and here is the outcome in UE editor (shots not present atm)

[LiborBatek]

Im getting error when triggering the build sequence action as follows

LogPython: Error: Traceback (most recent call last):
LogPython: Error:   File "C:\Users\lbate\AppData\Local\Ynput\AYON\addons\unreal_0.2.2-dev.1\ayon_unreal\api\hierarchy.py", line 287, in <lambda>
LogPython: Error:     lambda: _on_confirm_clicked(folder_selector, sequence_path, project)
LogPython: Error:             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
LogPython: Error:   File "C:\Users\lbate\AppData\Local\Ynput\AYON\addons\unreal_0.2.2-dev.1\ayon_unreal\api\hierarchy.py", line 252, in _on_confirm_clicked
LogPython: Error:     _create_sequence(
LogPython: Error:   File "C:\Users\lbate\AppData\Local\Ynput\AYON\addons\unreal_0.2.2-dev.1\ayon_unreal\api\hierarchy.py", line 172, in _create_sequence
LogPython: Error:     _create_sequence(
LogPython: Error:   File "C:\Users\lbate\AppData\Local\Ynput\AYON\addons\unreal_0.2.2-dev.1\ayon_unreal\api\hierarchy.py", line 164, in _create_sequence
LogPython: Error:     sequence, frame_range = generate_sequence(name, hierarchy_dir)
LogPython: Error:                             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
LogPython: Error:   File "C:\Users\lbate\AppData\Local\Ynput\AYON\addons\unreal_0.2.2-dev.1\ayon_unreal\api\pipeline.py", line 633, in generate_sequence
LogPython: Error:     fps = folder_entity["attrib"].get("fps") or 30.0
LogPython: Error:           ~~~~~~~~~~~~~^^^^^^^^^^
LogPython: Error: TypeError: 'NoneType' object is not subscriptable

I have triggered it on top most folder (as starting point), here is my ayon project with that hierarchy selected and shots inside...

and here is the outcome in UE editor (shots not present atm)

[LiborBatek]

here is my second try selecting the sq01 as root folder...you can see the result on the left in content browser (shots missing even in these circumstances)

[LiborBatek]

Now it correctly creates shot structure aka folder hierarchy and corresponding shot seq + level in each shot folder as seen on the pic below

One thing to note (probably not within scope of this PR) that when opening parent e.g. episodes_map it does contain all children shots but all being set to default frame ranges and not been correctly positioned on timeline. As this has been mentioned before in ticket for this feature, its a something for future and need to be discussed more - possible OTIO usage etc)

[moonyuet]

@antirotor, I have some discussion with @LiborBatek on the folder structure. Just want to hear your thought on this.
We both think that the shot structure should follow the hierarchy of the project we set in the AYON server.
Let's say the image below. We would have Ayon/{project_name}/episodes/ep01/sq01/sh010 created as the shot structure and sh010 level sequence and sh010_map as level. It seems to align with the project setup and looks more concise.

[antirotor]

We both think that the shot structure should follow the hierarchy of the project we set in the AYON server.

I totally agree!

[moonyuet]

@LiborBatek I have implemented the structure similar to what we have discussed. Can you please test again? Thanks!

[LiborBatek]

It looks better now but still there happens to be redundant folder with actual project inside - in my case Quantum_Demo which should not be there as seen in second scnr from Ayon project browser...

And how it should look:

[antirotor]

So I have a question. Given:

I am running it on already populated (and heavily abused) Unreal project. My point is that:

• the message complaining about "sequence folder not empty" is just remnant of the state where it was actually loading everything into "Sequences" folder in Unreal, or does it have another meaning?
• what about updating - if it means that it has to be empty, what about cases where you work on something, but production meanwhile adds a bunch of new shots? At that moment, I need to either delete everything so it can be re-created again, or I need to manually create whatever is added and that is IMO diminishing usefulness of this feature.

[moonyuet]

So I have a question. Given:

I am running it on already populated (and heavily abused) Unreal project. My point is that:

• the message complaining about "sequence folder not empty" is just remnant of the state where it was actually loading everything into "Sequences" folder in Unreal, or does it have another meaning?
• what about updating - if it means that it has to be empty, what about cases where you work on something, but production meanwhile adds a bunch of new shots? At that moment, I need to either delete everything so it can be re-created again, or I need to manually create whatever is added and that is IMO diminishing usefulness of this feature.

So I have a question. Given:

I am running it on already populated (and heavily abused) Unreal project. My point is that:

• the message complaining about "sequence folder not empty" is just remnant of the state where it was actually loading everything into "Sequences" folder in Unreal, or does it have another meaning?

This message is irrelevant anymore regarding to the change of the PR. It needs some rephrases.

• what about updating - if it means that it has to be empty, what about cases where you work on something, but production meanwhile adds a bunch of new shots? At that moment, I need to either delete everything so it can be re-created again, or I need to manually create whatever is added and that is IMO diminishing usefulness of this feature.

We need to improve the message and move some codes a little bit.

[moonyuet]

@LiborBatek @antirotor I have modified the check on the directory creation and it won't be limited to create level/level sequences anymore but user would receive the message about that. Just FYI there is a case of which the users create the sequence hierarchy with the existing folders and they would receive the warning from default unreal engine. Although the popup warns the users about the creation, it won't block to create the level/level sequence for the shot.

[LiborBatek]

Now this feature Build shot structure from the database correctly creates folder structure and its also possible to re-run the action and the user gets info about already existing folder structure.

I guess the editorial aka correct clip in/outs need to be still implemented / done (in separate PR??) @antirotor or?

as all sequences being on the very same clip in/out atm

[antirotor]

I wanted to say that we can do clipIn/out in next PR, but we are already getting that data, could we just add it there? Like - if it takes more then 20 minutes, I wouldn't do it.

The timeline stuff is something that we'll need to revisit later anyway because we should do it via OTIO.

[antirotor]

Apparently, because I've transfered the PR and so I am the author, I cannot approve it :D

[moonyuet]

Apparently, because I've transfered the PR and so I am the author, I cannot approve it :D

Ask @LiborBatek for helping.(Or Me?)

stale review