def __init__(self, parent=None):
super(PyFlow, self).__init__(parent=parent)
self.edHistory = EditorHistory(self)
self.setWindowTitle("PyFlow v{0}".format(currentVersion().__str__()))
self.undoStack = QUndoStack(self)
self.setContentsMargins(1, 1, 1, 1)
self.graphManager = GraphManagerSingleton()
self.canvasWidget = CanvasWidget(self.graphManager.get(), self)
self.canvasWidget.setObjectName("canvasWidget")
self.setCentralWidget(self.canvasWidget)
self.setTabPosition(QtCore.Qt.AllDockWidgetAreas, QTabWidget.North)
self.setDockOptions(QMainWindow.AnimatedDocks
| QMainWindow.AllowNestedDocks)
self.menuBar = QMenuBar(self)
self.menuBar.setGeometry(QtCore.QRect(0, 0, 863, 21))
self.menuBar.setObjectName("menuBar")
self.setMenuBar(self.menuBar)
self.toolBar = QToolBar(self)
self.toolBar.setObjectName("toolBar")
self.addToolBar(QtCore.Qt.TopToolBarArea, self.toolBar)
self.setWindowIcon(QtGui.QIcon(":/LogoBpApp.png"))
self._tools = set()
self.currentTempDir = ""
self.preferencesWindow = PreferencesWindow(self)
self.setMouseTracking(True)
self._lastClock = 0.0
self.fps = EDITOR_TARGET_FPS
self.tick_timer = QtCore.QTimer()
self._current_file_name = 'Untitled'
self.populateMenu()
def closeEvent(self, event):
self.tick_timer.stop()
self.tick_timer.timeout.disconnect()
EditorHistory().shutdown()
self.canvasWidget.shoutDown()
# save editor config
settings = ConfigManager().getSettings("APP_STATE")
# clear file each time to capture opened dock tools
settings.clear()
settings.sync()
settings.beginGroup('Editor')
settings.setValue("geometry", self.saveGeometry())
settings.setValue("state", self.saveState())
settings.endGroup()
# save tools state
settings.beginGroup('Tools')
for tool in self._tools:
if isinstance(tool, ShelfTool):
settings.beginGroup("ShelfTools")
settings.beginGroup(tool.name())
tool.saveState(settings)
settings.endGroup()
settings.endGroup()
if isinstance(tool, DockTool):
settings.beginGroup("DockTools")
settings.beginGroup(tool.uniqueName())
tool.saveState(settings)
settings.endGroup()
settings.endGroup()
tool.onDestroy()
settings.endGroup()
settings.sync()
# remove temp directory if exists
if os.path.exists(self.currentTempDir):
shutil.rmtree(self.currentTempDir)
# TODO: Use "Borg" pattern to destroy all singletons at once
EditorHistory.destroy()
GraphManagerSingleton.destroy()
ConfigManager.destroy()
PreferencesWindow.destroy()
PyFlow.appInstance = None
QMainWindow.closeEvent(self, event)
def __init__(self, parent=None):
super(PyFlow, self).__init__(parent=parent)
self._modified = False
self.setFocusPolicy(QtCore.Qt.StrongFocus)
self.currentSoftware = ""
self.edHistory = EditorHistory(self)
self.edHistory.statePushed.connect(self.historyStatePushed)
self.setWindowTitle(winTitle())
self.undoStack = QUndoStack(self)
self.setContentsMargins(1, 1, 1, 1)
self.graphManager = GraphManagerSingleton()
self.canvasWidget = BlueprintCanvasWidget(self.graphManager.get(),
self)
self.canvasWidget.setObjectName("canvasWidget")
self.setCentralWidget(self.canvasWidget)
self.setTabPosition(QtCore.Qt.AllDockWidgetAreas, QTabWidget.North)
self.setDockOptions(QMainWindow.AnimatedDocks
| QMainWindow.AllowNestedDocks)
self.menuBar = QMenuBar(self)
self.menuBar.setGeometry(QtCore.QRect(0, 0, 863, 21))
self.menuBar.setObjectName("menuBar")
self.setMenuBar(self.menuBar)
self.toolBar = QToolBar(self)
self.toolBar.setObjectName("toolBar")
self.addToolBar(QtCore.Qt.TopToolBarArea, self.toolBar)
self.setWindowIcon(QtGui.QIcon(":/LogoBpApp.png"))
self._tools = set()
self.currentTempDir = ""
self.preferencesWindow = PreferencesWindow(self)
self.setMouseTracking(True)
self._lastClock = 0.0
self.fps = EDITOR_TARGET_FPS
self.tick_timer = QtCore.QTimer()
self._currentFileName = ''
self.currentFileName = None
def __init__(self, parent=None):
super(PyFlow, self).__init__(parent=parent)
self.setupUi(self)
self.setWindowIcon(QtGui.QIcon(":/LogoBpApp.png"))
self._tools = set()
self.currentTempDir = ""
self.preferencesWindow = PreferencesWindow(self)
self.graphManager = GraphManager()
self.canvasWidget = Canvas(self.graphManager, self)
self.canvasWidget.requestFillProperties.connect(
self.onRequestFillProperties)
self.canvasWidget.requestClearProperties.connect(
self.onRequestClearProperties)
self.graphManager.graphChanged.connect(self.updateGraphTreeLocation)
self.updateGraphTreeLocation()
self.SceneLayout.addWidget(self.canvasWidget)
rxLettersAndNumbers = QtCore.QRegExp('^[a-zA-Z0-9]*$')
nameValidator = QtGui.QRegExpValidator(rxLettersAndNumbers,
self.leCompoundName)
self.leCompoundName.setValidator(nameValidator)
self.leCompoundName.returnPressed.connect(
self.onActiveCompoundNameAccepted)
rxLetters = QtCore.QRegExp('^[a-zA-Z]*$')
categoryValidator = QtGui.QRegExpValidator(rxLetters,
self.leCompoundCategory)
self.leCompoundCategory.setValidator(categoryValidator)
self.leCompoundCategory.returnPressed.connect(
self.onActiveCompoundCategoryAccepted)
self.setMouseTracking(True)
self._lastClock = 0.0
self.fps = EDITOR_TARGET_FPS
self.tick_timer = QtCore.QTimer()
self._current_file_name = 'Untitled'
self.populateMenu()
class PyFlow(QMainWindow):
appInstance = None
newFileExecuted = QtCore.Signal(bool)
fileBeenLoaded = QtCore.Signal()
def __init__(self, parent=None):
super(PyFlow, self).__init__(parent=parent)
self.edHistory = EditorHistory(self)
self.setWindowTitle("PyFlow v{0}".format(currentVersion().__str__()))
self.undoStack = QUndoStack(self)
self.setContentsMargins(1, 1, 1, 1)
self.graphManager = GraphManagerSingleton()
self.canvasWidget = CanvasWidget(self.graphManager.get(), self)
self.canvasWidget.setObjectName("canvasWidget")
self.setCentralWidget(self.canvasWidget)
self.setTabPosition(QtCore.Qt.AllDockWidgetAreas, QTabWidget.North)
self.setDockOptions(QMainWindow.AnimatedDocks
| QMainWindow.AllowNestedDocks)
self.menuBar = QMenuBar(self)
self.menuBar.setGeometry(QtCore.QRect(0, 0, 863, 21))
self.menuBar.setObjectName("menuBar")
self.setMenuBar(self.menuBar)
self.toolBar = QToolBar(self)
self.toolBar.setObjectName("toolBar")
self.addToolBar(QtCore.Qt.TopToolBarArea, self.toolBar)
self.setWindowIcon(QtGui.QIcon(":/LogoBpApp.png"))
self._tools = set()
self.currentTempDir = ""
self.preferencesWindow = PreferencesWindow(self)
self.setMouseTracking(True)
self._lastClock = 0.0
self.fps = EDITOR_TARGET_FPS
self.tick_timer = QtCore.QTimer()
self._current_file_name = 'Untitled'
self.populateMenu()
def getTempDirectory(self):
"""Returns unique temp directory for application instance.
This folder and all it's content will be removed from disc on application shutdown.
"""
if self.currentTempDir == "":
# create app folder in documents
# random string used for cases when multiple instances of app are running in the same time
tempDirPath = ConfigManager().getPrefsValue(
"PREFS", "General/TempFilesDir")
if tempDirPath[-1:] in ('/', '\\'):
tempDirPath = tempDirPath[:-1]
self.currentTempDir = "{0}_{1}".format(tempDirPath,
generateRandomString())
if not os.path.exists(self.currentTempDir):
os.makedirs(self.currentTempDir)
return self.currentTempDir
def getMenuBar(self):
return self.menuBar
def populateMenu(self):
fileMenu = self.menuBar.addMenu("File")
newFileAction = fileMenu.addAction("New file")
newFileAction.setIcon(QtGui.QIcon(":/new_file_icon.png"))
newFileAction.triggered.connect(self.newFile)
loadAction = fileMenu.addAction("Load")
loadAction.setIcon(QtGui.QIcon(":/folder_open_icon.png"))
loadAction.triggered.connect(self.load)
saveAction = fileMenu.addAction("Save")
saveAction.setIcon(QtGui.QIcon(":/save_icon.png"))
saveAction.triggered.connect(self.save)
saveAsAction = fileMenu.addAction("Save as")
saveAsAction.setIcon(QtGui.QIcon(":/save_as_icon.png"))
saveAsAction.triggered.connect(lambda: self.save(True))
IOMenu = fileMenu.addMenu("Custom IO")
for packageName, package in GET_PACKAGES().items():
# exporters
exporters = None
try:
exporters = package.GetExporters()
except:
continue
pkgMenu = IOMenu.addMenu(packageName)
for exporterName, exporterClass in exporters.items():
fileFormatMenu = pkgMenu.addMenu(exporterClass.displayName())
fileFormatMenu.setToolTip(exporterClass.toolTip())
if exporterClass.createExporterMenu():
exportAction = fileFormatMenu.addAction("Export")
exportAction.triggered.connect(
lambda checked=False, app=self, exporter=exporterClass:
exporter.doExport(app))
if exporterClass.createImporterMenu():
importAction = fileFormatMenu.addAction("Import")
importAction.triggered.connect(
lambda checked=False, app=self, exporter=exporterClass:
exporter.doImport(app))
editMenu = self.menuBar.addMenu("Edit")
preferencesAction = editMenu.addAction("Preferences")
preferencesAction.setIcon(QtGui.QIcon(":/options_icon.png"))
preferencesAction.triggered.connect(self.showPreferencesWindow)
pluginsMenu = self.menuBar.addMenu("Plugins")
packagePlugin = pluginsMenu.addAction("Create package...")
packagePlugin.triggered.connect(PackageWizard.run)
helpMenu = self.menuBar.addMenu("Help")
shortcutsAction = helpMenu.addAction("Shortcuts")
shortcutsAction.setIcon(QtGui.QIcon(":/shortcuts_icon.png"))
shortcutsAction.triggered.connect(self.shortcuts_info)
def showPreferencesWindow(self):
self.preferencesWindow.show()
def registerToolInstance(self, instance):
"""Registers tool instance reference
This needed to prevent classes from being garbage collected and to save widgets state
Args:
instance (ToolBase): Tool to be registered
"""
self._tools.add(instance)
def unregisterToolInstance(self, instance):
if instance in self._tools:
self._tools.remove(instance)
def onRequestFillProperties(self, propertiesFillDelegate):
for toolInstance in self._tools:
if isinstance(toolInstance, PropertiesTool):
toolInstance.clear()
toolInstance.assignPropertiesWidget(propertiesFillDelegate)
def onRequestClearProperties(self):
for toolInstance in self._tools:
if isinstance(toolInstance, PropertiesTool):
toolInstance.clear()
def getToolbar(self):
return self.toolBar
def getCanvas(self):
return self.canvasWidget.canvas
def keyPressEvent(self, event):
modifiers = event.modifiers()
currentInputAction = InputAction(name="temp",
actionType=InputActionType.Keyboard,
key=event.key(),
modifiers=modifiers)
actionSaveVariants = InputManager()["App.Save"]
actionNewFileVariants = InputManager()["App.NewFile"]
actionLoadVariants = InputManager()["App.Load"]
actionSaveAsVariants = InputManager()["App.SaveAs"]
if currentInputAction in actionNewFileVariants:
EditorHistory().clear()
self.newFile()
EditorHistory().saveState("New file")
if currentInputAction in actionSaveVariants:
self.save()
if currentInputAction in actionLoadVariants:
EditorHistory().clear()
self.load()
if currentInputAction in actionSaveAsVariants:
self.save(True)
@staticmethod
def fetchPackageNames(graphJson):
packages = set()
def worker(graphData):
for node in graphData["nodes"]:
packages.add(node["package"])
for inpJson in node["inputs"]:
packages.add(inpJson['package'])
for outJson in node["inputs"]:
packages.add(outJson['package'])
if "graphData" in node:
worker(node["graphData"])
worker(graphJson)
return packages
def loadFromData(self, data, fpath=""):
# check first if all packages we are trying to load are legal
existingPackages = GET_PACKAGES().keys()
graphPackages = PyFlow.fetchPackageNames(data)
missedPackages = set()
for pkg in graphPackages:
if pkg not in existingPackages:
missedPackages.add(pkg)
if len(missedPackages) > 0:
msg = "This graph can not be loaded. Following packages not found:\n\n"
index = 1
for missedPackageName in missedPackages:
msg += "{0}. {1}\n".format(index, missedPackageName)
index += 1
QMessageBox.critical(self, "Missing dependencies", msg)
return
self.newFile(keepRoot=False)
# load raw data
self.graphManager.get().deserialize(data)
self.fileBeenLoaded.emit()
self.graphManager.get().selectGraphByName(data["activeGraph"])
def load(self):
name_filter = "Graph files (*.json)"
savepath = QFileDialog.getOpenFileName(filter=name_filter)
if type(savepath) in [tuple, list]:
fpath = savepath[0]
else:
fpath = savepath
if not fpath == '':
with open(fpath, 'r') as f:
data = json.load(f)
self.loadFromData(data, fpath)
def save(self, save_as=False):
if save_as:
name_filter = "Graph files (*.json)"
savepath = QFileDialog.getSaveFileName(filter=name_filter)
if type(savepath) in [tuple, list]:
pth = savepath[0]
else:
pth = savepath
if not pth == '':
self._current_file_name = pth
else:
self._current_file_name = "Untitled"
else:
if not os.path.isfile(self._current_file_name):
name_filter = "Graph files (*.json)"
savepath = QFileDialog.getSaveFileName(filter=name_filter)
if type(savepath) in [tuple, list]:
pth = savepath[0]
else:
pth = savepath
if not pth == '':
self._current_file_name = pth
else:
self._current_file_name = "Untitled"
if self._current_file_name in ["", "Untitled"]:
return
if not self._current_file_name == '':
with open(self._current_file_name, 'w') as f:
saveData = self.graphManager.get().serialize()
json.dump(saveData, f, indent=4)
print(str("// saved: '{0}'".format(self._current_file_name)))
def newFile(self, keepRoot=True):
self.tick_timer.stop()
self.tick_timer.timeout.disconnect()
# broadcast
self.graphManager.get().clear(keepRoot=keepRoot)
self.newFileExecuted.emit(keepRoot)
self._current_file_name = 'Untitled'
self.onRequestClearProperties()
self.startMainLoop()
def startMainLoop(self):
self.tick_timer.timeout.connect(self.mainLoop)
self.tick_timer.start(1000 / EDITOR_TARGET_FPS)
def stopMainLoop(self):
self.tick_timer.stop()
self.tick_timer.timeout.disconnect()
def mainLoop(self):
deltaTime = clock() - self._lastClock
ds = (deltaTime * 1000.0)
if ds > 0:
self.fps = int(1000.0 / ds)
# Tick all graphs
# each graph will tick owning raw nodes
# each raw node will tick it's ui wrapper if it exists
self.graphManager.get().Tick(deltaTime)
# Tick canvas. Update ui only stuff such animation etc.
self.canvasWidget.Tick(deltaTime)
self._lastClock = clock()
def createPopupMenu(self):
pass
def getToolClassByName(self, packageName, toolName, toolClass=DockTool):
registeredTools = GET_TOOLS()
for ToolClass in registeredTools[packageName]:
if issubclass(ToolClass, toolClass):
if ToolClass.name() == toolName:
return ToolClass
return None
def createToolInstanceByClass(self,
packageName,
toolName,
toolClass=DockTool):
registeredTools = GET_TOOLS()
for ToolClass in registeredTools[packageName]:
if issubclass(ToolClass, toolClass):
if ToolClass.name() == toolName:
return ToolClass()
return None
def getRegisteredTools(self):
return self._tools
def invokeDockToolByName(self, packageName, name, settings=None):
# invokeDockToolByName Invokes dock tool by tool name and package name
# If settings provided QMainWindow::restoreDockWidget will be called instead QMainWindow::addDockWidget
toolClass = self.getToolClassByName(packageName, name, DockTool)
if toolClass is None:
return
isSingleton = toolClass.isSingleton()
if isSingleton:
# check if already registered
if name in [t.name() for t in self._tools]:
for tool in self._tools:
if tool.name() == name:
tool.show()
# Highlight window
print("highlight", tool.uniqueName())
return
ToolInstance = self.createToolInstanceByClass(packageName, name,
DockTool)
if ToolInstance:
self.registerToolInstance(ToolInstance)
if settings is not None:
ToolInstance.restoreState(settings)
if not self.restoreDockWidget(ToolInstance):
# handle if ui state was not restored
pass
else:
self.addDockWidget(ToolInstance.defaultDockArea(),
ToolInstance)
ToolInstance.setAppInstance(self)
ToolInstance.onShow()
return ToolInstance
def closeEvent(self, event):
self.tick_timer.stop()
self.tick_timer.timeout.disconnect()
self.canvasWidget.shoutDown()
# save editor config
settings = ConfigManager().getSettings("APP_STATE")
# clear file each time to capture opened dock tools
settings.clear()
settings.sync()
settings.beginGroup('Editor')
settings.setValue("geometry", self.saveGeometry())
settings.setValue("state", self.saveState())
settings.endGroup()
# save tools state
settings.beginGroup('Tools')
for tool in self._tools:
if isinstance(tool, ShelfTool):
settings.beginGroup("ShelfTools")
settings.beginGroup(tool.name())
tool.saveState(settings)
settings.endGroup()
settings.endGroup()
if isinstance(tool, DockTool):
settings.beginGroup("DockTools")
settings.beginGroup(tool.uniqueName())
tool.saveState(settings)
settings.endGroup()
settings.endGroup()
tool.onDestroy()
settings.endGroup()
settings.sync()
# remove temp directory if exists
if os.path.exists(self.currentTempDir):
shutil.rmtree(self.currentTempDir)
QMainWindow.closeEvent(self, event)
def shortcuts_info(self):
data = "Tab - togle node box\n"
data += "Ctrl+N - new file\n"
data += "Ctrl+S - save\n"
data += "Ctrl+Shift+S - save as\n"
data += "Ctrl+O - open file\n"
data += "F - frame selected\n"
data += "H - frame all\n"
data += "C - comment selected nodes\n"
data += "Delete - kill selected nodes\n"
data += "Ctrl+C - Copy\n"
data += "Ctrl+V - Paste\n"
data += "Alt+Drag - Duplicate\n"
data += "Ctrl+Z - Undo\n"
data += "Ctrl+Y - Redo\n"
data += "Alt+Click - Disconnect Pin\n"
data += "Ctrl+Shift+ArrowLeft - Align left\n"
data += "Ctrl+Shift+ArrowUp - Align Up\n"
data += "Ctrl+Shift+ArrowRight - Align right\n"
data += "Ctrl+Shift+ArrowBottom - Align Bottom\n"
QMessageBox.information(self, "Shortcuts", data)
@staticmethod
def instance(parent=None):
if PyFlow.appInstance is not None:
return PyFlow.appInstance
settings = ConfigManager().getSettings("APP_STATE")
instance = PyFlow(parent)
REGISTER_TOOL("PyFlowBase", LoggerTool)
a = GET_TOOLS()["PyFlowBase"][0]()
a.setAppInstance(instance)
instance.registerToolInstance(a)
instance.addDockWidget(a.defaultDockArea(), a)
a.setAppInstance(instance)
a.onShow()
try:
extraPackagePaths = []
extraPathsString = ConfigManager().getPrefsValue(
"PREFS", "General/ExtraPackageDirs")
if extraPathsString is not None:
extraPathsString = extraPathsString.rstrip(";")
extraPathsRaw = extraPathsString.split(";")
for rawPath in extraPathsRaw:
if os.path.exists(rawPath):
extraPackagePaths.append(os.path.normpath(rawPath))
INITIALIZE(additionalPackageLocations=extraPackagePaths)
except Exception as e:
QMessageBox.critical(None, "Fatal error", str(e))
return
instance.startMainLoop()
# populate tools
canvas = instance.getCanvas()
toolbar = instance.getToolbar()
geo = settings.value('Editor/geometry')
if geo is not None:
instance.restoreGeometry(geo)
state = settings.value('Editor/state')
if state is not None:
instance.restoreState(state)
settings.beginGroup("Tools")
for packageName, registeredToolSet in GET_TOOLS().items():
for ToolClass in registeredToolSet:
if issubclass(ToolClass, ShelfTool):
ToolInstance = ToolClass()
# prevent to be garbage collected
instance.registerToolInstance(ToolInstance)
ToolInstance.setAppInstance(instance)
action = QAction(instance)
action.setIcon(ToolInstance.getIcon())
action.setText(ToolInstance.name())
action.setToolTip(ToolInstance.toolTip())
action.setObjectName(ToolInstance.name())
action.triggered.connect(ToolInstance.do)
# check if context menu data available
menuBuilder = ToolInstance.contextMenuBuilder()
if menuBuilder:
menuGenerator = ContextMenuGenerator(menuBuilder)
menu = menuGenerator.generate()
action.setMenu(menu)
toolbar.addAction(action)
# step to ShelfTools/ToolName group and pass settings inside
settings.beginGroup("ShelfTools")
settings.beginGroup(ToolClass.name())
ToolInstance.restoreState(settings)
settings.endGroup()
settings.endGroup()
if issubclass(ToolClass, DockTool):
menus = instance.menuBar.findChildren(QMenu)
pluginsMenuAction = [
m for m in menus if m.title() == "Plugins"
][0].menuAction()
toolsMenu = getOrCreateMenu(instance.menuBar, "Tools")
instance.menuBar.insertMenu(pluginsMenuAction, toolsMenu)
packageSubMenu = getOrCreateMenu(toolsMenu, packageName)
toolsMenu.addMenu(packageSubMenu)
showToolAction = packageSubMenu.addAction(ToolClass.name())
icon = ToolClass.getIcon()
if icon:
showToolAction.setIcon(icon)
showToolAction.triggered.connect(
lambda pkgName=packageName, toolName=ToolClass.name(
): instance.invokeDockToolByName(pkgName, toolName))
settings.beginGroup("DockTools")
childGroups = settings.childGroups()
for dockToolGroupName in childGroups:
# This dock tool data been saved on last shutdown
settings.beginGroup(dockToolGroupName)
if dockToolGroupName in [
t.uniqueName() for t in instance._tools
]:
continue
toolName = dockToolGroupName.split("::")[0]
instance.invokeDockToolByName(packageName, toolName,
settings)
settings.endGroup()
settings.endGroup()
PyFlow.appInstance = instance
EditorHistory().saveState("New file")
for name, package in GET_PACKAGES().items():
prefsWidgets = package.PrefsWidgets()
if prefsWidgets is not None:
for categoryName, widgetClass in prefsWidgets.items():
PreferencesWindow().addCategory(categoryName,
widgetClass())
PreferencesWindow().selectByName("General")
return instance
def instance(parent=None):
if PyFlow.appInstance is not None:
return PyFlow.appInstance
settings = ConfigManager().getSettings("APP_STATE")
instance = PyFlow(parent)
REGISTER_TOOL("PyFlowBase", LoggerTool)
a = GET_TOOLS()["PyFlowBase"][0]()
a.setAppInstance(instance)
instance.registerToolInstance(a)
instance.addDockWidget(a.defaultDockArea(), a)
a.setAppInstance(instance)
a.onShow()
try:
extraPackagePaths = []
extraPathsString = ConfigManager().getPrefsValue(
"PREFS", "General/ExtraPackageDirs")
if extraPathsString is not None:
extraPathsString = extraPathsString.rstrip(";")
extraPathsRaw = extraPathsString.split(";")
for rawPath in extraPathsRaw:
if os.path.exists(rawPath):
extraPackagePaths.append(os.path.normpath(rawPath))
INITIALIZE(additionalPackageLocations=extraPackagePaths)
except Exception as e:
QMessageBox.critical(None, "Fatal error", str(e))
return
instance.startMainLoop()
# populate tools
canvas = instance.getCanvas()
toolbar = instance.getToolbar()
geo = settings.value('Editor/geometry')
if geo is not None:
instance.restoreGeometry(geo)
state = settings.value('Editor/state')
if state is not None:
instance.restoreState(state)
settings.beginGroup("Tools")
for packageName, registeredToolSet in GET_TOOLS().items():
for ToolClass in registeredToolSet:
if issubclass(ToolClass, ShelfTool):
ToolInstance = ToolClass()
# prevent to be garbage collected
instance.registerToolInstance(ToolInstance)
ToolInstance.setAppInstance(instance)
action = QAction(instance)
action.setIcon(ToolInstance.getIcon())
action.setText(ToolInstance.name())
action.setToolTip(ToolInstance.toolTip())
action.setObjectName(ToolInstance.name())
action.triggered.connect(ToolInstance.do)
# check if context menu data available
menuBuilder = ToolInstance.contextMenuBuilder()
if menuBuilder:
menuGenerator = ContextMenuGenerator(menuBuilder)
menu = menuGenerator.generate()
action.setMenu(menu)
toolbar.addAction(action)
# step to ShelfTools/ToolName group and pass settings inside
settings.beginGroup("ShelfTools")
settings.beginGroup(ToolClass.name())
ToolInstance.restoreState(settings)
settings.endGroup()
settings.endGroup()
if issubclass(ToolClass, DockTool):
menus = instance.menuBar.findChildren(QMenu)
pluginsMenuAction = [
m for m in menus if m.title() == "Plugins"
][0].menuAction()
toolsMenu = getOrCreateMenu(instance.menuBar, "Tools")
instance.menuBar.insertMenu(pluginsMenuAction, toolsMenu)
packageSubMenu = getOrCreateMenu(toolsMenu, packageName)
toolsMenu.addMenu(packageSubMenu)
showToolAction = packageSubMenu.addAction(ToolClass.name())
icon = ToolClass.getIcon()
if icon:
showToolAction.setIcon(icon)
showToolAction.triggered.connect(
lambda pkgName=packageName, toolName=ToolClass.name(
): instance.invokeDockToolByName(pkgName, toolName))
settings.beginGroup("DockTools")
childGroups = settings.childGroups()
for dockToolGroupName in childGroups:
# This dock tool data been saved on last shutdown
settings.beginGroup(dockToolGroupName)
if dockToolGroupName in [
t.uniqueName() for t in instance._tools
]:
continue
toolName = dockToolGroupName.split("::")[0]
instance.invokeDockToolByName(packageName, toolName,
settings)
settings.endGroup()
settings.endGroup()
PyFlow.appInstance = instance
EditorHistory().saveState("New file")
for name, package in GET_PACKAGES().items():
prefsWidgets = package.PrefsWidgets()
if prefsWidgets is not None:
for categoryName, widgetClass in prefsWidgets.items():
PreferencesWindow().addCategory(categoryName,
widgetClass())
PreferencesWindow().selectByName("General")
return instance
class PyFlow(QMainWindow):
appInstance = None
newFileExecuted = QtCore.Signal(bool)
fileBeenLoaded = QtCore.Signal()
def __init__(self, parent=None):
super(PyFlow, self).__init__(parent=parent)
self._modified = False
self.setFocusPolicy(QtCore.Qt.StrongFocus)
self.currentSoftware = ""
self.edHistory = EditorHistory(self)
self.edHistory.statePushed.connect(self.historyStatePushed)
self.setWindowTitle(winTitle())
self.undoStack = QUndoStack(self)
self.setContentsMargins(1, 1, 1, 1)
self.graphManager = GraphManagerSingleton()
self.canvasWidget = BlueprintCanvasWidget(self.graphManager.get(),
self)
self.canvasWidget.setObjectName("canvasWidget")
self.setCentralWidget(self.canvasWidget)
self.setTabPosition(QtCore.Qt.AllDockWidgetAreas, QTabWidget.North)
self.setDockOptions(QMainWindow.AnimatedDocks
| QMainWindow.AllowNestedDocks)
self.menuBar = QMenuBar(self)
self.menuBar.setGeometry(QtCore.QRect(0, 0, 863, 21))
self.menuBar.setObjectName("menuBar")
self.setMenuBar(self.menuBar)
self.toolBar = QToolBar(self)
self.toolBar.setObjectName("toolBar")
self.addToolBar(QtCore.Qt.TopToolBarArea, self.toolBar)
self.setWindowIcon(QtGui.QIcon(":/LogoBpApp.png"))
self._tools = set()
self.currentTempDir = ""
self.preferencesWindow = PreferencesWindow(self)
self.setMouseTracking(True)
self._lastClock = 0.0
self.fps = EDITOR_TARGET_FPS
self.tick_timer = QtCore.QTimer()
self._currentFileName = ''
self.currentFileName = None
def historyStatePushed(self, state):
if state.modifiesData():
self.modified = True
self.updateLabel()
# print(state, state.modifiesData())
@property
def modified(self):
return self._modified
@modified.setter
def modified(self, value):
self._modified = value
self.updateLabel()
def updateLabel(self):
label = "Untitled"
if self.currentFileName is not None:
if os.path.isfile(self.currentFileName):
label = os.path.basename(self.currentFileName)
if self.modified:
label += "*"
self.setWindowTitle("{0} - {1}".format(winTitle(), label))
def getTempDirectory(self):
"""Returns unique temp directory for application instance.
This folder and all it's content will be removed from disc on application shutdown.
"""
if self.currentTempDir == "":
# create app folder in documents
# random string used for cases when multiple instances of app are running in the same time
tempDirPath = ConfigManager().getPrefsValue(
"PREFS", "General/TempFilesDir")
if tempDirPath[-1:] in ('/', '\\'):
tempDirPath = tempDirPath[:-1]
self.currentTempDir = "{0}_{1}".format(tempDirPath,
generateRandomString())
if not os.path.exists(self.currentTempDir):
os.makedirs(self.currentTempDir)
return self.currentTempDir
def getMenuBar(self):
return self.menuBar
def populateMenu(self):
fileMenu = self.menuBar.addMenu("File")
newFileAction = fileMenu.addAction("New file")
newFileAction.setIcon(QtGui.QIcon(":/new_file_icon.png"))
newFileAction.triggered.connect(self.newFile)
loadAction = fileMenu.addAction("Load")
loadAction.setIcon(QtGui.QIcon(":/folder_open_icon.png"))
loadAction.triggered.connect(self.load)
saveAction = fileMenu.addAction("Save")
saveAction.setIcon(QtGui.QIcon(":/save_icon.png"))
saveAction.triggered.connect(self.save)
saveAsAction = fileMenu.addAction("Save as")
saveAsAction.setIcon(QtGui.QIcon(":/save_as_icon.png"))
saveAsAction.triggered.connect(lambda: self.save(True))
IOMenu = fileMenu.addMenu("Custom IO")
for packageName, package in GET_PACKAGES().items():
# exporters
exporters = None
try:
exporters = package.GetExporters()
except:
continue
pkgMenu = IOMenu.addMenu(packageName)
for exporterName, exporterClass in exporters.items():
fileFormatMenu = pkgMenu.addMenu(exporterClass.displayName())
fileFormatMenu.setToolTip(exporterClass.toolTip())
if exporterClass.createExporterMenu():
exportAction = fileFormatMenu.addAction("Export")
exportAction.triggered.connect(
lambda checked=False, app=self, exporter=exporterClass:
exporter.doExport(app))
if exporterClass.createImporterMenu():
importAction = fileFormatMenu.addAction("Import")
importAction.triggered.connect(
lambda checked=False, app=self, exporter=exporterClass:
exporter.doImport(app))
editMenu = self.menuBar.addMenu("Edit")
preferencesAction = editMenu.addAction("Preferences")
preferencesAction.setIcon(QtGui.QIcon(":/options_icon.png"))
preferencesAction.triggered.connect(self.showPreferencesWindow)
pluginsMenu = self.menuBar.addMenu("Plugins")
packagePlugin = pluginsMenu.addAction("Create package...")
packagePlugin.triggered.connect(PackageWizard.run)
helpMenu = self.menuBar.addMenu("Help")
helpMenu.addAction("Homepage").triggered.connect(
lambda _=False, url=
"https://wonderworks-software.github.io/PyFlow/": QtGui.
QDesktopServices.openUrl(url))
helpMenu.addAction("Docs").triggered.connect(
lambda _=False, url="https://pyflow.readthedocs.io/en/latest/":
QtGui.QDesktopServices.openUrl(url))
def showPreferencesWindow(self):
self.preferencesWindow.show()
def registerToolInstance(self, instance):
"""Registers tool instance reference
This needed to prevent classes from being garbage collected and to save widgets state
Args:
instance (ToolBase): Tool to be registered
"""
self._tools.add(instance)
def unregisterToolInstance(self, instance):
if instance in self._tools:
self._tools.remove(instance)
def onRequestFillProperties(self, propertiesFillDelegate):
for toolInstance in self._tools:
if isinstance(toolInstance, PropertiesTool):
toolInstance.clear()
toolInstance.assignPropertiesWidget(propertiesFillDelegate)
def onRequestFillSecurity(self, securityFillDelegate):
for toolInstance in self._tools:
if isinstance(toolInstance, SecurityRatingTool):
toolInstance.clear()
toolInstance.assignSecurityRatingWidget(securityFillDelegate)
def onRequestClearProperties(self):
for toolInstance in self._tools:
if isinstance(toolInstance, PropertiesTool):
toolInstance.clear()
def onRequestClearSecurity(self):
for toolInstance in self._tools:
if isinstance(toolInstance, SecurityRatingTool):
#toolInstance.clear()
pass
def getToolbar(self):
return self.toolBar
def getCanvas(self):
return self.canvasWidget.canvas
def keyPressEvent(self, event):
modifiers = event.modifiers()
currentInputAction = InputAction(name="temp",
actionType=InputActionType.Keyboard,
key=event.key(),
modifiers=modifiers)
actionSaveVariants = InputManager()["App.Save"]
actionNewFileVariants = InputManager()["App.NewFile"]
actionLoadVariants = InputManager()["App.Load"]
actionSaveAsVariants = InputManager()["App.SaveAs"]
if currentInputAction in actionNewFileVariants:
shouldSave = self.shouldSave()
if shouldSave == QMessageBox.Yes:
self.save()
elif shouldSave == QMessageBox.Discard:
return
EditorHistory().clear()
historyTools = self.getRegisteredTools(
classNameFilters=["HistoryTool"])
for historyTools in historyTools:
historyTools.onClear()
self.newFile()
EditorHistory().saveState("New file")
self.currentFileName = None
self.modified = False
self.updateLabel()
if currentInputAction in actionSaveVariants:
self.save()
if currentInputAction in actionLoadVariants:
shouldSave = self.shouldSave()
if shouldSave == QMessageBox.Yes:
self.save()
elif shouldSave == QMessageBox.Discard:
return
self.load()
if currentInputAction in actionSaveAsVariants:
self.save(True)
def loadFromFileChecked(self, filePath):
shouldSave = self.shouldSave()
if shouldSave == QMessageBox.Yes:
self.save()
elif shouldSave == QMessageBox.Discard:
return
self.loadFromFile(filePath)
self.modified = False
self.updateLabel()
def loadFromData(self, data, clearHistory=False):
# check first if all packages we are trying to load are legal
missedPackages = set()
if not validateGraphDataPackages(data, missedPackages):
msg = "This graph can not be loaded. Following packages not found:\n\n"
index = 1
for missedPackageName in missedPackages:
msg += "{0}. {1}\n".format(index, missedPackageName)
index += 1
QMessageBox.critical(self, "Missing dependencies", msg)
return
if clearHistory:
EditorHistory().clear()
historyTools = self.getRegisteredTools(
classNameFilters=["HistoryTool"])
for historyTools in historyTools:
historyTools.onClear()
self.newFile(keepRoot=False)
# load raw data
self.graphManager.get().deserialize(data)
self.fileBeenLoaded.emit()
self.graphManager.get().selectGraphByName(data["activeGraph"])
self.updateLabel()
PathsRegistry().rebuild()
@property
def currentFileName(self):
return self._currentFileName
@currentFileName.setter
def currentFileName(self, value):
self._currentFileName = value
self.updateLabel()
def loadFromFile(self, filePath):
with open(filePath, 'r') as f:
data = json.load(f)
self.loadFromData(data, clearHistory=True)
self.currentFileName = filePath
EditorHistory().saveState("Open {}".format(
os.path.basename(self.currentFileName)))
def load(self):
name_filter = "Graph files (*.pygraph)"
savepath = QFileDialog.getOpenFileName(filter=name_filter)
if type(savepath) in [tuple, list]:
fpath = savepath[0]
else:
fpath = savepath
if not fpath == '':
self.loadFromFile(fpath)
def save(self, save_as=False):
if save_as:
name_filter = "Graph files (*.pygraph)"
savepath = QFileDialog.getSaveFileName(filter=name_filter)
if type(savepath) in [tuple, list]:
pth = savepath[0]
else:
pth = savepath
if not pth == '':
self.currentFileName = pth
else:
self.currentFileName = None
else:
if self.currentFileName is None:
name_filter = "Graph files (*.pygraph)"
savepath = QFileDialog.getSaveFileName(filter=name_filter)
if type(savepath) in [tuple, list]:
pth = savepath[0]
else:
pth = savepath
if not pth == '':
self.currentFileName = pth
else:
self.currentFileName = None
if not self.currentFileName:
return False
if not self.currentFileName.endswith(".pygraph"):
self.currentFileName += ".pygraph"
if not self.currentFileName == '':
with open(self.currentFileName, 'w') as f:
saveData = self.graphManager.get().serialize()
json.dump(saveData, f, indent=4)
print(str("// saved: '{0}'".format(self.currentFileName)))
self.modified = False
self.updateLabel()
return True
def newFile(self, keepRoot=True):
self.tick_timer.stop()
self.tick_timer.timeout.disconnect()
# broadcast
self.graphManager.get().clear(keepRoot=keepRoot)
self.newFileExecuted.emit(keepRoot)
self.onRequestClearProperties()
self.onRequestClearSecurity()
self.startMainLoop()
def startMainLoop(self):
self.tick_timer.timeout.connect(self.mainLoop)
self.tick_timer.start(1000 / EDITOR_TARGET_FPS)
def stopMainLoop(self):
self.tick_timer.stop()
self.tick_timer.timeout.disconnect()
def mainLoop(self):
deltaTime = currentProcessorTime() - self._lastClock
ds = (deltaTime * 1000.0)
if ds > 0:
self.fps = int(1000.0 / ds)
# Tick all graphs
# each graph will tick owning raw nodes
# each raw node will tick it's ui wrapper if it exists
self.graphManager.get().Tick(deltaTime)
# Tick canvas. Update ui only stuff such animation etc.
self.canvasWidget.Tick(deltaTime)
self._lastClock = currentProcessorTime()
def createPopupMenu(self):
pass
def getToolClassByName(self, packageName, toolName, toolClass=DockTool):
registeredTools = GET_TOOLS()
for ToolClass in registeredTools[packageName]:
if issubclass(ToolClass, toolClass):
if ToolClass.name() == toolName:
return ToolClass
return None
def createToolInstanceByClass(self,
packageName,
toolName,
toolClass=DockTool):
registeredTools = GET_TOOLS()
for ToolClass in registeredTools[packageName]:
supportedSoftwares = ToolClass.supportedSoftwares()
if "any" not in supportedSoftwares:
if self.currentSoftware not in supportedSoftwares:
continue
if issubclass(ToolClass, toolClass):
if ToolClass.name() == toolName:
return ToolClass()
return None
def getRegisteredTools(self, classNameFilters=[]):
if len(classNameFilters) == 0:
return self._tools
else:
result = []
for tool in self._tools:
if tool.__class__.__name__ in classNameFilters:
result.append(tool)
return result
def invokeDockToolByName(self, packageName, name, settings=None):
# invokeDockToolByName Invokes dock tool by tool name and package name
# If settings provided QMainWindow::restoreDockWidget will be called instead QMainWindow::addDockWidget
toolClass = self.getToolClassByName(packageName, name, DockTool)
if toolClass is None:
return
isSingleton = toolClass.isSingleton()
if isSingleton:
# check if already registered
if name in [t.name() for t in self._tools]:
for tool in self._tools:
if tool.name() == name:
tool.show()
tool.onShow()
# Highlight window
#print("highlight", tool.uniqueName())
return tool
ToolInstance = self.createToolInstanceByClass(packageName, name,
DockTool)
if ToolInstance:
self.registerToolInstance(ToolInstance)
if settings is not None:
ToolInstance.restoreState(settings)
if not self.restoreDockWidget(ToolInstance):
# handle if ui state was not restored
pass
else:
self.addDockWidget(ToolInstance.defaultDockArea(),
ToolInstance)
ToolInstance.setAppInstance(self)
ToolInstance.onShow()
return ToolInstance
def shouldSave(self):
if self.modified:
btn = QMessageBox.warning(
self, "Confirm?", "Unsaved data will be lost. Save?",
QMessageBox.Yes | QMessageBox.No | QMessageBox.Discard)
if btn == QMessageBox.No:
return QMessageBox.No
else:
return btn
return QMessageBox.No
def closeEvent(self, event):
shouldSave = self.shouldSave()
if shouldSave == QMessageBox.Yes:
if not self.save():
event.ignore()
return
elif shouldSave == QMessageBox.Discard:
event.ignore()
return
self.tick_timer.stop()
self.tick_timer.timeout.disconnect()
EditorHistory().shutdown()
self.canvasWidget.shoutDown()
# save editor config
settings = ConfigManager().getSettings("APP_STATE")
# clear file each time to capture opened dock tools
settings.clear()
settings.sync()
settings.beginGroup('Editor')
settings.setValue("geometry", self.saveGeometry())
settings.setValue("state", self.saveState())
settings.endGroup()
# save tools state
settings.beginGroup('Tools')
for tool in self._tools:
if isinstance(tool, ShelfTool):
settings.beginGroup("ShelfTools")
settings.beginGroup(tool.name())
tool.saveState(settings)
settings.endGroup()
settings.endGroup()
if isinstance(tool, DockTool):
settings.beginGroup("DockTools")
settings.beginGroup(tool.uniqueName())
tool.saveState(settings)
settings.endGroup()
settings.endGroup()
tool.onDestroy()
settings.endGroup()
settings.sync()
# remove temp directory if exists
if os.path.exists(self.currentTempDir):
shutil.rmtree(self.currentTempDir)
SingletonDecorator.destroyAll()
PyFlow.appInstance = None
QMainWindow.closeEvent(self, event)
@staticmethod
def instance(parent=None, software=""):
assert (
software != ""
), "Invalid arguments. Please pass you software name as second argument!"
settings = ConfigManager().getSettings("APP_STATE")
instance = PyFlow(parent)
instance.currentSoftware = software
SessionDescriptor().software = instance.currentSoftware
if software == "standalone":
editableStyleSheet(instance)
try:
extraPackagePaths = []
extraPathsString = ConfigManager().getPrefsValue(
"PREFS", "General/ExtraPackageDirs")
if extraPathsString is not None:
extraPathsString = extraPathsString.rstrip(";")
extraPathsRaw = extraPathsString.split(";")
for rawPath in extraPathsRaw:
if os.path.exists(rawPath):
extraPackagePaths.append(os.path.normpath(rawPath))
INITIALIZE(additionalPackageLocations=extraPackagePaths,
software=software)
except Exception as e:
QMessageBox.critical(None, "Fatal error", str(e))
return
instance.startMainLoop()
# populate tools
canvas = instance.getCanvas()
toolbar = instance.getToolbar()
# populate menus
instance.populateMenu()
geo = settings.value('Editor/geometry')
if geo is not None:
instance.restoreGeometry(geo)
state = settings.value('Editor/state')
if state is not None:
instance.restoreState(state)
settings.beginGroup("Tools")
for packageName, registeredToolSet in GET_TOOLS().items():
for ToolClass in registeredToolSet:
if issubclass(ToolClass, ShelfTool):
ToolInstance = ToolClass()
# prevent to be garbage collected
instance.registerToolInstance(ToolInstance)
ToolInstance.setAppInstance(instance)
action = QAction(instance)
action.setIcon(ToolInstance.getIcon())
action.setText(ToolInstance.name())
action.setToolTip(ToolInstance.toolTip())
action.setObjectName(ToolInstance.name())
action.triggered.connect(ToolInstance.do)
# check if context menu data available
menuBuilder = ToolInstance.contextMenuBuilder()
if menuBuilder:
menuGenerator = ContextMenuGenerator(menuBuilder)
menu = menuGenerator.generate()
action.setMenu(menu)
toolbar.addAction(action)
# step to ShelfTools/ToolName group and pass settings inside
settings.beginGroup("ShelfTools")
settings.beginGroup(ToolClass.name())
ToolInstance.restoreState(settings)
settings.endGroup()
settings.endGroup()
if issubclass(ToolClass, DockTool):
menus = instance.menuBar.findChildren(QMenu)
pluginsMenuAction = [
m for m in menus if m.title() == "Plugins"
][0].menuAction()
toolsMenu = getOrCreateMenu(instance.menuBar, "Tools")
instance.menuBar.insertMenu(pluginsMenuAction, toolsMenu)
packageSubMenu = getOrCreateMenu(toolsMenu, packageName)
toolsMenu.addMenu(packageSubMenu)
showToolAction = packageSubMenu.addAction(ToolClass.name())
icon = ToolClass.getIcon()
if icon:
showToolAction.setIcon(icon)
showToolAction.triggered.connect(
lambda pkgName=packageName, toolName=ToolClass.name(
): instance.invokeDockToolByName(pkgName, toolName))
settings.beginGroup("DockTools")
childGroups = settings.childGroups()
for dockToolGroupName in childGroups:
# This dock tool data been saved on last shutdown
settings.beginGroup(dockToolGroupName)
if dockToolGroupName in [
t.uniqueName() for t in instance._tools
]:
settings.endGroup()
continue
toolName = dockToolGroupName.split("::")[0]
instance.invokeDockToolByName(packageName, toolName,
settings)
settings.endGroup()
settings.endGroup()
PyFlow.appInstance = instance
EditorHistory().saveState("New file")
for name, package in GET_PACKAGES().items():
prefsWidgets = package.PrefsWidgets()
if prefsWidgets is not None:
for categoryName, widgetClass in prefsWidgets.items():
PreferencesWindow().addCategory(categoryName,
widgetClass())
PreferencesWindow().selectByName("General")
return instance
def instance(parent=None, software=""):
assert (
software != ""
), "Invalid arguments. Please pass you software name as second argument!"
instance = PyFlow(parent)
settings = ConfigManager().getSettings("APP_STATE")
instance.currentSoftware = software
SessionDescriptor().software = instance.currentSoftware
if software == "standalone":
editableStyleSheet(instance)
try:
extraPackagePaths = []
extraPathsString = ConfigManager().getPrefsValue(
"PREFS", "General/ExtraPackageDirs")
if extraPathsString is not None:
extraPathsString = extraPathsString.rstrip(";")
extraPathsRaw = extraPathsString.split(";")
for rawPath in extraPathsRaw:
if os.path.exists(rawPath):
extraPackagePaths.append(os.path.normpath(rawPath))
INITIALIZE(additionalPackageLocations=extraPackagePaths,
software=software)
except Exception as e:
QMessageBox.critical(None, "Fatal error", str(e))
return
instance.startMainLoop()
# populate tools
canvas = instance.getCanvas()
toolbar = instance.getToolbar()
# populate menus
instance.populateMenu()
geo = settings.value('Editor/geometry')
if geo is not None:
instance.restoreGeometry(geo)
state = settings.value('Editor/state')
if state is not None:
instance.restoreState(state)
settings.beginGroup("Tools")
for packageName, registeredToolSet in GET_TOOLS().items():
for ToolClass in registeredToolSet:
if issubclass(ToolClass, ShelfTool):
ToolInstance = ToolClass()
# prevent to be garbage collected
instance.registerToolInstance(ToolInstance)
ToolInstance.setAppInstance(instance)
action = QAction(instance)
action.setIcon(ToolInstance.getIcon())
action.setText(ToolInstance.name())
action.setToolTip(ToolInstance.toolTip())
action.setObjectName(ToolInstance.name())
action.triggered.connect(ToolInstance.do)
# check if context menu data available
menuBuilder = ToolInstance.contextMenuBuilder()
if menuBuilder:
menuGenerator = ContextMenuGenerator(menuBuilder)
menu = menuGenerator.generate()
action.setMenu(menu)
toolbar.addAction(action)
# step to ShelfTools/ToolName group and pass settings inside
settings.beginGroup("ShelfTools")
settings.beginGroup(ToolClass.name())
ToolInstance.restoreState(settings)
settings.endGroup()
settings.endGroup()
if issubclass(ToolClass, DockTool):
menus = instance.menuBar.findChildren(QMenu)
pluginsMenuAction = [
m for m in menus if m.title() == "Plugins"
][0].menuAction()
toolsMenu = getOrCreateMenu(instance.menuBar, "Tools")
instance.menuBar.insertMenu(pluginsMenuAction, toolsMenu)
packageSubMenu = getOrCreateMenu(toolsMenu, packageName)
toolsMenu.addMenu(packageSubMenu)
showToolAction = packageSubMenu.addAction(ToolClass.name())
icon = ToolClass.getIcon()
if icon:
showToolAction.setIcon(icon)
showToolAction.triggered.connect(
lambda pkgName=packageName, toolName=ToolClass.name(
): instance.invokeDockToolByName(pkgName, toolName))
settings.beginGroup("DockTools")
childGroups = settings.childGroups()
for dockToolGroupName in childGroups:
# This dock tool data been saved on last shutdown
settings.beginGroup(dockToolGroupName)
if dockToolGroupName in [
t.uniqueName() for t in instance._tools
]:
settings.endGroup()
continue
toolName = dockToolGroupName.split("::")[0]
instance.invokeDockToolByName(packageName, toolName,
settings)
settings.endGroup()
settings.endGroup()
PyFlow.appInstance = instance
EditorHistory().saveState("New file")
for name, package in GET_PACKAGES().items():
prefsWidgets = package.PrefsWidgets()
if prefsWidgets is not None:
for categoryName, widgetClass in prefsWidgets.items():
PreferencesWindow().addCategory(categoryName,
widgetClass())
PreferencesWindow().selectByName("General")
if ConfigManager().loadedDefaults:
QMessageBox.information(
None, "First-time tips",
"Welcome to DepthAI GUI. To use this tool efficiently, please do the following:\n\n1. Maximize the window\n2. Enable NodeBox widget (Tools > PyFlowBase > NodeBox)\n3. Enable Properties widget (Tools > PyFlowBase > Properties)\n\nHave fun!"
)
return instance
class PyFlow(QMainWindow, GraphEditor_ui.Ui_MainWindow):
newFileExecuted = QtCore.Signal(bool)
def __init__(self, parent=None):
super(PyFlow, self).__init__(parent=parent)
self.setupUi(self)
self.setWindowIcon(QtGui.QIcon(":/LogoBpApp.png"))
self._tools = set()
self.currentTempDir = ""
self.preferencesWindow = PreferencesWindow(self)
self.graphManager = GraphManager()
self.canvasWidget = Canvas(self.graphManager, self)
self.canvasWidget.requestFillProperties.connect(
self.onRequestFillProperties)
self.canvasWidget.requestClearProperties.connect(
self.onRequestClearProperties)
self.graphManager.graphChanged.connect(self.updateGraphTreeLocation)
self.updateGraphTreeLocation()
self.SceneLayout.addWidget(self.canvasWidget)
rxLettersAndNumbers = QtCore.QRegExp('^[a-zA-Z0-9]*$')
nameValidator = QtGui.QRegExpValidator(rxLettersAndNumbers,
self.leCompoundName)
self.leCompoundName.setValidator(nameValidator)
self.leCompoundName.returnPressed.connect(
self.onActiveCompoundNameAccepted)
rxLetters = QtCore.QRegExp('^[a-zA-Z]*$')
categoryValidator = QtGui.QRegExpValidator(rxLetters,
self.leCompoundCategory)
self.leCompoundCategory.setValidator(categoryValidator)
self.leCompoundCategory.returnPressed.connect(
self.onActiveCompoundCategoryAccepted)
self.setMouseTracking(True)
self._lastClock = 0.0
self.fps = EDITOR_TARGET_FPS
self.tick_timer = QtCore.QTimer()
self._current_file_name = 'Untitled'
self.populateMenu()
def getTempDirectory(self):
"""Returns unique temp directory for application instance.
This folder and all it's content will be removed from disc on application shutdown.
"""
return self.currentTempDir
def populateMenu(self):
fileMenu = self.menuBar.addMenu("File")
newFileAction = fileMenu.addAction("New file")
newFileAction.setIcon(QtGui.QIcon(":/new_file_icon.png"))
newFileAction.triggered.connect(self.newFile)
loadAction = fileMenu.addAction("Load")
loadAction.setIcon(QtGui.QIcon(":/folder_open_icon.png"))
loadAction.triggered.connect(self.load)
saveAction = fileMenu.addAction("Save")
saveAction.setIcon(QtGui.QIcon(":/save_icon.png"))
saveAction.triggered.connect(self.save)
saveAsAction = fileMenu.addAction("Save as")
saveAsAction.setIcon(QtGui.QIcon(":/save_as_icon.png"))
saveAsAction.triggered.connect(lambda: self.save(True))
editMenu = self.menuBar.addMenu("Edit")
preferencesAction = editMenu.addAction("Preferences")
preferencesAction.setIcon(QtGui.QIcon(":/options_icon.png"))
preferencesAction.triggered.connect(self.showPreferencesWindow)
helpMenu = self.menuBar.addMenu("Help")
shortcutsAction = helpMenu.addAction("Shortcuts")
shortcutsAction.setIcon(QtGui.QIcon(":/shortcuts_icon.png"))
shortcutsAction.triggered.connect(self.shortcuts_info)
def showPreferencesWindow(self):
self.preferencesWindow.show()
def registerToolInstance(self, instance):
"""Registers tool instance reference
This needed to prevent classes from being garbage collected and to save widgets state
Args:
instance (ToolBase): Tool to be registered
"""
self._tools.add(instance)
def unregisterToolInstance(self, instance):
if instance in self._tools:
self._tools.remove(instance)
def onRequestFillProperties(self, propertiesFillDelegate):
for toolInstance in self._tools:
if isinstance(toolInstance, PropertiesTool):
toolInstance.clear()
toolInstance.assignPropertiesWidget(propertiesFillDelegate)
def onRequestClearProperties(self):
for toolInstance in self._tools:
if isinstance(toolInstance, PropertiesTool):
toolInstance.clear()
def getToolbar(self):
return self.toolBar
def getCanvas(self):
return self.canvasWidget
def setCompoundPropertiesWidgetVisible(self, bVisible):
if bVisible:
self.CompoundPropertiesWidget.show()
self.leCompoundName.setText(self.graphManager.activeGraph().name)
self.leCompoundCategory.setText(
self.graphManager.activeGraph().category)
else:
self.CompoundPropertiesWidget.hide()
def keyPressEvent(self, event):
modifiers = event.modifiers()
currentInputAction = InputAction(name="temp",
actionType=InputActionType.Keyboard,
key=event.key(),
modifiers=modifiers)
actionSaveVariants = InputManager()["App.Save"]
actionNewFileVariants = InputManager()["App.NewFile"]
actionLoadVariants = InputManager()["App.Load"]
actionSaveAsVariants = InputManager()["App.SaveAs"]
if currentInputAction in actionNewFileVariants:
self.newFile()
if currentInputAction in actionSaveVariants:
self.save()
if currentInputAction in actionLoadVariants:
self.load()
if currentInputAction in actionSaveAsVariants:
self.save_as()
def loadFromData(self, data, fpath=""):
self.newFile(keepRoot=False)
# load raw data
self.graphManager.deserialize(data)
# create ui nodes
for graph in self.graphManager.getAllGraphs():
self.canvasWidget.createWrappersForGraph(graph)
self.graphManager.selectRootGraph()
def load(self):
name_filter = "Graph files (*.json)"
savepath = QFileDialog.getOpenFileName(filter=name_filter)
if type(savepath) in [tuple, list]:
fpath = savepath[0]
else:
fpath = savepath
if not fpath == '':
with open(fpath, 'r') as f:
data = json.load(f)
self.loadFromData(data, fpath)
def save(self, save_as=False):
if save_as:
name_filter = "Graph files (*.json)"
savepath = QFileDialog.getSaveFileName(filter=name_filter)
if type(savepath) in [tuple, list]:
pth = savepath[0]
else:
pth = savepath
if not pth == '':
self._current_file_name = pth
else:
self._current_file_name = "Untitled"
else:
if not os.path.isfile(self._current_file_name):
name_filter = "Graph files (*.json)"
savepath = QFileDialog.getSaveFileName(filter=name_filter)
if type(savepath) in [tuple, list]:
pth = savepath[0]
else:
pth = savepath
if not pth == '':
self._current_file_name = pth
else:
self._current_file_name = "Untitled"
if self._current_file_name in ["", "Untitled"]:
return
if not self._current_file_name == '':
with open(self._current_file_name, 'w') as f:
saveData = self.graphManager.serialize()
json.dump(saveData, f, indent=4)
print(str("// saved: '{0}'".format(self._current_file_name)))
def newFile(self, keepRoot=True):
self.tick_timer.stop()
self.tick_timer.timeout.disconnect()
# broadcast
self.graphManager.clear(keepRoot=keepRoot)
self.newFileExecuted.emit(keepRoot)
self._current_file_name = 'Untitled'
self.onRequestClearProperties()
self.startMainLoop()
def updateGraphTreeLocation(self, *args, **kwargs):
location = self.canvasWidget.location()
clearLayout(self.layoutGraphPath)
spacerItem = QSpacerItem(40, 20, QSizePolicy.Expanding,
QSizePolicy.Minimum)
self.layoutGraphPath.addItem(spacerItem)
for folderName in location:
index = self.layoutGraphPath.count() - 1
btn = QPushButton(folderName)
def onClicked(checked, name=None):
self.canvasWidget.stepToCompound(name)
btn.clicked.connect(
lambda chk=False, name=folderName: onClicked(chk, name))
self.layoutGraphPath.insertWidget(index, btn)
self.setCompoundPropertiesWidgetVisible(
self.graphManager.activeGraph().depth() > 1)
def onActiveCompoundNameAccepted(self):
newName = self.graphManager.getUniqName(self.leCompoundName.text())
self.graphManager.activeGraph().name = newName
self.leCompoundName.blockSignals(True)
self.leCompoundName.setText(newName)
self.leCompoundName.blockSignals(False)
self.updateGraphTreeLocation()
def onActiveCompoundCategoryAccepted(self):
newCategoryName = self.leCompoundCategory.text()
self.graphManager.activeGraph().category = newCategoryName
def startMainLoop(self):
self.tick_timer.timeout.connect(self.mainLoop)
self.tick_timer.start(1000 / EDITOR_TARGET_FPS)
def stopMainLoop(self):
self.tick_timer.stop()
self.tick_timer.timeout.disconnect()
def mainLoop(self):
deltaTime = clock() - self._lastClock
ds = (deltaTime * 1000.0)
if ds > 0:
self.fps = int(1000.0 / ds)
# Tick all graphs
# each graph will tick owning raw nodes
# each raw node will tick it's ui wrapper if it exists
self.graphManager.Tick(deltaTime)
# Tick canvas. Update ui only stuff such animation etc.
self.canvasWidget.Tick(deltaTime)
self._lastClock = clock()
def createPopupMenu(self):
pass
def newPlugin(self, pluginType):
name, result = QInputDialog.getText(self, 'Plugin name',
'Enter plugin name')
if result:
_implementPlugin(name, pluginType)
def getToolClassByName(self, packageName, toolName, toolClass=DockTool):
registeredTools = GET_TOOLS()
for ToolClass in registeredTools[packageName]:
if issubclass(ToolClass, toolClass):
if ToolClass.name() == toolName:
return ToolClass
return None
def createToolInstanceByClass(self,
packageName,
toolName,
toolClass=DockTool):
registeredTools = GET_TOOLS()
for ToolClass in registeredTools[packageName]:
if issubclass(ToolClass, toolClass):
if ToolClass.name() == toolName:
return ToolClass()
return None
def invokeDockToolByName(self, packageName, name, settings=None):
# invokeDockToolByName Invokes dock tool by tool name and package name
# If settings provided QMainWindow::restoreDockWidget will be called instead QMainWindow::addDockWidget
toolClass = self.getToolClassByName(packageName, name, DockTool)
isSingleton = toolClass.isSingleton()
if isSingleton:
# check if already registered
if name in [t.name() for t in self._tools]:
for tool in self._tools:
if tool.name() == name:
# Highlight window
print("highlight", tool.uniqueName())
return
ToolInstance = self.createToolInstanceByClass(packageName, name,
DockTool)
if ToolInstance:
self.registerToolInstance(ToolInstance)
if settings is not None:
ToolInstance.restoreState(settings)
if not self.restoreDockWidget(ToolInstance):
# handle if ui state was not restored
pass
else:
self.addDockWidget(ToolInstance.defaultDockArea(),
ToolInstance)
ToolInstance.setCanvas(self.canvasWidget)
ToolInstance.onShow()
return ToolInstance
def closeEvent(self, event):
self.tick_timer.stop()
self.tick_timer.timeout.disconnect()
self.canvasWidget.shoutDown()
# save editor config
settings = QtCore.QSettings(ConfigManager().APP_SETTINGS_PATH,
QtCore.QSettings.IniFormat, self)
# clear file each time to capture opened dock tools
settings.clear()
settings.sync()
settings.beginGroup('Editor')
settings.setValue("geometry", self.saveGeometry())
settings.setValue("state", self.saveState())
settings.endGroup()
# save tools state
settings.beginGroup('Tools')
for tool in self._tools:
if isinstance(tool, ShelfTool):
settings.beginGroup("ShelfTools")
settings.beginGroup(tool.name())
tool.saveState(settings)
settings.endGroup()
settings.endGroup()
if isinstance(tool, DockTool):
settings.beginGroup("DockTools")
settings.beginGroup(tool.uniqueName())
tool.saveState(settings)
settings.endGroup()
settings.endGroup()
tool.onDestroy()
settings.endGroup()
settings.sync()
# remove temp directory
shutil.rmtree(self.currentTempDir, ignore_errors=True)
QMainWindow.closeEvent(self, event)
def shortcuts_info(self):
data = "Tab - togle node box\n"
data += "Ctrl+N - new file\n"
data += "Ctrl+S - save\n"
data += "Ctrl+Shift+S - save as\n"
data += "Ctrl+O - open file\n"
data += "F - frame selected\n"
data += "H - frame all\n"
data += "C - comment selected nodes\n"
data += "Delete - kill selected nodes\n"
data += "Ctrl+C - Copy\n"
data += "Ctrl+V - Paste\n"
data += "Alt+Drag - Duplicate\n"
data += "Ctrl+Z - Undo\n"
data += "Ctrl+Y - Redo\n"
data += "Alt+Click - Disconnect Pin\n"
data += "Ctrl+Shift+ArrowLeft - Align left\n"
data += "Ctrl+Shift+ArrowUp - Align Up\n"
data += "Ctrl+Shift+ArrowRight - Align right\n"
data += "Ctrl+Shift+ArrowBottom - Align Bottom\n"
QMessageBox.information(self, "Shortcuts", data)
@staticmethod
def instance(parent=None):
instance = PyFlow(parent)
instance.startMainLoop()
INITIALIZE()
# create app folder in documents
# random string used for cases when multiple instances of app are running in the same time
prefs = QtCore.QSettings(ConfigManager().PREFERENCES_CONFIG_PATH,
QtCore.QSettings.IniFormat)
tempDirPath = prefs.value("Preferences/General/TempFilesDir")
if tempDirPath == None:
tempDirPath = "/tmp/pyflow"
if tempDirPath[-1:] in ('/', '\\'):
tempDirPath = tempDirPath[:-1]
instance.currentTempDir = "{0}_{1}".format(tempDirPath,
generateRandomString())
if not os.path.exists(instance.currentTempDir):
os.makedirs(instance.currentTempDir)
# populate tools
canvas = instance.getCanvas()
toolbar = instance.getToolbar()
settings = QtCore.QSettings(ConfigManager().APP_SETTINGS_PATH,
QtCore.QSettings.IniFormat)
geo = settings.value('Editor/geometry')
if geo is not None:
instance.restoreGeometry(geo)
state = settings.value('Editor/state')
if state is not None:
instance.restoreState(state)
settings.beginGroup("Tools")
for packageName, registeredToolSet in GET_TOOLS().items():
for ToolClass in registeredToolSet:
if issubclass(ToolClass, ShelfTool):
ToolInstance = ToolClass()
# prevent to be garbage collected
instance.registerToolInstance(ToolInstance)
ToolInstance.setCanvas(canvas)
action = QAction(instance)
action.setIcon(ToolInstance.getIcon())
action.setText(ToolInstance.name())
action.setToolTip(ToolInstance.toolTip())
action.setObjectName(ToolInstance.name())
action.triggered.connect(ToolInstance.do)
# check if context menu data available
menuBuilder = ToolInstance.contextMenuBuilder()
if menuBuilder:
menuGenerator = ContextMenuGenerator(menuBuilder)
menu = menuGenerator.generate()
action.setMenu(menu)
toolbar.addAction(action)
# step to ShelfTools/ToolName group and pass settings inside
settings.beginGroup("ShelfTools")
settings.beginGroup(ToolClass.name())
ToolInstance.restoreState(settings)
settings.endGroup()
settings.endGroup()
if issubclass(ToolClass, DockTool):
menus = instance.menuBar.findChildren(QMenu)
helpMenuAction = [m for m in menus
if m.title() == "Help"][0].menuAction()
toolsMenu = getOrCreateMenu(instance.menuBar, "Tools")
instance.menuBar.insertMenu(helpMenuAction, toolsMenu)
packageSubMenu = getOrCreateMenu(toolsMenu, packageName)
toolsMenu.addMenu(packageSubMenu)
showToolAction = packageSubMenu.addAction(ToolClass.name())
icon = ToolClass.getIcon()
if icon:
showToolAction.setIcon(icon)
showToolAction.triggered.connect(
lambda pkgName=packageName, toolName=ToolClass.name(
): instance.invokeDockToolByName(pkgName, toolName))
settings.beginGroup("DockTools")
childGroups = settings.childGroups()
for dockToolGroupName in childGroups:
# This dock tool data been saved on last shutdown
settings.beginGroup(dockToolGroupName)
if dockToolGroupName in [
t.uniqueName() for t in instance._tools
]:
continue
toolName = dockToolGroupName.split("::")[0]
ToolInstance = instance.invokeDockToolByName(
packageName, toolName, settings)
settings.endGroup()
settings.endGroup()
return instance
