PrismCore module

Contents

PrismCore module#

class PrismCore.ErrorDetailsDialog(core, text)#

Bases: QDialog

setupUi()#
showEvent(self, arg__1: PySide2.QtGui.QShowEvent) → None#
sizeHint(self) → PySide2.QtCore.QSize#
staticMetaObject = <PySide2.QtCore.QMetaObject object>#
class PrismCore.PrismCore(app='Standalone', prismArgs=[], splashScreen=None)#

Bases: object

addToRecent(filepath)#
property assetPath#
atoi(text)#
attachScreenGrab(dlg, size=None)#
autoSaveDone(action=2)#
callHook(*args, **kwargs)#
callback(*args, **kwargs)#
changeProject(*args, **kwargs)#
checkAutoSave()#
checkCommands()#
checkIllegalCharacters(strings)#
closeSM(restart=False)#
compareVersions(version1, version2)#
convertPath(path, target='global')#
copyFile(source, destination, adminFallback=True)#
copyFileAsAdmin(source, destination)#
copySceneFile(origFile, targetFile, mode='copy')#
copyToClipboard(text, fixSlashes=True, file=False)#
copyWithProgress(src, dst, follow_symlinks=True, popup=True, start=True, finishCallback=None)#
copyfile(src, dst, thread=None, follow_symlinks=True)#

Copy data from src to dst.

If follow_symlinks is not set and src is a symbolic link, a new symlink will be created instead of copying the file it points to.

copyfileobj(fsrc, fdst, total, thread=None, length=16384, path='')#
copyfolder(src, dst, thread=None)#
createCmd(cmd, includeCurrent=False)#
createDirectory(path, adminFallback=True)#
createFolder(path, showMessage=False)#
createFolderAsAdmin(path)#
createPlugin(*args, **kwargs)#
createShortcut(link, target, args='', ignoreError=False)#
createShortcutDeprecated(vPath, vTarget='', args='', vWorkingDir='', vIcon='')#
dependencyViewer(depRoot='', modal=False)#
detectFileSequence(path)#
ffmpegError(title, text, result)#
fileInPipeline(filepath=None, validateFilename=True)#
fixPath(path)#
generateScenePath(*args, **kwargs)#
getAboutString()#
getActiveStyleSheet()#
getAssetPath(location='global')#
getCheckStateValue(checkState)#
getClipboard()#
getCompositingOut(*args, **kwargs)#
getConfig(cat=None, param=None, configPath=None, config=None, dft=None, location=None, allowCache=True)#
getCopyFileCmd(source, destination)#
getCreateFolderCmd(path)#
getCurrentFileName(path=True)#
getDefaultWindowsAppByExtension(ext)#
getEntityPath(*args, **kwargs)#
getExecutableOverride(pluginName)#
getFPS()#
getFileCommandStr(command)#
getFileModificationDate(path, validate=False, ignoreError=True, asString=True, asDatetime=False)#
getFilesFromFolder(path, recursive=True)#
getFormattedDate(stamp=None, datetimeInst=None)#
getFrameRange()#
getHighestVersion(*args, **kwargs)#
getIconForFileType(extension)#
getInstaller(plugins=None)#
getLoadedPlugins()#
getLocalPath()#
getLockScenefilesEnabled()#
getPlugin(pluginName, allowUnloaded=False)#
getPluginData(pluginName, data)#
getPluginNames()#
getPluginSceneFormats()#
getPrismDataDir()#
getPythonPath(executable=None, root=None)#
getQScreenGeo()#
getRecentScenefiles(project=None)#
getRegisteredStyleSheets()#
getRemoveFileCmd(path)#
getResolution()#
getScenefileData(*args, **kwargs)#
getScenefilePaths(scenePath)#
getSequencePath(location='global')#
getShotPath(location='global')#
getStateManager(create=True)#
getStyleSheet(name)#
getTaskNames(*args, **kwargs)#
getTempFilepath(filename=None, ext='.jpg', filenamebase=None)#
getTexturePath(location='global')#
getUIscale()#
getUserPrefConfigPath()#
getUserPrefDir()#
getVersioninfoPath(scenepath)#
getWindowsDocumentsPath()#
getWriteToFileCmd(path, text)#
handleCmd(command)#
handleRemoveReadonly(func, path, exc)#
initializePlugins(appPlugin)#
isAutosaveTimerActive()#
isObjectValid(obj)#
isPopupTooLong(text)#
isScenelockTimerActive()#
isStateManagerOpen()#
isStr(data)#
lockScenefile(filepath=None)#
missingModule(moduleName)#
naturalKeys(text)#
onExit()#
openConsole()#
openFile(filepath)#
openFolder(path)#
openInstaller()#
openSetup()#
openWebsite(location)#
parentWindow(win, parent=None)#
popup(text, title=None, severity='warning', notShowAgain=False, parent=None, modal=True, widget=None, show=True)#
popupNoButton(text, title=None, buttons=None, default=None, icon=None, parent=None, show=True)#
popupQuestion(text, title=None, buttons=None, default=None, icon=None, widget=None, parent=None, escapeButton=None, doExec=True)#
prismSettings(tab=0, restart=False, reload_module=None, settingsType=None)#
projectBrowser(openUi=True)#
readYaml(path=None, data=None, stream=None)#
registerCallback(*args, **kwargs)#
registerStyleSheet(path, default=False)#
reloadCustomPlugins()#
reloadPlugins(plugins=None)#
removeFile(path, adminFallback=True)#
removeFileAsAdmin(path)#
removeScreenGrab(dlg)#
replaceFolderContent(path, fromStr, toStr)#
resolveFrameExpression(expression)#
runFileCommand(command)#
runFileCommands(commands)#
runServer(listener, conn, callback=None)#
saveScene(comment='', publish=False, versionUp=True, prismReq=True, filepath='', details=None, preview=None, location='local')#
saveSceneInfo(filepath, details=None, preview=None, clean=True, replace=False)#
saveVersionInfo(filepath, details=None)#
saveWithComment()#
saveWithCommentAccepted(dlg)#
scaleUI(win=None, sFactor=0)#
sceneOpen(arg=None)#
sceneUnload(arg=None)#
scenefileSaved(arg=None)#
sendAutomaticErrorReport(text, data=None)#
sendData(data, conn)#
sendError(errorText)#
sendErrorReport(dlg, errorMessage)#
sendFeedback(msg, subject='Prism feedback', attachment=None)#
sendFeedbackDlg(state=None)#
property sequencePath#
setActiveStyleSheet(name)#
setConfig(cat=None, param=None, val=None, data=None, configPath=None, delete=False, config=None, location=None, updateNestedData=True)#
setDebugMode(enabled)#
setFrameRange(startFrame, endFrame)#
setLocalPath(path, projectName=None)#
setTrayStartup(enabled)#
setTrayStartupWindows(enabled, allUsers=False)#
setupStartMenu(quiet=False)#
setupUninstaller(quiet=False)#
shortenPopupMsg(text)#
property shotPath#
shouldAutosaveTimerRun()#
shouldScenelockTimerRun()#
showAbout()#
showErrorDetailPopup(text, sendReport=True, data=None)#
showErrorPopup(text, data=None)#
showFileNotInProjectWarning(title=None, msg=None)#
sortNatural(alist)#
startAutosaveTimer(quit=False)#
startClient(port, key)#
startCommunication(port, key, callback=None)#
startSceneLockTimer(quit=False)#
startServer(port, key)#
startTray()#
startup()#
stateManager(stateDataPath=None, restart=False, openUi=True, reload_module=False, new_instance=False, standalone=False)#
stateManagerEnabled()#
property texturePath#
property timeMeasure#

