PrismUtils package#
Submodules#
PrismUtils.Callbacks module#
- class PrismUtils.Callbacks.Callbacks(core)#
Bases:
object- callHook(hookName, *args, **kwargs)#
- callback(name='', *args, **kwargs)#
- getProjectHooks()#
- registerCallback(callbackName, function, priority=50, plugin=None)#
- registerHook(hookName, filepath)#
- registerProjectHooks()#
- unregisterCallback(callbackId)#
- unregisterPluginCallbacks(plugin)#
- PrismUtils.Callbacks.movePosition(self, op: PySide2.QtGui.QTextCursor.MoveOperation, arg__2: PySide2.QtGui.QTextCursor.MoveMode = PySide2.QtGui.QTextCursor.MoveMode.MoveAnchor, n: int = 1) bool#
PrismUtils.ConfigManager module#
- class PrismUtils.ConfigManager.ConfigManager(core)#
Bases:
object- addConfigItem(key, path)#
- clearCache(path=None)#
- convertDeprecatedConfig(path)#
- createUserPrefs()#
- findDeprecatedConfig(path)#
- generateConfigPath(name, location=None)#
- getCacheTime(path)#
- getConfig(cat=None, param=None, configPath=None, config=None, dft=None, location=None, allowCache=True)#
- getConfigPath(config, location=None)#
- getProjectConfigName(projectPath=None)#
- getProjectConfigPath(projectPath=None, pipelineDir=None, useEnv=True)#
- getProjectExtension()#
- readConfig(configPath)#
- readIni(path=None, data=None)#
- readJson(path=None, stream=None, data=None, ignoreErrors=False)#
- readYaml(path=None, data=None, stream=None, retry=True)#
- setConfig(cat=None, param=None, val=None, data=None, configPath=None, delete=False, config=None, location=None, updateNestedData=True)#
- updateNestedDicts(d, u, exclude=None)#
- writeConfig(path, data)#
- writeJson(data, path=None, stream=None, indent=4, quiet=False)#
- writeYaml(path=None, data=None, stream=None, retry=True)#
- PrismUtils.ConfigManager.movePosition(self, op: PySide2.QtGui.QTextCursor.MoveOperation, arg__2: PySide2.QtGui.QTextCursor.MoveMode = PySide2.QtGui.QTextCursor.MoveMode.MoveAnchor, n: int = 1) bool#
PrismUtils.Decorators module#
- PrismUtils.Decorators.err_catcher(name)#
- PrismUtils.Decorators.err_catcher_plugin(name)#
- PrismUtils.Decorators.err_catcher_standalone(name)#
- PrismUtils.Decorators.err_handler(func, name='', plugin=False)#
- PrismUtils.Decorators.movePosition(self, op: PySide2.QtGui.QTextCursor.MoveOperation, arg__2: PySide2.QtGui.QTextCursor.MoveMode = PySide2.QtGui.QTextCursor.MoveMode.MoveAnchor, n: int = 1) bool#
- PrismUtils.Decorators.timmer(name)#
PrismUtils.Integration module#
- class PrismUtils.Integration.Ingegration(core)#
Bases:
object- addAllIntegrations()#
- addIntegration(app, path=None, quiet=False)#
- addIntegrations(integrations, quiet=True)#
- convertDeprecatedConfig()#
- getIntegrations()#
- refreshAllIntegrations()#
- removeAllIntegrations()#
- removeIntegration(app, path, quiet=False)#
- removeIntegrationData(content=None, filepath=None, deleteEmpty=True, searchStrings=None)#
- removeIntegrations(integrations, quiet=True)#
- requestIntegrationPath(app)#
- PrismUtils.Integration.movePosition(self, op: PySide2.QtGui.QTextCursor.MoveOperation, arg__2: PySide2.QtGui.QTextCursor.MoveMode = PySide2.QtGui.QTextCursor.MoveMode.MoveAnchor, n: int = 1) bool#
PrismUtils.Lockfile module#
- class PrismUtils.Lockfile.Lockfile(core, fileName, timeout=10, delay=0.05)#
Bases:
object- acquire(content=None, force=False)#
- forceRelease()#
- isLocked()#
- release()#
- waitUntilReady(timeout=None)#
- exception PrismUtils.Lockfile.LockfileException#
Bases:
Exception
PrismUtils.MediaManager module#
- class PrismUtils.MediaManager.MediaManager(core)#
Bases:
object- checkMSVC()#
- checkOddResolution(path, popup=False)#
- convertMedia(inputpath, startNum, outputpath, settings=None)#
- detectSequence(filepaths)#
- detectSequences(files, getFirstFile=False, sequencePattern=True)#
- property emptyPrvPixmap#
- property emptyPrvPixmapBig#
- filterValidMediaFiles(filepaths)#
- getColoredIcon(path, force=False, r=150, g=210, b=240)#
- getExternalMediaPlayer()#
- getFFmpeg(validate=False)#
- getFallbackPixmap(big=False)#
- getFilenameWithFrameNumber(filename, framenumber)#
- getFilenameWithoutFrameNumber(filename)#
- getFilesFromSequence(sequence)#
- getFirstFilePpathFromSequence(sequence)#
- getFrameNumberFromFilename(filename)#
- getFrameRangeFromSequence(filepaths)#
- getImageIO()#
- getImgSources(path, getFirstFile=False, sequencePattern=True)#
- getLayersFromFile(filepath)#
- getMediaInformation(path)#
- getMediaResolution(path, videoReader=None)#
- getMediaSequence(path)#
- getOIIO()#
- getPixmapFromClipboard()#
- getPixmapFromExrPath(path, width=None, height=None, channel=None, allowThumb=True, regenerateThumb=False)#
- getPixmapFromPath(path, width=None, height=None, colorAdjust=False)#
- getPixmapFromUrl(url)#
- getPixmapFromVideoPath(path, allowThumb=True, regenerateThumb=False, videoReader=None, imgNum=0)#
- getSequenceFromFilename(filename)#
- getThumbnailPath(path)#
- getUseThumbnailForFile(filepath)#
- getUseThumbnails()#
- getVideoDuration(path, videoReader=None)#
- getVideoReader(filepath)#
- invalidateOiioCache(force=False)#
- isFilenameInSequence(filename, sequence)#
- playMediaInExternalPlayer(path)#
- savePixmap(pmap, path)#
- scalePixmap(pixmap, width, height, keepRatio=True, fitIntoBounds=True, crop=False, fillBackground=False)#
- setUseThumbnails(state)#
- validateFFmpeg(path)#
- PrismUtils.MediaManager.movePosition(self, op: PySide2.QtGui.QTextCursor.MoveOperation, arg__2: PySide2.QtGui.QTextCursor.MoveMode = PySide2.QtGui.QTextCursor.MoveMode.MoveAnchor, n: int = 1) bool#
PrismUtils.MediaProducts module#
- class PrismUtils.MediaProducts.MediaProducts(core)#
Bases:
object- addToMasterVersion(path=None, context=None, isFilepath=True, mediaType=None)#
- checkMasterVersions(entities, parent=None)#
- createAov(entity, identifier, version, aov, identifierType='3drenders')#
- createExternalMedia(filepath, entity, identifier, version, action='copy', location='global')#
- createIdentifier(entity, identifier, identifierType='3drenders', location='global')#
- createVersion(entity, identifier, version, identifierType='3drenders', location='global')#
- deleteMasterVersion(path, isFilepath=False, mediaType=None, allowClear=True, allowRename=True)#
- generateMediaProductPath(entity, task, extension, framePadding='', comment=None, version=None, location='global', aov='beauty', returnDetails=False, mediaType=None, singleFrame=False, ignoreEmpty=False, ignoreFolder=False, user=None, additionalContext=None, state=None, filenameTemplate=None)#
- generatePlayblastPath(entity, task, extension, framePadding='', comment=None, version=None, location='global', returnDetails=False, user=None, filenameTemplate=None)#
- get2dVersionInfoPathFromFilepath(path)#
- getAOVsFromVersion(version)#
- getAovPathFromVersion(version)#
- getDataFromFilepath(path)#
- getDisplayNameForIdentifier(identifier, mediaType)#
- getExternalPathFromVersion(version)#
- getFilePatternFromVersion(version)#
- getFilesFromContext(context)#
- getHighestMediaVersion(context, getExisting=False, ignoreEmpty=False, ignoreFolder=False)#
- getIdentifierPathFromEntity(entity)#
- getIdentifiersByType(entity, locations=None)#
- getLatestVersionFromFilepath(filepath, includeMaster=True)#
- getLatestVersionFromIdentifier(identifier, includeMaster=True)#
- getLatestVersionFromVersions(versions, includeMaster=True)#
- getLinkedToTasks()#
- getLocationFromPath(path)#
- getMasterVersionLabel(path)#
- getMasterVersionNumber(masterPath, allowCache=True)#
- getMediaDataFromVersionFolder(path, mediaType='3drenders')#
- getMediaTypeFromContext(context)#
- getMediaTypeFromPath(path)#
- getMediaVersionInfoPathFromFilepath(path, mediaType=None)#
- getOutdatedMasterVersions(entities)#
- getPlayblastVersionInfoPathFromFilepath(path)#
- getRenderProductDataFromFilepath(filepath, mediaType='3drenders')#
- getUseMaster()#
- getVersionFromFilepath(path)#
- getVersionFromPlayblastFilepath(path)#
- getVersionFromVersionFolder(versionFolder, context=None)#
- getVersionInfoPathFromContext(context)#
- getVersionPathFromIdentifier(entity)#
- getVersionPathFromMediaFilePath(path, mediaType)#
- getVersionPathsFromMaster(path, isFilepath=True)#
- getVersionStackContextFromPath(filepath, mediaType=None)#
- getVersionsFromContext(context, keys=None, locations=None)#
- getVersionsFromIdentifier(identifier, locations=None)#
- getVersionsFromSameVersionStack(path, mediaType=None)#
- ingestMedia(files, entity, identifier, version, aov, mediaType='3drenders', filenameTemplate=None, location='global')#
- onIngestCanceled()#
- onMediaFileIngested(thread, targetPath, numFiles)#
- setComment(versionPath, comment)#
- updateMasterVersion(path=None, context=None, isFilepath=True, add=False, mediaType=None)#
- PrismUtils.MediaProducts.movePosition(self, op: PySide2.QtGui.QTextCursor.MoveOperation, arg__2: PySide2.QtGui.QTextCursor.MoveMode = PySide2.QtGui.QTextCursor.MoveMode.MoveAnchor, n: int = 1) bool#
PrismUtils.PathManager module#
- class PrismUtils.PathManager.MasterManager(core, entities, mode, parent=None)#
Bases:
QDialog- onAcceptClicked()#
- onItemDoubleClicked(item)#
- onUpdateMasterClicked(versionData)#
- openInProjectBrowser(path)#
- refreshData()#
- refreshProjectBrowserVersions()#
- refreshTable()#
- setupUi()#
- showContextMenu(pos)#
- showEvent(self, arg__1: PySide2.QtGui.QShowEvent) None#
- sizeHint(self) PySide2.QtCore.QSize#
- staticMetaObject = <PySide2.QtCore.QMetaObject object>#
- updateMaster(versionData)#
- updateSelected()#
- class PrismUtils.PathManager.PathManager(core)#
Bases:
object- addExportProductBasePath(location, path, configData=None)#
- addRenderProductBasePath(location, path, configData=None)#
- convertExportPath(path, fromLocation, toLocation)#
- convertGlobalRenderPath(path, target='global')#
- generateScenePath(entity, department, task='', extension='', version='', comment='', user='', location=None)#
- getCachePathData(cachePath, addPathData=True, validateModTime=False, allowCache=True)#
- getCompositingOut(taskName, fileType, useVersion, render, location='global', comment='', ignoreEmpty=False, node=None)#
- getEntityPath(entity=None, step=None, category=None, reqEntity=None, location='global')#
- getEntityTypeFromPath(path, projectPath=None)#
- getExportProductBasePaths(default=True, configPath=None, configData=None)#
- getFrameFromFilename(filename)#
- getLocationFromPath(path)#
- getLocationPath(locationName)#
- getMediaConversionOutputPath(context, inputpath, extension, addFramePadding=True)#
- getMediaProductData(productPath, isFilepath=True, addPathData=True, mediaType='3drenders', validateModTime=False)#
- getPlayblastProductData(productPath, isFilepath=True, addPathData=True, validateModTime=False)#
- getRenderProductBasePaths(default=True, configPath=None, configData=None)#
- getRenderProductData(productPath, isFilepath=True, addPathData=True, mediaType='3drenders', validateModTime=False, isVersionFolder=False, allowCache=True)#
- removeExportProductBasePath(location, configData=None)#
- removeRenderProductBasePath(location, configData=None)#
- replaceVersionInStr(inputStr, replacement)#
- requestFilepath(title='Select File', startPath='', parent=None, fileFilter='All files (*.*)', saveDialog=True)#
- requestPath(title='Select folder', startPath='', parent=None)#
- splitext(path)#
- PrismUtils.PathManager.movePosition(self, op: PySide2.QtGui.QTextCursor.MoveOperation, arg__2: PySide2.QtGui.QTextCursor.MoveMode = PySide2.QtGui.QTextCursor.MoveMode.MoveAnchor, n: int = 1) bool#
PrismUtils.PluginManager module#
- class PrismUtils.PluginManager.PluginManager(core)#
Bases:
object- activatePlugin(path)#
- addToPluginConfig(pluginPath=None, searchPath=None, idx=0)#
- backupPlugin(pluginPath)#
- callUnpatchedFunction(function, *args, **kwargs)#
- canPluginBeFound(pluginPath)#
- clearPluginBackup(backupPath)#
- createPlugin(pluginName, pluginType, location='root', path='')#
- deactivatePlugin(pluginName)#
- downloadPlugin(plugin)#
- getAutoLoadPlugin(pluginName)#
- getComputerPluginPath()#
- getDefaultPluginPath()#
- getFallbackPluginPath()#
- getFunctionInfo(function)#
- getFunctionPatch(function, preferredPatchers=None)#
- getLoadedPlugins()#
- getNonExistentPath(path)#
- getNotAutoLoadPlugins(configOnly=False)#
- getPlugin(pluginName, allowUnloaded=False)#
- getPluginData(pluginName, data)#
- getPluginDirs(includeDefaults=True, includeEnv=True, includeConfig=True, enabledOnly=True)#
- getPluginMetaData()#
- getPluginNameFromPath(path)#
- getPluginNames()#
- getPluginPath(location='root', pluginType='', path='', pluginName='')#
- getPluginSceneFormats()#
- getPlugins()#
- getRenderfarmPlugin(name)#
- getRenderfarmPlugins()#
- getUnloadedPlugin(pluginName)#
- getUnloadedPlugins()#
- getUserPluginPath()#
- initializePlugins(appPlugin)#
- installHub()#
- isFunctionMonkeyPatched(function, plugin=None)#
- isPluginLoaded(pluginName)#
- loadAppPlugin(pluginName, pluginPath=None, startup=False)#
- loadPlugin(path=None, name=None, force=True, activate=None, showWarnings=False)#
- loadPluginMetaData(path=None)#
- loadPlugins(pluginPaths=None, directory=None, directories=None, recursive=False, force=True, ignore=None)#
- monkeyPatch(orig, new, plugin, quiet=False, force=False)#
- postInstallPlugins(plugins, basepath, load=True)#
- registerRenderfarmPlugin(plugin)#
- reloadCustomPlugins()#
- reloadPlugin(pluginName)#
- reloadPlugins(plugins=None)#
- removeFromPluginConfig(pluginPaths=None, searchPaths=None)#
- removePlugin(pluginPath)#
- removeUnloadedPlugin(pluginName)#
- restorePluginFromBackup(backupPath)#
- searchPluginPath(pluginName)#
- searchPluginPaths(pluginName)#
- searchPlugins(pluginPaths=None, directory=None, directories=None, recursive=True, pluginNames=None)#
- setAutoLoadPlugin(pluginName, autoload)#
- setPluginPathEnabled(path, enabled)#
- setPluginSearchPathEnabled(path, enabled)#
- setupIntegrations(plugin)#
- unloadAppPlugin()#
- unloadPlugin(pluginName=None, plugin=None)#
- unloadProjectPlugins()#
- unmonkeyPatchFunction(functionData)#
- unmonkeyPatchPluginFunctions(plugin)#
- unregisterRenderfarmPlugin(plugin)#
- updatePlugins(pluginUpdates)#
- class PrismUtils.PluginManager.UnloadedPlugin(core, pluginName, path='', location='')#
Bases:
object
- PrismUtils.PluginManager.movePosition(self, op: PySide2.QtGui.QTextCursor.MoveOperation, arg__2: PySide2.QtGui.QTextCursor.MoveMode = PySide2.QtGui.QTextCursor.MoveMode.MoveAnchor, n: int = 1) bool#
PrismUtils.PrismWidgets module#
- class PrismUtils.PrismWidgets.CreateDepartmentDlg(core, entity=None, configData=None, department=None, parent=None)#
Bases:
QDialog- createClicked()#
- departmentCreated#
- getAbbreviation()#
- getDefaultTasks()#
- getDepartment()#
- getEntity()#
- getName()#
- setAbbreviation(abbreviation)#
- setDefaultTasks(tasks)#
- setEntity(entity)#
- setName(name)#
- setupUi()#
- staticMetaObject = <PySide2.QtCore.QMetaObject object>#
- class PrismUtils.PrismWidgets.CreateItem(startText='', showTasks=False, taskType='', core=None, getStep=False, showType=False, allowChars=[], denyChars=[], valueRequired=True, mode='', validate=True, presets=None, allowNext=False)#
Bases:
QDialog,Ui_dlg_CreateItem- buttonboxClicked(button)#
- connectEvents()#
- enableOk(widget)#
- enableOkStep(widget)#
- getTasks()#
- keyPressEvent(self, arg__1: PySide2.QtGui.QKeyEvent) None#
- returnName()#
- showEvent(self, arg__1: PySide2.QtGui.QShowEvent) None#
- showTasks()#
- staticMetaObject = <PySide2.QtCore.QMetaObject object>#
- taskClicked(task)#
- typeChanged(state)#
- class PrismUtils.PrismWidgets.CreateTaskPresetDlg(core, entity=None, configData=None, preset=None, parent=None)#
Bases:
QDialog- createClicked()#
- getDepartments()#
- getName()#
- onDepartmentSelectionChanged()#
- onTaskSelectionChanged()#
- refreshDepartments()#
- selectDepartments(departments)#
- setName(name)#
- setupUi()#
- staticMetaObject = <PySide2.QtCore.QMetaObject object>#
- taskPresetCreated#
- class PrismUtils.PrismWidgets.EnterText#
Bases:
QDialog,Ui_dlg_EnterText- staticMetaObject = <PySide2.QtCore.QMetaObject object>#
- class PrismUtils.PrismWidgets.SaveComment(core)#
Bases:
QDialog,Ui_dlg_SaveComment- enterEvent(self, event: PySide2.QtCore.QEvent) None#
- getDetails()#
- grabArea()#
- setEmptyPreview()#
- staticMetaObject = <PySide2.QtCore.QMetaObject object>#
- class PrismUtils.PrismWidgets.SetPath(core)#
Bases:
QDialog,Ui_dlg_SetPath- browse()#
- connectEvents()#
- enableOk(text)#
- staticMetaObject = <PySide2.QtCore.QMetaObject object>#
- PrismUtils.PrismWidgets.movePosition(self, op: PySide2.QtGui.QTextCursor.MoveOperation, arg__2: PySide2.QtGui.QTextCursor.MoveMode = PySide2.QtGui.QTextCursor.MoveMode.MoveAnchor, n: int = 1) bool#
PrismUtils.Products module#
- class PrismUtils.Products.PreferredVersionDialog(origin, version)#
Bases:
QDialog- addItemToTree(entity, parent=None)#
- onAcceptClicked()#
- refreshTree()#
- setupUi()#
- signalSelected#
- sizeHint(self) PySide2.QtCore.QSize#
- staticMetaObject = <PySide2.QtCore.QMetaObject object>#
- class PrismUtils.Products.Products(core)#
Bases:
object- checkMasterVersions(entities, parent=None)#
- createProduct(entity, product, location='global')#
- deleteMasterVersion(path, errorMsg=None, allowClear=True, allowRename=True)#
- generateProductPath(entity, task, extension=None, startframe=None, endframe=None, comment=None, user=None, version=None, framePadding=None, location=None, returnDetails=False, wedge=None)#
- getDataFromVersionContext(context)#
- getGroupFromProduct(product)#
- getIntVersionFromVersionName(versionName)#
- getLatestVersionFromPath(path, includeMaster=True)#
- getLatestVersionFromVersions(versions, includeMaster=True, wedge=None)#
- getLatestVersionpathFromProduct(product, entity=None, includeMaster=True, wedge=None, locations=None)#
- getLinkedToTasks()#
- getLocationFromFilepath(path)#
- getLocationFromPath(path)#
- getLocationPathFromLocation(location)#
- getMasterVersionLabel(path)#
- getMasterVersionNumber(masterPath, allowCache=True)#
- getNextAvailableVersion(entity, product)#
- getOutdatedMasterVersions(entities)#
- getPreferredFileFromFiles(files, relative=False)#
- getPreferredFileFromVersion(version, location=None)#
- getProductDataFromFilepath(filepath)#
- getProductDataFromVersionFolder(path)#
- getProductNamesFromEntity(entity, locations=None)#
- getProductPathFromEntity(entity, includeProduct=False)#
- getProductsByTags(entity, tags)#
- getProductsFromEntity(entity, locations=None)#
- getTagsFromProduct(product)#
- getUseMaster()#
- getVersionFromFilepath(path, num=False)#
- getVersionInfoFromVersion(version)#
- getVersionInfoPathFromProductFilepath(filepath)#
- getVersionStackContextFromPath(filepath)#
- getVersionpathFromProductVersion(product, version, entity=None, wedge=None, locations=None)#
- getVersionsFromContext(context, locations=None)#
- getVersionsFromPath(path)#
- getVersionsFromProduct(entity, product, locations='all')#
- getVersionsFromSameVersionStack(path)#
- ingestProductVersion(files, entity, product, comment=None, version=None, location='global')#
- renameMaster(masterFolder)#
- setComment(versionPath, comment)#
- setPreferredFileForVersion(version, preferredFile, callback=None)#
- setPreferredFileForVersionDlg(version, callback=None)#
- setProductTags(product, tags)#
- setProductsGroup(products, group, projectWide=False)#
- updateMasterVersion(path)#
- PrismUtils.Products.movePosition(self, op: PySide2.QtGui.QTextCursor.MoveOperation, arg__2: PySide2.QtGui.QTextCursor.MoveMode = PySide2.QtGui.QTextCursor.MoveMode.MoveAnchor, n: int = 1) bool#
PrismUtils.ProjectEntities module#
- class PrismUtils.ProjectEntities.ConnectEntitiesDlg(core, parent=None)#
Bases:
QDialog- onAccepted()#
- onSelectedEntityChanged(items=None)#
- refreshConnectedEntityInfo(items=None)#
- refreshEntities()#
- refreshEntityInfo(items=None)#
- selectConnectedEntities()#
- setupUi()#
- sizeHint(self) PySide2.QtCore.QSize#
- staticMetaObject = <PySide2.QtCore.QMetaObject object>#
- tabChanged()#
- class PrismUtils.ProjectEntities.EntityDlg(origin, parent=None)#
Bases:
QDialog- buttonClicked(button)#
- entitySelected#
- itemDoubleClicked(item, column)#
- setupUi()#
- sizeHint(self) PySide2.QtCore.QSize#
- staticMetaObject = <PySide2.QtCore.QMetaObject object>#
- class PrismUtils.ProjectEntities.ProjectEntities(core)#
Bases:
object- addEntityAction(key, types, function, label)#
- backupScenefile(targetFolder, bufferMinutes=5)#
- connectEntityDlg(entities=None, parent=None)#
- copySceneFile(filepath, entity, department, task, location=None)#
- createAsset(entity, dialog=None)#
- createAssetFolder(entity, dialog=None)#
- createCategory(entity, step, category)#
- createDefaultCat(entity, step)#
- createDepartment(department, entity, stepPath='', createCat=True)#
- createEntity(entity, dialog=None, frameRange=None, silent=False, preview=None)#
- createPresetScene()#
- createSceneFromPreset(entity, fileName, step=None, category=None, comment=None, version=None, location='local')#
- createShot(entity, frameRange=None)#
- createTasksFromPreset(entity, preset=None, presetName=None)#
- createVersionFromAutoBackup(filepath, entity, department, task)#
- createVersionFromAutoBackupDlg(prog, entity, department, task, parent=None)#
- createVersionFromCurrentScene(entity, department, task)#
- deleteShot(shotName)#
- filterAssets(assets, filterStr, projectPath=None)#
- filterOmittedAssets(assets)#
- getAsset(assetName, projectPath=None)#
- getAssetActions()#
- getAssetDescription(assetName, projectPath=None)#
- getAssetFoldersFromPath(path, pathType='asset')#
- getAssetNameFromPath(path)#
- getAssetPathFromAssetName(assetName)#
- getAssetPaths(path=None, returnFolders=False, depth=0)#
- getAssetRelPathFromPath(path, projectPath=None)#
- getAssetSubFolders()#
- getAssets()#
- getAutobackPath(prog, entity=None, department=None, task=None)#
- getBlacklistedExtensions()#
- getCategories(entity, step=None)#
- getCleanEntity(entity)#
- getConnectedEntities(entity)#
- getCurrentDependencies()#
- getDefaultTasksForDepartment(entity, department)#
- getDepartmentAbbreviation(entity, department)#
- getDependencies(path)#
- getEmptyAssetFolders()#
- getEntityName(entity)#
- getEntityPreview(entity, width=None, height=None)#
- getEntityPreviewPath(entity)#
- getHighestVersion(entity, department, task, getExistingPath=False, fileTypes='*', localVersions=True, getExistingVersion=False)#
- getLongDepartmentName(entity, abbreviation)#
- getMetaData(entity, projectPath=None)#
- getPresetScenes()#
- getPresetScenesFromFolder(folder)#
- getScenePresetPathFromName(name)#
- getScenePreviewPath(scenepath)#
- getScenefileData(fileName, preview=False, getEntityFromPath=False)#
- getScenefileInfoPath(scenePath)#
- getScenefiles(entity=None, step=None, category=None, extensions=None, path=None)#
- getSequences(searchFilter='', locations=None)#
- getShotActions()#
- getShotName(entity)#
- getShotRange(entity, handles=False)#
- getShots(searchFilter='', locations=None, getSequences=True)#
- getShotsFromSequence(sequence)#
- getSteps(entity)#
- getTaskData(entity, department, task)#
- getTaskDataPath(entity, department, task)#
- getTaskNames(taskType=None, locations=None, context=None, key=None, taskname=None, addDepartments=True)#
- getTypeFromPath(path, content=None)#
- getUniqueEntities(entities)#
- indexOf(val, listData)#
- ingestScenefiles(files, entity, department, task, finishCallback=None, data=None, rename=True)#
- isAssetOmitted(entity)#
- isAssetPathOmitted(assetPath)#
- isEntityOmitted(entity)#
- isShotOmitted(entity)#
- isValidAssetName(assetName)#
- isValidScenefilename(filename, extensions=None)#
- omitEntity(entity, omit=True)#
- orderDepartments(entity, departments)#
- orderTasks(entity, department, tasks)#
- refreshOmittedEntities()#
- removeEntityAction(key)#
- renameSequence(curSeqName, newSeqName, locations=None)#
- renameShot(curShotData, newShotData, locations=None)#
- setAssetDescription(assetName, description)#
- setComment(filepath, comment)#
- setConnectedEntities(entities, connectedEntities, add=False, remove=False, setReverse=True)#
- setDescription(filepath, description)#
- setEntityPreview(entity, pixmap, width=250, height=141)#
- setMetaData(entity, metaData)#
- setScenePreview(scenepath, preview)#
- setScenefileInfo(scenePath, key, value)#
- setShotRange(entity, start, end)#
- setTaskData(entity, department, task, key, val)#
- PrismUtils.ProjectEntities.movePosition(self, op: PySide2.QtGui.QTextCursor.MoveOperation, arg__2: PySide2.QtGui.QTextCursor.MoveMode = PySide2.QtGui.QTextCursor.MoveMode.MoveAnchor, n: int = 1) bool#
PrismUtils.ProjectWidgets module#
- class PrismUtils.ProjectWidgets.CreateAssetDlg(core, parent=None, startText=None)#
Bases:
CreateItem- browsePreview()#
- capturePreview()#
- getDescription()#
- getThumbnail()#
- pastePreviewFromClipboard()#
- previewMouseReleaseEvent(event)#
- rclThumbnail(pos=None)#
- setPixmap(pmsmall)#
- setupUi_()#
- sizeHint(self) PySide2.QtCore.QSize#
- staticMetaObject = <PySide2.QtCore.QMetaObject object>#
- class PrismUtils.ProjectWidgets.CreateAssetFolderDlg(core, parent=None, startText=None)#
Bases:
CreateItem- setupUi_()#
- staticMetaObject = <PySide2.QtCore.QMetaObject object>#
- class PrismUtils.ProjectWidgets.CreateIdentifierDlg(origin, entity=None)#
Bases:
QDialog- createClicked()#
- enableOk()#
- onDepartmentClicked()#
- onTaskClicked()#
- setupUi_()#
- sizeHint(self) PySide2.QtCore.QSize#
- staticMetaObject = <PySide2.QtCore.QMetaObject object>#
- class PrismUtils.ProjectWidgets.CreateMediaVersionDlg(origin, entity=None)#
Bases:
QDialog- createClicked()#
- setupUi_()#
- sizeHint(self) PySide2.QtCore.QSize#
- staticMetaObject = <PySide2.QtCore.QMetaObject object>#
- class PrismUtils.ProjectWidgets.CreateProductDlg(origin, entity=None)#
Bases:
QDialog- createClicked()#
- enableOk()#
- onDepartmentClicked()#
- onTaskClicked()#
- setupUi_()#
- sizeHint(self) PySide2.QtCore.QSize#
- staticMetaObject = <PySide2.QtCore.QMetaObject object>#
- class PrismUtils.ProjectWidgets.CreateProductVersionDlg(origin, entity=None)#
Bases:
QDialog- browseFile()#
- browseFolder()#
- clearFiles()#
- createClicked()#
- fileDragEnterEvent(e)#
- fileDragLeaveEvent(e)#
- fileDragMoveEvent(e)#
- fileDropEvent(e)#
- fileMouseClickEvent(event)#
- openFolder()#
- setupUi_()#
- sizeHint(self) PySide2.QtCore.QSize#
- staticMetaObject = <PySide2.QtCore.QMetaObject object>#
- class PrismUtils.ProjectWidgets.CreateProject(core, name=None, path=None, settings=None)#
Bases:
QDialog,Ui_dlg_createProject- addFolderDlg(parent)#
- addFolderToItem(parent)#
- addItemToTree(entity, parent=None)#
- backClicked()#
- browse()#
- browsePreview()#
- browseProjectSettings()#
- capturePreview()#
- closeEvent(self, arg__1: PySide2.QtGui.QCloseEvent) None#
- connectEvents()#
- createClicked()#
- createPresetDlg()#
- createPresetFromCurrent()#
- customizeSettings()#
- enterEvent(self, event: PySide2.QtCore.QEvent) None#
- getProjectName()#
- getProjectPath()#
- getStructureFromTree()#
- getStructureFromTreeItem(item)#
- loadLayout()#
- managePresets()#
- mouseClickEvent(event)#
- nameChanged(name)#
- nextClicked()#
- onSettingsSourceChanged(idx=None)#
- paintEvent(self, event: PySide2.QtGui.QPaintEvent) None#
- pastePreviewFromClipboard()#
- rclPreview(pos=None)#
- rclTree(pos)#
- refreshPresets()#
- refreshStructureTree()#
- reloadSettings()#
- removeItem(item)#
- renameItem(item)#
- renameItemDlg(parent)#
- runSanityChecks()#
- settingsApplied(settings)#
- staticMetaObject = <PySide2.QtCore.QMetaObject object>#
- validateText(origText, pathUi)#
- class PrismUtils.ProjectWidgets.DragWidget#
Bases:
QWidget- mouseMoveEvent(self, event: PySide2.QtGui.QMouseEvent) None#
- mousePressEvent(self, event: PySide2.QtGui.QMouseEvent) None#
- staticMetaObject = <PySide2.QtCore.QMetaObject object>#
- class PrismUtils.ProjectWidgets.IngestMediaDlg(core, startText='', entity=None, parent=None)#
Bases:
QDialog- browseFile()#
- browseFolder()#
- clearMedia()#
- connectEvents()#
- createClicked()#
- enableOk()#
- entityMouseClickEvent(event)#
- mediaDragEnterEvent(e)#
- mediaDragLeaveEvent(e)#
- mediaDragMoveEvent(e)#
- mediaDropEvent(e)#
- mediaMouseClickEvent(event)#
- onAovClicked()#
- onDepartmentClicked()#
- onIdentifierClicked()#
- onMediaTypeChanged(idx=None)#
- onTaskClicked()#
- onVersionClicked()#
- openFolder()#
- setEntity(entity)#
- setupUi()#
- sizeHint(self) PySide2.QtCore.QSize#
- staticMetaObject = <PySide2.QtCore.QMetaObject object>#
- class PrismUtils.ProjectWidgets.ManagePresets(parent)#
Bases:
QDialog- addPresetFromFolder()#
- connectEvents()#
- createPreset(path)#
- deletePreset()#
- loadLayout()#
- presetRightClicked(pos)#
- refreshPresets()#
- signalPresetsChanged#
- staticMetaObject = <PySide2.QtCore.QMetaObject object>#
- class PrismUtils.ProjectWidgets.ProjectCreated(prjname, core, basepath)#
Bases:
QDialog- connectEvents()#
- loadLayout()#
- staticMetaObject = <PySide2.QtCore.QMetaObject object>#
- class PrismUtils.ProjectWidgets.SetProject(core, openUi='')#
Bases:
QDialog- loadLayout()#
- resizeEvent(self, arg__1: PySide2.QtGui.QResizeEvent) None#
- staticMetaObject = <PySide2.QtCore.QMetaObject object>#
- class PrismUtils.ProjectWidgets.SetProjectClass(core, pdialog, openUi='', refresh=True)#
Bases:
QDialog- connectEvents()#
- deselectItems(ignore=None)#
- enterEvent(self, event: PySide2.QtCore.QEvent) None#
- getProjectWidgetClass()#
- getProjects()#
- getSelectedItems()#
- itemSelected(item, event=None)#
- loadLayout()#
- openProject(widget)#
- preCreate()#
- refreshUi()#
- resizeEvent(self, arg__1: PySide2.QtGui.QResizeEvent) None#
- showEvent(self, arg__1: PySide2.QtGui.QShowEvent) None#
- signalShowing#
- startupChanged(state)#
- staticMetaObject = <PySide2.QtCore.QMetaObject object>#
- class PrismUtils.ProjectWidgets.VersionSpinBox#
Bases:
QSpinBox- staticMetaObject = <PySide2.QtCore.QMetaObject object>#
- textFromValue(self, val: int) str#
- PrismUtils.ProjectWidgets.movePosition(self, op: PySide2.QtGui.QTextCursor.MoveOperation, arg__2: PySide2.QtGui.QTextCursor.MoveMode = PySide2.QtGui.QTextCursor.MoveMode.MoveAnchor, n: int = 1) bool#
PrismUtils.Projects module#
- class PrismUtils.Projects.Projects(core)#
Bases:
object- class HelpLabel#
Bases:
QLabel- mouseMoveEvent(self, ev: PySide2.QtGui.QMouseEvent) None#
- staticMetaObject = <PySide2.QtCore.QMetaObject object>#
- class ProjectListWidget(origin)#
Bases:
QDialog- deselectItems(ignore=None)#
- focusInEvent(self, event: PySide2.QtGui.QFocusEvent) None#
- focusOutEvent(self, event: PySide2.QtGui.QFocusEvent) None#
- getSelectedItems()#
- getSelectedProject()#
- itemSelected(item, event=None)#
- openProject(widget)#
- preCreate()#
- refreshUi()#
- setupUi()#
- showEvent(self, arg__1: PySide2.QtGui.QShowEvent) None#
- showWidget()#
- signalShowing#
- staticMetaObject = <PySide2.QtCore.QMetaObject object>#
- class ProjectWidget(parent, data, minHeight=200, allowRemove=True, previewScale=1, useWidgetWidth=False)#
Bases:
QWidget- applyStyle(styleType='deselected')#
- browseProjectPreview()#
- captureProjectPreview()#
- deleteRecent()#
- deselect()#
- enterEvent(self, event: PySide2.QtCore.QEvent) None#
- getContextMenu()#
- getDisplayName()#
- getIcon()#
- getPreviewImage(load=True)#
- isSelected()#
- leaveEvent(self, event: PySide2.QtCore.QEvent) None#
- mouseDoubleClickEvent(self, event: PySide2.QtGui.QMouseEvent) None#
- mousePressEvent(self, event: PySide2.QtGui.QMouseEvent) None#
- mouseReleaseEvent(self, event: PySide2.QtGui.QMouseEvent) None#
- onCopyPathClicked()#
- onOpenExplorerClicked()#
- pasteProjectPreviewFromClipboard()#
- refreshUi()#
- resizeEvent(self, event: PySide2.QtGui.QResizeEvent) None#
- rightClicked(pos)#
- select(event=None)#
- setLoadingPreview()#
- setupUi()#
- signalDoubleClicked#
- signalReleased#
- signalRemoved#
- signalSelect#
- sizeHint(self) PySide2.QtCore.QSize#
- staticMetaObject = <PySide2.QtCore.QMetaObject object>#
- updatePreview(load=True)#
- updatePreview_threaded()#
- class RoundedLabel#
Bases:
QLabel- paintEvent(self, arg__1: PySide2.QtGui.QPaintEvent) None#
- staticMetaObject = <PySide2.QtCore.QMetaObject object>#
- addCodePreset(name, code='')#
- addDepartment(entity, name, abbreviation, defaultTasks=None, configData=None)#
- addProjectStructureItem(key, value)#
- addTaskPreset(entity, name, departments=None, configData=None)#
- changeProject(configPath=None, openUi='', settingsTab=None, settingsType=None, unset=False)#
- createPresetFromFolder(name, path)#
- createPresetFromSettings(name, settings, structure, dft=None)#
- createProject(name, path, settings=None, preset='Default', image=None, structure=None, parent=None)#
- createProjectDialog(name=None, path=None, settings=None)#
- createProjectStructure(path, entity)#
- deletePreset(name=None, path=None)#
- ensureProject(openUi='')#
- extractKeysFromPath(path, template, context=None)#
- getAssetDepartments(configData=None)#
- getAssetTaskPresets(configData=None)#
- getAvailableProjects(includeCurrent=False)#
- getCodePresets()#
- getConfigFolder()#
- getDefaultCodePresets()#
- getDefaultLocalPath(projectName=None)#
- getDefaultPipelineFolder()#
- getDefaultProjectSettings()#
- getDefaultProjectStructure()#
- getDftAssetTaskPresets()#
- getDftShotTaskPresets()#
- getFallbackFolder()#
- getFolderStructureFromPath(projectPath, simple=False)#
- getFps()#
- getHookFolder()#
- getMatchingPaths(template)#
- getPipelineFolder(projectPath=None, structure=None)#
- getPluginFolder()#
- getPreset(name=None, path=None)#
- getPresetFolder()#
- getPresetPaths()#
- getPresets()#
- getPrism1ProjectStructure()#
- getProjectDepartments()#
- getProjectFolderFromConfigPath(configPath)#
- getProjectImage(projectPath=None, projectConfig=None, validate=True, structure=None)#
- getProjectResolution()#
- getProjectStructure(projectPath=None, projectStructure=None)#
- getRecentProjects(includeCurrent=False)#
- getResolutionPresets()#
- getResolvedProjectStructurePath(key, context=None, structure=None, fallback=None)#
- getResolvedProjectStructurePaths(key, context=None, structure=None, fallback=None)#
- getRootPresetPath()#
- getShotDepartments(configData=None)#
- getShotTaskPresets(configData=None)#
- getStructureValues(structure)#
- getTemplateKeys(template)#
- getTemplatePath(key, default=False)#
- getTemplatesFromExpression(expression, context=None)#
- getUseLocalFiles(projectConfig=None)#
- getUserPresetPath()#
- hasActiveProject()#
- isPrism1Project(path)#
- openProject(parent=None)#
- openProjectSettings(tab=0, restart=False, reload_module=False, config=None, projectData=None)#
- refreshLocalFiles()#
- refreshProjectEnvironment()#
- removeCodePreset(name)#
- resolveStructurePath(path, context=None, structure=None, addProjectPath=True, fillContextKeys=True, fallback=None)#
- resolveStructurePiece(key, structure, context, fillContextKeys=True, fallback=None)#
- saveProjectImage(projectPath=None, projectConfig=None, image=None)#
- setCodePresets(presets)#
- setDepartments(entity, departments, configData=None)#
- setPrism1Compatibility(state)#
- setProject(startup=None, openUi='')#
- setRecentPrj(path, action='add')#
- setTaskPresets(entity, presets, configData=None)#
- setTemplatePath(key, value)#
- unloadProjectEnvironment(beforeRefresh=False)#
- validateExpression(expression)#
- validateFolderKey(path, item)#
- validateFolderStructure(structure)#
- validateProjectPresetConfig(presetPath, configPath, dft=None)#
- PrismUtils.Projects.movePosition(self, op: PySide2.QtGui.QTextCursor.MoveOperation, arg__2: PySide2.QtGui.QTextCursor.MoveMode = PySide2.QtGui.QTextCursor.MoveMode.MoveAnchor, n: int = 1) bool#
PrismUtils.SanityChecks module#
- class PrismUtils.SanityChecks.SanityChecks(core)#
Bases:
object- checkAppVersion()#
- checkFPS()#
- checkFramerange()#
- checkImportVersions()#
- checkResolution()#
- checkRestartRequired(quiet=False)#
- onCheckFpsClicked(button, projectFps)#
- onCheckFramerangeClicked(button, shotRange, handleRange=None)#
- onCheckResolutionClicked(button, projectResolution)#
- onImportVersionsClicked(button)#
- runChecks(category, quiet=False)#
- PrismUtils.SanityChecks.movePosition(self, op: PySide2.QtGui.QTextCursor.MoveOperation, arg__2: PySide2.QtGui.QTextCursor.MoveMode = PySide2.QtGui.QTextCursor.MoveMode.MoveAnchor, n: int = 1) bool#
PrismUtils.ScreenShot module#
- class PrismUtils.ScreenShot.ScreenShot(core)#
Bases:
QDialog- mouseMoveEvent(self, event: PySide2.QtGui.QMouseEvent) None#
- mousePressEvent(self, event: PySide2.QtGui.QMouseEvent) None#
- mouseReleaseEvent(self, event: PySide2.QtGui.QMouseEvent) None#
- paintEvent(self, event: PySide2.QtGui.QPaintEvent) None#
- staticMetaObject = <PySide2.QtCore.QMetaObject object>#
- PrismUtils.ScreenShot.grabScreenArea(core)#
- PrismUtils.ScreenShot.movePosition(self, op: PySide2.QtGui.QTextCursor.MoveOperation, arg__2: PySide2.QtGui.QTextCursor.MoveMode = PySide2.QtGui.QTextCursor.MoveMode.MoveAnchor, n: int = 1) bool#
PrismUtils.Users module#
- class PrismUtils.Users.ChangeUser(core)#
Bases:
QDialog,Ui_dlg_ChangeUser- connectEvents()#
- enterEvent(self, event: PySide2.QtCore.QEvent) None#
- loadUi()#
- setNames()#
- setUser()#
- staticMetaObject = <PySide2.QtCore.QMetaObject object>#
- validate(editfield=None)#
- class PrismUtils.Users.HelpLabel(parent)#
Bases:
QLabel- enterEvent(self, event: PySide2.QtCore.QEvent) None#
- mouseMoveEvent(self, ev: PySide2.QtGui.QMouseEvent) None#
- signalEntered#
- staticMetaObject = <PySide2.QtCore.QMetaObject object>#
- class PrismUtils.Users.Users(core)#
Bases:
object- changeUser()#
- ensureUser()#
- getDefaultUsername()#
- getUser()#
- getUserAbbreviation(userName=None, fromConfig=True)#
- getUserEnvironmentVariables()#
- isAbbreviationReadOnly()#
- isUserReadOnly()#
- refreshEnvironment()#
- setAbbreviationReadOnly(readOnly)#
- setUser(username, setAbbreviation=True, abbreviation=None, force=False)#
- setUserAbbreviation(abbreviation, force=False)#
- setUserEnvironmentVariable(key, value)#
- setUserReadOnly(readOnly)#
- validateUser()#
- PrismUtils.Users.movePosition(self, op: PySide2.QtGui.QTextCursor.MoveOperation, arg__2: PySide2.QtGui.QTextCursor.MoveMode = PySide2.QtGui.QTextCursor.MoveMode.MoveAnchor, n: int = 1) bool#