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.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.