Skip to content

Commit

Permalink
Merge pull request #93 from ynput/rename_family_to_producttype
Browse files Browse the repository at this point in the history
  • Loading branch information
mkolar authored Nov 30, 2023
2 parents 6f3785d + b878a52 commit 947370a
Show file tree
Hide file tree
Showing 75 changed files with 285 additions and 345 deletions.
7 changes: 3 additions & 4 deletions website/docs/addon_aftereffects_artist.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ sidebar_label: AfterEffects
- [Load](artist_tools_loader)
- [Publish](artist_tools_publisher)
- [Manage](artist_tools_inventory)
- [Subset Manager](artist_tools_subset_manager)

## Setup

Expand Down Expand Up @@ -39,7 +38,7 @@ You can show the extension panel by going to `Window` > `Extensions` > `AYON`.

When you are ready to share some work, you will need to publish it. This is done by opening the `Publisher` through the `Publish...` button.

There is always instance for workfile created automatically (see 'workfileCompositing' item in `Subsets to publish` column.) This allows to publish (and therefore backup) workfile which is used to produce another publishable elements (as `image` and `review` items).
There is always instance for workfile created automatically (see 'workfileCompositing' item in `Products to publish` column.) This allows to publish (and therefore backup) workfile which is used to produce another publishable elements (as `image` and `review` items).

Main publishable item in AfterEffects will be of `render` family. Result of this item (instance) is picture sequence that could be a final delivery product or loaded and used in another DCCs.

Expand All @@ -49,7 +48,7 @@ After this process you should have something like this:

![Highlights](assets/aftereffects_publish_instance.png)

Name of publishable instance (eg. subset name) could be configured with a template in `project_settings/global/tools/creator/subset_name_profiles`.
Name of publishable instance (eg. product name) could be configured with a template in `project_settings/global/tools/creator/product_name_profiles`.
(This must be configured by admin who has access to AYON Settings.)

Trash icon under the list of instances allows to delete any selected `render` instance.
Expand Down Expand Up @@ -110,7 +109,7 @@ The supported families for loading into AfterEffects are:
- `audio`
- `background` `(set of images sorted in predefined order)`

To load an item, right-click on the subset you want and choose a representation you want to load:
To load an item, right-click on the product you want and choose a representation you want to load:

![Loader](assets/photoshop_loader_load.gif)

Expand Down
16 changes: 8 additions & 8 deletions website/docs/addon_blender_artist.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,27 +52,27 @@ publish. Go **AYON → Create... → Model**.
with correct name as you've started Blender or switched context to specific asset. You
can edit that field to change it to different asset (but that one must already exists).

`Subset` field is a name you can decide on. It should describe what kind of data you
`Product` field is a name you can decide on. It should describe what kind of data you
have in the model. For example, you can name it `Proxy` to indicate that this is
low resolution stuff. See [Subset](artist_concepts.md#subset).
low resolution stuff. See [Product](artist_concepts.md#product).

<!-- :::note LOD support
By changing subset name you can take advantage of _LOD support_ in AYON. Your
asset can contain various resolution defined by different subsets. You can then
By changing product name you can take advantage of _LOD support_ in AYON. Your
asset can contain various resolution defined by different products. You can then
switch between them very easy using [Inventory (Manage)](artist_tools_inventory).
There LODs are conveniently grouped so they don't clutter Inventory view.
Name your subset like `main_LOD1`. Important part is that `_LOD1`. You can have as many LODs as you need.
Name your product like `main_LOD1`. Important part is that `_LOD1`. You can have as many LODs as you need.
::: -->

Read-only field just under it show final subset name, adding subset field to
Read-only field just under it show final product name, adding product field to
name of the group you have selected.

`Use selection` checkbox will use whatever you have selected in Outliner to be
wrapped in Model instance. This is usually what you want. Click on **Create** button.

You'll notice then after you've created new Model instance, there is a new
collection in Outliner called after your asset and subset, in our case it is
collection in Outliner called after your asset and product, in our case it is
`character1_modelDefault`. The assets selected when creating the Model instance
are linked in the new collection.

Expand Down Expand Up @@ -184,7 +184,7 @@ Select your whole rig hierarchy and go **AYON → Create...**. Select **Rig**.

![Blender - Rig Hierarchy Example](assets/blender-rig_create.jpg)

A new collection named after the selected Asset and Subset should have been created.
A new collection named after the selected Asset and Product should have been created.
In our case, it is `character1_rigDefault`. All the selected armature and models
have been linked in this new collection. You should end up with something like
this:
Expand Down
4 changes: 2 additions & 2 deletions website/docs/addon_deadline_admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,11 +101,11 @@ Each publishing from AYON consists of 2 jobs, first one is rendering, second one
- `Families`: "render"
- `Add Ftrack Family` to "Enabled"

Make sure that you actually configured to create review for published subset in `ayon+settings://deadline/publish/ProcessSubmittedJobOnFarm`
Make sure that you actually configured to create review for published product in `ayon+settings://deadline/publish/ProcessSubmittedJobOnFarm`

![Ftrack Family](assets/deadline_review.png)

Example: I want to create review for all reviewable subsets in Harmony :
Example: I want to create review for all reviewable products in Harmony :
- Add "harmony" as a new key an ".*" as a value.


Expand Down
2 changes: 1 addition & 1 deletion website/docs/addon_ftrack_actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ You can add same note to multiple Asset Versions at once with this action.
<div class="row markdown">
<div class="col col--10 markdown">

## Delete Asset/Subset
## Delete Asset/Product

</div>
<div class="col col--2 markdown">
Expand Down
2 changes: 1 addition & 1 deletion website/docs/addon_harmony_artist.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ The supported families for Harmony are:
- `workfile`
- Only of type `zip`.

To load, right-click on the subset you want and choose a representation:
To load, right-click on the product you want and choose a representation:

![Loader](assets/photoshop_loader_load.gif) <!-- gif has to be changed (Harmony needed) -->

Expand Down
8 changes: 4 additions & 4 deletions website/docs/addon_hiero_artist.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,15 +89,15 @@ This tool will set any defined colorspace definition from AYON `Settings / Proje

<div class="row markdown">

With AYON, 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.
With AYON, 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 *products*, with or without **reference video**. Publishig is naturally creating clip's **thumbnails** and assigns it to shot *asset*. Hiero is also publishing **audio** *product* 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>

<iframe width="512px" height="288px" src="https://www.youtube.com/embed/mdIfbTY5fCc" frameborder="0" modestbranding="1" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen="1"></iframe>

### 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 recommend following.
1. Merge all tracks which supposed to be one and they are multiply 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**
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 *product* 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 AYON will trim this to appropriate length with use of FFMPEG. Please be avare we only support MP4(h264) or JPG sequence at the moment.

Expand Down Expand Up @@ -130,7 +130,7 @@ In AYON it is done by tagging a clip with our own metadata. Select all clips you
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.
Then you can alter Product name, but this will be changed dynamically and replaces with timeline's track name.
<br></br>

Keep **Use selection** on.
Expand Down Expand Up @@ -160,7 +160,7 @@ In case you wish to use *multiple elements of shots* workflow then keep **Enambl
</div>
<div class="col col--6 markdown">

Subset name is created dynamically if `<track_name>` is selected on **Subset name**.
Product name is created dynamically if `<track_name>` is selected on **Product 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`
Expand Down
4 changes: 2 additions & 2 deletions website/docs/addon_houdini_admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ In this example I made two shelves:


## Creator plugins
Enable or disable the plugins. Some of them have extra options such as defining the default subsets names.
Enable or disable the plugins. Some of them have extra options such as defining the default products names.

- Create Alembic Camera
- Create Arnold Ass
Expand All @@ -110,7 +110,7 @@ Enable or disable the plugins executed at publishing.
- Validate Latest Containers
- Validate Mesh is Static
- Validate Review Colorspace
- Validate Subset Name
- Validate Product Name
- Validate Unreal Static Mesh Name
- Validate workfile paths settings

Expand Down
14 changes: 7 additions & 7 deletions website/docs/addon_houdini_artist.md
Original file line number Diff line number Diff line change
Expand Up @@ -267,7 +267,7 @@ Steps:
- Ayon will create Flimbox FBX ROP in **/out** with path and frame range already set.
- After that, you can **AYON -> Publish** and after some validations your mesh will be published to a `.fbx` file.

:::info Node Name and subset name
:::info Node Name and product name
By default, the name will be something like this `staticMeshMain`

![staticmesh-name-default](assets/houdini/artist/staticmesh-name-default.png)
Expand Down Expand Up @@ -393,19 +393,19 @@ For more info, Go to [Manage (Inventory)](artist_tools_inventory)

### How does Ayon name ROP nodes ? and is it safe to rename them ?

Nodes are named after their `subset` names by default.
It's safe to change the node name but it's not safe to change the `subset` name (found in `Extra` attributes) without referring to your pipeline admin.
![extra_attributes_subset](assets/houdini/artist/extra_attributes_subset.png)
Nodes are named after their `product` names by default.
It's safe to change the node name but it's not safe to change the `product` name (found in `Extra` attributes) without referring to your pipeline admin.
![extra_attributes_product](assets/houdini/artist/extra_attributes_subsets.png)

The default subset naming profile consists of family name (product type) and variant name
The default product naming profile consists of family name (product type) and variant name
For example if you are creating a `camera` publish and set the variant to name `Main`
Then Ayon will create a rop node with the name `cameraMain`.

:::info
Admins are free to update subset naming profiles.
Admins are free to update product naming profiles.
:::

![faq_subset_name](assets/houdini/artist/faq_subset_name.png)
![faq_product_name](assets/houdini/artist/faq_product_name.png)

### Does Ayon work with vanilla Houdini ROPs and Deadline nodes ?
This feature is not implemented yet.
Expand Down
4 changes: 2 additions & 2 deletions website/docs/addon_maya_admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ Object named `SomeCube_0001_foo_GEO` will pass but `SomeCube_GEO` will not and `
There is a validation for top level group name too. You can specify whatever regex you'd like to use. Default will
pass everything with `_GRP` suffix. You can use *named capturing groups* to validate against specific data. If you
put `(?P<asset>.*)` it will try to match everything captured in that group against current asset name. Likewise you can
use it for **subset** and **project** - `(?P<subset>.*)` and `(?P<project>.*)`.
use it for **product** and **project** - `(?P<product>.*)` and `(?P<project>.*)`.

**Example**

Expand Down Expand Up @@ -100,7 +100,7 @@ list of paths specified in **Settings**. You can find it in **Settings -> Projec

## Templated Build Workfile

Building a workfile using a template designed by users. Helping to assert homogeneous subsets hierarchy and imports. Template stored as file easy to define, change and customize for production needs.
Building a workfile using a template designed by users. Helping to assert homogeneous products hierarchy and imports. Template stored as file easy to define, change and customize for production needs.

**1. Make a template**

Expand Down
2 changes: 1 addition & 1 deletion website/docs/addon_maya_arnold_artist.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ aiSubdivIterations
:::

### Standin Proxy Workflow
If a subset has a proxy representation, this will be used as display in the viewport. At render time the standin path will be replaced using the recommended string replacement workflow;
If a product has a proxy representation, this will be used as display in the viewport. At render time the standin path will be replaced using the recommended string replacement workflow;

https://help.autodesk.com/view/ARNOL/ENU/?guid=arnold_for_maya_operators_am_Updating_procedural_file_paths_with_string_replace_html

Expand Down
Loading

0 comments on commit 947370a

Please sign in to comment.