PackageSuperToolAPI

This page and subpages provide an API reference for the PackageSuperToolAPI Python package. See How To Write a Package SuperTool for more information.

Top-level Functions

PackageSuperToolAPI.IsUIMode()

Return type:

bool

Returns:

True if Katana is running in UI mode, otherwise False if Katana is running in batch/script/shell (headless) mode.

Modules

• Base Node
  • BaseNode
    • BaseNode.VERSION
    • BaseNode.__init__()
    • BaseNode.adoptLocationForEditing()
    • BaseNode.adoptLocationsForEditing()
    • BaseNode.canAdoptLocationForEditing()
    • BaseNode.canAdoptLocationsForEditing()
    • BaseNode.getAPIVersion()
    • BaseNode.getDefaultRootLocation()
    • BaseNode.getItemListAttributeName()
    • BaseNode.getLocationAttributes()
    • BaseNode.getPackageForPath()
    • BaseNode.getRegisteredDisplayPackageClasses()
    • BaseNode.getRegisteredPackageClasses()
    • BaseNode.getRootLocation()
    • BaseNode.getRootPackage()
    • BaseNode.getShowIncomingScene()
    • BaseNode.getSuperToolName()
    • BaseNode.getSyncSelection()
    • BaseNode.getVersion()
    • BaseNode.isLocationAdopted()
    • BaseNode.setRootLocation()
    • BaseNode.setShowIncomingScene()
    • BaseNode.setSyncSelection()
    • BaseNode.setVersion()
    • BaseNode.superToolRegistered()
    • BaseNode.upgrade()
  • RegisterTagAdoptedNodeType()
• Base Editor
  • BaseEditor
    • BaseEditor.AddPackageRegistry
    • BaseEditor.PackageMenuActionsRegistry
    • BaseEditor.SEPARATOR
    • BaseEditor.TAB_AREA_UPDATE_INTERVAL
    • BaseEditor.__init__()
    • BaseEditor.addTab()
    • BaseEditor.canSelectionBeExported()
    • BaseEditor.getAddPackageMenuActions()
    • BaseEditor.getAttribute()
    • BaseEditor.getChildrenUnder()
    • BaseEditor.getDefaultAddMenuGroupName()
    • BaseEditor.getDefaultSceneGraphViewTerminalOpUpdates()
    • BaseEditor.getDefaultSceneGraphViewTerminalOps()
    • BaseEditor.getKeyboardShortcuts()
    • BaseEditor.getLayoutOrientation()
    • BaseEditor.getMainNode()
    • BaseEditor.getMainPanelWidget()
    • BaseEditor.getMenuActions()
    • BaseEditor.getPackageForPath()
    • BaseEditor.getSceneGraphView()
    • BaseEditor.getSceneGraphViewTerminalOpUpdates()
    • BaseEditor.getSceneGraphViewTerminalOps()
    • BaseEditor.getSelectedItems()
    • BaseEditor.getSelectedPackages()
    • BaseEditor.getSuperToolName()
    • BaseEditor.getTabNames()
    • BaseEditor.getTabWidget()
    • BaseEditor.getTopLevelPackage()
    • BaseEditor.hideEvent()
    • BaseEditor.onSelectionChanged()
    • BaseEditor.populateContextMenu()
    • BaseEditor.registerAddPackageKeyboardShortcut()
    • BaseEditor.registerKeyboardShortcuts()
    • BaseEditor.registerPackageKeyboardShortcuts()
    • BaseEditor.removeTab()
    • BaseEditor.setColumnToUpdateOnStateChange()
    • BaseEditor.setupSceneGraphViewColumns()
    • BaseEditor.setupTabWidget()
    • BaseEditor.showEvent()
    • BaseEditor.staticMetaObject
  • GafferThreeInteractionDelegate
    • GafferThreeInteractionDelegate.addToNodeSpecificShelfEnvironment()