with self.core.timeMeasure:

tr(text)#
unloadPlugin(pluginName)#
unloadProjectPlugins()#
unlockScenefile()#
unregisterCallback(*args, **kwargs)#
updateEnvironment()#
updateLogging(level=None)#
updateProgressPopup(progress, popup=None)#
updateProjectEnvironment()#
validateCopyFile(source, destination)#
validateCreateFolder(path)#
validateFileCommand(command)#
validateLineEdit(widget, allowChars=None, denyChars=None)#
validateRemoveFile(path)#
validateStr(text, allowChars=None, denyChars=None)#
validateWriteToFile(path, text)#
class waitPopup(core, text, title=None, buttons=None, default=None, icon=None, hidden=False, parent=None, allowCancel=False, activate=True)#

Bases: QObject

with self.core.waitPopup(self.core, text):

cancel()#
canceled#
close()#
createPopup()#
exec_()#
isVisible()#
show()#
staticMetaObject = <PySide2.QtCore.QMetaObject object>#
winRunAsAdmin(script)#
writeErrorLog(text, data=None)#
writeToFile(path, text, adminFallback=True)#
writeToFileAsAdmin(path, text)#
writeYaml(path=None, data=None, stream=None)#
class PrismCore.SplashScreen#

Bases: QWidget

resizeEvent(self, event: PySide2.QtGui.QResizeEvent) → None#
setStatus(status)#
setVersion(version)#
setupUi()#
staticMetaObject = <PySide2.QtCore.QMetaObject object>#
class PrismCore.TimeMeasure#

Bases: object

class PrismCore.Worker(core=None, function=None)#

Bases: QThread

cancel()#
dataSent#
errored#
run(self) → None#
staticMetaObject = <PySide2.QtCore.QMetaObject object>#
updated#
warningSent#
PrismCore.create(app='Standalone', prismArgs=None)#
PrismCore.movePosition(self, op: PySide2.QtGui.QTextCursor.MoveOperation, arg__2: PySide2.QtGui.QTextCursor.MoveMode = PySide2.QtGui.QTextCursor.MoveMode.MoveAnchor, n: int = 1) → bool#
PrismCore.show(app='Standalone', prismArgs=None)#
Contents