Customizing Node TypesΒΆ
- Basics
- GafferThree
- Importomatic
AssetModuleAssetModule.DeprecatedAssetModule.RegisterType()AssetModule.GetAllRegisteredHandlers()AssetModule.GetAssetType()AssetModule.SetAssetType()AssetModule.GetCustomAssetName()AssetModule.SetCustomAssetName()AssetModule.GetHandlerForType()AssetModule.GetHandlerForNode()AssetModule.GetTypeNames()AssetModule.RegisterCreateCallback()AssetModule.RegisterBatchCreateCallback()AssetModule.GetCreateCallbackNames()AssetModule.IsCreateCallbackDeprecated()AssetModule.TriggerCreateCallback()AssetModule.TriggerPostCreateCallback()AssetModule.TriggerBatchCreateCallback()AssetModule.HasBatchCreateCallback()AssetModule.RegisterUtilCallback()AssetModule.GetUtilCallbackNames()AssetModule.setItemState()AssetModule.getEditor()AssetModule.addToContextMenu()AssetModule.getPrimarySpref()AssetModule.setPrimarySprefVersion()AssetModule.getSecondarySprefList()AssetModule.setSecondarySprefVersion()AssetModule.setSecondaryItemState()AssetModule.freeze()AssetModule.thaw()AssetModule.getAssetTreeRoot()
AssetTreeChildAssetTreeChild.setItemState()AssetTreeChild.isSelectable()AssetTreeChild.isDraggable()AssetTreeChild.getAssetId()AssetTreeChild.setAssetId()AssetTreeChild.isVersionSettable()AssetTreeChild.getChildren()AssetTreeChild.acceptsDrop()AssetTreeChild.acceptDrop()AssetTreeChild.getEditor()AssetTreeChild.getItemKey()AssetTreeChild.isIgnorable()AssetTreeChild.isIgnored()AssetTreeChild.setIgnored()AssetTreeChild.isDeletable()AssetTreeChild.delete()AssetTreeChild.canDuplicate()AssetTreeChild.duplicateItem()AssetTreeChild.addToContextMenu()AssetTreeChild.addNodeObservers()AssetTreeChild.getDefaultOpenState()AssetTreeChild.getCustomVersionTagNames()
- Look-File-Baking Nodes
- LookFileBaking
BakingContext()GetBakeState()GetGlobalBakeState()PreLookFileBake()PostLookFileBake()PreLookFileBakeHandlerPostLookFileBakeHandlerPreLookFileMaterialsOut()PostLookFileMaterialsOut()PreLookFileMaterialsOutHandlerPostLookFileMaterialsOutHandlerValidateGraphState()GetLookFileBakeOp()GetLookFileBakeOps()GetLocationIntervalEvictor()
- LookFileBaking
- Custom Node Types
NodeTypeBuilderNodeTypeBuilderNodeTypeBuilder.SetGenericAssignPolicyRegistrationCallback()NodeTypeBuilder.__init__()NodeTypeBuilder.setNodeTypeVersion()NodeTypeBuilder.setNodeTypeVersionUpdateFnc()NodeTypeBuilder.setInputPortNames()NodeTypeBuilder.setOutputPortNames()NodeTypeBuilder.setParametersTemplateAttr()NodeTypeBuilder.setGenericAssignRoots()NodeTypeBuilder.setBuildParametersFnc()NodeTypeBuilder.setHintsForParameter()NodeTypeBuilder.setHintsForNode()NodeTypeBuilder.addTimingParameters()NodeTypeBuilder.addTransformParameters()NodeTypeBuilder.addInteractiveTransformCallbacks()NodeTypeBuilder.addMakeInteractiveParameter()NodeTypeBuilder.setBuildOpChainFnc()NodeTypeBuilder.setAppendToParametersOpChainFnc()NodeTypeBuilder.setGetScenegraphLocationFnc()NodeTypeBuilder.setGetInputPortAndGraphStateFnc()NodeTypeBuilder.setAddParameterHintsFnc()NodeTypeBuilder.setCustomMethod()NodeTypeBuilder.setIsHiddenFromMenus()NodeTypeBuilder.build()NodeTypeBuilder.OpChainInterfaceNodeTypeBuilder.OpChainInterface.FAILNodeTypeBuilder.OpChainInterface.NO_OPNodeTypeBuilder.OpChainInterface.SKIPNodeTypeBuilder.OpChainInterface.__init__()NodeTypeBuilder.OpChainInterface.addInputRequest()NodeTypeBuilder.OpChainInterface.addRequiredInput()NodeTypeBuilder.OpChainInterface.appendOp()NodeTypeBuilder.OpChainInterface.setExplicitInputRequestsEnabled()NodeTypeBuilder.OpChainInterface.setExplicitInputRequirementsEnabled()NodeTypeBuilder.OpChainInterface.setMinRequiredInputs()
- Op Chain Interfaces
BaseOpChainInterfaceBaseOpChainInterface.__init__()BaseOpChainInterface.getOutputPortName()BaseOpChainInterface.getGraphState()BaseOpChainInterface.getFrameTime()BaseOpChainInterface.getNumSamples()BaseOpChainInterface.getShutterOpen()BaseOpChainInterface.getShutterClose()BaseOpChainInterface.getModifiedFrameTime()BaseOpChainInterface.addOpSystemArgs()BaseOpChainInterface.buildAttrFromParam()BaseOpChainInterface.buildAttrListForEnableableParameters()BaseOpChainInterface.getTransformAsAttribute()BaseOpChainInterface.getExclusiveToNameAndAttribute()
OpChainInterfaceOpChainInterface.__init__()OpChainInterface.appendOp()OpChainInterface.setMinRequiredInputs()OpChainInterface.setExplicitInputRequestsEnabled()OpChainInterface.setExplicitInputRequirementsEnabled()OpChainInterface.FAILOpChainInterface.SKIPOpChainInterface.NO_OPOpChainInterface.addInputRequest()OpChainInterface.addRequiredInput()
ParametersOpChainInterface
- Migration Guide: Modifying Graph State
- Supporting Local Graph State in Parameter Evaluation
PackageSuperToolAPI- Base Node
BaseNodeBaseNode.VERSIONBaseNode.__init__()BaseNode.getSuperToolName()BaseNode.getDefaultRootLocation()BaseNode.getItemListAttributeName()BaseNode.upgrade()BaseNode.getVersion()BaseNode.setVersion()BaseNode.getAPIVersion()BaseNode.getRootLocation()BaseNode.setRootLocation()BaseNode.getShowIncomingScene()BaseNode.setShowIncomingScene()BaseNode.getSyncSelection()BaseNode.setSyncSelection()BaseNode.getRegisteredPackageClasses()BaseNode.getRegisteredDisplayPackageClasses()BaseNode.getRootPackage()BaseNode.getPackageForPath()BaseNode.isLocationAdopted()BaseNode.canAdoptLocationForEditing()BaseNode.canAdoptLocationsForEditing()BaseNode.adoptLocationForEditing()BaseNode.adoptLocationsForEditing()BaseNode.getLocationAttributes()BaseNode.superToolRegistered()
RegisterTagAdoptedNodeType()
- Base Editor
BaseEditorBaseEditor.TAB_AREA_UPDATE_INTERVALBaseEditor.SEPARATORBaseEditor.AddPackageRegistryBaseEditor.PackageMenuActionsRegistryBaseEditor.__init__()BaseEditor.registerKeyboardShortcuts()BaseEditor.registerAddPackageKeyboardShortcut()BaseEditor.registerPackageKeyboardShortcuts()BaseEditor.getDefaultSceneGraphViewTerminalOps()BaseEditor.getDefaultSceneGraphViewTerminalOpUpdates()BaseEditor.getSuperToolName()BaseEditor.getTabNames()BaseEditor.getLayoutOrientation()BaseEditor.getKeyboardShortcuts()BaseEditor.getSceneGraphViewTerminalOps()BaseEditor.getSceneGraphViewTerminalOpUpdates()BaseEditor.setupSceneGraphViewColumns()BaseEditor.setupTabWidget()BaseEditor.getDefaultAddMenuGroupName()BaseEditor.getAddPackageMenuActions()BaseEditor.getMenuActions()BaseEditor.onSelectionChanged()BaseEditor.setColumnToUpdateOnStateChange()BaseEditor.getMainNode()BaseEditor.getSceneGraphView()BaseEditor.getTabWidget()BaseEditor.getMainPanelWidget()BaseEditor.getSelectedItems()BaseEditor.getAttribute()BaseEditor.getPackageForPath()BaseEditor.getSelectedPackages()BaseEditor.getTopLevelPackage()BaseEditor.canSelectionBeExported()BaseEditor.populateContextMenu()BaseEditor.addTab()BaseEditor.removeTab()BaseEditor.getChildrenUnder()BaseEditor.showEvent()BaseEditor.hideEvent()
GafferThreeInteractionDelegate
- Packages
- Packages
PackagePackage.__init__()Package.create()Package.getAdoptableLocationTypes()Package.setEditPackageClass()Package.getEditPackageClass()Package.createPackageGroupNode()Package.createStandardPackageNodes()Package.createPackage()Package.getMainNodeFromNode()Package.getPackageFromNode()Package.getPackageClassFromNode()Package.walkUpPackageHierarchy()Package.canCreateChildPackage()Package.canCreatePackageClass()Package.canBeCreatedByPackageClass()Package.getOverrideNodeAndParameter()Package.getOrCreateNodeByType()Package.isNodeOfType()Package.getCreateNode()Package.createChildPackage()Package.canReorderChildPackage()Package.reorderChildPackage()Package.canAdoptPackage()Package.canBeAdoptedByPackage()Package.supportsLocking()Package.adoptPackage()Package.getChildPackage()Package.getChildPackages()Package.getPackageNode()Package.getMainNode()Package.getLocationPath()Package.getName()Package.setName()Package.createPostMergeStackNode()Package.delete()Package.canDuplicate()Package.canBeDuplicated()Package.canBeRenamed()Package.canBeDeleted()Package.getExtraNodeDependencies()Package.initializeExtraNodeDependencies()Package.duplicate()Package.getParentPackage()Package.getPostMergePackageStack()
EditPackageGroupPackageGroupEditPackageDummyGroupPackageDummyGroupPackage.DEFAULT_NAMEDummyGroupPackage.DISPLAY_ICONDummyGroupPackage.__init__()DummyGroupPackage.create()DummyGroupPackage.createForLocation()DummyGroupPackage.getLocationPath()DummyGroupPackage.getMainNode()DummyGroupPackage.canAdoptPackage()DummyGroupPackage.canCreateChildPackage()DummyGroupPackage.getChildPackages()DummyGroupPackage.createChildPackage()DummyGroupPackage.getChildPackageCreateNode()DummyGroupPackage.createParentPackageHierarchy()DummyGroupPackage.getParentPackage()DummyGroupPackage.delete()DummyGroupPackage.childRemoved()
RootPackage
- Mix-ins
MixinCallbackMixinDisableableMixinGroupMixinGroupMixin.getLocationTypes()GroupMixin.canCreateChildPackage()GroupMixin.getChildPackage()GroupMixin.getChildPackages()GroupMixin.createChildPackage()GroupMixin.getChildPackageCreateNode()GroupMixin.childRemoved()GroupMixin.canAdoptPackage()GroupMixin.adoptPackage()GroupMixin.canReorderChildPackage()GroupMixin.reorderChildPackage()
LinkingMixinLinkingMixin.LINKING_ILLUMINATION_NODE_NAMELinkingMixin.LINKING_SHADOW_NODE_NAMELinkingMixin.LINKING_ILLUMINATION_NODE_REFLinkingMixin.LINKING_SHADOW_NODE_REFLinkingMixin.LINKING_ILLUMINATION_EFFECTLinkingMixin.LINKING_SHADOW_EFFECTLinkingMixin.getLinkingNodes()LinkingMixin.getIlluminationLinkingNode()LinkingMixin.getShadowLinkingNode()
LockingMixinLookFileReferenceEditMixinMaterialMixinMuteAndSoloMixinMuteAndSoloMixin.MUTEANDSOLO_NODE_REFERENCEMuteAndSoloMixin.SOLOLISTEDIT_NODE_REFERENCEMuteAndSoloMixin.NODE_NAMEMuteAndSoloMixin.getOverrideNodeAndParameter()MuteAndSoloMixin.isMuted()MuteAndSoloMixin.isMuteOverrideEnabled()MuteAndSoloMixin.isSoloed()MuteAndSoloMixin.isSoloOverrideEnabled()MuteAndSoloMixin.setMuted()MuteAndSoloMixin.setSoloed()MuteAndSoloMixin.delete()MuteAndSoloMixin.getExtraNodeDependencies()MuteAndSoloMixin.initializeExtraNodeDependencies()MuteAndSoloMixin.getMuteSoloAndSoloListEditNode()
MuteAndSoloEditMixin
- Module Functions
- Packages
- Node Utilities
PrependNode()AppendNode()GetDownstreamNodes()AddNodeRef()GetRefNode()RemoveNodeRef()SetOrCreateDeepScalarParameter()SetOrCreateDeepArrayParameter()SetOrCreateDeepVectorParameter()DeleteDeepParameter()NodeDeletionGuard()IsNodeGuardedFromDeletion()GetSuperToolGroupName()GetPackageTypeParameterPath()GetPackageLocationParameterPath()GetSceneGraphPathExpression()AddPackageTypeAndPath()SetPackageNodeName()GetEditPackages()GetEditPackageLocationPaths()GetEditPackageForLocationPath()WireInlineNodes()AppendNodes()PositionMergeInputs()UpdateChildPackagePaths()UpdateEditPackagePaths()TransferNodeConnections()GetUpstreamPort()GetDownstreamPorts()
- Base Node
- SuperTools
- NodesUsdAPI