GafferThree

Module defining an API for working with GafferThree nodes and package classes.

GafferThreeAPI.RegisterPackageClass(packageClass)

Registers a new package class for the GafferThree SuperTool.

Parameters:packageClass (type) – The package class to be registered.
GafferThreeAPI.RegisterDeprecatedPackageClass(deprecatedPackageClassName, packageClass)

Registers a package class identified by the given name which previously existed for the GafferThree SuperTool as deprecated, marking it as having been replaced by the given package class.

When attempting to create a package using the given deprecated package class name, a deprecation warning will be logged, and a package of the given new package class will be created instead.

Parameters:
  • deprecatedPackageClassName (str) – The name of the package class that was deprecated.
  • packageClass (type) – The package class that replaced the deprecated package class.
Since:

Katana 4.0v1
GafferThreeAPI.GetSceneGraphViewTerminalOps(graphState, rootLocations)
Return type:

tuple of tuple of ((str, FnAttribute.GroupAttribute) or (str, FnAttribute.GroupAttribute, str))
Parameters:
  • graphState (NodegraphAPI.GraphState) – The graph state to be queried for the “system” Op arguments, for the Ops that need it.
  • rootLocations (tuple of str) – The top-level locations for the given SceneGraphView.
Returns:

A tuple with a description of a chain of Ops, each in the form of a tuple of Op type name as a string and Op arguments as a FnAttribute.GroupAttribute and a key for the Ops that may need to be updated with new arguments in the future.
GafferThreeAPI.GetSceneGraphViewTerminalOpUpdates(graphState, rootLocations)
Return type:

tuple of tuple of (str, FnAttribute.GroupAttribute, str)
Parameters:
  • graphState (NodegraphAPI.GraphState) – The graph state to be queried for the “system” Op arguments, for the Ops that need it.
  • rootLocations (tuple of str) – The top-level locations for the given SceneGraphView.
Returns:

A tuple with a description of a chain of Ops whose arguments are to be updated, each in the form of a tuple of Op type name as a string, Op arguments as a FnAttribute.GroupAttribute and a key indicating which Op to update.
GafferThreeAPI.RegisterSceneGraphViewSetupCallback(callback)

Registers the given callback to be called when the SceneGraphView of an edited GafferThree node is being configured for editing in the Parameters tab.

The callback is expected to define the following parameters:

  • objectHash – the hash of the edited GafferThree node
  • node – the edited GafferThree node
  • editor – the node editor widget that contains the SceneGraphView
  • sceneGraphView – the SceneGraphView that is being configured
Parameters:callback (callable) – The setup callback to register.
Since:Katana 4.5v1
GafferThreeAPI.RegisterTabWidgetSetupCallback(callback)

Registers the given callback to be called when the QTabWidget of an edited GafferThree node is being configured for editing in the Parameters tab.

The callback is expected to define the following parameters:

  • objectHash – the hash of the edited GafferThree node
  • node – the edited GafferThree node
  • editor – the node editor widget that contains the QTabWidget
  • tabWidget – the QTabWidget that is being configured
Parameters:callback (callable) – The setup callback to register.
Since:Katana 4.5v1