NaviNIBS.Navigator.Model.Addons module

class NaviNIBS.Navigator.Model.Addons.AddonSessionConfig

Bases: ABC

Base class to define an addon’s configuration parameters that will be saved in session config

sigConfigAboutToChange: Signal

sigConfigChanged: Signal

asDict()

Return type:

dict[str, Any]

classmethod fromDict(d)

class NaviNIBS.Navigator.Model.Addons.AddonClassElement(ClassName, importModule, key=None, isBuiltIn=False)

Bases: Generic[ACE]

Parameters:

• _ClassName

• _importModule

• _key

• isBuiltIn (bool)

_ClassName: str

_importModule: str

_key: str

isBuiltIn: bool

property key

property ClassName

property importModule

property Class: Type[ACE]

Return type:

Type[~ACE]

reload()

asDict()

Return type:

Dict[str, Any]

classmethod fromDict(d)

class NaviNIBS.Navigator.Model.Addons.AddonExtra(navigatorGUI, session)

Bases: ABC

Base class to define optional custom code for an addon.

Use this when an addon needs to provide custom code not part of a main view panel, navigation view layer, etc. This may be used for code-only addon pieces (such as providing a data output stream), or for patching existing GUI functionality (using the reference to the root NavigatorGUI instance).

Any AddonCode class elements defined in an addon configuration will be instantiated and passed references to the root NavigatorGUI instance and the session model when the addon is loaded.

Parameters:

• _navigatorGUI

• _session

_navigatorGUI: NavigatorGUI

_session: Session

class NaviNIBS.Navigator.Model.Addons.Addon(key, addonInstallPath, addonVersion=None, MainViewPanels=NOTHING, NavigationViews=NOTHING, NavigationViewLayers=NOTHING, Extras=NOTHING, SessionAttrs=NOTHING, sessionAttrs=NOTHING, isActive=True)

Bases: GenericCollectionDictItem[str]

Parameters:

• _key

• _addonInstallPath

• _addonVersion

• _MainViewPanels

• _NavigationViews

• _NavigationViewLayers

• _Extras

• _SessionAttrs

• _sessionAttrs

• _isActive

_addonInstallPath: str

_addonVersion: str | None

_MainViewPanels: tp.Dict[str, AddonClassElement[MainViewPanel]]

_NavigationViews: tp.Dict[str, AddonClassElement[NavigationView]]

_NavigationViewLayers: tp.Dict[str, AddonClassElement[ViewLayer]]

_Extras: tp.Dict[str, AddonClassElement[AddonExtra]]

_SessionAttrs: tp.Dict[str, AddonClassElement[AddonSessionConfig]]

_sessionAttrs: dict[str, AddonSessionConfig]

property MainViewPanels

property addonInstallPath

property SessionAttrs

property needsToInstantiateExtras

instantiateExtras(navigatorGUI, session)

asDict()

Return type:

Dict[str, Any]

getConfigFilename(unpackedSessionDir, filenamePrefix='')

Return type:

str

writeConfig(unpackedSessionDir, filenamePrefix='')

Return type:

str

classmethod fromDict(d)

Return type:

Addon

class NaviNIBS.Navigator.Model.Addons.Addons(items=NOTHING)

Bases: GenericCollection[str, Addon]

Parameters:

_items

asList(unpackedSessionDir, filenamePrefix='', doWriteAddonConfigs=True)

Return type:

List[str]

classmethod fromList(addonList, unpackedSessionDir)

Return type:

Addons