• Packages
  • Packages
    • Package
      • Package.__init__()
      • Package.adoptPackage()
      • Package.canAdoptPackage()
      • Package.canBeAdoptedByPackage()
      • Package.canBeCreatedByPackageClass()
      • Package.canBeDeleted()
      • Package.canBeDuplicated()
      • Package.canBeRenamed()
      • Package.canCreateChildPackage()
      • Package.canCreatePackageClass()
      • Package.canDuplicate()
      • Package.canReorderChildPackage()
      • Package.create()
      • Package.createChildPackage()
      • Package.createPackage()
      • Package.createPackageGroupNode()
      • Package.createPostMergeStackNode()
      • Package.createStandardPackageNodes()
      • Package.delete()
      • Package.duplicate()
      • Package.getAdoptableLocationTypes()
      • Package.getChildPackage()
      • Package.getChildPackages()
      • Package.getCreateNode()
      • Package.getEditPackageClass()
      • Package.getExtraNodeDependencies()
      • Package.getLocationPath()
      • Package.getMainNode()
      • Package.getMainNodeFromNode()
      • Package.getName()
      • Package.getOrCreateNodeByType()
      • Package.getOverrideNodeAndParameter()
      • Package.getPackageClassFromNode()
      • Package.getPackageFromNode()
      • Package.getPackageNode()
      • Package.getParentPackage()
      • Package.getPostMergePackageStack()
      • Package.initializeExtraNodeDependencies()
      • Package.isNodeOfType()
      • Package.reorderChildPackage()
      • Package.setEditPackageClass()
      • Package.setName()
      • Package.supportsLocking()
      • Package.walkUpPackageHierarchy()
    • EditPackage
      • EditPackage.canBeAdoptedByPackage()
      • EditPackage.canBeCreatedByPackageClass()
      • EditPackage.canBeRenamed()
      • EditPackage.canCreatePackageClass()
      • EditPackage.create()
      • EditPackage.createPackage()
      • EditPackage.createPackageEditStackNode()
      • EditPackage.delete()
    • GroupPackage
      • GroupPackage.DEFAULT_NAME
      • GroupPackage.DISPLAY_ICON
      • GroupPackage.create()
      • GroupPackage.createStandardPackageNodes()
      • GroupPackage.getChildPackages()
      • GroupPackage.getExtraNodeDependencies()
      • GroupPackage.initializeExtraNodeDependencies()
    • GroupEditPackage
      • GroupEditPackage.childRemoved()
      • GroupEditPackage.create()
      • GroupEditPackage.getChildPackageCreateNode()
      • GroupEditPackage.getChildPackages()
    • DummyGroupPackage
      • DummyGroupPackage.DEFAULT_NAME
      • DummyGroupPackage.DISPLAY_ICON
      • DummyGroupPackage.__init__()
      • DummyGroupPackage.canAdoptPackage()
      • DummyGroupPackage.canCreateChildPackage()
      • DummyGroupPackage.childRemoved()
      • DummyGroupPackage.create()
      • DummyGroupPackage.createChildPackage()
      • DummyGroupPackage.createForLocation()
      • DummyGroupPackage.createParentPackageHierarchy()
      • DummyGroupPackage.delete()
      • DummyGroupPackage.getChildPackageCreateNode()
      • DummyGroupPackage.getChildPackages()
      • DummyGroupPackage.getLocationPath()
      • DummyGroupPackage.getMainNode()
      • DummyGroupPackage.getParentPackage()
    • RootPackage
      • RootPackage.__init__()
      • RootPackage.canBeDeleted()
      • RootPackage.canBeRenamed()
      • RootPackage.canCreatePackageClass()
      • RootPackage.create()
      • RootPackage.delete()
      • RootPackage.setName()
  • Mix-ins
    • Mixin
    • CallbackMixin
      • CallbackMixin.executeCreationCallback()
      • CallbackMixin.onSceneGraphViewShaderSelected()
      • CallbackMixin.registerCallbacks()
    • DisableableMixin
      • DisableableMixin.isDisabled()
      • DisableableMixin.isDisabledByParents()
      • DisableableMixin.setDisabled()
    • GroupMixin
      • GroupMixin.adoptPackage()
      • GroupMixin.canAdoptPackage()
      • GroupMixin.canCreateChildPackage()
      • GroupMixin.canReorderChildPackage()
      • GroupMixin.childRemoved()
      • GroupMixin.createChildPackage()
      • GroupMixin.getChildPackage()
      • GroupMixin.getChildPackageCreateNode()
      • GroupMixin.getChildPackages()
      • GroupMixin.getLocationTypes()
      • GroupMixin.reorderChildPackage()
    • LinkingMixin
      • LinkingMixin.LINKING_ILLUMINATION_EFFECT
      • LinkingMixin.LINKING_ILLUMINATION_NODE_NAME
      • LinkingMixin.LINKING_ILLUMINATION_NODE_REF
      • LinkingMixin.LINKING_SHADOW_EFFECT
      • LinkingMixin.LINKING_SHADOW_NODE_NAME
      • LinkingMixin.LINKING_SHADOW_NODE_REF
      • LinkingMixin.getIlluminationLinkingNode()
      • LinkingMixin.getLinkingNodes()
      • LinkingMixin.getShadowLinkingNode()
    • LockingMixin
      • LockingMixin.isLocked()
      • LockingMixin.setLocked()
    • LookFileReferenceEditMixin
      • LookFileReferenceEditMixin.getLookFileMaterial()
      • LookFileReferenceEditMixin.isLookFileMaterialActive()
      • LookFileReferenceEditMixin.setLookFileMaterial()
      • LookFileReferenceEditMixin.setLookFileMaterialActive()
    • MaterialMixin
      • MaterialMixin.getLookFileMaterial()
      • MaterialMixin.getShader()
      • MaterialMixin.isLookFileMaterialActive()
      • MaterialMixin.isUsingLookFileMaterial()
      • MaterialMixin.setIsUsingLookFileMaterial()
      • MaterialMixin.setLookFileMaterial()
      • MaterialMixin.setLookFileMaterialActive()
      • MaterialMixin.setShader()
    • MuteAndSoloMixin
      • MuteAndSoloMixin.MUTEANDSOLO_NODE_REFERENCE
      • MuteAndSoloMixin.NODE_NAME
      • MuteAndSoloMixin.SOLOLISTEDIT_NODE_REFERENCE
      • MuteAndSoloMixin.delete()
      • MuteAndSoloMixin.getExtraNodeDependencies()
      • MuteAndSoloMixin.getMuteSoloAndSoloListEditNode()
      • MuteAndSoloMixin.getOverrideNodeAndParameter()
      • MuteAndSoloMixin.initializeExtraNodeDependencies()
      • MuteAndSoloMixin.isMuteOverrideEnabled()
      • MuteAndSoloMixin.isMuted()
      • MuteAndSoloMixin.isSoloOverrideEnabled()
      • MuteAndSoloMixin.isSoloed()
      • MuteAndSoloMixin.setMuted()
      • MuteAndSoloMixin.setSoloed()
    • MuteAndSoloEditMixin
      • MuteAndSoloEditMixin.delete()
      • MuteAndSoloEditMixin.setMuted()
      • MuteAndSoloEditMixin.setSoloed()
  • Module Functions
    • GetPackageClass()
    • GetPackageClassAndPackageName()
    • GetPackageClassForGroupLocationType()
    • GetRegisteredDisplayPackageClasses()
    • GetRegisteredPackageClasses()
    • IsLocationTypeAdoptable()
    • RegisterPackage()
    • RegisterPackageClass()
• Node Utilities
  • AddNodeRef()
  • AddPackageTypeAndPath()
  • AppendNode()
  • AppendNodes()
  • DeleteDeepParameter()
  • GetDownstreamNodes()
  • GetDownstreamPorts()
  • GetEditPackageForLocationPath()
  • GetEditPackageLocationPaths()
  • GetEditPackages()
  • GetPackageLocationParameterPath()
  • GetPackageTypeParameterPath()
  • GetRefNode()
  • GetSceneGraphPathExpression()
  • GetSuperToolGroupName()
  • GetUpstreamPort()
  • IsNodeGuardedFromDeletion()
  • NodeDeletionGuard()
  • PositionMergeInputs()
  • PrependNode()
  • RemoveNodeRef()
  • SetOrCreateDeepArrayParameter()
  • SetOrCreateDeepScalarParameter()
  • SetOrCreateDeepVectorParameter()
  • SetPackageNodeName()
  • TransferNodeConnections()
  • UpdateChildPackagePaths()
  • UpdateEditPackagePaths()
  • WireInlineNodes()