Package autodesk_toxik :: Module pimgr

Module pimgr

Plug-in manager module.

This module provides access to the plug-in manager. The plug-in manager is responsible for querying and loading various Toxik plug-in tool (.dltool), module (.dlmodule), view (.dlview) and file format (.dlformat) libraries.

The functions provided by this module allow querying for the available plugins, managing the load path and loading desired plugins into the runtime system.

Plug-in Search Path

The default search paths for Toxik plug-ins is controlled by the DL_PLUGINS_DIR environment variable.

Classes
	PimgrError

Functions

list(path=None)
Lists all the plug-ins in the specified directory, or in the default plug-in search path if None is specified.

loadAllPlugins(pluginPath=None, verbose=False)
Convenience function that loads all the available plug-ins in the specified path or the default plug-in search path if None is specified.

addPath(...)
Adds a directory (dir) to the plug-in search path.

[str]

getPath(...)
Returns: The list of directories that the plug-in manager searches to load plug-ins.

load(...)
Loads a plug-in.

[str]

loadType(...)
Loads all plug-ins registered on the system that match the type specified by the string parameter type.

[str]

loadWild(...)
Loads all plug-ins registered on the system that match the specified wildcard.

setPath(...)
Sets the search path for plug-ins.

Variables
	__package__ = `'autodesk_toxik'`

Function Details

list(path=None)

Lists all the plug-ins in the specified directory, or in the default plug-in search path if None is specified.

Parameters:

path (str or list of str)

loadAllPlugins(pluginPath=None, verbose=False)

Convenience function that loads all the available plug-ins in the specified path or the default plug-in search path if None is specified.

Parameters:

pluginPath (str)
verbose (bool)

addPath(...)

Adds a directory (dir) to the plug-in search path.

Parameters:

dir (str) - The directory to add.

getPath(...)

Returns: [str]: The list of directories that the plug-in manager searches to load plug-ins.

load(...)

Loads a plug-in.

Example:

   load( "libDLquicktimeFormats.dlformat" )

Parameters:

name (str) - The name of the plugin to load.

Raises:

Exception - If the operation has failed.

loadType(...)

Loads all plug-ins registered on the system that match the type specified by the string parameter type.

Parameters:

type (str) - This argument is typically set to "dltool", "dlmodule", "dlview", "dlformat", or other.
path (str) - Optional argument that can be set to a specific directory to use.

Returns: [str]

The list of names of plug-ins that have been loaded or that were already loaded.

loadWild(...)

Loads all plug-ins registered on the system that match the specified wildcard.

Parameters:

type (str) - Type wildcard.
path (str) - Optional argument that can be set to a specific directory to use.

Returns: [str]

The list of names of plug-ins that have been loaded or that were already loaded.

setPath(...)

Sets the search path for plug-ins. The parameter should be a list of strings (paths).

Parameters:

dirList (list of str)