maya.plugin#

Bookmarks’ Maya plugin.

Make sure the BOOKMARKS_ROOT environment variable is set to point the root of the Bookmarks distribution package as it is required to find and load all the necessary dependencies.

Functions:

init_environment([key, pyside])

Add the dependencies required to run Bookmarks to a python environment.

initializePlugin(name)

Initializes the plugin.

is_batch()

Checks if Maya is running in batch mode.

uninitializePlugin(name)

Un-initializes the plugin.
bookmarks.maya.plugin.init_environment(key='BOOKMARKS_ROOT', pyside=False)[source]#

Add the dependencies required to run Bookmarks to a python environment.

The Bookmarks installer should set the ‘BOOKMARKS_ROOT’ environment variable to the installation directory. This is required to load the python modules into the current environment.

Parameters:

  • key (str) – The environment variable used to find the distribution directory. Optional, defaults to ‘BOOKMARKS_ROOT

  • pyside (bool) – Adds the PySide modules bundled with Bookmarks if True. Optional, defaults to False.

Raises:

  • EnvironmentError – When the key environment is not set.

  • RuntimeError – When the key environment is invalid or points to a missing directory.

bookmarks.maya.plugin.initializePlugin(name)[source]#

Initializes the plugin.

bookmarks.maya.plugin.is_batch()[source]#

Checks if Maya is running in batch mode.

bookmarks.maya.plugin.uninitializePlugin(name)[source]#

Un-initializes the plugin.