Skip to content

Developer Docs

Most important Locations.

  1. config
  2. provides general addon config and a list of variables and functions to access settings across the addon.
  3. also allows to get lakeFs related classes and functions in there global state
  4. hooks
  5. Ayon + Pyblish related addons and hooks.
  6. standalone
  7. AyonUsd standalone tools. They should be DCC agnostic.
  8. utils
  9. utility functions to make interaction with the addon simpler.

Standalone

Pinning Support.

Standalone/Usd/pinning/pinning_file_helper.py

The Ayon Usd resolver has a feature we call pinning support.\ This allows storing the current resolver state for an Usd stage in a file to load the frozen stage without server interaction.

generate_pinning_file\ creates a pinning file JSON from a given USD stage

def generate_pinning_file(
    entry_usd: str, root_info: Dict[str, str], pinning_file_path: str
):

Example Code:

import os
import ayon_api
from ayon_usd.standalone.usd.pinning import pinning_file_helper


in_usd_file = "/path/to/usd/file.usd"
root_info = ayon_api.get_project_roots_for_site(os.environ.get("AYON_PROJECT_NAME"))

pinning_file_helper.generate_pinning_file(in_usd_file, root_info, "/path/to/output_file.json")

[!WARNING] USD file entrypoint URI versus filepath The in_usd_file can be anything that the AyonUsdResolver can resolve, including an AYON URI. However, it is important to know that whatever you use as the input must be the input when you load the usd. In other words: if you use an URI to generate the pinning file you need to open the stage with the same URI, whereas if you use an file path you will need to do the same.

it is generally advised to use an URI as they will never have any system specific data in them. The generated pinning file also has a key that will tell you what entry point was used to generate the pinning file. You can simply read out this key and use it to open a stage with the pinning file ayon_pinning_data_entry_scene.