Frame13/ayon-core
1
0
Fork 1
mirror of https://github.com/ynput/ayon-core.git synced 2026-01-01 16:34:53 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

renaming integration

Browse source
This commit is contained in:
Ondřej Samohel 2022-03-01 11:32:03 +01:00
parent 3b44a85541
commit 713b82b19c
No known key found for this signature in database
GPG key ID: 02376E18990A97C6
44 changed files with 376 additions and 353 deletions
Download patch file Download diff file Expand all files Collapse all files

2
openpype/hosts/unreal/api/__init__.py
View file

@ -16,7 +16,7 @@ INVENTORY_PATH = os.path.join(PLUGINS_DIR, "inventory")
def install():
"""Install Unreal configuration for Avalon."""
"""Install Unreal configuration for OpenPype."""
print("-=" * 40)
logo = '''.
.

2
openpype/hosts/unreal/api/helpers.py
View file

@ -29,7 +29,7 @@ class OpenPypeHelpers(unreal.OpenPypeLib):
Example:
AvalonHelpers().set_folder_color(
OpenPypeHelpers().set_folder_color(
"/Game/Path", unreal.LinearColor(a=1.0, r=1.0, g=0.5, b=0)
)

18
openpype/hosts/unreal/api/lib.py
View file

@ -230,18 +230,18 @@ def create_unreal_project(project_name: str,
ue_id = "{" + loaded_modules.get("BuildId") + "}"
plugins_path = None
if os.path.isdir(env.get("AVALON_UNREAL_PLUGIN", "")):
if os.path.isdir(env.get("OPENPYPE_UNREAL_PLUGIN", "")):
# copy plugin to correct path under project
plugins_path = pr_dir / "Plugins"
avalon_plugin_path = plugins_path / "Avalon"
if not avalon_plugin_path.is_dir():
avalon_plugin_path.mkdir(parents=True, exist_ok=True)
openpype_plugin_path = plugins_path / "OpenPype"
if not openpype_plugin_path.is_dir():
openpype_plugin_path.mkdir(parents=True, exist_ok=True)
dir_util._path_created = {}
dir_util.copy_tree(os.environ.get("AVALON_UNREAL_PLUGIN"),
avalon_plugin_path.as_posix())
dir_util.copy_tree(os.environ.get("OPENPYPE_UNREAL_PLUGIN"),
openpype_plugin_path.as_posix())
if not (avalon_plugin_path / "Binaries").is_dir() \
or not (avalon_plugin_path / "Intermediate").is_dir():
if not (openpype_plugin_path / "Binaries").is_dir() \
or not (openpype_plugin_path / "Intermediate").is_dir():
dev_mode = True
# data for project file
@ -304,7 +304,7 @@ def _prepare_cpp_project(project_file: Path, engine_path: Path) -> None:
"""Prepare CPP Unreal Project.
This function will add source files needed for project to be
rebuild along with the avalon integration plugin.
rebuild along with the OpenPype integration plugin.
There seems not to be automated way to do it from command line.
But there might be way to create at least those target and build files

74
openpype/hosts/unreal/api/pipeline.py
View file

@ -1,21 +1,17 @@
# -*- coding: utf-8 -*-
import sys
import pyblish.api
from avalon.pipeline import AVALON_CONTAINER_ID
import unreal # noqa
from typing import List
from openpype.tools.utils import host_tools
from avalon import api
AVALON_CONTAINERS = "OpenPypeContainers"
OPENPYPE_CONTAINERS = "OpenPypeContainers"
def install():
pyblish.api.register_host("unreal")
_register_callbacks()
_register_events()
@ -46,7 +42,7 @@ class Creator(api.Creator):
def process(self):
nodes = list()
with unreal.ScopedEditorTransaction("Avalon Creating Instance"):
with unreal.ScopedEditorTransaction("OpenPype Creating Instance"):
if (self.options or {}).get("useSelection"):
self.log.info("setting ...")
print("settings ...")
@ -63,23 +59,21 @@ class Creator(api.Creator):
return instance
class Loader(api.Loader):
hosts = ["unreal"]
def ls():
"""
List all containers found in *Content Manager* of Unreal and return
"""List all containers.
List all found in *Content Manager* of Unreal and return
metadata from them. Adding `objectName` to set.
"""
ar = unreal.AssetRegistryHelpers.get_asset_registry()
avalon_containers = ar.get_assets_by_class("AssetContainer", True)
openpype_containers = ar.get_assets_by_class("AssetContainer", True)
# get_asset_by_class returns AssetData. To get all metadata we need to
# load asset. get_tag_values() work only on metadata registered in
# Asset Registy Project settings (and there is no way to set it with
# Asset Registry Project settings (and there is no way to set it with
# python short of editing ini configuration file).
for asset_data in avalon_containers:
for asset_data in openpype_containers:
asset = asset_data.get_asset()
data = unreal.EditorAssetLibrary.get_metadata_tag_values(asset)
data["objectName"] = asset_data.asset_name
@ -89,8 +83,7 @@ def ls():
def parse_container(container):
"""
To get data from container, AssetContainer must be loaded.
"""To get data from container, AssetContainer must be loaded.
Args:
container(str): path to container
@ -107,20 +100,19 @@ def parse_container(container):
def publish():
"""Shorthand to publish from within host"""
"""Shorthand to publish from within host."""
import pyblish.util
return pyblish.util.publish()
def containerise(name, namespace, nodes, context, loader=None, suffix="_CON"):
"""Bundles *nodes* (assets) into a *container* and add metadata to it.
Unreal doesn't support *groups* of assets that you can add metadata to.
But it does support folders that helps to organize asset. Unfortunately
those folders are just that - you cannot add any additional information
to them. `Avalon Integration Plugin`_ is providing way out - Implementing
to them. OpenPype Integration Plugin is providing way out - Implementing
`AssetContainer` Blueprint class. This class when added to folder can
handle metadata on it using standard
:func:`unreal.EditorAssetLibrary.set_metadata_tag()` and
@ -129,10 +121,7 @@ def containerise(name, namespace, nodes, context, loader=None, suffix="_CON"):
those assets is available as `assets` property.
This is list of strings starting with asset type and ending with its path:
`Material /Game/Avalon/Test/TestMaterial.TestMaterial`
.. _Avalon Integration Plugin:
https://github.com/pypeclub/avalon-unreal-integration
`Material /Game/OpenPype/Test/TestMaterial.TestMaterial`
"""
# 1 - create directory for container
@ -160,10 +149,11 @@ def containerise(name, namespace, nodes, context, loader=None, suffix="_CON"):
def instantiate(root, name, data, assets=None, suffix="_INS"):
"""
Bundles *nodes* into *container* marking it with metadata as publishable
instance. If assets are provided, they are moved to new path where
`AvalonPublishInstance` class asset is created and imprinted with metadata.
"""Bundles *nodes* into *container*.
Marking it with metadata as publishable instance. If assets are provided,
they are moved to new path where `OpenPypePublishInstance` class asset is
created and imprinted with metadata.
This can then be collected for publishing by Pyblish for example.
@ -174,6 +164,7 @@ def instantiate(root, name, data, assets=None, suffix="_INS"):
assets (list of str): list of asset paths to include in publish
instance
suffix (str): suffix string to append to instance name
"""
container_name = "{}{}".format(name, suffix)
@ -203,7 +194,7 @@ def imprint(node, data):
loaded_asset, key, str(value)
)
with unreal.ScopedEditorTransaction("Avalon containerising"):
with unreal.ScopedEditorTransaction("OpenPype containerising"):
unreal.EditorAssetLibrary.save_asset(node)
@ -248,7 +239,7 @@ def show_experimental_tools():
def create_folder(root: str, name: str) -> str:
"""Create new folder
"""Create new folder.
If folder exists, append number at the end and try again, incrementing
if needed.
@ -281,8 +272,7 @@ def create_folder(root: str, name: str) -> str:
def move_assets_to_path(root: str, name: str, assets: List[str]) -> str:
"""
Moving (renaming) list of asset paths to new destination.
"""Moving (renaming) list of asset paths to new destination.
Args:
root (str): root of the path (eg. `/Game`)
@ -316,8 +306,8 @@ def move_assets_to_path(root: str, name: str, assets: List[str]) -> str:
def create_container(container: str, path: str) -> unreal.Object:
"""
Helper function to create Asset Container class on given path.
"""Helper function to create Asset Container class on given path.
This Asset Class helps to mark given path as Container
and enable asset version control on it.
@ -331,7 +321,7 @@ def create_container(container: str, path: str) -> unreal.Object:
Example:
create_avalon_container(
create_container(
"/Game/modelingFooCharacter_CON",
"modelingFooCharacter_CON"
)
@ -345,9 +335,9 @@ def create_container(container: str, path: str) -> unreal.Object:
def create_publish_instance(instance: str, path: str) -> unreal.Object:
"""
Helper function to create Avalon Publish Instance on given path.
This behaves similary as :func:`create_avalon_container`.
"""Helper function to create OpenPype Publish Instance on given path.
This behaves similarly as :func:`create_openpype_container`.
Args:
path (str): Path where to create Publish Instance.
@ -365,13 +355,13 @@ def create_publish_instance(instance: str, path: str) -> unreal.Object:
)
"""
factory = unreal.AvalonPublishInstanceFactory()
factory = unreal.OpenPypePublishInstanceFactory()
tools = unreal.AssetToolsHelpers().get_asset_tools()
asset = tools.create_asset(instance, path, None, factory)
return asset
def cast_map_to_str_dict(map) -> dict:
def cast_map_to_str_dict(umap) -> dict:
"""Cast Unreal Map to dict.
Helper function to cast Unreal Map object to plain old python
@ -379,10 +369,10 @@ def cast_map_to_str_dict(map) -> dict:
metadata dicts.
Args:
map: Unreal Map object
umap: Unreal Map object
Returns:
dict
"""
return {str(key): str(value) for (key, value) in map.items()}
return {str(key): str(value) for (key, value) in umap.items()}