-
+
![]()
The ShotGrid developer portal..
+ .
The code associated with this documentation can be found
.
@@ -144,7 +144,7 @@
-
© Copyright 2023, Autodesk.
+
© Copyright 2024, Autodesk.
diff --git a/searchindex.js b/searchindex.js
index 00da02cb..40ca53ba 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["engine", "hooks", "index"], "filenames": ["engine.rst", "hooks.rst", "index.rst"], "titles": ["The Alias Engine Code", "Alias Engine Hooks", "The Alias Engine"], "terms": {"aliasengin": 0, "i": [0, 1], "main": [0, 1], "class": [0, 1], "which": [0, 1], "construct": 0, "initi": [0, 1], "toolkit": [0, 1, 2], "copyright": [0, 1], "c": [0, 1], "2023": [0, 1], "autodesk": [0, 1], "inc": [0, 1], "confidenti": [0, 1], "AND": [0, 1], "proprietari": [0, 1], "thi": [0, 1], "work": [0, 1], "provid": [0, 1], "AS": [0, 1], "subject": [0, 1], "shotgrid": [0, 1, 2], "pipelin": [0, 1], "sourc": [0, 1], "licens": [0, 1], "includ": [0, 1], "distribut": [0, 1], "packag": [0, 1], "see": [0, 1, 2], "By": [0, 1], "access": [0, 1], "us": [0, 1], "copi": [0, 1], "modifi": [0, 1], "you": [0, 1], "indic": [0, 1], "your": [0, 1], "agreement": [0, 1], "all": [0, 1], "right": [0, 1], "expressli": [0, 1], "grant": [0, 1], "therein": [0, 1], "ar": [0, 1], "reserv": [0, 1], "import": [0, 1], "o": [0, 1], "sy": 0, "pprint": 0, "sgtk": [0, 1], "from": [0, 1], "util": [0, 1], "localfilestoragemanag": 0, "platform": [0, 1, 2], "name": [0, 1], "hidden": [0, 1], "window": 0, "parent": [0, 1], "sg": 0, "widget": [0, 1], "__proxy_window_titl": 0, "dialog": [0, 1], "owner": 0, "proxi": 0, "def": [0, 1], "__init__": [0, 1], "self": [0, 1], "tk": [0, 2], "context": [0, 1], "engine_instance_nam": 0, "env": 0, "get": [0, 1], "environ": [0, 1], "variabl": [0, 1], "care": 0, "about": [0, 1], "alias_execpath": 0, "getenv": 0, "tk_alias_execpath": 0, "none": [0, 1], "alias_bindir": 0, "path": [0, 1], "dirnam": [0, 1], "alias_codenam": 0, "tk_alias_codenam": 0, "autostudio": 0, "alias_vers": 0, "tk_alias_vers": 0, "__hostnam": 0, "shotgrid_alias_host": 0, "__namespac": 0, "shotgrid_alias_namespac": 0, "__port": 0, "shotgrid_alias_port": 0, "int": [0, 1], "python": [0, 1], "modul": 0, "_tk_alia": 0, "keep": [0, 1], "track": 0, "stage": [0, 1], "allow": [0, 1], "switch": [0, 1], "_contexts_by_stage_nam": 0, "_contexts_by_path": 0, "menu": [0, 1, 2], "gener": [0, 1], "respons": [0, 1], "ad": [0, 1], "__menu_gener": 0, "event": [0, 1], "watcher": [0, 1], "manag": [0, 1], "handl": [0, 1], "callback": [0, 1], "__event_watch": 0, "data": [0, 2], "valid": [0, 2], "function": [0, 1], "set": [0, 1], "up": [0, 1], "app": [0, 1, 2], "__data_valid": 0, "A": [0, 1], "socketio": 0, "client": 0, "commun": 0, "openmodel": [0, 1], "__sio": 0, "inform": [0, 1], "server": 0, "connect": [0, 1], "__server_info": 0, "plugin": [0, 1], "bootstrap": 0, "__plugin_info": 0, "api": [0, 1], "call": [0, 1], "__init_api": 0, "__alias_pi": 0, "creat": [0, 1], "qwidget": [0, 1], "its": [0, 1], "__proxy_window": 0, "when": [0, 1], "run": [0, 1], "same": [0, 1], "process": [0, 1], "version": [0, 1], "2024": 0, "0": [0, 1], "qt": [0, 1], "instanc": [0, 1], "__qt_app": 0, "hasattr": [0, 1], "argv": 0, "flag": 0, "inid": 0, "determin": [0, 1], "how": [0, 1], "__in_alias_process": 0, "basenam": [0, 1], "execut": [0, 1], "ex": 0, "open_model": 0, "tk_alias_open_model": 0, "For": [0, 1], "backward": [0, 1], "compat": [0, 1], "mode": [0, 1], "unless": 0, "__is_open_model": 0, "els": [0, 1], "1": [0, 1], "true": [0, 1], "gui": 0, "tk_alias_has_ui": 0, "found": [0, 1], "explicitli": 0, "turn": 0, "off": 0, "__has_ui": 0, "fals": [0, 1], "Not": 0, "defin": [0, 1], "have": [0, 1], "ui": [0, 1], "we": [0, 1], "sai": 0, "base": [0, 1], "init": 0, "method": [0, 1], "super": [0, 1], "4": 0, "staticmethod": 0, "get_current_engin": 0, "return": [0, 1], "current": [0, 1], "ensur": [0, 1], "refer": [0, 1], "stale": 0, "e": [0, 1], "g": [0, 1], "": [0, 1, 2], "becom": 0, "after": [0, 1], "ha": [0, 1], "been": [0, 1], "reload": 0, "current_engin": [0, 1], "on_plugin_init": 0, "3": [0, 1], "logger": [0, 1], "info": [0, 1], "f": 0, "v": [0, 1], "plugin_vers": 0, "python_vers": 0, "properti": [0, 1], "host_info": 0, "applic": 0, "host": 0, "dictionari": [0, 1], "eg": 0, "afterfx": 0, "2017": [0, 1], "dict": [0, 1], "plugin_info": 0, "has_ui": 0, "interact": 0, "openalia": 0, "otherwis": [0, 1], "context_change_allow": [0, 1], "specifi": [0, 1], "chang": [0, 1], "in_alias_process": 0, "whether": 0, "alias_pi": 0, "aliaspi": 0, "object": [0, 1], "can": [0, 1, 2], "make": [0, 1], "request": 0, "other": [0, 1], "helper": [0, 1], "event_watch": [0, 1], "aliaseventwatch": 0, "help": [0, 1], "messag": [0, 1], "data_valid": [0, 1], "aliasdatavalid": [0, 1], "overrid": [0, 1], "pre_app_init": 0, "an": [0, 1], "oper": [0, 1], "state": [0, 1], "system": 0, "typic": 0, "implement": [0, 1, 2], "deriv": 0, "befor": [0, 1], "ani": [0, 1], "load": [0, 1], "debug": [0, 1], "tk_alia": 0, "import_modul": [0, 1], "requir": [0, 1], "call_threadsaf": 0, "server_info": 0, "pformat": 0, "No": [0, 1], "re": [0, 1], "post_app_init": 0, "qtgui": [0, 1], "If": [0, 1], "alreadi": [0, 1], "restart": 0, "do": [0, 1], "post": [0, 1], "now": [0, 1], "post_qt_init": 0, "startup": 0, "py": [0, 1], "qapplic": 0, "post_context_chang": 0, "old_context": 0, "new_context": 0, "occur": 0, "param": [0, 1], "previou": [0, 1], "rebuild": 0, "onli": [0, 1], "build": [0, 1], "destroy_engin": 0, "should": [0, 1], "tear": 0, "down": [0, 1], "itself": 0, "destroi": 0, "shutdown": 0, "clean_menu": 0, "close": 0, "shotgun": [0, 1], "still": [0, 1], "open": [0, 1], "sinc": 0, "some": [0, 1], "thread": 0, "cleanup": 0, "onclos": 0, "handler": 0, "note": [0, 1], "through": [0, 1], "list": [0, 1], "created_qt_dialog": 0, "dialogs_still_open": 0, "disconnect": 0, "quit": 0, "show_panel": 0, "panel_id": 0, "titl": 0, "bundl": 0, "widget_class": 0, "arg": 0, "kwarg": [0, 1], "show": [0, 1], "panel": [0, 1], "thei": [0, 1], "properli": 0, "support": [0, 1], "In": [0, 1], "case": [0, 1], "second": 0, "exist": [0, 1], "one": [0, 1], "instead": [0, 1], "uniqu": [0, 1], "identifi": [0, 1], "obtain": 0, "register_panel": 0, "framework": [0, 1], "associ": [0, 1], "must": [0, 1], "addit": [0, 1], "paramet": [0, 1], "pass": [0, 1], "constructor": [0, 1], "begin": [0, 1], "format": [0, 1], "error": [0, 1], "sorri": 0, "doe": [0, 1], "displai": [0, 1], "cannot": [0, 1], "try": [0, 1], "find": [0, 1], "order": [0, 1], "avoid": 0, "mani": [0, 1], "time": [0, 1], "qt_dialog": 0, "_widget": 0, "continu": [0, 1], "objectnam": 0, "widget_inst": 0, "raise_": 0, "activatewindow": 0, "break": [0, 1], "t": [0, 1], "new": [0, 1], "show_dialog": 0, "setobjectnam": 0, "_get_dialog_par": 0, "__get_or_create_proxy_window": 0, "_emit_log_messag": 0, "record": 0, "log": [0, 1], "termin": 0, "namespac": 0, "wa": [0, 1], "dispatch": [0, 1], "Its": 0, "default": [0, 1], "levelnam": 0, "type": [0, 1], "loghandl": 0, "standard": [0, 1, 2], "logrecord": 0, "todo": 0, "improv": 0, "redirect": 0, "promptlin": 0, "public": 0, "restart_process": 0, "emit_threadsaf": 0, "rais": [0, 1], "notimplementederror": [0, 1], "attempt": [0, 1], "exit": [0, 1], "runnign": 0, "qt_app": 0, "__init_qt_app": 0, "qtcore": [0, 1], "pyside_fold": 0, "__file__": 0, "site_packages_fold": 0, "lib_fold": 0, "python_fold": 0, "shotgun_create_fold": 0, "qt_folder": 0, "join": [0, 1], "pysid": 0, "plugins_dir": 0, "qcoreappl": 0, "addlibrarypath": 0, "setquitonlastwindowclos": 0, "_app_quit": 0, "processev": 0, "abouttoquit": 0, "finish": 0, "loop": 0, "start": 0, "noth": 0, "warn": [0, 1], "though": 0, "creation": 0, "initiali": 0, "style": 0, "_initialize_dark_look_and_feel": 0, "unicod": 0, "charact": 0, "need": [0, 1], "convert": [0, 1], "correctli": 0, "tell": 0, "interpret": 0, "string": [0, 1], "utf": 0, "8": 0, "utf8": 0, "qtextcodec": 0, "codecfornam": 0, "setcodecforcstr": 0, "codec": 0, "text": [0, 1], "check": [0, 1], "pop": 0, "__check_version_support": 0, "member": 0, "menu_gener": 0, "aliasmenugener": 0, "__init_alias_event_watch": 0, "It": [0, 1, 2], "bar": 0, "command": [0, 1], "__run_app_instance_command": 0, "file": [0, 1], "sgtk_file_to_open": 0, "open_fil": [0, 1], "clear": 0, "var": 0, "so": [0, 1], "doesn": [0, 1], "reopen": 0, "del": 0, "save_context_for_stag": [0, 1], "save": [0, 1], "restor": 0, "becaus": [0, 1], "differ": [0, 1], "user": [0, 1], "As": [0, 1], "store": [0, 1], "both": 0, "suppli": [0, 1], "current_stag": 0, "get_current_stag": 0, "save_fil": [0, 1], "conveni": 0, "statu": [0, 1], "alstatuscod": 0, "success": [0, 1], "valu": [0, 1], "non": [0, 1], "updat": [0, 1], "save_file_a": [0, 1], "str": [0, 1], "on_stage_act": 0, "result": [0, 1], "trigger": [0, 1], "stagecr": 0, "accord": [0, 1], "mai": [0, 1], "alias_api": [0, 1], "pythoncallbackmessageresult": 0, "invalid": [0, 1], "yet": [0, 1], "form": [0, 1], "elif": [0, 1], "reset": [0, 1], "project": [0, 1], "context_from_entity_dictionari": 0, "change_context": 0, "open_save_as_dialog": [0, 1], "multi": [0, 2], "workfiles2": [0, 2], "launch": [0, 2], "browser": 0, "workfil": 0, "show_file_save_dlg": 0, "use_modal_dialog": 0, "appear": 0, "via": [0, 1], "our": 0, "own": [0, 1], "file_dialog": 0, "qfiledialog": 0, "caption": [0, 1], "directori": 0, "expandus": 0, "filter": [0, 1], "wire": [0, 1], "setlabeltext": 0, "accept": [0, 1], "reject": [0, 1], "cancel": [0, 1], "setopt": 0, "dontresolvesymlink": 0, "dontusenativedialog": 0, "exec_": 0, "selectedfil": 0, "splitext": [0, 1], "open_delete_stages_dialog": [0, 1], "new_fil": [0, 1], "prompt": 0, "ask": [0, 1], "he": 0, "want": [0, 1], "delet": [0, 1], "them": 0, "shader": 0, "view": [0, 1], "action": [0, 1], "message_typ": 0, "qmessagebox": [0, 1], "ye": 0, "answer": 0, "question": 0, "get_tk_from_project": [0, 1], "tank": [0, 1], "given": [0, 1], "id": [0, 1], "deal": [0, 1], "librari": 0, "perform": [0, 1], "get_tk_from_project_id": 0, "except": [0, 1], "fallback": 0, "configur": [0, 1, 2], "rtype": [0, 1], "project_id": 0, "first": [0, 1], "live": 0, "anoth": [0, 1], "in_current_project": 0, "pc_local_path": 0, "__get_pipeline_configuration_local_path": 0, "couldn": [0, 1], "sgtk_from_path": 0, "more": [0, 1], "robust": 0, "get_reference_templ": [0, 1], "sg_data": [0, 1], "reference_templ": [0, 1], "templat": [0, 1], "contain": [0, 1, 2], "task": [0, 1], "field": [0, 1], "kei": [0, 1], "ctx": 0, "get_environment_from_context": 0, "engine_set": 0, "get_engine_set": 0, "reference_template_nam": 0, "privat": 0, "__setup_sio": 0, "hostnam": 0, "port": 0, "bool": [0, 1], "shotgridaliassocketiocli": 0, "fail": [0, 1], "forc": [0, 1], "either": 0, "headless": 0, "batch": [0, 1], "argument": [0, 1], "These": 0, "directli": [0, 1], "even": [0, 1], "old": 0, "wai": [0, 1], "api_import_error": 0, "n": 0, "api_modul": 0, "separ": [0, 1], "than": [0, 1], "conflict": 0, "between": [0, 1], "qtquick": 0, "qml": 0, "model": 0, "framework_alia": 0, "alias_api_om": 0, "univers": [0, 1], "readi": 0, "initialize_univers": 0, "listen": 0, "socket": 0, "get_alias_api": 0, "wrap": 0, "made": [0, 1], "rout": 0, "actual": 0, "aceess": 0, "pyd": 0, "sys_module_nam": 0, "saniti": 0, "assert": 0, "import_error": 0, "regist": [0, 1], "watch": 0, "immedi": 0, "almessagetyp": 0, "dagnamemodifi": 0, "caus": 0, "crash": 0, "look": [0, 1], "like": [0, 1], "bug": 0, "where": [0, 1, 2], "alias_event_watch": 0, "register_alias_callback": 0, "stageact": 0, "start_watch": 0, "skip": 0, "comparison": 0, "get_set": 0, "compatibility_dialog_min_vers": 0, "2020": 0, "msg": 0, "fulli": 0, "test": 0, "experi": 0, "instabl": 0, "pleas": [0, 1], "report": [0, 1], "issu": [0, 1], "support_url": 0, "2021": 0, "compatibility_dialog_old_vers": 0, "capabl": 0, "consid": 0, "upgrad": 0, "recent": [0, 1], "successfulli": [0, 1], "set_parent_window": 0, "setwindowtitl": 0, "winid": 0, "dialogpar": 0, "isinst": [0, 1], "get_dialog_par": 0, "activewindow": 0, "adjust": 0, "center": 0, "take": [0, 1], "effect": 0, "adjust_window": 0, "seri": 0, "run_at_startup": 0, "yaml": 0, "map": [0, 1], "app_instance_command": 0, "command_nam": 0, "item": [0, 1], "app_inst": 0, "add": [0, 1, 2], "entri": [0, 1], "command_dict": 0, "setdefault": 0, "instance_nam": 0, "commands_to_run": 0, "app_setting_dict": 0, "app_instance_nam": 0, "setting_command_nam": 0, "retriev": [0, 1], "instal": 0, "command_funct": 0, "append": [0, 1], "whose": 0, "known_command": 0, "unknown": [0, 1], "known": [0, 1], "just": [0, 1], "bail": 0, "final": [0, 1], "config": [0, 1], "local": [0, 1], "stand": 0, "cach": 0, "folder": [0, 1], "abl": [0, 1], "entiti": [0, 1], "could": [0, 1], "plugin_id": 0, "basic": [0, 1], "desktop": 0, "relat": [0, 1], "distant": 0, "here": [0, 1], "go": 0, "mgr": 0, "toolkitmanag": 0, "constant": [0, 1], "default_plugin_id": 0, "pipeline_configur": 0, "get_pipeline_configur": 0, "link": [0, 1], "len": [0, 1], "pipeline_config": 0, "restrict": 0, "2": [0, 1], "primari": 0, "__get_project_pipeline_configur": 0, "__get_primary_pipeline_configur": 0, "too": [0, 1], "config_local_path": 0, "get_configuration_root": 0, "shotgun_url": 0, "cfg": 0, "disk": [0, 1], "prepare_engin": 0, "pars": 0, "pc": 0, "primary_pipeline_config_nam": 0, "keyerror": 0, "The": 1, "custom": 1, "below": 1, "specif": 1, "detail": [1, 2], "rule": 1, "2022": 1, "code": [1, 2], "hookbaseclass": 1, "get_hook_baseclass": 1, "aliasdatavalidationerror": 1, "sanitizedresult": 1, "repres": 1, "sanit": 1, "is_valid": 1, "long": 1, "follow": 1, "expect": 1, "get_validation_data": 1, "scene": 1, "meth": 1, "To": 1, "validationrul": 1, "exampl": 1, "abov": 1, "assum": 1, "being": 1, "step": 1, "necessari": 1, "fix": 1, "yml": 1, "global": 1, "toggl": 1, "demonstr": 1, "purpos": 1, "custom_rule_is_valid": 1, "check_my_custom_rul": 1, "fail_fast": 1, "button": 1, "click": 1, "guidelin": 1, "advanc": 1, "prefix": 1, "check_": 1, "fast": 1, "namedtupl": 1, "also": 1, "collect": 1, "aliasobject": 1, "node": 1, "lambda": 1, "alsurfacenod": 1, "faist": 1, "fix_my_custom_rul": 1, "next": 1, "simplic": 1, "fix_": 1, "action_callback": 1, "row": 1, "me": 1, "revalid": 1, "what": 1, "happend": 1, "my_custom_rul": 1, "my": 1, "descript": 1, "br": 1, "hand": 1, "error_msg": 1, "let": 1, "fix_nam": 1, "check_func": 1, "fix_func": 1, "sanitize_check_result": 1, "conform": 1, "incom": 1, "succe": 1, "empti": 1, "option": 1, "receiv": 1, "boolean": 1, "post_fix_act": 1, "onc": 1, "individu": 1, "resolv": 1, "rule_id": 1, "refresh": 1, "viewport": 1, "cos_unus": 1, "references_exist": 1, "node_pivots_at_origin": 1, "isdisjoint": 1, "redraw_screen": 1, "2015": 1, "softwar": 1, "avail": 1, "broken": 1, "publish": 1, "generate_act": 1, "sg_publish_data": 1, "ui_area": 1, "particular": 1, "each": 1, "somewher": 1, "popul": 1, "kept": 1, "place": 1, "point": 1, "loader": 1, "establish": 1, "appropri": 1, "least": 1, "those": 1, "tailor": 1, "output": 1, "tooltip": 1, "etc": 1, "suitabl": 1, "shown": 1, "brows": 1, "area": 1, "histori": 1, "perfectli": 1, "possibl": 1, "introspect": 1, "character_attach": 1, "scan": 1, "figur": 1, "out": 1, "attach": 1, "left": 1, "run_act": 1, "denot": 1, "element": 1, "action_inst": 1, "import_as_refer": 1, "texture_nod": 1, "canva": 1, "import_subdiv": 1, "subdiv": 1, "execute_multiple_act": 1, "execute_act": 1, "hold": 1, "come": 1, "reus": 1, "written": 1, "stop": 1, "appli": 1, "select": 1, "midwai": 1, "single_act": 1, "sent": 1, "enumer": 1, "get_publish_path": 1, "_create_refer": 1, "_import_fil": 1, "_import_file_as_refer": 1, "_create_texture_nod": 1, "_import_subdivis": 1, "create_refer": 1, "session": 1, "import_fil": 1, "fly": 1, "wref": 1, "belong": 1, "manipul": 1, "extract": 1, "translat": 1, "attributeerror": 1, "There": 1, "href": 1, "http": 1, "github": 1, "com": 1, "shotgunsoftwar": 1, "wiki": 1, "b": 1, "source_templ": 1, "template_from_path": 1, "locat": 1, "template_field": 1, "get_field": 1, "extens": 1, "reference_path": 1, "apply_field": 1, "output_path": 1, "output_ext": 1, "_": 1, "load_framework": 1, "aliastranslations_v0": 1, "x": 1, "tk_framework_aliastransl": 1, "imag": 1, "create_texture_nod": 1, "subdivis": 1, "aliaspythonexcept": 1, "api_error": 1, "err_msg": 1, "help_link": 1, "enu": 1, "guid": 1, "667410ad": 1, "cf4d": 1, "43b3": 1, "ae96": 1, "0c1331cb80b2": 1, "annot": 1, "One": 1, "line": 1, "describ": 1, "p": 1, "export": 1, "tool": 1, "sync": 1, "review": 1, "item_filt": 1, "interest": 1, "match": 1, "present": 1, "glob": 1, "patter": 1, "maya": 1, "enabl": 1, "disabl": 1, "visibl": 1, "uncheck": 1, "has_annotation_loc": 1, "ok": 1, "logic": 1, "insid": 1, "root": 1, "bg_process": 1, "in_bg_process": 1, "publish_data": 1, "version_data": 1, "sg_version_data": 1, "note_link": 1, "get_annotation_locator_str": 1, "batch_data": 1, "note_data": 1, "content": 1, "request_typ": 1, "entity_typ": 1, "complet": 1, "reli": 1, "inherit": 1, "someth": 1, "publish_fil": 1, "publish_sess": 1, "icon": 1, "verbos": 1, "simpl": 1, "html": 1, "loader_url": 1, "sgdev": 1, "contextid": 1, "pc_app_load": 1, "h3": 1, "filenam": 1, "number": 1, "bump": 1, "reflect": 1, "worklfow": 1, "recogn": 1, "ul": 1, "li": 1, "ext": 1, "filename_v": 1, "detect": 1, "automat": 1, "increment": 1, "v001": 1, "v002": 1, "produc": 1, "prior": 1, "amount": 1, "pad": 1, "workflow": 1, "overwrit": 1, "multipl": 1, "howev": 1, "most": 1, "dure": 1, "settings_typ": 1, "default_valu": 1, "part": 1, "base_set": 1, "alias_publish_set": 1, "correspond": 1, "temporari": 1, "measur": 1, "until": 1, "nativ": 1, "_session_path": 1, "extra": 1, "_get_save_as_act": 1, "ref": 1, "get_refer": 1, "ref_path": 1, "against": 1, "normal": 1, "trail": 1, "doubl": 1, "shotgunpath": 1, "work_templ": 1, "action_button": 1, "label": 1, "abil": 1, "jump": 1, "next_version_path": 1, "_get_next_version_info": 1, "version_numb": 1, "while": 1, "publish_template_set": 1, "publish_templ": 1, "get_template_by_nam": 1, "phase": 1, "sure": 1, "background": 1, "later": 1, "session_path": 1, "session_nam": 1, "task_nam": 1, "entity_nam": 1, "file_nam": 1, "depend": 1, "publish_depend": 1, "_alias_find_additional_session_depend": 1, "_save_to_next_vers": 1, "get_current_path": 1, "color": 1, "red": 1, "translator_set": 1, "releas": 1, "catpart": 1, "among": 1, "per": 1, "definit": 1, "alias_refer": 1, "vred": 1, "don": 1, "publish_path": 1, "condit": 1, "translation_typ": 1, "translator_path": 1, "alias_info": 1, "get_product_inform": 1, "local_properti": 1, "license_set": 1, "product_kei": 1, "product_vers": 1, "product_license_typ": 1, "product_license_path": 1, "publish_fold": 1, "ensure_folder_exist": 1, "get_properti": 1, "add_extra_param": 1, "parent_sg_publish_data": 1, "share": 1, "thumbnail": 1, "child": 1, "request_timeout": 1, "60": 1, "start_tim": 1, "perf_count": 1, "thumbnail_shar": 1, "share_thumbnail": 1, "source_ent": 1, "sleep": 1, "couln": 1, "action_show_in_shotgun": 1, "reveal": 1, "get_publish_templ": 1, "get_publish_typ": 1, "path_info": 1, "get_file_path_compon": 1, "lowercas": 1, "dot": 1, "lstrip": 1, "lower": 1, "type_def": 1, "publish_typ": 1, "file_extens": 1, "pre": 1, "capit": 1, "get_publish_nam": 1, "sequenc": 1, "_copy_work_to_publish": 1, "design": 1, "suffici": 1, "satisfi": 1, "met": 1, "sequence_path": 1, "meet": 1, "criteria": 1, "respect": 1, "publish_plugin": 1, "remov": 1, "done": 1, "eras": 1, "variant": 1, "lister": 1, "has_vari": 1, "get_vari": 1, "alias_vari": 1, "upload_thumbnail": 1, "entity_id": 1, "variant_filepath": 1, "file_ext": 1, "upload": 1, "field_nam": 1, "display_nam": 1, "insert": 1, "png": 1, "level": 1, "disk_loc": 1, "pardir": 1, "version_up": 1, "_get_version_numb": 1, "_get_version_docs_act": 1, "leav": 1, "mean": 1, "won": 1, "much": 1, "within": 1, "simpli": 1, "inject": 1, "version_path": 1, "get_version_path": 1, "choos": 1, "collector": 1, "zero": 1, "work_field": 1, "did": 1, "unavail": 1, "get_version_numb": 1, "doc": 1, "action_open_url": 1, "url": 1, "sgsub": 1, "sg_supervisor_artist_sa_integrations_sa_integrations_user_guide_html": 1, "shutil": 1, "send": 1, "quicktim": 1, "worker": 1, "lmv": 1, "translation_worker_loc": 1, "translation_worker_framework": 1, "translation_work": 1, "version_type_2d": 1, "2d": 1, "version_type_3d": 1, "3d": 1, "version_type_opt": 1, "version_type_descript": 1, "video": 1, "represent": 1, "geometri": 1, "reciev": 1, "upload_version_set": 1, "last_opt": 1, "version_typ": 1, "unsupport": 1, "site": 1, "pref": 1, "block": 1, "is_3d_viewer_en": 1, "_is_3d_viewer_en": 1, "contact": 1, "prefer": 1, "framework_lmv": 1, "lmv_v0": 1, "miss": 1, "atf": 1, "strip": 1, "path_compon": 1, "publish_nam": 1, "use_framework_transl": 1, "package_path": 1, "thumbnail_path": 1, "output_directori": 1, "_translate_file_to_lmv": 1, "sg_translation_typ": 1, "sg_uploaded_movi": 1, "newli": 1, "get_thumbnail_as_path": 1, "rmtree": 1, "media": 1, "_get_thumbnail_from_lmv": 1, "interfac": 1, "create_settings_widget": 1, "side": 1, "publishitem": 1, "subclass": 1, "edit": 1, "defer": 1, "widget_layout": 1, "qvboxlayout": 1, "group": 1, "box": 1, "description_group_box": 1, "qgroupbox": 1, "settitl": 1, "combobox": 1, "description_label": 1, "qlabel": 1, "setwordwrap": 1, "setopenexternallink": 1, "settextformat": 1, "richtext": 1, "layout": 1, "description_layout": 1, "addwidget": 1, "addstretch": 1, "setlayout": 1, "version_type_combobox": 1, "qcombobox": 1, "setaccessiblenam": 1, "dropdown": 1, "additem": 1, "signal": 1, "slot": 1, "currentindexchang": 1, "index": 1, "_on_version_type_chang": 1, "currenttext": 1, "minor": 1, "get_ui_set": 1, "set_ui_set": 1, "setproperti": 1, "invok": 1, "gather": 1, "previous": 1, "repopul": 1, "again": 1, "drive": 1, "necessarili": 1, "subset": 1, "setting_a": 1, "ui_set": 1, "version_type_index": 1, "currentindex": 1, "seeting_a": 1, "setting_b": 1, "ones": 1, "decid": 1, "wish": 1, "accordingli": 1, "version_type_valu": 1, "max": 1, "current_version_index": 1, "correct": 1, "verstion": 1, "manual": 1, "setcurrentindex": 1, "selector": 1, "web": 1, "playabl": 1, "viewer": 1, "settext": 1, "protect": 1, "ship": 1, "zip": 1, "lmv_translat": 1, "lmvtranslat": 1, "svf_file_nam": 1, "convers": 1, "extract_thumbnail": 1, "enable_3d_view": 1, "enable_3d_viewer_pref": 1, "preferences_read": 1, "ignor": 1, "get_templ": 1, "uuid": 1, "hookclass": 1, "file_path": 1, "parent_act": 1, "file_vers": 1, "read_onli": 1, "revis": 1, "latest": 1, "read": 1, "current_path": 1, "At": 1, "end": 1, "save_context": 1, "save_a": 1, "prepare_new": 1, "queue": 1, "interfer": 1, "create_context_manag": 1, "is_empty_fil": 1, "new_stag": 1, "open_in_current_stag": 1, "get_stag": 1, "stage_nam": 1, "uuid4": 1, "hex": 1, "create_stag": 1, "whcih": 1, "integr": 2, "hook": 2, "loader2": 2, "publish2": 2, "shotgunpanel": 2}, "objects": {}, "objtypes": {}, "objnames": {}, "titleterms": {"The": [0, 2], "alia": [0, 1, 2], "engin": [0, 1, 2], "code": 0, "hook": 1, "tk": 1, "multi": 1, "data": 1, "valid": 1, "aliasdatavalidationhook": 1, "loader2": 1, "aliasact": 1, "publish2": 1, "publishannotationsplugin": 1, "aliassessionpublishplugin": 1, "aliastranslationpublishplugin": 1, "aliaspublishvariantsplugin": 1, "aliasstartversioncontrolplugin": 1, "uploadversionplugin": 1, "shotgunpanel": 1, "workfiles2": 1, "sceneoper": 1, "overview": 2, "custom": 2, "content": 2}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.intersphinx": 1, "sphinx": 57}, "alltitles": {"The Alias Engine Code": [[0, "the-alias-engine-code"]], "Alias Engine Hooks": [[1, "alias-engine-hooks"]], "tk-multi-data-validation": [[1, "tk-multi-data-validation"]], "AliasDataValidationHook": [[1, "aliasdatavalidationhook"]], "tk-multi-loader2": [[1, "tk-multi-loader2"]], "AliasActions": [[1, "aliasactions"], [1, "hooks-tk-multi-shotgunpanel-scene-actions"]], "tk-multi-publish2": [[1, "tk-multi-publish2"]], "PublishAnnotationsPlugin": [[1, "publishannotationsplugin"]], "AliasSessionPublishPlugin": [[1, "aliassessionpublishplugin"]], "AliasTranslationPublishPlugin": [[1, "aliastranslationpublishplugin"]], "AliasPublishVariantsPlugin": [[1, "aliaspublishvariantsplugin"]], "AliasStartVersionControlPlugin": [[1, "aliasstartversioncontrolplugin"]], "UploadVersionPlugin": [[1, "uploadversionplugin"]], "tk-multi-shotgunpanel": [[1, "tk-multi-shotgunpanel"]], "tk-multi-workfiles2": [[1, "tk-multi-workfiles2"]], "SceneOperation": [[1, "sceneoperation"]], "The Alias Engine": [[2, "the-alias-engine"]], "Overview": [[2, "overview"]], "Customizations": [[2, "customizations"]], "Contents": [[2, "contents"]]}, "indexentries": {}})
\ No newline at end of file
+Search.setIndex({"docnames": ["engine", "hooks", "index"], "filenames": ["engine.rst", "hooks.rst", "index.rst"], "titles": ["The Alias Engine Code", "Alias Engine Hooks", "The Alias Engine"], "terms": {"aliasengin": 0, "i": [0, 1], "main": [0, 1], "class": [0, 1], "which": [0, 1], "construct": 0, "initi": [0, 1], "toolkit": [0, 1, 2], "copyright": [0, 1], "c": [0, 1], "2023": [0, 1], "autodesk": [0, 1], "inc": [0, 1], "confidenti": [0, 1], "AND": [0, 1], "proprietari": [0, 1], "thi": [0, 1], "work": [0, 1], "provid": [0, 1], "AS": [0, 1], "subject": [0, 1], "shotgrid": [0, 1, 2], "pipelin": [0, 1], "sourc": [0, 1], "licens": [0, 1], "includ": [0, 1], "distribut": [0, 1], "packag": [0, 1], "see": [0, 1, 2], "By": [0, 1], "access": [0, 1], "us": [0, 1], "copi": [0, 1], "modifi": [0, 1], "you": [0, 1], "indic": [0, 1], "your": [0, 1], "agreement": [0, 1], "all": [0, 1], "right": [0, 1], "expressli": [0, 1], "grant": [0, 1], "therein": [0, 1], "ar": [0, 1], "reserv": [0, 1], "import": [0, 1], "o": [0, 1], "sy": 0, "pprint": 0, "sgtk": [0, 1], "from": [0, 1], "util": [0, 1], "localfilestoragemanag": 0, "platform": [0, 1, 2], "name": [0, 1], "hidden": [0, 1], "window": 0, "parent": [0, 1], "sg": 0, "widget": [0, 1], "__proxy_window_titl": 0, "dialog": [0, 1], "owner": 0, "proxi": 0, "def": [0, 1], "__init__": [0, 1], "self": [0, 1], "tk": [0, 2], "context": [0, 1], "engine_instance_nam": 0, "env": 0, "get": [0, 1], "environ": [0, 1], "variabl": [0, 1], "care": 0, "about": [0, 1], "alias_execpath": 0, "getenv": 0, "tk_alias_execpath": 0, "none": [0, 1], "alias_bindir": 0, "path": [0, 1], "dirnam": [0, 1], "alias_codenam": 0, "tk_alias_codenam": 0, "autostudio": 0, "alias_vers": 0, "tk_alias_vers": 0, "__hostnam": 0, "shotgrid_alias_host": 0, "__namespac": 0, "shotgrid_alias_namespac": 0, "__port": 0, "shotgrid_alias_port": 0, "int": [0, 1], "python": [0, 1], "modul": 0, "_tk_alia": 0, "keep": [0, 1], "track": 0, "stage": [0, 1], "allow": [0, 1], "switch": [0, 1], "_contexts_by_stage_nam": 0, "_contexts_by_path": 0, "menu": [0, 1, 2], "gener": [0, 1], "respons": [0, 1], "ad": [0, 1], "__menu_gener": 0, "event": [0, 1], "watcher": [0, 1], "manag": [0, 1], "handl": [0, 1], "callback": [0, 1], "__event_watch": 0, "data": [0, 2], "valid": [0, 2], "function": [0, 1], "set": [0, 1], "up": [0, 1], "app": [0, 1, 2], "__data_valid": 0, "A": [0, 1], "socketio": 0, "client": 0, "commun": 0, "openmodel": [0, 1], "__sio": 0, "inform": [0, 1], "server": 0, "connect": [0, 1], "__server_info": 0, "plugin": [0, 1], "bootstrap": 0, "__plugin_info": 0, "api": [0, 1], "call": [0, 1], "__init_api": 0, "__alias_pi": 0, "creat": [0, 1], "qwidget": [0, 1], "its": [0, 1], "__proxy_window": 0, "when": [0, 1], "run": [0, 1], "same": [0, 1], "process": [0, 1], "version": [0, 1], "2024": 0, "0": [0, 1], "qt": [0, 1], "instanc": [0, 1], "__qt_app": 0, "hasattr": [0, 1], "argv": 0, "flag": 0, "inid": 0, "determin": [0, 1], "how": [0, 1], "__in_alias_process": 0, "basenam": [0, 1], "execut": [0, 1], "ex": 0, "open_model": 0, "tk_alias_open_model": 0, "For": [0, 1], "backward": [0, 1], "compat": [0, 1], "mode": [0, 1], "unless": 0, "__is_open_model": 0, "els": [0, 1], "1": [0, 1], "true": [0, 1], "gui": 0, "tk_alias_has_ui": 0, "found": [0, 1], "explicitli": 0, "turn": 0, "off": 0, "__has_ui": 0, "fals": [0, 1], "Not": [0, 1], "defin": [0, 1], "have": [0, 1], "ui": [0, 1], "we": [0, 1], "sai": 0, "base": [0, 1], "init": 0, "method": [0, 1], "super": [0, 1], "4": 0, "staticmethod": 0, "get_current_engin": 0, "return": [0, 1], "current": [0, 1], "ensur": [0, 1], "refer": [0, 1], "stale": 0, "e": [0, 1], "g": [0, 1], "": [0, 1, 2], "becom": 0, "after": [0, 1], "ha": [0, 1], "been": [0, 1], "reload": 0, "current_engin": [0, 1], "on_plugin_init": 0, "3": [0, 1], "logger": [0, 1], "info": [0, 1], "f": [0, 1], "v": [0, 1], "plugin_vers": 0, "python_vers": 0, "properti": [0, 1], "host_info": 0, "applic": 0, "host": 0, "dictionari": [0, 1], "eg": 0, "afterfx": 0, "2017": [0, 1], "dict": [0, 1], "plugin_info": 0, "has_ui": 0, "interact": 0, "openalia": 0, "otherwis": [0, 1], "context_change_allow": [0, 1], "specifi": [0, 1], "chang": [0, 1], "in_alias_process": 0, "whether": 0, "alias_pi": 0, "aliaspi": 0, "object": [0, 1], "can": [0, 1, 2], "make": [0, 1], "request": 0, "other": [0, 1], "helper": [0, 1], "event_watch": [0, 1], "aliaseventwatch": 0, "help": [0, 1], "messag": [0, 1], "data_valid": [0, 1], "aliasdatavalid": [0, 1], "executable_path": 0, "overrid": [0, 1], "pre_app_init": 0, "an": [0, 1], "oper": [0, 1], "state": [0, 1], "system": 0, "typic": 0, "implement": [0, 1, 2], "deriv": 0, "befor": [0, 1], "ani": [0, 1], "load": [0, 1], "debug": [0, 1], "tk_alia": 0, "import_modul": [0, 1], "requir": [0, 1], "call_threadsaf": 0, "server_info": 0, "pformat": 0, "No": [0, 1], "re": [0, 1], "post_app_init": 0, "qtgui": [0, 1], "If": [0, 1], "alreadi": [0, 1], "restart": 0, "do": [0, 1], "post": [0, 1], "now": [0, 1], "post_qt_init": 0, "startup": 0, "py": [0, 1], "qapplic": 0, "post_context_chang": 0, "old_context": 0, "new_context": 0, "occur": 0, "param": [0, 1], "previou": [0, 1], "rebuild": 0, "onli": [0, 1], "build": [0, 1], "destroy_engin": 0, "should": [0, 1], "tear": 0, "down": [0, 1], "itself": 0, "destroi": 0, "shutdown": 0, "clean_menu": 0, "close": 0, "shotgun": [0, 1], "still": [0, 1], "open": [0, 1], "sinc": 0, "some": [0, 1], "thread": 0, "cleanup": 0, "onclos": 0, "handler": 0, "note": [0, 1], "through": [0, 1], "list": [0, 1], "created_qt_dialog": 0, "dialogs_still_open": 0, "disconnect": 0, "quit": 0, "show_panel": 0, "panel_id": 0, "titl": 0, "bundl": 0, "widget_class": 0, "arg": 0, "kwarg": [0, 1], "show": [0, 1], "panel": [0, 1], "thei": [0, 1], "properli": 0, "support": [0, 1], "In": [0, 1], "case": [0, 1], "second": 0, "exist": [0, 1], "one": [0, 1], "instead": [0, 1], "uniqu": [0, 1], "identifi": [0, 1], "obtain": 0, "register_panel": 0, "framework": [0, 1], "associ": 0, "must": [0, 1], "addit": [0, 1], "paramet": [0, 1], "pass": [0, 1], "constructor": [0, 1], "begin": [0, 1], "format": [0, 1], "error": [0, 1], "sorri": 0, "doe": [0, 1], "displai": [0, 1], "cannot": [0, 1], "try": [0, 1], "find": [0, 1], "order": [0, 1], "avoid": 0, "mani": [0, 1], "time": [0, 1], "qt_dialog": 0, "_widget": 0, "continu": [0, 1], "objectnam": 0, "widget_inst": 0, "raise_": 0, "activatewindow": 0, "break": [0, 1], "t": [0, 1], "new": [0, 1], "show_dialog": 0, "setobjectnam": 0, "_get_dialog_par": 0, "__get_or_create_proxy_window": 0, "_emit_log_messag": 0, "record": 0, "log": [0, 1], "termin": 0, "namespac": 0, "wa": [0, 1], "dispatch": [0, 1], "Its": 0, "default": [0, 1], "levelnam": 0, "type": [0, 1], "loghandl": 0, "standard": [0, 1, 2], "logrecord": 0, "todo": 0, "improv": 0, "redirect": 0, "promptlin": 0, "public": 0, "restart_process": 0, "rais": [0, 1], "notimplementederror": [0, 1], "statu": [0, 1], "remove_menu": 0, "alstatuscod": 0, "success": [0, 1], "valu": [0, 1], "remov": [0, 1], "successfulli": [0, 1], "elif": [0, 1], "failur": 0, "fail": [0, 1], "warn": [0, 1], "non": [0, 1], "emit_threadsaf": 0, "attempt": [0, 1], "exit": [0, 1], "runnign": 0, "shut": 0, "qt_app": 0, "__init_qt_app": 0, "qtcore": [0, 1], "pyside_fold": 0, "__file__": 0, "site_packages_fold": 0, "lib_fold": 0, "python_fold": 0, "shotgun_create_fold": 0, "qt_folder": 0, "join": [0, 1], "pysid": 0, "plugins_dir": 0, "qcoreappl": 0, "addlibrarypath": 0, "setquitonlastwindowclos": 0, "_app_quit": 0, "processev": 0, "abouttoquit": 0, "finish": 0, "loop": 0, "start": 0, "noth": 0, "though": 0, "creation": 0, "initiali": 0, "style": 0, "_initialize_dark_look_and_feel": 0, "unicod": 0, "charact": 0, "need": [0, 1], "convert": [0, 1], "correctli": 0, "tell": 0, "interpret": 0, "string": [0, 1], "utf": 0, "8": 0, "utf8": 0, "qtextcodec": 0, "codecfornam": 0, "setcodecforcstr": 0, "codec": 0, "text": [0, 1], "check": [0, 1], "pop": 0, "__check_version_support": 0, "member": 0, "menu_gener": 0, "aliasmenugener": 0, "__init_alias_event_watch": 0, "It": [0, 1, 2], "bar": 0, "command": [0, 1], "__run_app_instance_command": 0, "file": [0, 1], "sgtk_file_to_open": 0, "open_fil": [0, 1], "add": [0, 1, 2], "timer": 0, "delai": 0, "5": 0, "around": 0, "readi": 0, "bullet": 0, "proof": 0, "solut": 0, "most": [0, 1], "better": 0, "altern": 0, "older": 0, "qtimer": 0, "singleshot": 0, "1000": 0, "lambda": [0, 1], "clear": 0, "var": 0, "so": [0, 1], "doesn": [0, 1], "reopen": 0, "del": 0, "save_context_for_stag": [0, 1], "save": [0, 1], "restor": 0, "becaus": [0, 1], "differ": [0, 1], "user": [0, 1], "As": [0, 1], "store": [0, 1], "both": 0, "suppli": [0, 1], "current_stag": 0, "get_current_stag": 0, "save_fil": [0, 1], "conveni": 0, "updat": [0, 1], "save_file_a": [0, 1], "str": [0, 1], "on_stage_act": 0, "result": [0, 1], "trigger": [0, 1], "stagecr": 0, "accord": [0, 1], "mai": [0, 1], "alias_api": [0, 1], "pythoncallbackmessageresult": 0, "invalid": [0, 1], "yet": [0, 1], "form": [0, 1], "reset": [0, 1], "project": [0, 1], "context_from_entity_dictionari": 0, "change_context": 0, "open_save_as_dialog": [0, 1], "multi": [0, 2], "workfiles2": [0, 2], "launch": [0, 2], "browser": 0, "workfil": 0, "show_file_save_dlg": 0, "use_modal_dialog": 0, "appear": 0, "via": [0, 1], "our": 0, "own": [0, 1], "file_dialog": 0, "qfiledialog": 0, "caption": [0, 1], "directori": [0, 1], "expandus": 0, "filter": [0, 1], "wire": [0, 1], "setlabeltext": 0, "accept": [0, 1], "reject": [0, 1], "cancel": [0, 1], "setopt": 0, "dontresolvesymlink": 0, "dontusenativedialog": 0, "exec_": 0, "selectedfil": 0, "splitext": [0, 1], "open_delete_stages_dialog": [0, 1], "new_fil": [0, 1], "prompt": 0, "ask": [0, 1], "he": 0, "want": [0, 1], "delet": [0, 1], "them": 0, "shader": 0, "view": [0, 1], "action": [0, 1], "message_typ": 0, "qmessagebox": [0, 1], "ye": 0, "answer": 0, "question": 0, "get_tk_from_project": [0, 1], "tank": [0, 1], "given": [0, 1], "id": [0, 1], "deal": [0, 1], "librari": 0, "perform": [0, 1], "get_tk_from_project_id": 0, "except": [0, 1], "fallback": 0, "configur": [0, 1, 2], "rtype": [0, 1], "project_id": 0, "first": [0, 1], "live": 0, "anoth": [0, 1], "in_current_project": 0, "pc_local_path": 0, "__get_pipeline_configuration_local_path": 0, "couldn": [0, 1], "sgtk_from_path": 0, "more": [0, 1], "robust": 0, "get_reference_templ": [0, 1], "sg_data": [0, 1], "reference_templ": [0, 1], "templat": [0, 1], "contain": [0, 1, 2], "task": [0, 1], "field": [0, 1], "kei": [0, 1], "ctx": 0, "get_environment_from_context": 0, "engine_set": 0, "get_engine_set": 0, "reference_template_nam": 0, "privat": 0, "__setup_sio": 0, "hostnam": 0, "port": 0, "bool": [0, 1], "shotgridaliassocketiocli": 0, "forc": [0, 1], "either": 0, "headless": 0, "batch": [0, 1], "argument": [0, 1], "These": 0, "directli": [0, 1], "even": [0, 1], "old": 0, "wai": [0, 1], "api_import_error": 0, "n": 0, "api_modul": 0, "separ": [0, 1], "than": [0, 1], "conflict": 0, "between": [0, 1], "qtquick": 0, "qml": 0, "model": 0, "framework_alia": 0, "alias_api_om": 0, "univers": [0, 1], "initialize_univers": 0, "listen": 0, "socket": 0, "get_alias_api": 0, "wrap": 0, "made": [0, 1], "rout": 0, "actual": 0, "aceess": 0, "pyd": 0, "sys_module_nam": 0, "saniti": 0, "assert": 0, "import_error": 0, "regist": [0, 1], "watch": 0, "immedi": 0, "almessagetyp": 0, "dagnamemodifi": 0, "caus": 0, "crash": 0, "look": [0, 1], "like": [0, 1], "bug": 0, "where": [0, 1, 2], "alias_event_watch": 0, "register_alias_callback": 0, "stageact": 0, "start_watch": 0, "skip": 0, "comparison": 0, "get_set": 0, "compatibility_dialog_min_vers": 0, "2020": 0, "msg": 0, "fulli": 0, "test": 0, "experi": 0, "instabl": 0, "pleas": [0, 1], "report": [0, 1], "issu": [0, 1], "support_url": 0, "2021": 0, "compatibility_dialog_old_vers": 0, "capabl": 0, "consid": 0, "upgrad": 0, "recent": [0, 1], "set_parent_window": 0, "setwindowtitl": 0, "winid": 0, "dialogpar": 0, "isinst": [0, 1], "get_dialog_par": 0, "activewindow": 0, "adjust": 0, "center": 0, "take": [0, 1], "effect": 0, "adjust_window": 0, "seri": 0, "run_at_startup": 0, "yaml": 0, "map": [0, 1], "app_instance_command": 0, "command_nam": 0, "item": [0, 1], "app_inst": 0, "entri": [0, 1], "command_dict": 0, "setdefault": 0, "instance_nam": 0, "commands_to_run": 0, "app_setting_dict": 0, "app_instance_nam": 0, "setting_command_nam": 0, "retriev": [0, 1], "instal": [0, 1], "command_funct": 0, "append": [0, 1], "whose": 0, "known_command": 0, "unknown": 0, "known": [0, 1], "just": [0, 1], "bail": 0, "final": [0, 1], "config": [0, 1], "local": [0, 1], "stand": 0, "cach": 0, "folder": [0, 1], "abl": [0, 1], "entiti": [0, 1], "could": [0, 1], "plugin_id": 0, "basic": [0, 1], "desktop": 0, "relat": [0, 1], "distant": 0, "here": [0, 1], "go": 0, "mgr": 0, "toolkitmanag": 0, "constant": [0, 1], "default_plugin_id": 0, "pipeline_configur": 0, "get_pipeline_configur": 0, "link": [0, 1], "len": [0, 1], "pipeline_config": 0, "restrict": 0, "2": [0, 1], "primari": 0, "__get_project_pipeline_configur": 0, "__get_primary_pipeline_configur": 0, "too": [0, 1], "config_local_path": 0, "get_configuration_root": 0, "shotgun_url": 0, "cfg": 0, "disk": [0, 1], "prepare_engin": 0, "pars": 0, "pc": 0, "primary_pipeline_config_nam": 0, "keyerror": 0, "The": 1, "custom": 1, "below": 1, "specif": 1, "detail": [1, 2], "rule": 1, "2022": 1, "code": [1, 2], "hookbaseclass": 1, "get_hook_baseclass": 1, "aliasdatavalidationerror": 1, "sanitizedresult": 1, "repres": 1, "sanit": 1, "is_valid": 1, "long": 1, "follow": 1, "expect": 1, "get_validation_data": 1, "scene": 1, "meth": 1, "To": 1, "validationrul": 1, "exampl": 1, "abov": 1, "assum": 1, "being": 1, "step": 1, "necessari": 1, "fix": 1, "yml": 1, "global": 1, "toggl": 1, "demonstr": 1, "purpos": 1, "custom_rule_is_valid": 1, "check_my_custom_rul": 1, "fail_fast": 1, "button": 1, "click": 1, "guidelin": 1, "advanc": 1, "prefix": 1, "check_": 1, "fast": 1, "namedtupl": 1, "also": 1, "collect": 1, "aliasobject": 1, "node": 1, "alsurfacenod": 1, "faist": 1, "fix_my_custom_rul": 1, "next": 1, "simplic": 1, "fix_": 1, "action_callback": 1, "row": 1, "me": 1, "revalid": 1, "what": 1, "happend": 1, "my_custom_rul": 1, "my": 1, "descript": 1, "br": 1, "hand": 1, "error_msg": 1, "let": 1, "fix_nam": 1, "check_func": 1, "fix_func": 1, "sanitize_check_result": 1, "conform": 1, "incom": 1, "succe": 1, "empti": 1, "option": 1, "receiv": 1, "boolean": 1, "post_fix_act": 1, "onc": 1, "individu": 1, "resolv": 1, "rule_id": 1, "refresh": 1, "viewport": 1, "cos_unus": 1, "references_exist": 1, "node_pivots_at_origin": 1, "isdisjoint": 1, "redraw_screen": 1, "2015": 1, "softwar": 1, "avail": 1, "broken": 1, "publish": 1, "generate_act": 1, "sg_publish_data": 1, "ui_area": 1, "particular": 1, "each": 1, "somewher": 1, "popul": 1, "kept": 1, "place": 1, "point": 1, "loader": 1, "establish": 1, "appropri": 1, "least": 1, "those": 1, "tailor": 1, "output": 1, "tooltip": 1, "etc": 1, "suitabl": 1, "shown": 1, "brows": 1, "area": 1, "histori": 1, "perfectli": 1, "possibl": 1, "introspect": 1, "character_attach": 1, "scan": 1, "figur": 1, "out": 1, "attach": 1, "left": 1, "run_act": 1, "denot": 1, "element": 1, "action_inst": 1, "import_as_refer": 1, "texture_nod": 1, "canva": 1, "import_subdiv": 1, "subdiv": 1, "execute_multiple_act": 1, "execute_act": 1, "hold": 1, "come": 1, "reus": 1, "written": 1, "stop": 1, "appli": 1, "select": 1, "midwai": 1, "single_act": 1, "sent": 1, "enumer": 1, "get_publish_path": 1, "_create_refer": 1, "_import_fil": 1, "_import_file_as_refer": 1, "_create_texture_nod": 1, "_import_subdivis": 1, "create_refer": 1, "session": 1, "import_fil": 1, "fly": 1, "wref": 1, "belong": 1, "manipul": 1, "extract": 1, "translat": 1, "attributeerror": 1, "There": 1, "href": 1, "http": 1, "github": 1, "com": 1, "shotgunsoftwar": 1, "wiki": 1, "b": 1, "source_templ": 1, "template_from_path": 1, "locat": 1, "template_field": 1, "get_field": 1, "extens": 1, "reference_path": 1, "apply_field": 1, "output_path": 1, "output_ext": 1, "_": 1, "load_framework": 1, "aliastranslations_v0": 1, "x": 1, "tk_framework_aliastransl": 1, "imag": 1, "create_texture_nod": 1, "subdivis": 1, "aliaspythonexcept": 1, "api_error": 1, "err_msg": 1, "help_link": 1, "enu": 1, "guid": 1, "667410ad": 1, "cf4d": 1, "43b3": 1, "ae96": 1, "0c1331cb80b2": 1, "annot": 1, "One": 1, "line": 1, "describ": 1, "p": 1, "export": 1, "tool": 1, "sync": 1, "review": 1, "item_filt": 1, "interest": 1, "match": 1, "present": 1, "glob": 1, "patter": 1, "maya": 1, "enabl": 1, "disabl": 1, "visibl": 1, "uncheck": 1, "has_annotation_loc": 1, "ok": 1, "logic": 1, "insid": 1, "root": 1, "bg_process": 1, "in_bg_process": 1, "publish_data": 1, "version_data": 1, "sg_version_data": 1, "note_link": 1, "get_annotation_locator_str": 1, "batch_data": 1, "note_data": 1, "content": 1, "request_typ": 1, "entity_typ": 1, "complet": 1, "reli": 1, "inherit": 1, "someth": 1, "publish_fil": 1, "publish_sess": 1, "icon": 1, "verbos": 1, "simpl": 1, "html": 1, "loader_url": 1, "sgdev": 1, "contextid": 1, "pc_app_load": 1, "h3": 1, "filenam": 1, "number": 1, "bump": 1, "reflect": 1, "worklfow": 1, "recogn": 1, "ul": 1, "li": 1, "ext": 1, "filename_v": 1, "detect": 1, "automat": 1, "increment": 1, "v001": 1, "v002": 1, "produc": 1, "prior": 1, "amount": 1, "pad": 1, "workflow": 1, "overwrit": 1, "multipl": 1, "howev": 1, "dure": 1, "settings_typ": 1, "default_valu": 1, "part": 1, "base_set": 1, "alias_publish_set": 1, "correspond": 1, "temporari": 1, "measur": 1, "until": 1, "nativ": 1, "_session_path": 1, "extra": 1, "_get_save_as_act": 1, "ref": 1, "get_refer": 1, "ref_path": 1, "against": 1, "normal": 1, "trail": 1, "doubl": 1, "shotgunpath": 1, "work_templ": 1, "action_button": 1, "label": 1, "abil": 1, "jump": 1, "next_version_path": 1, "_get_next_version_info": 1, "version_numb": 1, "while": 1, "publish_template_set": 1, "publish_templ": 1, "get_template_by_nam": 1, "phase": 1, "sure": 1, "background": 1, "later": 1, "session_path": 1, "session_nam": 1, "task_nam": 1, "entity_nam": 1, "file_nam": 1, "depend": 1, "publish_depend": 1, "_alias_find_additional_session_depend": 1, "_save_to_next_vers": 1, "get_current_path": 1, "color": 1, "red": 1, "translator_set": 1, "releas": 1, "catpart": 1, "among": 1, "per": 1, "definit": 1, "alias_refer": 1, "vred": 1, "don": 1, "publish_path": 1, "condit": 1, "translation_typ": 1, "translator_typ": 1, "translator_path": 1, "alias_info": 1, "get_product_inform": 1, "local_properti": 1, "license_set": 1, "product_kei": 1, "product_vers": 1, "product_license_typ": 1, "product_license_path": 1, "publish_fold": 1, "ensure_folder_exist": 1, "get_properti": 1, "add_extra_param": 1, "parent_sg_publish_data": 1, "share": 1, "thumbnail": 1, "child": 1, "request_timeout": 1, "60": 1, "start_tim": 1, "perf_count": 1, "thumbnail_shar": 1, "share_thumbnail": 1, "source_ent": 1, "sleep": 1, "couln": 1, "action_show_in_shotgun": 1, "reveal": 1, "get_publish_templ": 1, "get_publish_typ": 1, "path_info": 1, "get_file_path_compon": 1, "lowercas": 1, "dot": 1, "lstrip": 1, "lower": 1, "type_def": 1, "publish_typ": 1, "file_extens": 1, "pre": 1, "capit": 1, "get_publish_nam": 1, "sequenc": 1, "_copy_work_to_publish": 1, "design": 1, "suffici": 1, "satisfi": 1, "met": 1, "sequence_path": 1, "meet": 1, "criteria": 1, "respect": 1, "publish_plugin": 1, "done": 1, "eras": 1, "variant": 1, "lister": 1, "has_vari": 1, "get_vari": 1, "alias_vari": 1, "upload_thumbnail": 1, "entity_id": 1, "variant_filepath": 1, "file_ext": 1, "upload": 1, "field_nam": 1, "display_nam": 1, "insert": 1, "png": 1, "level": 1, "disk_loc": 1, "pardir": 1, "version_up": 1, "_get_version_numb": 1, "_get_version_docs_act": 1, "leav": 1, "mean": 1, "won": 1, "much": 1, "within": 1, "simpli": 1, "inject": 1, "version_path": 1, "get_version_path": 1, "choos": 1, "collector": 1, "zero": 1, "work_field": 1, "did": 1, "unavail": 1, "get_version_numb": 1, "doc": 1, "action_open_url": 1, "url": 1, "sgsub": 1, "sg_supervisor_artist_sa_integrations_sa_integrations_user_guide_html": 1, "shutil": 1, "tempfil": 1, "version_type_2d": 1, "2d": 1, "version_type_3d": 1, "3d": 1, "version_type_opt": 1, "version_type_descript": 1, "video": 1, "represent": 1, "lmv": 1, "geometri": 1, "reciev": 1, "upload_version_set": 1, "last_opt": 1, "version_typ": 1, "unsupport": 1, "site": 1, "pref": 1, "block": 1, "is_3d_viewer_en": 1, "_is_3d_viewer_en": 1, "contact": 1, "prefer": 1, "framework_lmv": 1, "lmv_v1": 1, "miss": 1, "v1": 1, "lmv_translat": 1, "lmvtranslat": 1, "lmv_translator_path": 1, "get_translator_path": 1, "Be": 1, "strip": 1, "path_compon": 1, "publish_nam": 1, "media": 1, "version_id": 1, "thumbnail_path": 1, "get_thumbnail_as_path": 1, "media_package_path": 1, "media_version_typ": 1, "ignor": 1, "_translate_file_to_lmv": 1, "web": 1, "sg_translation_typ": 1, "uploaded_movie_path": 1, "uplod": 1, "sg_uploaded_movi": 1, "plai": 1, "hover": 1, "_cleanup_temp_fil": 1, "interfac": 1, "create_settings_widget": 1, "side": 1, "publishitem": 1, "subclass": 1, "edit": 1, "defer": 1, "widget_layout": 1, "qvboxlayout": 1, "group": 1, "box": 1, "description_group_box": 1, "qgroupbox": 1, "settitl": 1, "combobox": 1, "description_label": 1, "qlabel": 1, "setwordwrap": 1, "setopenexternallink": 1, "settextformat": 1, "richtext": 1, "layout": 1, "description_layout": 1, "addwidget": 1, "addstretch": 1, "setlayout": 1, "version_type_combobox": 1, "qcombobox": 1, "setaccessiblenam": 1, "dropdown": 1, "additem": 1, "signal": 1, "slot": 1, "currentindexchang": 1, "index": 1, "_on_version_type_chang": 1, "currenttext": 1, "minor": 1, "get_ui_set": 1, "set_ui_set": 1, "setproperti": 1, "invok": 1, "gather": 1, "previous": 1, "repopul": 1, "again": 1, "drive": 1, "necessarili": 1, "subset": 1, "setting_a": 1, "ui_set": 1, "version_type_index": 1, "currentindex": 1, "seeting_a": 1, "setting_b": 1, "ones": 1, "decid": 1, "wish": 1, "accordingli": 1, "version_type_valu": 1, "max": 1, "current_version_index": 1, "correct": 1, "verstion": 1, "manual": 1, "setcurrentindex": 1, "selector": 1, "playabl": 1, "viewer": 1, "settext": 1, "protect": 1, "remove_from_root": 1, "top": 1, "sub": 1, "singl": 1, "children": 1, "clean": 1, "tempdir": 1, "gettempdir": 1, "commonpath": 1, "temp": 1, "dir": 1, "relative_path": 1, "relpath": 1, "normpath": 1, "split": 1, "sep": 1, "isdir": 1, "rmtree": 1, "isfil": 1, "zip": 1, "package_path": 1, "lmv_thumbnail_path": 1, "svf_file_nam": 1, "output_directori": 1, "enable_3d_view": 1, "enable_3d_viewer_pref": 1, "preferences_read": 1, "import_note_attach": 1, "_import_note_attachments_as_canva": 1, "get_templ": 1, "sg_note": 1, "find_on": 1, "temporarydirectori": 1, "temp_dir": 1, "temp_path": 1, "download_attach": 1, "uuid": 1, "hookclass": 1, "file_path": 1, "parent_act": 1, "file_vers": 1, "read_onli": 1, "revis": 1, "latest": 1, "read": 1, "current_path": 1, "At": 1, "end": 1, "save_context": 1, "save_a": 1, "prepare_new": 1, "queue": 1, "interfer": 1, "create_context_manag": 1, "is_empty_fil": 1, "new_stag": 1, "open_in_current_stag": 1, "get_stag": 1, "stage_nam": 1, "uuid4": 1, "hex": 1, "create_stag": 1, "whcih": 1, "integr": 2, "hook": 2, "loader2": 2, "publish2": 2, "shotgunpanel": 2}, "objects": {}, "objtypes": {}, "objnames": {}, "titleterms": {"The": [0, 2], "alia": [0, 1, 2], "engin": [0, 1, 2], "code": 0, "hook": 1, "tk": 1, "multi": 1, "data": 1, "valid": 1, "aliasdatavalidationhook": 1, "loader2": 1, "aliasact": 1, "publish2": 1, "publishannotationsplugin": 1, "aliassessionpublishplugin": 1, "aliastranslationpublishplugin": 1, "aliaspublishvariantsplugin": 1, "aliasstartversioncontrolplugin": 1, "uploadversionplugin": 1, "shotgunpanel": 1, "workfiles2": 1, "sceneoper": 1, "overview": 2, "custom": 2, "content": 2}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.intersphinx": 1, "sphinx": 57}, "alltitles": {"The Alias Engine Code": [[0, "the-alias-engine-code"]], "Alias Engine Hooks": [[1, "alias-engine-hooks"]], "tk-multi-data-validation": [[1, "tk-multi-data-validation"]], "AliasDataValidationHook": [[1, "aliasdatavalidationhook"]], "tk-multi-loader2": [[1, "tk-multi-loader2"]], "AliasActions": [[1, "aliasactions"], [1, "hooks-tk-multi-shotgunpanel-scene-actions"]], "tk-multi-publish2": [[1, "tk-multi-publish2"]], "PublishAnnotationsPlugin": [[1, "publishannotationsplugin"]], "AliasSessionPublishPlugin": [[1, "aliassessionpublishplugin"]], "AliasTranslationPublishPlugin": [[1, "aliastranslationpublishplugin"]], "AliasPublishVariantsPlugin": [[1, "aliaspublishvariantsplugin"]], "AliasStartVersionControlPlugin": [[1, "aliasstartversioncontrolplugin"]], "UploadVersionPlugin": [[1, "uploadversionplugin"]], "tk-multi-shotgunpanel": [[1, "tk-multi-shotgunpanel"]], "tk-multi-workfiles2": [[1, "tk-multi-workfiles2"]], "SceneOperation": [[1, "sceneoperation"]], "The Alias Engine": [[2, "the-alias-engine"]], "Overview": [[2, "overview"]], "Customizations": [[2, "customizations"]], "Contents": [[2, "contents"]]}, "indexentries": {}})
\ No newline at end of file