mirror of
https://github.com/ynput/ayon-core.git
synced 2025-12-24 21:04:40 +01:00
Hiero: updating documentation
This commit is contained in:
Jakub Jezek
parent
c0e0820739
commit
afca03cdd1
24 changed files with 194 additions and 285 deletions
193
website/docs/artist_hosts_hiero.md
Normal file
193
website/docs/artist_hosts_hiero.md
Normal file
|
|
@ -0,0 +1,193 @@
|
|||
---
|
||||
id: artist_hosts_hiero
|
||||
title: Hiero
|
||||
sidebar_label: Hiero / Nuke Studio
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
:::note
|
||||
All the information also applies to **_Nuke Studio_**(NKS), but for simplicity we only refer to Hiero/NKS. The workflows are identical for both. We are supporting versions **`11.0`** and above.
|
||||
:::
|
||||
|
||||
|
||||
|
||||
## OpenPype global tools
|
||||
|
||||
- [Work Files](artist_tools.md#workfiles)
|
||||
- [Create](artist_tools.md#creator)
|
||||
- [Load](artist_tools.md#loader)
|
||||
- [Manage (Inventory)](artist_tools.md#inventory)
|
||||
- [Publish](artist_tools.md#publisher)
|
||||
|
||||
|
||||
## Hiero specific tools
|
||||
|
||||
|
||||
|
||||
<div class="row markdown">
|
||||
<div class="col col--6 markdown">
|
||||
|
||||
### Create Default Tags
|
||||
|
||||
This tool will recreate all necessary OpenPype tags needed for successful publishing. It is automatically ran at start of the Hiero/NKS. Use this tool to manually re-create all the tags if you accidentaly delete them, or you want to reset them to default values.
|
||||
|
||||
#### Result
|
||||
|
||||
- Will create tags in Tags bin in case there were none
|
||||
- Will set all tags to default values if they have been altered
|
||||
|
||||
</div>
|
||||
<div class="col col--6 markdown">
|
||||
|
||||
 <!-- picture needs to be changed -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="row markdown">
|
||||
<div class="col col--6 markdown">
|
||||
|
||||
### Apply Colorspace Project
|
||||
|
||||
This tool will set any defined colorspace definition from OpenPype `Settings / Project / Anatomy / Color Management and Output Formats / Hiero / Workfile` to Hiero `menu / Project / Edit Settings / Color Management tab`
|
||||
|
||||
#### Result
|
||||
|
||||
- Define corect color management settings on project
|
||||
|
||||
</div>
|
||||
<div class="col col--6 markdown">
|
||||
|
||||
 <!-- picture needs to be changed -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<div class="row markdown">
|
||||
<div class="col col--6 markdown">
|
||||
|
||||
### Apply Colorspace Clips
|
||||
|
||||
This tool will set any defined colorspace definition from OpenPype `Settings / Project / Anatomy / Color Management and Output Formats / Hiero / Colorspace on Inputs by regex detection` to any matching clip's source path.
|
||||
|
||||
#### Result
|
||||
|
||||
- Set correct `Set Media Color Transform` on each clip of active timeline if it matches defined expressions
|
||||
|
||||
</div>
|
||||
<div class="col col--6 markdown">
|
||||
|
||||
 <!-- picture needs to be changed -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
## Publishing Shots
|
||||
|
||||
|
||||
|
||||
<div class="row markdown">
|
||||
|
||||
With OpenPype, you can use Hiero/NKS as a starting point for creating a project's **shots** as *assets* from timeline clips with its *hierarchycal parents* like **episodes**, **sequences**, **folders**, and its child **tasks**. Most importantly it will create **versions** of plate *subsets*, with or without **reference video**. Publishig is naturally creating clip's **thumbnails** and assigns it to shot *asset*. Hiero is also publishing **audio** *subset* and various **soft-effects** either as retiming component as part of published plates or **color-tranformations**, that will be evailable later on for compositor artists to use either as *viewport input-process* or *loaded nodes* in graph editor.
|
||||
<br></br><br></br>
|
||||
|
||||
### Preparing timeline for conversion to instances
|
||||
Because we don't support on-fly data conversion so in case of working with raw camera sources or some other formats which need to be converted for 2D/3D work. We suggest to convert those before and reconform the timeline. Before any clips in timeline could be converted to publishable instances we recomend following.
|
||||
1. Merge all tracks which supposed to be one and they are multipy only because of editor's style
|
||||
2. Rename tracks to follow basic structure > if only one layer then `main` in case of multiple layer (elements) for one shot then `main`, and other elements for example: `bg`, `greenscreen`, `fg01`, `fg02`, `display01`, etc. please avoid using [-/_.,%&*] or spaces. These names will be later used in *subset* name creation as `{family}{trackName}` so for example **plateMain** or **plateFg01**
|
||||
3. Define correct `Set Media Color Transform` at all clips as those will be also published to metadata and used for later loading with correct color transformation.
|
||||
4. Reviewable video material which you wish to be used as preview videos on any supported Projec manager platform (Ftrack) has to be added ideally to track named **review**. This can be offline edit used as reference video for 2D/3D artists. This video material can be edited to fit length of **main** timeline track or it cand be one long video clip under all clips in **main** track, because OpenPype will trim this to appropriate length with use of FFMPEG. Please be avare we only support MP4(h264) or JPG sequence at the moment.
|
||||
|
||||
<div class="col--6 markdown">
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
### Converting timeline clips to instances
|
||||
|
||||
Every clip on timeline which is inteded to be published has to be converted to publishable instance.
|
||||
|
||||
<div class="col col--6 markdown">
|
||||
|
||||
In OpenPype it is done by tagging a clip with our own metadata. Select all clips you wish to convert and `menu > OpenPype > Create`.
|
||||
<br></br><br></br>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="col col--6 markdown">
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<div class="col col--6 markdown">
|
||||
|
||||
Then chose `Create Publishable Clip` in **Instance Creator** dialogue.
|
||||
<br></br>
|
||||
|
||||
Then you can alter Subset name, but this will be changed dynamically and replaces with timeline's track name.
|
||||
<br></br>
|
||||
|
||||
Keep **Use selection** on.
|
||||
<br></br>
|
||||
|
||||
Hit **Create**
|
||||
<br></br>
|
||||
</div>
|
||||
|
||||
<div class="col col--6 markdown">
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<div class="col col--6 markdown">
|
||||
|
||||
Dialogue `Pype publish attributes creator` will open. Here you can define instance properties. If you wish to rename clips dynamically during creation then Keep **Rename clips** ticked.
|
||||
<br></br>
|
||||
|
||||
In case you wish to use *multiple elements of shots* workflow then keep **Enamble vertical sync** ticked on and define correct hero track which is holding main plates, this is usually the **main** track.
|
||||
</div>
|
||||
|
||||
<div class="col col--6 markdown">
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<div class="col col--6 markdown">
|
||||
|
||||
Subset name is created dynamically if `<track_name>` is selected on **Subset name**.
|
||||
<br></br>
|
||||
|
||||
I case you wish to publish reviewable video as explained above then find the appropriate track from drop down menu **Use review track**. Usually named `review`
|
||||
<br></br>
|
||||
|
||||
Hover above each input field for help.
|
||||
<br></br>
|
||||
|
||||
Handles can be defined here to. In case you wish to have individual clip set differently we recomend to set here the default value and later change those in the created OpenPype tag's metadata under `handleStart` and `handleEnd` properties (look bellow for details)
|
||||
</div>
|
||||
|
||||
<div class="col col--6 markdown">
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<div class="col col--6 markdown">
|
||||
|
||||
After you hit **Ok** tags are added to selected clips (except clips in **review** tracks).
|
||||
<br></br>
|
||||
|
||||
If you wish to change any individual propertie of the shot then you are able to do it here. In this example we can change `handleStart` and `handleEnd` to some other values.
|
||||
</div>
|
||||
|
||||
<div class="col col--6 markdown">
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -1,284 +0,0 @@
|
|||
---
|
||||
id: artist_hosts_nukestudio
|
||||
title: Hiero
|
||||
sidebar_label: Hiero / Nuke Studio
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
:::note
|
||||
All the information also applies to **_Nuke Studio_**, but for simplicity we only refer to Hiero. The workflows are identical for both. We are supporting versions **`11.0`** and above.
|
||||
:::
|
||||
|
||||
|
||||
## Hiero specific tools
|
||||
|
||||
|
||||
|
||||
<div class="row markdown">
|
||||
<div class="col col--6 markdown">
|
||||
|
||||
### Create Default Tags
|
||||
|
||||
This tool will recreate all necessary OpenPype tags needed for successful publishing. It is automatically ran at start of the Hiero. Use this tool to manually re-create all the tags if you accidentaly delete them, or you want to reset them to default values.
|
||||
|
||||
</div>
|
||||
<div class="col col--6 markdown">
|
||||
|
||||
 <!-- picture needs to be changed -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
#### Result
|
||||
|
||||
- Will create tags in Tags bin in case there were none
|
||||
- Will set all tags to default values if they have been altered
|
||||
|
||||
## Publishing Shots
|
||||
|
||||
|
||||
|
||||
<div class="row markdown">
|
||||
<div class="col col--6 markdown">
|
||||
|
||||
With OpenPype, you can use Hiero as a starting point for creating project hierarchy in avalon and ftrack database (episodes, sequences, shots, folders etc.), publishing plates, reference quicktimes, audio and various soft effects that will be evailable later on for compositors and 3D artist to use.
|
||||
|
||||
There are two ways to `Publish` data and create shots in database from Hiero. Use either context menu on right clicking selected clips or go to top `menu > OpenPype > Publish`.
|
||||
|
||||
</div>
|
||||
<div class="col col--6 markdown">
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
Keep in mind that the publishing currently works on selected shots
|
||||
|
||||
Shot names for all the related plates that you want to publish (subsets) has to be the same to be correctly paired together (as it is shown in image).
|
||||
Note the layer **review** which contains `plateMainReview`.
|
||||
This media is just h264, 1920x1080 video for that will be used as preview of the actual `plateMain` subset and will be uploaded to Ftrack. We explain how to work with review tag in [**Reviewing**](#reviewing).
|
||||
|
||||
|
||||
:::important
|
||||
To to successfuly publish a shot from Hiero:
|
||||
1. At least one clip of your shot must be tagged with `Hierarchy`, `subset` and `handleStart/End`.
|
||||
2. Your source media must be pre-cut to correct length (including handles)
|
||||
:::
|
||||
|
||||
### Tagging
|
||||
|
||||
|
||||
OpenPype's custom tags are used for defining shot parameters and to define which clips and how they are going to be published.
|
||||
|
||||
If you want to add any properties to your clips you'll need to adjust values on the given tag and then drag it onto the clip.
|
||||
|
||||
|
||||
<figure>
|
||||
|
||||
|
||||
|
||||
<figcaption>
|
||||
|
||||
1. double click on preferable tag and drag&drop it to selected clip(s)
|
||||
2. Basic set of tags on clip (usually subset: plateMain)
|
||||
3. Additionally select clip and edit its parameters
|
||||
4. Edit parameters here but do not touch `family`
|
||||
|
||||
</figcaption>
|
||||
</figure>
|
||||
|
||||
:::important
|
||||
Only clips with `subset` will be directly processed for publishing.
|
||||
:::
|
||||
|
||||
### Custom Tags Details
|
||||
|
||||
#### Asset related
|
||||
| Icon | Description | Editable | Options |
|
||||
| ------------------- | ---------------------------------------------------------------------------------- | ------------------------------------- | ---------------------------------------------------------------------------------------- |
|
||||
| ![Hierarchy][hi] | Define parent hierarchy of the shot. Usually combined with one of subset tags. | root, folder, sequence, episode, shot | example: {sequence} = name of Hiero sequence or overwrite by any text without `-` or `_` |
|
||||
| ![Frame Start][fst] | Set start frame of the shot. Using `"source"` will keep original frame numbers. | number | int `number` or `"source"` |
|
||||
|
||||
|
||||
#### Subsets
|
||||
|
||||
| Icon | Description | Editable | Options |
|
||||
| ------------------ | ------------------------------------------------------------------------------ | -------- | --------------------------------- |
|
||||
| ![Review][rew] | Choose which track holds review quicktime for the given shot. | track | `"review"` or other track name |
|
||||
| ![Plate Main][pmn] | Main plate subset identifier | subset | `"main"` or other |
|
||||
| ![Plate FG][pfg] | Foreground plate subset identifier (comped over the main plate) | subset | `"Fg##"` or other |
|
||||
| ![Plate BG][pbg] | Background plate subset identifier (comped under the main plate) | subset | `"Bg##"` or other |
|
||||
| ![Plate Ref][ref] | Reference plate subset identifier | subset | `"Ref"` or other |
|
||||
|
||||
#### Subset's attributes
|
||||
|
||||
| Icon | Description | Editable | Options |
|
||||
| ------------------ | --------------------------------------------------------------------------------- | ------------------- | ----------------------------- |
|
||||
| ![Resolution][rsl] | Use source resolution instead of sequence settings. | none | |
|
||||
| ![Retiming][rtm] | Publish retime metadata to shot if retime or time-warp found on clip | marginIn, marginOut | int `number` frame cushioning |
|
||||
| ![Lens][lns] | Specify lens focal length metadata (work in progress) | focalLengthMm | int `number` |
|
||||
|
||||
#### Handles
|
||||
|
||||
| Icon | Description | Editable | Options |
|
||||
| --------------------- | ---------------------------------------------------------------------------- | -------- | -------------------------- |
|
||||
| ![Handles Start][ahs] | Handles at the start of the clip/shot | value | change to any int `number` |
|
||||
| ![Handles End][ahe] | Handles at the end of a clip/shot | value | change to any int `number` |
|
||||
|
||||
[hi]: assets/nks_icons/hierarchy.png
|
||||
|
||||
[ahs]: assets/nks_icons/3_add_handles_start.png
|
||||
|
||||
[ahe]: assets/nks_icons/1_add_handles_end.png
|
||||
|
||||
[rsl]: assets/nks_icons/resolution.png
|
||||
|
||||
[rtm]: assets/nks_icons/retiming.png
|
||||
|
||||
[rew]: assets/nks_icons/review.png
|
||||
|
||||
[pmn]: assets/nks_icons/z_layer_main.png
|
||||
|
||||
[pfg]: assets/nks_icons/z_layer_fg.png
|
||||
|
||||
[pbg]: assets/nks_icons/z_layer_bg.png
|
||||
|
||||
[lns]: assets/nks_icons/lense1.png
|
||||
|
||||
[fst]: assets/nks_icons/frame_start.png
|
||||
|
||||
[ref]: assets/nks_icons/reference.png
|
||||
|
||||
### Handles
|
||||
|
||||
OpenPype requires handle information in shot metadata even if they are set to 0.
|
||||
For this you need to add handles tags to the main clip (Should be the one with Hierarchy tag).
|
||||
This way we are defining a shot property. In case you wish to have different
|
||||
handles on other subsets (e.g. when plateBG is longer than plateFG) you can add handle tags with different value to this longer plate.
|
||||
|
||||
If you wish to have different handles length (say 100) than one of the default tags, simply drag `start: add 10 frames` to your clip
|
||||
and then go to clips tags, find the tag, then replace 10 for 100 in name and also change value to 100.
|
||||
This is also explained following tutorial [`Extending premade handles tags`](#extending-premade-handles-tags)
|
||||
|
||||
:::caution
|
||||
Even if you don't need any handles you have to add `start: add 0 frames` and `end: add 0 frames` tags to the clip with Hierarchy tag.
|
||||
:::
|
||||
|
||||
### Retiming
|
||||
|
||||
OpenPype is also able to publish retiming parameters into the database.
|
||||
Any clip with **editorial**/**retime** or **TimeWarp** soft effect has to be tagged with `Retiming` tag, if you want this information preserved during publishing.
|
||||
|
||||
Any animation on **TimeWarp** is also preserved and reapplied in _Nuke_.
|
||||
|
||||
You can only combine **retime** and with a single **Timewarp**.
|
||||
|
||||
### Reviewing
|
||||
|
||||
There are two ways to publish reviewable **h264 mov** into OpenPype (and Ftrack).
|
||||
|
||||
<Tabs
|
||||
defaultValue="reviewtag"
|
||||
values={[
|
||||
{label: 'Review Tag', value: 'reviewtag'},
|
||||
{label: 'Sidecar File', value: 'sidecar'},
|
||||
]}>
|
||||
|
||||
<TabItem value="reviewtag">
|
||||
|
||||
|
||||
|
||||
The first one uses the Review Tag pointing to the track that holds the reviewable quicktimes for plates.
|
||||
|
||||
This tag metadata has `track` key inside that points to `review` track by default. If you drop this tag onto any publishable clip on the timeline you're telling OpenPype "you will find quicktime version of this plate on `review` track (clips must have the same name)"
|
||||
|
||||
In the image on the right we dropped it to **plateMain** clip. Then we renamed the layer tha hold reviewable quicktime called `plateMainReview`. You can see that the clip names are the same.
|
||||
|
||||
|
||||
|
||||
<figure>
|
||||
|
||||
|
||||
|
||||
<figcaption>
|
||||
|
||||
1. `-review` suffix is added to publishing item label if any reviewable file is found
|
||||
2. `plateMain` clip is holding the Review tag
|
||||
3. layer name is `review` as it is used as default in _Review_ Tag in _track_
|
||||
4. name of clip is the same across all subsets
|
||||
|
||||
</figcaption>
|
||||
</figure>
|
||||
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="sidecar">
|
||||
|
||||
Second way would be to add the **h264 mov 1920x1080** into the same folder
|
||||
as image sequence. The name of the file has to be the same as image sequence.
|
||||
Publisher will pick this file up and add it to the files list during collecting.
|
||||
This will also add `"- review"` to instance label in **Publish**.
|
||||
|
||||
Example:
|
||||
|
||||
- img seq: `image_sequence_name.0001.exr`
|
||||
- mov: `image_sequence_name.mov`
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
|
||||
--------------
|
||||
|
||||
|
||||
### LUT Workflow
|
||||
|
||||
|
||||
<div class="row markdown">
|
||||
<div class="col col--6 markdown">
|
||||
|
||||
It is possible to publish Hiero soft effects for compositors to use later on. You can add the effect to a particular clip or to whole layer as shows on the picture. All clips
|
||||
below the `Video 6` layer (green arrow) will be published with the **LUT** subset which combines all the colour corrections from he soft effects. Any clips above the `Video 6` layer will have no **LUT** published with them.
|
||||
|
||||
|
||||
</div>
|
||||
<div class="col col--6 markdown">
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
Any external Lut files used in the soft effects will be copied over to `resources` of the published subset folder `lutPlateMain` (in our example).
|
||||
|
||||
:::note
|
||||
|
||||
<div class="row markdown">
|
||||
<div class="col col--6 markdown">
|
||||
|
||||
You cannot currently publish soft effects on their own because at the moment we only support soft effects as a part of other subset publishing. Image is demonstrating successful publishing.
|
||||
|
||||
</div>
|
||||
<div class="col col--6 markdown">
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
:::
|
||||
|
||||
## Tutorials
|
||||
|
||||
|
||||
### Basic publishing with soft effects
|
||||
|
||||
<iframe src="https://drive.google.com/file/d/1-BN6ia9ic9om69mq3T4jiwZnbrBGdyNi/preview"></iframe>
|
||||
|
||||
|
||||
### Extending premade handles tags
|
||||
|
||||
<iframe src="https://drive.google.com/file/d/1-BexenWWmSURA-QFgxkoZtyxMEhZHOLr/preview"></iframe>
|
||||
BIN
website/docs/assets/hiero_createUIFrames.png
Normal file
BIN
website/docs/assets/hiero_createUIFrames.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 40 KiB |
BIN
website/docs/assets/hiero_createUIRename.png
Normal file
BIN
website/docs/assets/hiero_createUIRename.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 30 KiB |
BIN
website/docs/assets/hiero_defaultTags.png
Normal file
BIN
website/docs/assets/hiero_defaultTags.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 7.1 KiB |
BIN
website/docs/assets/hiero_instanceCreator.png
Normal file
BIN
website/docs/assets/hiero_instanceCreator.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 10 KiB |
BIN
website/docs/assets/hiero_menuColorspaceClip.png
Normal file
BIN
website/docs/assets/hiero_menuColorspaceClip.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 6.4 KiB |
BIN
website/docs/assets/hiero_menuColorspaceProject.png
Normal file
BIN
website/docs/assets/hiero_menuColorspaceProject.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 6.7 KiB |
BIN
website/docs/assets/hiero_menuCreate.png
Normal file
BIN
website/docs/assets/hiero_menuCreate.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 6.4 KiB |
BIN
website/docs/assets/hiero_menuDefaultTags.png
Normal file
BIN
website/docs/assets/hiero_menuDefaultTags.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 9 KiB |
BIN
website/docs/assets/hiero_menuPublish.png
Normal file
BIN
website/docs/assets/hiero_menuPublish.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 5.9 KiB |
BIN
website/docs/assets/hiero_tagHandles.png
Normal file
BIN
website/docs/assets/hiero_tagHandles.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 20 KiB |
BIN
website/docs/assets/hiero_timelinePrep.png
Normal file
BIN
website/docs/assets/hiero_timelinePrep.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 17 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 21 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 5.5 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 14 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 156 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 44 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 13 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 29 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 177 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 77 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 73 KiB |
|
|
@ -16,7 +16,7 @@ module.exports = {
|
|||
collapsed: false,
|
||||
label: "Integrations",
|
||||
items: [
|
||||
"artist_hosts_nukestudio",
|
||||
"artist_hosts_hiero",
|
||||
"artist_hosts_nuke",
|
||||
"artist_hosts_maya",
|
||||
"artist_hosts_blender",
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue