update docs and rename isPath to is Dir Path

This commit is contained in:
Mustafa-Zarkash 2023-09-29 17:25:04 +03:00
parent b93da3bd3d
commit a4d55b420b
7 changed files with 17 additions and 19 deletions

View file

@ -787,7 +787,7 @@ def update_houdini_vars_context():
template_data
)
if item["is_path"]:
if item["is_dir_path"]:
item_value = item_value.replace("\\", "/")
try:
os.makedirs(item_value)

View file

@ -6,7 +6,7 @@
{
"var": "JOB",
"value": "{root[work]}/{project[name]}/{hierarchy}/{asset}/work/{task[name]}",
"is_path": true
"is_dir_path": true
}
]
}

View file

@ -37,8 +37,8 @@
},
{
"type": "boolean",
"key": "is_path",
"label": "isPath"
"key": "is_dir_path",
"label": "is Dir Path"
}
]
}

View file

@ -6,7 +6,7 @@ class HoudiniVarModel(BaseSettingsModel):
_layout = "expanded"
var: str = Field("", title="Var")
value: str = Field("", title="Value")
is_path: bool = Field(False, title="isPath")
is_dir_path: bool = Field(False, title="is Dir Path")
class UpdateHoudiniVarcontextModel(BaseSettingsModel):
@ -32,7 +32,7 @@ DEFAULT_GENERAL_SETTINGS = {
{
"var": "JOB",
"value": "{root[work]}/{project[name]}/{hierarchy}/{asset}/work/{task[name]}", # noqa
"is_path": True
"is_dir_path": True
}
]
}

View file

@ -4,26 +4,24 @@ title: Houdini
sidebar_label: Houdini
---
## General Settings
### JOB Path
### Houdini Vars
Allows admins to have a list of vars (e.g. JOB) with (dynamic) values that will be updated on context changes, e.g. when switching to another asset or task.
Using template keys is supported but formatting keys capitalization variants is not, e.g. `{Asset}` and `{ASSET}` won't work
The Houdini `$JOB` path can be customized through project settings with a (dynamic) path that will be updated on context changes, e.g. when switching to another asset or task.
:::note
If the folder does not exist on the context change it will be created by this feature so that `$JOB` will always try to point to an existing folder.
If `is Dir Path` toggle is activated, Openpype will consider the given value is a path of a folder.
If the folder does not exist on the context change it will be created by this feature so that the path will always try to point to an existing folder.
:::
Disabling this feature will leave `$JOB` var unmanaged and thus no context update changes will occur.
Disabling `Update Houdini vars on context change` feature will leave all Houdini vars unmanaged and thus no context update changes will occur.
JOB Path can be:
- Arbitrary path
- Openpype template path
> This allows dynamic values for assets or shots.<br>
> Using template keys is supported but formatting keys capitalization variants is not,
> e.g. `{Asset}` and `{ASSET}` won't work
- Empty
> In this case, JOB will be synced to HIP
> If `$JOB` is present in the Houdini var list and has an empty value, OpenPype will set its value to `$HIP`
![update job on context change](assets/houdini/update-job-context-change.png)
![update-houdini-vars-context-change](assets/houdini/update-houdini-vars-context-change.png)

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 7.9 KiB