shelfutils module

shelfutils.chooseAndOpenAudioFile()

Chooses and loads a soundtrack file, and sets up the Audio Panel parameters to play the audio durng animation playback or playbar scrubbing.

shelfutils.downloadAndInstallPackage(shelf_name, shelf_url, install_path, tmp_path=None)

Downloads the shelf package from ‘shelf_url’ and installs it into the given installation directory. Returns the final install path of the shelf package. Returns the empty string on failure.

shelfutils.findFilesByExtension(dir, file_ext)

Recursively searches in ‘dir’ and returns a list of all the files found in the directory tree that match the given file extension. Does not search in hidden directories or ‘backup’ directories.

shelfutils.findShelfFiles(shelf_install_dir, shelf_extensions=None)

Recursively searches in ‘shelf_install_dir’ and returns a list of shelf files found in the directory tree. Does not search in hidden directories or ‘backup’ directories.

shelfutils.findShelfOTLFiles(shelf_install_dir)

Recursively searches in ‘shelf_install_dir’ and returns a list of shelf files found in the directory tree. Does not search in hidden directories or ‘backup’ directories.

shelfutils.installOrboltAsset(kwargs, node_name, url)

Script that Houdini calls when clicking on a shelf tool that corresponds to an Orbolt asset. We can either direct the user to the asset store if it the asset has not been installed yet or install it in the viewport.

shelfutils.installPackage(shelf_name, shelf_pkg_path, install_path)

Installs the shelf package, ‘shelf_pkg_path’, into the given installation directory. This removes previously installed packages with the same shelf name. Returns the final installation path for the shelf package. Returns the empty string on failure.

shelfutils.normalizePath(path)

Normalizes the given file path by replacing backward slashes with forward slashes. This function is useful when comparing file paths.

shelfutils.populateShelfFromJSON()

Load the list of shelf tools corresponding to Orbolt assets and populate them in the shelf.