Scene Graph View¶

SceneGraphView¶

Module providing the SceneGraphView class which provides a view of the scene graph generated by Geolib3 from an arbitrary node.

You can find a complete set of examples using the SceneGraphView widget in $KATANA_ROOT/plugins/Resources/Examples/Tabs/PrototypeSceneGraphTab.py

Bridge¶

Module containing the Bridge abstract base class.

class UI4.Widgets.SceneGraphView.Bridge.Bridge¶

Bases: object

Abstract base class that represents the functions exposed by the Bridge to allow users to configure and interrogate the information stored about the scene graph.

__abstractmethods__ = frozenset(['getTitleText', 'addColumnSet', 'updateViewLink', 'getCurrentRules', 'setLocationNamesPolished', 'setTopLevelLocations', 'setRuleEvaluator', 'matchRules', 'isStopping', 'getColumnByName', 'getNumberOfChildren', 'setRuleShowChildren', 'addRule', 'getNumberOfTopLevelLocations', 'renameRule', 'setLocationAddedOrUpdatedCallback', 'getColumnByIndex', 'setLocationRemovedCallback', 'thaw', 'setRuleEnabled', 'getTopLevelDisplayIndex', 'fontChanged', 'getRuleByName', 'setUpdateViewportAutomatically', 'setRuleComment', 'setTerminalOps', 'getColumnPresetManager', 'setLocationNamePolishCallback', 'getParent', 'getOverrideNodeAndParameterName', 'setRuleMatchInversion', 'addAttributeDataItemType', 'getTopLevelLocations', 'setViewNode', 'addColumn', 'topLevelLocationRenamed', 'isEditable', 'setRuleTarget', 'freeze', 'setStopRecursiveExpandAttributeNames', 'setRuleMatchPolicy', 'setStopRecursiveExpandLocationTypes', 'isProcessing', 'getSceneGraphChildren', 'endColumnConfiguration', 'setLocationActive', 'addTopLevelLocation', 'removeTopLevelLocation', 'getNumberOfColumns', 'clearTopLevelLocations', 'isFrozen', 'removeRule', 'beginColumnConfiguration', 'getViewLink', 'locationNamesPolished', 'getColumnDataType', 'setMaxEventsToProcess', 'setLocationDataProcessedCallback', 'getRootColumnSet', 'expandLocation', 'isNameColumn', 'getAttributeDataItemTypes', 'setRuleCriteria', 'getPotentialChildren', 'getSceneGraphAttributes', 'getResolvedAttributeName', 'collapseLocation', 'setViewOp', 'getDisplayData', 'setTopLevelDisplayIndex', 'resetAttributeDataItemTypes', 'interruptClientProcessing', 'getRuleMatchInversion', 'clearRuleCriteria', 'setRuleInverted', 'setKeyPressEventCallback'])¶

__dict__ = dict_proxy({'getColumnVisibilitySettings': <function getColumnVisibilitySettings at 0x7f0dfb32b938>, '__abstractmethods__': frozenset(['getTitleText', 'addColumnSet', 'updateViewLink', 'getCurrentRules', 'setLocationNamesPolished', 'setTopLevelLocations', 'setRuleEvaluator', 'matchRules', 'isStopping', 'getColumnByName', 'getNumberOfChildren', 'setRuleShowChildren', 'addRule', 'getNumberOfTopLevelLocations', 'renameRule', 'setLocationAddedOrUpdatedCallback', 'getColumnByIndex', 'setLocationRemovedCallback', 'thaw', 'setRuleEnabled', 'getTopLevelDisplayIndex', 'fontChanged', 'getRuleByName', 'setUpdateViewportAutomatically', 'setRuleComment', 'setTerminalOps', 'getColumnPresetManager', 'setLocationNamePolishCallback', 'getParent', 'getOverrideNodeAndParameterName', 'setRuleMatchInversion', 'addAttributeDataItemType', 'getTopLevelLocations', 'setViewNode', 'addColumn', 'topLevelLocationRenamed', 'isEditable', 'setRuleTarget', 'freeze', 'setStopRecursiveExpandAttributeNames', 'setRuleMatchPolicy', 'setStopRecursiveExpandLocationTypes', 'isProcessing', 'getSceneGraphChildren', 'endColumnConfiguration', 'setLocationActive', 'addTopLevelLocation', 'removeTopLevelLocation', 'getNumberOfColumns', 'clearTopLevelLocations', 'isFrozen', 'removeRule', 'beginColumnConfiguration', 'getViewLink', 'locationNamesPolished', 'getColumnDataType', 'setMaxEventsToProcess', 'setLocationDataProcessedCallback', 'getRootColumnSet', 'expandLocation', 'isNameColumn', 'getAttributeDataItemTypes', 'setRuleCriteria', 'getPotentialChildren', 'getSceneGraphAttributes', 'getResolvedAttributeName', 'collapseLocation', 'setViewOp', 'getDisplayData', 'setTopLevelDisplayIndex', 'resetAttributeDataItemTypes', 'interruptClientProcessing', 'getRuleMatchInversion', 'clearRuleCriteria', 'setRuleInverted', 'setKeyPressEventCallback']), 'getColumnWidthsSettings': <function getColumnWidthsSettings at 0x7f0dfb32ba28>, 'getTitleText': <function getTitleText at 0x7f0dfb32bed8>, 'addColumnSet': <function addColumnSet at 0x7f0dfb32b6e0>, 'updateViewLink': <function updateViewLink at 0x7f0dfb32d500>, 'getCurrentRules': <function getCurrentRules at 0x7f0dfb32dd70>, 'showColumnSet': <function showColumnSet at 0x7f0dfb32b848>, 'setLocationNamesPolished': <function setLocationNamesPolished at 0x7f0dfb32df50>, '__dict__': <attribute '__dict__' of 'Bridge' objects>, 'setTopLevelLocations': <function setTopLevelLocations at 0x7f0dfb32b2a8>, '__weakref__': <attribute '__weakref__' of 'Bridge' objects>, 'setRuleEvaluator': <function setRuleEvaluator at 0x7f0dfb32d938>, 'matchRules': <function matchRules at 0x7f0dfb32d6e0>, 'isStopping': <function isStopping at 0x7f0dfb38bed8>, 'getColumnByName': <function getColumnByName at 0x7f0dfb32be60>, 'getNumberOfChildren': <function getNumberOfChildren at 0x7f0dfb32d0c8>, 'setRuleShowChildren': <function setRuleShowChildren at 0x7f0dfb32db18>, 'setViewLink': <function setViewLink at 0x7f0dfb32d488>, 'getRuleMatchInversion': <function getRuleMatchInversion at 0x7f0dfb32dcf8>, 'getNumberOfTopLevelLocations': <function getNumberOfTopLevelLocations at 0x7f0dfb32b320>, 'renameRule': <function renameRule at 0x7f0dfb32d848>, '_abc_negative_cache': <_weakrefset.WeakSet object at 0x7f0dfb3287d0>, 'updateTerminalOps': <function updateTerminalOps at 0x7f0dfb38b8c0>, 'setLocationAddedOrUpdatedCallback': <function setLocationAddedOrUpdatedCallback at 0x7f0dfb38b6e0>, 'getOverrideNodeAndParameterName': <function getOverrideNodeAndParameterName at 0x7f0dfb32d578>, 'getColumnByIndex': <function getColumnByIndex at 0x7f0dfb32bde8>, 'setLocationRemovedCallback': <function setLocationRemovedCallback at 0x7f0dfb38b758>, 'thaw': <function thaw at 0x7f0dfb38bcf8>, 'setRuleEnabled': <function setRuleEnabled at 0x7f0dfb32da28>, 'removeRule': <function removeRule at 0x7f0dfb32d7d0>, 'fontChanged': <function fontChanged at 0x7f0dfb32d668>, 'getRuleByName': <function getRuleByName at 0x7f0dfb32de60>, 'setUpdateViewportAutomatically': <function setUpdateViewportAutomatically at 0x7f0dfb32d5f0>, 'setRuleComment': <function setRuleComment at 0x7f0dfb32db90>, 'setTerminalOps': <function setTerminalOps at 0x7f0dfb38b848>, '__doc__': '\n Abstract base class that represents the functions exposed by the B{Bridge}\n to allow users to configure and interrogate the information stored about\n the scene graph.\n ', 'getColumnPresetManager': <function getColumnPresetManager at 0x7f0dfb32b578>, 'setLocationNamePolishCallback': <function setLocationNamePolishCallback at 0x7f0dfb32ded8>, 'setRuleMatchInversion': <function setRuleMatchInversion at 0x7f0dfb32dc80>, 'setLocationActive': <function setLocationActive at 0x7f0dfb38ba28>, 'getParent': <function getParent at 0x7f0dfb32d050>, 'addAttributeDataItemType': <function addAttributeDataItemType at 0x7f0dfb3310c8>, 'applyColumnVisibilitySettings': <function applyColumnVisibilitySettings at 0x7f0dfb32b9b0>, 'getTopLevelLocations': <function getTopLevelLocations at 0x7f0dfb32b230>, 'applyColumnWidthsSettings': <function applyColumnWidthsSettings at 0x7f0dfb32baa0>, '_abc_negative_cache_version': 22, 'columnResized': <function columnResized at 0x7f0dfb32bb18>, 'setViewNode': <function setViewNode at 0x7f0dfb38baa0>, 'addColumn': <function addColumn at 0x7f0dfb32b758>, '_abc_registry': <_weakrefset.WeakSet object at 0x7f0dfb328650>, 'topLevelLocationRenamed': <function topLevelLocationRenamed at 0x7f0dfb32b410>, '__module__': 'UI4.Widgets.SceneGraphView.Bridge', '__metaclass__': <class 'abc.ABCMeta'>, 'isEditable': <function isEditable at 0x7f0dfb32bcf8>, 'setRuleTarget': <function setRuleTarget at 0x7f0dfb32d8c0>, 'freeze': <function freeze at 0x7f0dfb38bc80>, 'setStopRecursiveExpandAttributeNames': <function setStopRecursiveExpandAttributeNames at 0x7f0dfb32b050>, 'setRuleMatchPolicy': <function setRuleMatchPolicy at 0x7f0dfb32dc08>, 'setStopRecursiveExpandLocationTypes': <function setStopRecursiveExpandLocationTypes at 0x7f0dfb32b0c8>, 'isProcessing': <function isProcessing at 0x7f0dfb38be60>, 'getSceneGraphChildren': <function getSceneGraphChildren at 0x7f0dfb38b938>, '_abc_cache': <_weakrefset.WeakSet object at 0x7f0dfb328750>, 'addRule': <function addRule at 0x7f0dfb32d758>, 'endColumnConfiguration': <function endColumnConfiguration at 0x7f0dfb32b7d0>, 'columnTitleClicked': <function columnTitleClicked at 0x7f0dfb32bc08>, 'addTopLevelLocation': <function addTopLevelLocation at 0x7f0dfb32b140>, 'removeTopLevelLocation': <function removeTopLevelLocation at 0x7f0dfb32b1b8>, 'getNumberOfColumns': <function getNumberOfColumns at 0x7f0dfb32bd70>, 'clearTopLevelLocations': <function clearTopLevelLocations at 0x7f0dfb32b398>, 'isFrozen': <function isFrozen at 0x7f0dfb38bd70>, 'moveColumn': <function moveColumn at 0x7f0dfb32bb90>, 'getTopLevelDisplayIndex': <function getTopLevelDisplayIndex at 0x7f0dfb32b488>, 'beginColumnConfiguration': <function beginColumnConfiguration at 0x7f0dfb32b5f0>, 'getViewLink': <function getViewLink at 0x7f0dfb32d2a8>, 'locationNamesPolished': <function locationNamesPolished at 0x7f0dfb331050>, 'getColumnDataType': <function getColumnDataType at 0x7f0dfb32bf50>, 'setMaxEventsToProcess': <function setMaxEventsToProcess at 0x7f0dfb38bf50>, 'setRuleCriteria': <function setRuleCriteria at 0x7f0dfb32d9b0>, 'getRootColumnSet': <function getRootColumnSet at 0x7f0dfb32b668>, 'getPotentialChildren': <function getPotentialChildren at 0x7f0dfb32d140>, 'isNameColumn': <function isNameColumn at 0x7f0dfb32bc80>, 'getAttributeDataItemTypes': <function getAttributeDataItemTypes at 0x7f0dfb331140>, 'setLocationDataProcessedCallback': <function setLocationDataProcessedCallback at 0x7f0dfb38b7d0>, 'expandLocation': <function expandLocation at 0x7f0dfb38bb90>, 'getSceneGraphAttributes': <function getSceneGraphAttributes at 0x7f0dfb38b9b0>, 'getResolvedAttributeName': <function getResolvedAttributeName at 0x7f0dfb32d1b8>, 'collapseLocation': <function collapseLocation at 0x7f0dfb38bc08>, 'setViewOp': <function setViewOp at 0x7f0dfb38bb18>, 'getDisplayData': <function getDisplayData at 0x7f0dfb32d230>, 'setTopLevelDisplayIndex': <function setTopLevelDisplayIndex at 0x7f0dfb32b500>, 'resetAttributeDataItemTypes': <function resetAttributeDataItemTypes at 0x7f0dfb3311b8>, 'interruptClientProcessing': <function interruptClientProcessing at 0x7f0dfb38bde8>, 'hideColumnSet': <function hideColumnSet at 0x7f0dfb32b8c0>, 'clearRuleCriteria': <function clearRuleCriteria at 0x7f0dfb32dde8>, 'setRuleInverted': <function setRuleInverted at 0x7f0dfb32daa0>, 'setKeyPressEventCallback': <function setKeyPressEventCallback at 0x7f0dfb32d320>})¶

__metaclass__¶

alias of ABCMeta

__module__ = 'UI4.Widgets.SceneGraphView.Bridge'¶

__weakref__¶

list of weak references to the object (if defined)

addAttributeDataItemType(itemTypeClass)¶

Adds a custom attribute data item type. This enables attribute data to be displayed as items in the widget as a child of a location. An example use-case for this is displaying of error messages or collection items in the Scene Graph tab.

Parameters:	itemTypeClass (type) – A class derived from AttributeDataTreeWidgetItem that implements the appearance of a custom attribute data item type.

addColumn(columnName)¶

Add a stand-alone column to this view with the given column title and return a handle to the column so it can be configured.

By default, the column will display the current location name, as a text field but. You must set the display index to a particular value.

addColumnSet(columnSetName)¶

A column set is a grouping of column headers. It has an ordering index which determined where in the top-level its group members should be ordered.

Each column member itself has a local (within the group) ordering index.

addRule(ruleName)¶

addTopLevelLocation(topLevelLocationPath, index=None)¶

Adds a new top-level location to the SceneGraphView widget. By default the only top-level location will be /root. If index is supplied, inserts the new top-level location at the given index in the widget, otherwise appends to the widget.

Parameters:	topLevelLocationPath (str) – Full path to location to be added as a top- level location. index (int or None) – The index in the list of top-level locations at which to add the new location, or {None} to append the location to the list.

applyColumnVisibilitySettings(columnVisibility)¶

Parameters:	columnVisibility (dict) – A dictionary containing the visibility settings for all columns and column sets, indexed by name. Can be used to restore the visible columns and column sets when restoring a tab layout.
See:	SceneGraphColumn

applyColumnWidthsSettings(columnWidths)¶

Parameters:	columnWidths (dict) – A dictionary containing the widths of columns, indexed by name. Can be used to restore column widths when restoring a tab layout.
See:	SceneGraphColumn

beginColumnConfiguration()¶

A function that together with :py:obj:`endColumnConfiguration` can be used to wrap several calls of :py:obj:`addColumnSet` and :py:obj:`addColumn` without triggering column configuration change callback functions, to allow for efficient updating of UI widgets.

A registered column configuration change callback function is triggered when calling :py:obj:`endColumnConfiguration`.

clearRuleCriteria(ruleName, triggerEvaluation=True)¶

clearTopLevelLocations()¶

Removes all top-level locations from the SceneGraphView widget, so that it will be empty.

collapseLocation(handle, topLevelHandle, recursive=False)¶

Collapses the scene graph location represented by the given handle underneath the top-level scene graph location represented by the given top-level handle, optionally recursively collapsing all its child locations.

Parameters:

handle (SceneGraphHandle) – A handle representing the scene graph location to collapse, optionally including its children. topLevelHandle (SceneGraphHandle) – A handle representing the top-level scene graph location that contains the scene graph location(s) to collapse. recursive (bool) – Flag to control whether to collapse all child locations of the scene graph location represented by the given handle. If set to True, the entire hierarchy underneath the scene graph location is collapsed, if False, only the scene graph location itself is collapsed (the default).

columnResized(columnIndex, newColumnWidth)¶

Called by the ViewLink when a column is resized by the user.

columnTitleClicked(columnIndex, columnTitleRect)¶

Called by the ViewLink when a column title is clicked by the user.

endColumnConfiguration()¶

A function that together with :py:obj:`beginColumnConfiguration` can be used to wrap several calls of :py:obj:`addColumnSet` and :py:obj:`addColumn` without triggering column configuration change callback functions, to allow for efficient updating of UI widgets.

Triggers a registered column configuration change callback function.

expandLocation(handle, topLevelHandle, recursive=False, stopTypes=None)¶

Expands the scene graph location represented by the given handle underneath the top-level scene graph location represented by the given top-level handle, optionally recursively expanding all its child locations.

Parameters:

handle (SceneGraphHandle) – A handle representing the scene graph location to expand, optionally including its children. topLevelHandle (SceneGraphHandle) – A handle representing the top-level scene graph location that contains the scene graph location(s) to expand. recursive (bool) – Flag to control whether to expand all child locations of the scene graph location represented by the given handle. If set to True, the entire hierarchy underneath the scene graph location is expanded, if False, only the scene graph location itself is expanded (the default). stopTypes (tuple or list or set or str or None) – A tuple or list of names of types of scene graph locations or a single location type name at which the expansion should be stopped. Only used when recursive is True.

fontChanged()¶

Triggers an update of the columns when the font is changed.

freeze()¶

Freezes the clients managed by this SceneGraphView. Usually wired into show/hide UI event handlers, this will freeze updates to the clients managed by this SceneGraphView. Calling this function will ensure that potentially expensive work will be deferred until the corresponding thaw() call is made. Usually called by the hide() event handler.

getAttributeDataItemTypes()¶

Return type:	list of type
Returns:	A list of classes derived from AttributeDataTreeWidgetItem that are registered as custom attribute data item types.

getColumnByIndex(columnIndex, visibleOnly=True)¶

Return type:	UI4.SceneGraphView.SceneGraphViewColumn.SceneGraphColumn or None
Parameters:	columnIndex (int) – The index of the column to return.
Returns:	The SceneGraphColumn object with the given index, or None if no such column was found.

getColumnByName(columnName)¶

Return type:	UI4.SceneGraphView.SceneGraphViewColumn.SceneGraphColumn or None
Parameters:	columnName (str) – The name of the column to return.
Returns:	The first SceneGraphColumn object found with the given name, or None if no such column was found.

getColumnDataType(columnIndex)¶

Return type:	int
Parameters:	columnIndex (int) – The index of the column whose data type to return.
Returns:	The type of data contained in the column with the given index.

getColumnPresetManager()¶

Return type:	ColumnPresetManager
Returns:	An instance of the internal ColoumnPresetManager.

getColumnVisibilitySettings()¶

Return type:	dict
Returns:	A dictionary containing the visibility settings for all columns and column sets, indexed by name. Can be used to retrieve and save the visible columns and column sets when saving a tab layout.
See:	SceneGraphColumn

getColumnWidthsSettings()¶

Return type:	dict
Returns:	A dictionary containing the widths of all columns, indexed by name. Can be used to retrieve and save the column widths when saving a tab layout.
See:	SceneGraphColumn

getCurrentRules()¶

getDisplayData(handle, topLevelHandle, columnIndex)¶

Return type:	str or float or list
Returns:	The data that is to be displayed in the column with the given index for the scene graph location represented by the given handles.

getNumberOfChildren(locationPath)¶

Return type:	str or None
Parameters:	locationPath (str) – The path to return the number of children of.
Returns:	The number of children under the given location path. This is the number of children for which we have cached location data.

getNumberOfColumns()¶

Returns:	The number of columns that should be displayed.

getNumberOfTopLevelLocations()¶

Return type:	int
Returns:	The number of top-level locations displayed in the SceneGraphView widget.

getOverrideNodeAndParameterName(locationPath, attributeName)¶

Return type:	tuple of NodegraphAPI.Node or None and str or None.
Parameters:	locationPath (str) – The path of a scene graph location for which to return an override parameter node. attributeName (str) – The name of a scene graph attribute for which to return an override node and parameter name pair.
Returns:	A node and parameter name pair. Where the node contains a parameter which sets the value of the scene graph attribute with the given name on the scene graph location with the given path, or a tuple containing two instances of None if no such node and parameter pair is available.

getParent(locationPath)¶

Return type:	str or None
Parameters:	locationPath (str) – The path to return the parent for.
Returns:	The parent path of the given location path, or None if the path is the root of the tree.

getPotentialChildren(locationPath)¶

Return type:	list of str
Parameters:	locationPath (str) – The path to return the potential children of.
Returns:	A list of the potential children under the given location path. These are potential children according to the data returned from the runtime, and so not all these children may end up existing in the viewed scene, and we may not have data cached for all of them. Note therefore that the size of this array may not match the result from getNumberOfChildren.

getResolvedAttributeName(handle, attributeName)¶

Resolves names of meta attributes to names of actual attributes for a given renderer, for example material.meta.intensity to material.prmanLightParams.Intensity.

Return type:	tuple of (bool, str)
Parameters:	handle (SceneGraphHandle) – A handle representing the scene graph location that contains the attribute whose resolved name to return. attributeName (str) – The potentially unresolved name of the attribute to resolve.
Returns:	A tuple containing a boolean value indicating whether the attribute name needed to be resolved and was resolved, and the resolved name of the attribute with the given unresolved name contained in the scene graph location represented by the given handle, if so.

getRootColumnSet()¶

Return type:	SceneGraphColumnSet
Returns:	A reference to the root SceneGraphColumnSet object for the widget.

getRuleByName(ruleName)¶

getRuleMatchInversion()¶

getSceneGraphAttributes(locationPath, callback=None, oneShot=False)¶

Obtain the scene graph attributes at the specified location.

See:	UI4.Widgets.SceneGraphView.SceneGraphView

getSceneGraphChildren(parentLocationPath, callback=None, oneShot=False)¶

Obtain the children at the specified location.

See:	UI4.Widgets.SceneGraphView.SceneGraphView

getTitleText(columnIndex)¶

Return type:	str
Parameters:	columnIndex (int) – The index of the column whose title text to return.
Returns:	The title text that should be displayed for the column with the given index.

getTopLevelDisplayIndex(handle)¶

Get the display index for the given top-level location.

getTopLevelLocations()¶

Return type:	list of str
Returns:	A list of paths of scene graph locations displayed as top-level locations in the SceneGraphView widget.

getViewLink()¶

Return type:	ViewLink or None
Returns:	The view link set for this bridge, or None if no view link has been set.

hideColumnSet(columnSetName)¶

Makes the column set with the given name invisible.

This function will have no effect if the specified name does not exist.

Parameters:	columnSetName (str) – The name assigned to the column set that should be hidden.
See:	UI4.SceneGraphView.SceneGraphViewColumn.SceneGraphColumn

interruptClientProcessing()¶

Cancel client processing. Useful to halt a long running cook process.

isEditable(columnIndex)¶

Return True if the column at the given column index represents an editable piece of data.

isFrozen()¶

Return type:	bool
Returns:	True if the clients managed by this SceneGraphView are frozen, otherwise False.

isNameColumn(columnIndex)¶

Return True if the column at the given column index represents the scene graph location’s name.

isProcessing()¶

Return type:	bool
Returns:	True if events were processed during the last idle loop, and the clients managed by this SceneGraphView are not frozen, otherwise False.

isStopping()¶

Return type:	bool
Returns:	True if the widget has had processing interrupted, and is in the process of stopping - i.e. is still receiving incoming events from the client manager since the interruption was sent.

locationNamesPolished()¶

Return type:	bool
Returns:	A boolean value indicating whether scene graph location names are being “polished” in the widget.

matchRules(handle, topLevelHandle)¶

moveColumn(columnIndex, newColumnIndex)¶

Called by the ViewLink when a column is moved by the user.

removeRule(ruleName)¶

removeTopLevelLocation(topLevelLocationPath)¶

Removes the top-level location with the given path from the SceneGraphView widget.

Parameters:	topLevelLocationPath (str) – The path of the top-level scene graph location to remove.

renameRule(oldName, newName)¶

resetAttributeDataItemTypes()¶

Clears all registered custom attribute data item types.

setKeyPressEventCallback(callback)¶

Specifies a function to handle key press events from the underlying Qt widget.

The callback is expected to have the following signature:

function(keyPressEvent)

• keyPressEvent is an instance of QtGui.QKeyEvent, and specifies which key has been pressed.

Parameters:	callback (callable) – A callable function to handle key press events.

setLocationActive(locationPath)¶

This will instruct Geolib3 to recompute the specified location whenever it receives updates for the OpTree.

Parameters:	locationPath (str) – The scene graph location path that will be set as active in the Geolib3 client.

setLocationAddedOrUpdatedCallback(callback)¶

Sets the callback which is triggered when a location is added or updated.

setLocationDataProcessedCallback(callback)¶

Sets the callback which is triggered after any (and all) location updates have been processed.

setLocationNamePolishCallback(callback)¶

Sets the function to call to “polish” the name for a scene graph location.

The callback is expected to have the following signature:

function(locationPath, topLevelLocationPath) : polishedLocationPath

• locationPath is a str containing the full path of the scene graph location whose name is to be polished, e.g. “/root/world/lgt/lightRig1/lightRig1_keyLight”
• topLevelLocationPath is a str containing the full path of the top-level location under which this location is being polished, e.g. “/root/world/lgt”
• polishedLocationPath is the polished name for the scene graph location, e.g. “keyLight”

Parameters:	callback (callable) – A callable object that will be called to determine the polished name for a scene graph location.

setLocationNamesPolished(locationNamesPolished)¶

Sets whether name “polishing” should be applied to scene graph location names in the widget.

Parameters:	namesPolished (bool) – A boolean value indicating whether we wish to run the specified name polishing callback on scene graph location names in the widget.

setLocationRemovedCallback(callback)¶

Sets the callback which is triggered when a location is removed.

setMaxEventsToProcess(maxEventsToProcess)¶

Set the maximum number of events that the client manager can process per cycle.

Parameters:	maxEventsToProcess (int) – The maximum number of events that the client manager can process per cycle. A negative or zero value indicates no maximum.

setRuleComment(ruleName, comment)¶

setRuleCriteria(ruleName, criteriaName, criteria)¶

setRuleEnabled(ruleName, isEnabled)¶

setRuleEvaluator(ruleName, evaluator, useDefaultCriteria=False)¶

setRuleInverted(ruleName, isInverted)¶

setRuleMatchInversion(invert)¶

setRuleMatchPolicy(policy)¶

setRuleShowChildren(ruleName, showChildren)¶

setRuleTarget(ruleName, column)¶

setStopRecursiveExpandAttributeNames(attributeNames)¶

Sets a list of attribute names whose presence at a location should stop recursive expansion.

Parameters:	attributeNames (list of str) – A list of attribute names whose presence at a location should stop recursive expansion.

setStopRecursiveExpandLocationTypes(locationTypes)¶

Sets a list of location types at which recursive expansion should stop.

Parameters:	locationTypes (list of str) – A list of location types at which recursive expansion should stop.

setTerminalOps(terminalOpArgs)¶

Creates a chain of Ops, based on the given Op description in the form of a sequence of Op type and Op argument tuples, and sets the last one of them to be the Op to use in the clients managed by this client manager. The Op arguments can be omitted if there are no arguments for the Op. If Op arguments has been given, an optional ‘key’ can be provided which is used to identify the Op when updating its arguments.

When created, each Op will take its input from the previous Op in the sequence. These Ops will overwrite any previously created terminal Ops.

Parameters:	terminalOpArgs (tuple of tuple of (str, FnAttribute.GroupAttribute, str) or (str, FnAttribute.GroupAttribute) or (str)) – A list of Op type name, Op args and terminal Op key triplets.

setTopLevelDisplayIndex(locationPath, index)¶

Set the display index for the given top-level location to change its order in the top-level list.

Parameters:	locationPath (str) – A string representing the scene graph location to set. index (int) – The new display index for the specified item.

setTopLevelLocations(topLevelLocations)¶

Sets the list of paths of scene graph locations the SceneGraphView widget shows as top-level locations to the given list.

Parameters:	topLevelLocations (list of str) – A list of paths of scene graph locations to show as top-level locations in the SceneGraphView widget.

setUpdateViewportAutomatically(updateViewportAutomatically)¶

Sets whether the viewport of the SceneGraphView widget should update automatically. By default, this is True.

Parameters:	updateViewportAutomatically (bool) – True if the viewport of the widget should update automatically, or False for the viewport to only update when updateViewport is called.

setViewLink(viewLink)¶

Deprecated:	This function will be removed.

setViewNode(viewNode, applyImplicitResolvers=False, extraImplicitResolverOpArgs=None)¶

Sets the Op used in the SceneGraphView widget’s Geolib3 client to the terminal Op for the given viewed node, and optionally appends Ops related to resolving of materials, constraints etc.

Parameters:

viewNode (NodegraphAPI.Node or None) – The node whose terminal Op to use for the Geolib3 client, or None to reset the Geolib3 client. applyImplicitResolvers (bool) – Flag that controls whether Ops for implicit resolvers are to be appended to the given viewed node’s terminal Op in the Geolib3 client used by the SceneGraphView widget. extraImplicitResolverOpArgs (dict or None) – dict mapping Op type names (str) to group attributes (GroupAttribute) describing additional arguments to pass to Ops with the given types.

setViewOp(viewOp, applyImplicitResolvers=False, extraImplicitResolverOpArgs=None)¶

Sets the Op used in the SceneGraphView widget’s Geolib3 client to the given Op, and optionally appends Ops related to resolving of materials, constraints etc.

Parameters:

op (FnGeolibOp or None) – The Op to use for the Geolib3 client, or None to reset the Geolib3 client. applyImplicitResolvers (bool) – Flag that controls whether Ops for implicit resolvers are to be appended to the given viewed node’s terminal Op in the Geolib3 client used by the SceneGraphView widget. extraImplicitResolverOpArgs (dict or None) – dict mapping Op type names (str) to group attributes (GroupAttribute) describing additional arguments to pass to Ops with the given types.

showColumnSet(columnSetName)¶

Makes the column set with the given name visible.

This function will have no effect if the specified name does not exist.

Parameters:	columnSetName (str) – The name assigned to the column set that should be shown.
See:	UI4.SceneGraphView.SceneGraphViewColumn.SceneGraphColumn

thaw()¶

Thaws the clients managed by this SceneGraphView, thereby causing updates sent by Geolib3 to be processed and displayed in the UI.

topLevelLocationRenamed(oldLocationPath, newLocationPath)¶

Notify the SceneGraphView widget that a top-level location has been renamed. This is intended to be called in response to a UI event, e.g. a node being renamed in the Gaffer UI.

updateTerminalOps(terminalOpArgs, txn=None)¶

Updates the arguments of a chain of custom terminal Ops that were previously appended to the Op tree.

Parameters:	terminalOpArgs (tuple of tuple of (str, FnAttribute.GroupAttribute, str)) – A sequence of terminal Op type, Op arguments and terminal op key triplets. txn (FnGeolib.GeolibRuntime.Transaction or None) – The transaction that will be used to set the Op arguments. If no transaction is provided, we create one.

updateViewLink()¶

Updates the view link that has been set for this bridge.

ColumnDataType¶

Module containing the RegisterDataType function and the ColumnDataType class.

class UI4.Widgets.SceneGraphView.ColumnDataType.ColumnDataType¶

Bases: object

Simple class encapsulating a number of data types to drive the editing of data in a given column.

Color¶

alias of ColorItemDelegate

Dummy¶

alias of DummyItemDelegate

LightLink¶

alias of LightLinkItemDelegate

Mute¶

alias of MuteItemDelegate

Name¶

alias of NameItemDelegate

Number¶

alias of NumberItemDelegate

Shader¶

alias of ShaderItemDelegate

Solo¶

alias of SoloItemDelegate

String¶

alias of ParameterItemDelegate

WorkingSet¶

alias of WorkingSetItemDelegate

__dict__ = dict_proxy({'Dummy': <class 'UI4.Widgets.SceneGraphView.ItemDelegates.BaseItemDelegate.DummyItemDelegate'>, '__module__': 'UI4.Widgets.SceneGraphView.ColumnDataType', 'String': <class 'UI4.Widgets.SceneGraphView.ItemDelegates.ParameterItemDelegate.ParameterItemDelegate'>, 'WorkingSet': <class 'UI4.Widgets.SceneGraphView.ItemDelegates.WorkingSetItemDelegate.WorkingSetItemDelegate'>, 'Color': <class 'UI4.Widgets.SceneGraphView.ItemDelegates.ColorItemDelegate.ColorItemDelegate'>, 'Mute': <class 'UI4.Widgets.SceneGraphView.ItemDelegates.MuteAndSoloItemDelegates.MuteItemDelegate'>, 'Number': <class 'UI4.Widgets.SceneGraphView.ItemDelegates.NumberItemDelegate.NumberItemDelegate'>, 'Shader': <class 'UI4.Widgets.SceneGraphView.ItemDelegates.ShaderItemDelegate.ShaderItemDelegate'>, 'LightLink': <class 'UI4.Widgets.SceneGraphView.ItemDelegates.LightLinkItemDelegate.LightLinkItemDelegate'>, '__dict__': <attribute '__dict__' of 'ColumnDataType' objects>, 'Solo': <class 'UI4.Widgets.SceneGraphView.ItemDelegates.MuteAndSoloItemDelegates.SoloItemDelegate'>, '__weakref__': <attribute '__weakref__' of 'ColumnDataType' objects>, '__doc__': '\n Simple class encapsulating a number of data types to drive the editing of\n data in a given column.\n ', 'Name': <class 'UI4.Widgets.SceneGraphView.ItemDelegates.NameItemDelegate.NameItemDelegate'>})¶

__module__ = 'UI4.Widgets.SceneGraphView.ColumnDataType'¶

__weakref__¶

list of weak references to the object (if defined)

UI4.Widgets.SceneGraphView.ColumnDataType.RegisterDataType(dataTypeName, itemDelegateClass)¶

Registers a data type that can be assigned to a column.

Parameters:	dataTypeName (str) – A descriptive name by which to refer to the data type. itemDelegateClass (QStyledItemDelegated-derived class) – The item delegate class to use for controlling the appearance and editing behavior of data of the given data type name.

ColumnManager¶

Module containing the ColumnManager class.

class UI4.Widgets.SceneGraphView.ColumnManager.ColumnManager(columnChangedCallback, columnPresetManager=None)¶

Bases: object

Class that handles all logic and requests for column configuration for the SceneGraphView widget.

Should be read in conjunction with SceneGraphViewColumn.py.

__dict__ = dict_proxy({'__module__': 'UI4.Widgets.SceneGraphView.ColumnManager', 'setColumnChangedCallback': <function setColumnChangedCallback at 0x7f0dfb33a410>, 'getColumnWidthsSettings': <function getColumnWidthsSettings at 0x7f0dfb33acf8>, 'isEditable': <function isEditable at 0x7f0dfb33aa28>, 'setColumnSetVisible': <function setColumnSetVisible at 0x7f0dfb33ab90>, 'addColumnSet': <function addColumnSet at 0x7f0dfb33a320>, 'showColumnSet': <function showColumnSet at 0x7f0dfb33aaa0>, 'getColumnVisibilitySettings': <function getColumnVisibilitySettings at 0x7f0dfb33ac08>, 'getColumnAttributeName': <function getColumnAttributeName at 0x7f0dfb33a848>, '__dict__': <attribute '__dict__' of 'ColumnManager' objects>, 'getColumnCount': <function getColumnCount at 0x7f0dfb33a578>, 'getColumnTitles': <function getColumnTitles at 0x7f0dfb33a758>, 'getColumnWidths': <function getColumnWidths at 0x7f0dfb33a7d0>, 'getRootColumnSet': <function getRootColumnSet at 0x7f0dfb33a500>, 'hideColumnSet': <function hideColumnSet at 0x7f0dfb33ab18>, '__init__': <function __init__ at 0x7f0dfb33a2a8>, 'getDataType': <function getDataType at 0x7f0dfb33a938>, 'getColumnByName': <function getColumnByName at 0x7f0dfb33a668>, '__weakref__': <attribute '__weakref__' of 'ColumnManager' objects>, 'getColumnTitleText': <function getColumnTitleText at 0x7f0dfb33a6e0>, 'applyColumnVisibilitySettings': <function applyColumnVisibilitySettings at 0x7f0dfb33ac80>, 'isLocationNameColumn': <function isLocationNameColumn at 0x7f0dfb33a9b0>, 'moveColumn': <function moveColumn at 0x7f0dfb33a488>, 'applyColumnWidthsSettings': <function applyColumnWidthsSettings at 0x7f0dfb33ad70>, 'getColumnAttributeNames': <function getColumnAttributeNames at 0x7f0dfb33a8c0>, 'addColumn': <function addColumn at 0x7f0dfb33a398>, '__doc__': '\n Class that handles all logic and requests for column configuration for the\n SceneGraphView widget.\n\n Should be read in conjunction with C{SceneGraphViewColumn.py}.\n ', 'getColumnByIndex': <function getColumnByIndex at 0x7f0dfb33a5f0>})¶

__init__(columnChangedCallback, columnPresetManager=None)¶

Initializes an instance of the class.

Parameters:	columnChangedCallback (callable or None) – A callback to be triggered when the configuration of columns has been changed. columnPresetManager (ColumnPresetManager or None) – A ColumnPresetManager to manage keyboard shortcuts and presets for column sets managed by this class.
Raises:	ValueError – If the given callback object is not callable.

__module__ = 'UI4.Widgets.SceneGraphView.ColumnManager'¶

__weakref__¶

list of weak references to the object (if defined)

addColumn(columnName)¶

addColumnSet(columnSetName)¶

applyColumnVisibilitySettings(columnVisibility)¶

applyColumnWidthsSettings(columnWidths)¶

getColumnAttributeName(columnIndex, visibleOnly=True)¶

The SceneGraphTree module requires this special “__location_name__” attribute name to be returned in order to display the location name rather than an attribute name in location name columns.

Return type:	str
Parameters:	columnIndex (int) – The index of the column whose attribute name to return. visibleOnly (bool) – Flag to control whether to skip invisible columns.
Returns:	The name of the attribute whose data is to be displayed in the column with the given index.

getColumnAttributeNames(columnIndex, visibleOnly=True)¶

The SceneGraphTree module requires this special “__location_name__” attribute name to be returned in order to display the location name rather than an attribute name in location name columns.

Return type:	list of str
Parameters:	columnIndex (int) – The index of the column whose attribute name to return. visibleOnly (bool) – Flag to control whether to skip invisible columns.
Returns:	A list of names of attributes whose data are to be displayed in the column with the given index.

getColumnByIndex(columnIndex, visibleOnly=True)¶

getColumnByName(columnName)¶

getColumnCount(visibleOnly=True)¶

getColumnTitleText(columnIndex, visibleOnly=True)¶

getColumnTitles(visibleOnly=True)¶

getColumnVisibilitySettings()¶

getColumnWidths(visibleOnly=True)¶

getColumnWidthsSettings()¶

getDataType(columnIndex)¶

Return type:	int
Parameters:	columnIndex (int) – The index of the column whose data type to return.
Returns:	The type of data contained in the column with the given index.

getRootColumnSet()¶

hideColumnSet(columnSetName)¶

isEditable(columnIndex, visibleOnly=True)¶

isLocationNameColumn(columnIndex, visibleOnly=True)¶

moveColumn(columnIndex, newColumnIndex, visibleOnly=True)¶

setColumnChangedCallback(callback)¶

setColumnSetVisible(columnSetName, visible)¶

showColumnSet(columnSetName)¶

ColumnPresetManager¶

Module containing the ColumnPreset and ColumnPresetManager classes.

class UI4.Widgets.SceneGraphView.ColumnPresetManager.ColumnPreset¶

Bases: object

Class representing a column configuration preset.

__dict__ = dict_proxy({'__module__': 'UI4.Widgets.SceneGraphView.ColumnPresetManager', 'activate': <function activate at 0x7f0dfb3472a8>, 'removeShown': <function removeShown at 0x7f0dfb347140>, 'addHidden': <function addHidden at 0x7f0dfb33af50>, 'addToggled': <function addToggled at 0x7f0dfb3471b8>, '__doc__': '\n Class representing a column configuration preset.\n ', 'addShown': <function addShown at 0x7f0dfb3470c8>, '__dict__': <attribute '__dict__' of 'ColumnPreset' objects>, 'removeHidden': <function removeHidden at 0x7f0dfb347050>, '__weakref__': <attribute '__weakref__' of 'ColumnPreset' objects>, 'removeToggled': <function removeToggled at 0x7f0dfb347230>, '__init__': <function __init__ at 0x7f0dfb33aed8>})¶

__init__()¶

Initializes an instance of the class.

__module__ = 'UI4.Widgets.SceneGraphView.ColumnPresetManager'¶

__weakref__¶

list of weak references to the object (if defined)

activate()¶

Activates the preset by hiding/showing/toggling the registered columns or column sets.

addHidden(columnOrSet)¶

Adds a column or set which should be hidden when this preset is activated.

Parameters:	columnOrSet (BaseSceneGraphColumn) – A column or set which should be hidden in this preset.

addShown(columnOrSet)¶

Adds a column or set which should be shown when this preset is activated.

Parameters:	columnOrSet (BaseSceneGraphColumn) – A column or set which should be shown in this preset.

addToggled(columnOrSet)¶

Adds a column or set whose visibility state should be toggled when this preset is actived.

Parameters:	columnOrSet (BaseSceneGraphColumn) – A column or set whose visibility state should be toggled when this preset is activated.

removeHidden(columnOrSet)¶

Removes a column or set from the list of items to hide when this preset is activated.

Parameters:	columnOrSet (BaseSceneGraphColumn) – A column or set to remove from the list of items to hide when this preset is activated.

removeShown(columnOrSet)¶

Removes a column or set from the list of items to show when this preset is activated.

Parameters:	columnOrSet (BaseSceneGraphColumn) – A column or set to remove from the list of items to show when this preset is activated.

removeToggled(columnOrSet)¶

Removes a column or set from the list of items whose visibility state should be toggled when this preset is actived.

Parameters:	columnOrSet (BaseSceneGraphColumn) – A column or set to remove from the list of items whose visibility state should be toggled when this preset is activated.

class UI4.Widgets.SceneGraphView.ColumnPresetManager.ColumnPresetManager¶

Bases: object

Class implenting a manager for ColumnPresets. Handles key press events and activates any presets associated with the keys pressed.

class ShortcutMode¶

Bases: object

Constants used for uniquely identifying different shortcut modes which can be provided to ColumnPresetManager.setShortcutMode. These define the behaviour of shortcuts that are added through addColumnSetShortcut, but not addPreset.

Toggle = 1¶

Unique = 0¶

__dict__ = dict_proxy({'__module__': 'UI4.Widgets.SceneGraphView.ColumnPresetManager', 'getValidShortcutModes': <classmethod object at 0x7f0dfb342130>, 'Toggle': 1, '__dict__': <attribute '__dict__' of 'ShortcutMode' objects>, 'Unique': 0, '__weakref__': <attribute '__weakref__' of 'ShortcutMode' objects>, '__doc__': '\n Constants used for uniquely identifying different shortcut modes which\n can be provided to L{ColumnPresetManager.setShortcutMode()}. These define\n the behaviour of shortcuts that are added through\n L{addColumnSetShortcut()}, but not L{addPreset()}.\n '})¶

__module__ = 'UI4.Widgets.SceneGraphView.ColumnPresetManager'¶

__weakref__¶

list of weak references to the object (if defined)

classmethod getValidShortcutModes()¶

Return type:	list of int
Returns:	A list of valid shortcut mode values.

ColumnPresetManager.__dict__ = dict_proxy({'__module__': 'UI4.Widgets.SceneGraphView.ColumnPresetManager', 'removeColumnSetShortcut': <function removeColumnSetShortcut at 0x7f0dfb347668>, 'addPreset': <function addPreset at 0x7f0dfb347500>, '__weakref__': <attribute '__weakref__' of 'ColumnPresetManager' objects>, 'processKeyPressEvent': <function processKeyPressEvent at 0x7f0dfb347410>, 'removePreset': <function removePreset at 0x7f0dfb347578>, 'removeColumnSetShortcuts': <function removeColumnSetShortcuts at 0x7f0dfb3476e0>, '__dict__': <attribute '__dict__' of 'ColumnPresetManager' objects>, 'addColumnSetShortcut': <function addColumnSetShortcut at 0x7f0dfb3475f0>, 'setShortcutMode': <function setShortcutMode at 0x7f0dfb347488>, '__doc__': '\n Class implenting a manager for ColumnPresets. Handles key press events and\n activates any presets associated with the keys pressed.\n ', '__init__': <function __init__ at 0x7f0dfb347320>, 'ShortcutMode': <class 'UI4.Widgets.SceneGraphView.ColumnPresetManager.ShortcutMode'>})¶

ColumnPresetManager.__init__()¶

Initializes an instance of the class.

Presets are stored in a dictionary, indexed by the key press value. Each entry in the __presets dictionary is a list of ColumnPreset objects which should be activated for the corresponding key press. Each entry in the __shortcutsForColumnSets dictionary is a list of SceneGraphColumnSet objects which should be shown/hidden for the corresponding key press.

ColumnPresetManager.__module__ = 'UI4.Widgets.SceneGraphView.ColumnPresetManager'¶

ColumnPresetManager.__weakref__¶

list of weak references to the object (if defined)

ColumnPresetManager.addColumnSetShortcut(columnSet, shortcut)¶

Adds a new column set to the manager, associated with the given shortcut.

Parameters:	shortcut (string or None or int or QKeySequence) – A value that can be accepted by the QKeySequence constructor, for use as a keyboard shortcut that will activate the column set. columnSet (SceneGraphColumnSet) – The column set to associate with the shortcut.

ColumnPresetManager.addPreset(shortcut)¶

Adds a new preset to the manager, and returns it.

Return type:	ColumnPreset
Parameters:	shortcut (string or None or int or QKeySequence) – A value that can be accepted by the QKeySequence constructor, for use as a keyboard shortcut that will activate this preset.
Returns:	The new preset.

ColumnPresetManager.processKeyPressEvent(event)¶

Handles a keyPressEvent from a layout containing SceneGraphColumn objects. Checks the list of registered presets and activates any whose shortcut key matches the key pressed.

Return type:	bool
Parameters:	event (QtGui.QKeyEvent) – The keyPressEvent which we wish to handle.
Returns:	True if the given event has been handled, otherwise False.

ColumnPresetManager.removeColumnSetShortcut(columnSet, shortcut)¶

Removes a shortcut for the given column set from the manager.

Parameters:	columnSet (SceneGraphColumnSet) – The column set to remove from the manager. shortcut (string or None or int or QKeySequence) – A value that can be accepted by the QKeySequence constructor, representing the shortcut to remove.

ColumnPresetManager.removeColumnSetShortcuts(columnSet)¶

Removes all shortcuts for the given column set from the manager.

Parameters:	columnSet (SceneGraphColumnSet) – The column set to remove the shortcuts for.

ColumnPresetManager.removePreset(preset)¶

Removes a given preset from the manager.

Parameters:	preset (ColumnPreset) – The preset to remove from the manager.

ColumnPresetManager.setShortcutMode(shortcutMode)¶

Sets the shortcut mode used when handling keyboard shortcuts that are added through addColumnSetShortcut. The valid modes are defined by constants in ColumnPresetManager.ShortcutMode.

Parameters:	shortcutMode (int) – The mode to use - must be one of the constants defined by ColumnPresetManager.ShortcutMode

ContextMenuEvent¶

Module providing the ContextMenuEvent class which encapsulates information related to context menu customization.

class UI4.Widgets.SceneGraphView.ContextMenuEvent.ContextMenuEvent(event, locationPath=None, topLevelLocationPath=None, selectedLocations=None, sceneGraphColumn=None)¶

Bases: PyQt5.QtGui.QContextMenuEvent

Class that provides information related to the selection state and context at the point in time when a user requests a right-click menu be displayed.

If you make use of the setContextMenuEventCallback() function, your callback will be passed an instance of this class which will be pre-populated with a range of information pertaining to the context in which the right-click menu was requested.

__init__(event, locationPath=None, topLevelLocationPath=None, selectedLocations=None, sceneGraphColumn=None)¶

__module__ = 'UI4.Widgets.SceneGraphView.ContextMenuEvent'¶

getLocationPath()¶

Returns the path of the scene graph location under the mouse pointer when this ContextMenuEvent was triggered.

If ContextMenuEvent did not occur over a scene graph location this will return None.

Return type:	str or None
Returns:	Path of the scene graph location under the mouse pointer.

getSceneGraphColumn()¶

Returns the column object which refers to the column in which this ContextMenuEvent occurred.

Return type:	SceneGraphColumn
Returns:	The column object.

getSelectedLocations()¶

Returns a list of scene graph locations that were selected by the user when this ContextMenuEvent was triggered.

For each selected scene graph location the list contains a 2-tuple of the following form:

(top-level location path, location path)

• top-level location path refers to the top-level scene graph location that the selected scene graph location belongs to.
• location path refers to the selected scene graph location.

Return type:	list of tuple
Returns:	List of currently selected scene graph locations and the top-level scene graph locations to which they belong.

getTopLevelLocationPath()¶

Returns the path of the top-level scene graph location to which the scene graph location returned by getLocationPath belongs.

If getLocationPath returns None this function also returns None.

Return type:	str or None
Returns:	Top-level item’s scene graph location path or None if this event did not occur over a scene graph location.

HorizontalHeaderView¶

Module containing the HorizontalHeaderView class.

class UI4.Widgets.SceneGraphView.HorizontalHeaderView.HorizontalHeaderView(parent=None)¶

Bases: PyQt5.QtWidgets.QHeaderView

Class implementing a custom header view for the SceneGraphView widget’s tree widget. Controls resizing behaviour of columns with support for a fixed width, minimum width and maximum width set on item delegates used for the columns in the tree widget.

ClickStyleRole = 258¶

HeaderTitleIconRole = 260¶

IsToggledOnFunctionRole = 259¶

SectionClickableRole = 257¶

__init__(parent=None)¶

Initializes an instance of the class.

Parameters:	parent (QtWidgets.QWidget) – The parent widget to use for the header view instance, should be an instance of TreeWidget.

__module__ = 'UI4.Widgets.SceneGraphView.HorizontalHeaderView'¶

contextMenuEvent(contextMenuEvent)¶

Event handler for context menu events.

Parameters:	contextMenuEvent (QtGui.QContextMenuEvent) – An object containing details about the context menu event to process.

enterEvent(event)¶

Event handler for widget enter events.

Reimplemented in order to paint sections that are clickable in a hovered appearance.

Parameters:	event (QtCore.QEvent) – An object containing details about the enter event to process.

leaveEvent(event)¶

Event handler for widget leave events.

Reimplemented in order to paint sections that are clickable and that had been painted in a hovered appearance in a normal appearance again.

Parameters:	event (QtCore.QEvent) – An object containing details about the leave event to process.

mouseDoubleClickEvent(mouseEvent)¶

Event handler for mouse double-click events.

Reimplemented in order to call a specialized function of the tree widget parent to resize a column to its contents if its section handle has been double-clicked, bypassing the default behavior.

Parameters:	mouseEvent (QtGui.QMouseEvent) – An object containing details about the mouse event to process.

mouseMoveEvent(mouseEvent)¶

Event handler for mouse move events.

Reimplemented in order to change the cursor shape when the pointer is over a section handle of a column that cannot be resized.

Parameters:	mouseEvent (QtGui.QMouseEvent) – An object containing details about the mouse event to process.

mousePressEvent(mouseEvent)¶

Event handler for mouse press events.

Reimplemented in order to support clickable sections without making the entire header view clickable. Whether or not sections are clickable is determined by user data stored in the header view’s model. The function emits the "sectionPressed" signal if a clickable section has been clicked with the left button.

Parameters:	mouseEvent (QtGui.QMouseEvent) – An object containing details about the mouse press event to process.

mouseReleaseEvent(mouseEvent)¶

Event handler for mouse release events.

Reimplemented in order to cause a re-draw of the title that was previously clicked.

Parameters:	mouseEvent (QtGui.QMouseEvent) – An object containing details about the mouse release event to process.

paintSection(painter, rect, logicalIndex)¶

Paints the section specified by the given logical index, using the given painter and rectangle.

Parameters:	painter (QtGui.QPainter) – The painter to use for drawing the section. rect (QtCore.QRect) – The rectangular area of the section to draw. logicalIndex (int) – The index of the section to draw.

resizeSection(logicalIndex, size)¶

Resizes the section specified by logicalIndex to size measured in pixels.

Reimplemented to respect item delegate column width constraints.

Parameters:	logicalIndex (int) – Logical index of column to be resized size (int) – New size

SceneGraphLocationTranslation¶

Module providing utility functions for working with paths of scene graph locations.

UI4.Widgets.SceneGraphView.SceneGraphLocationTranslation.GetParentPath(locationPath, topLevelLocationPath='/root')¶

Return the parent scene graph location of path. If path represents the root of the scene then None will be returned.

UI4.Widgets.SceneGraphView.SceneGraphLocationTranslation.GetLocationName(locationPath)¶

Extract the location name from the location path.

E.g.

/root -> root /root/world/geo -> geo

UI4.Widgets.SceneGraphView.SceneGraphLocationTranslation.IsLocationUnderTopLevelLocation(locationPath, topLevelLocationPath)¶

Return True if locationPath exists under topLevelLocationPath otherwise return False.

e.g. /root -> /root/world/geo == True /root/world/light -> /root/world == False /root/world/ -> /root/world_1/geo == False /root/world/geo -> /root/world/geo_scalar/geo == False /root/world/geo -> /root/world/geo/arm/hand == True

UI4.Widgets.SceneGraphView.SceneGraphLocationTranslation.ExplodePath(locationPath)¶

Explodes the scene graph location path into a list of all its child locations including itself.

e.g. /root/world/cam = [‘/root’, ‘/root/world’, ‘/root/world/cam’]

SceneGraphTree¶

Module providing the SceneGraphTree class.

class UI4.Widgets.SceneGraphView.SceneGraphTree.SceneGraphTree¶

Bases: object

Encapsulates a raw ‘locations and attributes’ view of the scene graph that is currently being displayed by the SceneGraphView.

It is made up of TreeItems which represent a single location in the scene graph. There is a single root location in the scene graph which has the location path /root. A TreeItem also contains attribute data which can be interrogated.

A TreeItem has one or more children of type TreeItem. They can be efficiently accessed in O(1) time by name or index. The index ordering is strict and defined by the scene graph processing commands that created it, this can be determined by the potential children list.

Provides an interface to the Bridge which provides efficient access to TreeItems.

__dict__ = dict_proxy({'__module__': 'UI4.Widgets.SceneGraphView.SceneGraphTree', '__weakref__': <attribute '__weakref__' of 'SceneGraphTree' objects>, 'clear': <function clear at 0x7f0dfb34f578>, 'hasLocation': <function hasLocation at 0x7f0dfb34f500>, '__dict__': <attribute '__dict__' of 'SceneGraphTree' objects>, 'addOrUpdateSceneGraphLocation': <function addOrUpdateSceneGraphLocation at 0x7f0dfb34f398>, 'getTreeItem': <function getTreeItem at 0x7f0dfb34f488>, 'deleteSceneGraphLocation': <function deleteSceneGraphLocation at 0x7f0dfb34f410>, '__doc__': "\n Encapsulates a raw 'locations and attributes' view of the scene graph that\n is currently being displayed by the C{SceneGraphView}.\n\n It is made up of L{TreeItem}s which represent a single location in the\n scene graph. There is a single root location in the scene graph which has\n the location path C{/root}. A L{TreeItem} also contains attribute data\n which can be interrogated.\n\n A L{TreeItem} has one or more children of type L{TreeItem}. They can be\n efficiently accessed in O(1) time by name or index. The index ordering is\n strict and defined by the scene graph processing commands that created it,\n this can be determined by the potential children list.\n\n Provides an interface to the C{Bridge} which provides efficient access to\n L{TreeItem}s.\n ", '__init__': <function __init__ at 0x7f0dfb34f320>})¶

__init__()¶

Initializes an instance of the class.

__module__ = 'UI4.Widgets.SceneGraphView.SceneGraphTree'¶

__weakref__¶

list of weak references to the object (if defined)

addOrUpdateSceneGraphLocation(locationPath, locationData)¶

Creates a new scene graph tree item to represent the scene graph location with the given path, and stores the given location data on it.

If the location already exists, this function updates the location data on the existing tree item.

Return type:	TreeItem
Parameters:	locationPath (str) – The path of the scene graph location for which to create or update a scene graph tree item. locationData (PyFnGeolib.LocationData) – An object that contains the data to store for the scene graph location represented by the tree item to create or update.
Returns:	The created or updated scene graph tree item.

clear()¶

Deletes all tree items in this SceneGraphTree instance.

deleteSceneGraphLocation(locationPath)¶

Delete the TreeItem specified by locationPath.

If locationPath refers to a TreeItem which does not exist, or has child tree items, this function will throw an error.

getTreeItem(locationPath)¶

Return type:	TreeItem
Parameters:	locationPath (str) – The path of the scene graph location for which to return the corresponding scene graph tree item.
Returns:	The tree item that represents the scene graph location with the given path.
Raises:	SceneGraphTreeException – If no tree item exists that corresponds to the given scene graph location path.

hasLocation(locationPath)¶

Return type:	bool
Parameters:	locationPath (str) – The path of the scene graph location for which to check whether a corresponding scene graph tree item exists.
Returns:	True if there is a tree item that corresponds to the given location path, otherwise False.

exception UI4.Widgets.SceneGraphView.SceneGraphTree.SceneGraphTreeException¶

Bases: exceptions.Exception

Exception thrown when attempting invalid tree operations.

__module__ = 'UI4.Widgets.SceneGraphView.SceneGraphTree'¶

__weakref__¶

list of weak references to the object (if defined)

class UI4.Widgets.SceneGraphView.SceneGraphTree.TreeItem(locationPath, locationData, parentTreeItem)¶

Bases: object

Is used by the SceneGraphTree to store scene graph locations and their attributes.

Provides a number of functions by which its children and location within the SceneGraphTree topology can be interrogated.

__dict__ = dict_proxy({'addChild': <function addChild at 0x7f0dfb34f140>, '__module__': 'UI4.Widgets.SceneGraphView.SceneGraphTree', 'getPotentialChildren': <function getPotentialChildren at 0x7f0dfb3478c0>, 'getNumberOfChildren': <function getNumberOfChildren at 0x7f0dfb347ed8>, 'getAttributeData': <function getAttributeData at 0x7f0dfb347f50>, 'getChildBySceneGraphIndex': <function getChildBySceneGraphIndex at 0x7f0dfb347c80>, 'getSceneGraphIndexOfChildTreeItem': <function getSceneGraphIndexOfChildTreeItem at 0x7f0dfb347de8>, 'getLocationType': <function getLocationType at 0x7f0dfb347b90>, 'getLocationName': <function getLocationName at 0x7f0dfb347aa0>, '_TreeItem__populateLookupMaps': <function __populateLookupMaps at 0x7f0dfb34f230>, '__dict__': <attribute '__dict__' of 'TreeItem' objects>, 'deleteChild': <function deleteChild at 0x7f0dfb34f1b8>, '__weakref__': <attribute '__weakref__' of 'TreeItem' objects>, '__init__': <function __init__ at 0x7f0dfb347848>, 'getChildItems': <function getChildItems at 0x7f0dfb3479b0>, 'getLocationPath': <function getLocationPath at 0x7f0dfb347b18>, 'getParent': <function getParent at 0x7f0dfb347a28>, 'getChildByName': <function getChildByName at 0x7f0dfb347c08>, 'getSceneGraphIndexOfLocationName': <function getSceneGraphIndexOfLocationName at 0x7f0dfb347cf8>, 'updateLocationData': <function updateLocationData at 0x7f0dfb347e60>, 'getLocationData': <function getLocationData at 0x7f0dfb34f0c8>, 'getAttributes': <function getAttributes at 0x7f0dfb34f050>, '__repr__': <function __repr__ at 0x7f0dfb34f2a8>, 'getSceneGraphIndexInParent': <function getSceneGraphIndexInParent at 0x7f0dfb347d70>, '__doc__': '\n Is used by the C{SceneGraphTree} to store scene graph locations and their\n attributes.\n\n Provides a number of functions by which its children and location within\n the C{SceneGraphTree} topology can be interrogated.\n ', 'getChildNames': <function getChildNames at 0x7f0dfb347938>})¶

__init__(locationPath, locationData, parentTreeItem)¶

Initializes an instance of the class.

Parameters:	locationPath (str) – The path of the scene graph location to represent by this tree item instance. locationData (PyFnGeolib.LocationData) – Data to store in the tree item instance. parentTreeItem (TreeItem or None) – The tree item to use as the parent of this tree item instance, or None if this tree item instance is to be considered the root of a scene graph tree.

__module__ = 'UI4.Widgets.SceneGraphView.SceneGraphTree'¶

__repr__()¶

__weakref__¶

list of weak references to the object (if defined)

addChild(childTreeItem)¶

Add the specified child TreeItem to children of this TreeItem.

deleteChild(childTreeItem)¶

Delete the specified child TreeItem from the location’s list of children

getAttributeData(attributeName, returnResolvedData=True)¶

Return type:	str or float or int or list or None
Parameters:	attributeName (str) – The name of the attribute whose data to return. returnResolvedData (bool) – Flag to control whether to return the data of the resolved attribute if the name of a meta attribute is given. For example, attributeName could be material.meta.intensity, which could contain the name of an actual attribute, such as material.prmanLightParams.Intensity. If returnResolvedData is True, the data of the actual attribute is returned. If it is False, the name of the actual attribute is returned.
Returns:	The data of the attribute with the given name, or None if no data for the attribute with the given name is available.

getAttributes()¶

Return type:	PyFnAttribute.Attribute
Returns:	The scene graph attributes stored at the location represented by this tree item instance.

getChildByName(locationName)¶

Return type:	TreeItem
Parameters:	locationName (str) – The name of the scene graph location whose corresponding tree item to return.
Returns:	The child tree item with the given location name.
Note:	The cost of this operation is O(1)
Raises:	SceneGraphTreeException – If the given location name does not correspond to a child tree item of this tree item instance.

getChildBySceneGraphIndex(sceneGraphIndex)¶

Return the TreeItem at the specified scene graph index.

If the location name is not a child of this TreeItem then a SceneGraphTreeException will be thrown.

The cost of this operation is O(1)

getChildItems()¶

Return type:	list of TreeItem
Returns:	A list of all child tree items of this tree item.

getChildNames()¶

Return type:	list of str
Returns:	A list of names of child tree items of this tree item.

getLocationData()¶

Return type:	PyFnGeolib.LocationData
Returns:	An object that contains the data stored for the scene graph location represented by this tree item instance. Can be used to test the data’s hash against new updates.

getLocationName()¶

Return type:	str
Returns:	The leaf-level location of this tree item, for example geo for /root/world/geo, and root for /root.

getLocationPath()¶

Return type:	str
Returns:	The path of the scene graph location represented by this tree item instance.

getLocationType()¶

Return type:	str or None
Returns:	The name of the type attribute of the scene graph location represented by this tree item instance, or None if the location type is not available.

getNumberOfChildren()¶

Return type:	int
Returns:	The number of child locations under the scene graph location represented by this tree item instance.

getParent()¶

Return type:	TreeItem or None
Returns:	The parent tree item of this tree item instance, or None if this tree item instance represents the root of the scene graph tree.

getPotentialChildren()¶

Return type:	list
Returns:	A list of potential children of this tree item instance. The ordering of the returned list defines the order in which they should appear.

getSceneGraphIndexInParent()¶

Return the scene graph index of this TreeItem in its parent.

If this is the root of the SceneGraph then the scene graph index is 0

The cost of this operation is O(1)

getSceneGraphIndexOfChildTreeItem(childTreeItem)¶

Return the scene graph index of the child TreeItem.

If childTreeItem is not a child of this TreeItem then a SceneGraphTreeException will be thrown.

The cost of this operation is O(1)

getSceneGraphIndexOfLocationName(locationName)¶

Returns the scene graph index of the specified location name.

If the location name is not a child of this TreeItem then a SceneGraphTreeException will be thrown.

The cost of this operation is O(1)

updateLocationData(locationData)¶

Updates the location data for this TreeItem and also regenerates any internal data structures.

Parameters:	locationData (PyFnGeolib.LocationData) – An object that contains the data to store for the scene graph location represented by this tree item instance.

SceneGraphViewClientManager¶

Module containing the SceneGraphViewClientManager class.

class UI4.Widgets.SceneGraphView.SceneGraphViewClientManager.SceneGraphViewClientManager¶

Bases: UI4.Util.ClientManager.ClientManager

Class responsible for managing Geolib3 clients for the SceneGraphView widget.

One client is created per top-level location in the widget.

__init__()¶

__module__ = 'UI4.Widgets.SceneGraphView.SceneGraphViewClientManager'¶

topLevelLocationAdded(topLevelLocation)¶

Informs ClientManager that there is a new top-level location.

Parameters:	topLevelLocation (str) – The top-level location being added.

topLevelLocationRemoved(topLevelLocation)¶

Informs ClientManager that a top-level location has been removed

Parameters:	topLevelLocation (str) – The top-level location being removed.

SceneGraphViewColumn¶

Module providing the SceneGraphColumn, SceneGraphColumnSet and SceneGraphColumnTitle classes.

UI4.Widgets.SceneGraphView.SceneGraphViewColumn.GetNonInformationalAttributeName(attributeNames)¶

Return type:	str or None
Parameters:	attributeNames (list of str) – A list of names of attributes to filter.
Returns:	The name of the first attribute that doesn’t store data for informational purposes only, or the name of the first attribute if all attribute names indicate informational purposes, or None if the given list of attribute names is empty.

class UI4.Widgets.SceneGraphView.SceneGraphViewColumn.BaseSceneGraphColumn(name='Untitled', columnChangedCallback=None, parentSet=None)¶

Bases: object

A base class for columns and column sets.

A column or column set may live inside a parent column set, or may stand alone.

__dict__ = dict_proxy({'__module__': 'UI4.Widgets.SceneGraphView.SceneGraphViewColumn', 'setColumnChangedCallback': <function setColumnChangedCallback at 0x7f0dfb5cd488>, 'setName': <function setName at 0x7f0dfb5aaf50>, 'setParentSet': <function setParentSet at 0x7f0dfb5cd1b8>, 'setIndex': <function setIndex at 0x7f0dfb5cd2a8>, 'getParentSets': <function getParentSets at 0x7f0dfb5cd0c8>, '__dict__': <attribute '__dict__' of 'BaseSceneGraphColumn' objects>, 'callColumnChangedCallback': <function callColumnChangedCallback at 0x7f0dfb5cd500>, 'getParentSetNames': <function getParentSetNames at 0x7f0dfb5cd140>, 'getColumnChangedCallback': <function getColumnChangedCallback at 0x7f0dfb5cd410>, 'getParentSet': <function getParentSet at 0x7f0dfb5cd050>, '__weakref__': <attribute '__weakref__' of 'BaseSceneGraphColumn' objects>, '__init__': <function __init__ at 0x7f0dfb5aae60>, 'getIndex': <function getIndex at 0x7f0dfb5cd230>, 'getName': <function getName at 0x7f0dfb5aaed8>, 'isVisible': <function isVisible at 0x7f0dfb5cd320>, 'setVisible': <function setVisible at 0x7f0dfb5cd398>, '__doc__': '\n A base class for columns and column sets.\n\n A column or column set may live inside a parent column set, or may stand\n alone.\n '})¶

__init__(name='Untitled', columnChangedCallback=None, parentSet=None)¶

Initializes an instance of the class.

Parameters:	name (str) – The name to use for the column object. columnChangedCallback (callable or None) – A callback to be triggered when the configuration of columns has been changed. This includes changes to visibility state. parentSet (SceneGraphColumnSet or None) – The set to which this new instance should be added, or None if the column object is a stand-alone column or column set.

__module__ = 'UI4.Widgets.SceneGraphView.SceneGraphViewColumn'¶

__weakref__¶

list of weak references to the object (if defined)

callColumnChangedCallback()¶

Tries to execute the callback that is set to be triggered when the configuration of columns has been changed, and logs an error if an exception occurs.

Does nothing if no such callback has been set.

getColumnChangedCallback()¶

Return type:	callable or None
Returns:	The callback to be triggered when the configuration of columns has been changed, or None if no such callback has been set.
Note:	The callback is also called when the visibility state of the column or column set has been changed.

getIndex()¶

Return type:	int
Returns:	The index of this instance within its parent set, or -1 if the instance does not have a parent set.

getName()¶

Return type:	str
Returns:	The name of this column object.

getParentSet()¶

Return type:	SceneGraphColumnSet or None
Returns:	The column set that contains the column or column set represented by this instance, or None if the column is not part of a column set.

getParentSetNames()¶

Return type:	list of str
Returns:	A list of the names of all this column object’s ancestors.

getParentSets()¶

Return type:	list of SceneGraphColumnSet
Returns:	A list of all this column object’s ancestors.

isVisible()¶

Return type:	bool
Returns:	The visibility of the column or column set represented by this instance.

setColumnChangedCallback(callback)¶

Sets the callback that is to be triggered when the configuration of columns has been changed. This includes the visibility state of columns.

Parameters:	callback (callable or None) – The callback to be triggered when the configuration of columns has been changed.
Raises:	ValueError – If the given callback object is not callable.

setIndex(index)¶

Sets the index of this column object within its parent set to the given index.

Parameters:	index (int) – The index to set for this column object within its parent set.

setName(name)¶

Sets the name of this column object to the given name.

Parameters:	name (str) – The name to set for this column object.

setParentSet(parentSet)¶

Sets the parent of this column object to the given column set.

Parameters:	parentSet (SceneGraphColumnSet or None) – The parent set to set for this column object, or None to make this column object a stand-alone column or column set.

setVisible(visible)¶

Sets the visibility of the column or column set represented by this instance to the given visibility.

Parameters:	visible (bool) – The visibility to set for the column or column set represented by this instance.

class UI4.Widgets.SceneGraphView.SceneGraphViewColumn.SceneGraphColumn(columnName='Untitled', columnChangedCallback=None, parentSet=None)¶

Bases: UI4.Widgets.SceneGraphView.SceneGraphViewColumn.BaseSceneGraphColumn

A SceneGraphColumn represents a single column in a SceneGraphView.

__init__(columnName='Untitled', columnChangedCallback=None, parentSet=None)¶

Initializes an instance of the class.

Parameters:	columnName (str) – The name of the new column. columnChangedCallback (callable) – A function to be called when the configuration of columns changes. This includes changes to visibility state. parentSet (SceneGraphColumnSet) – The set to which this new column should be added.

__module__ = 'UI4.Widgets.SceneGraphView.SceneGraphViewColumn'¶

getAttributeName()¶

Return type:	str or None
Returns:	The attribute name associated with this column, or None if no attribute name is set for this column.

getAttributeNames()¶

Return type:	list of str
Returns:	The attribute names associated with this column.

classmethod getColorDisplayTypeName()¶

Return type:	str
Returns:	The data type name for color data.
See:	getSupportedDisplayTypes

getDataType()¶

Return type:	int
Returns:	The type of data that the column represents.

classmethod getDefaultDisplayTypeIndex()¶

Return type:	int
Returns:	The index of the supported default display type.
See:	getSupportedDisplayTypes

classmethod getDefaultDisplayTypeName()¶

Return type:	str
Returns:	The name of the default display type to associate with a column.
See:	getSupportedDisplayTypes

getFixedWidth()¶

Return type:	int or None
Returns:	The fixed width of the column in pixels, or None if no fixed width has been set for the column.

getLookFileMaterialAssignmentCallback()¶

Return type:	callable or None
Returns:	The callback that is used for assigning a Look File Material to a package.

getMasterMaterialCallbacks()¶

Return type:	tuple of callable or None
Returns:	A tuple of callbacks to use for obtaining a list of paths of scene graph locations that represent Master Materials and for assigning a Master Material to a light.

getMaximumWidth()¶

Return type:	int or None
Returns:	The maximum width of the column in pixels, or None if no maximum width has been set for the column.

getMinimumWidth()¶

Return type:	int or None
Returns:	The minimum width of the column in pixels, or None if no minimum width has been set for the column.

getProperties()¶

Return type:	list of tuple of (str, object)
Returns:	The list of (propertyName, propertyValue) tuples that are currently assigned to the column.

classmethod getSupportedDisplayTypes()¶

Return type:	list of str
Returns:	A list of supported column display type names. These data type names are used to differentiate between different widgets that should be displayed for a scene graph column.

getTitle()¶

Return type:	SceneGraphColumnTitle
Returns:	The title object for this column.

getTitleClickStyle()¶

Return type:	str
Returns:	The style in which the title behaves in response to click events.

getTitleClickedCallback()¶

Return type:	callable or None
Returns:	A callback that is to be triggered when the header of this column is clicked, or None if no such callback has been set for this column.

getTitleIcon()¶

Return type:	QtGui.QIcon or None
Returns:	The icon to display on the column title, if one is set.

getTitleIconName()¶

Return type:	str
Returns:	The name of the icon used for the title of this column.
Note:	The title icon may or may not be displayed in the header for the column, depending on its title style.

getTitleStyle()¶

Return type:	str
Returns:	The title style for the column. Will be one of SceneGraphColumnTitle.TextOnly, IconOnly or TextAndIcon.

getTitleText()¶

Return type:	str
Returns:	The title text for the column.
Note:	The title text may or may not be displayed in the header for the column, depending on its title style.

getTitleToolTip()¶

Return type:	str
Returns:	The tooltip text to display for the title.

getWidth()¶

Return type:	int
Returns:	The width of the column in pixels. This is -1 by default, indicating no preference for the width of the column.

isEditable()¶

Return type:	bool
Returns:	The editable state of the column.

isLocationName()¶

Return type:	bool
Returns:	True if this column is intended for displaying location names, otherwise False.

isTitleToggledOn()¶

Return type:	bool
Returns:	Whether the title is turned on or off. This is only valid if the title’s ClickStyle is Toggle (see setTitleClickStyle).

isValueComparisonEnabled()¶

Return type:	bool
Returns:	True if the value of a parameter that corresponds to a cell in the column for which the item delegate instance is used is to be compared to the value of the corresponding attribute in the scene that is produced at the currently viewed node, or False if not.
See:	setValueComparisonEnabled

setAttributeName(attributeName, callCallback=True)¶

Sets the attribute name associated with this column.

Parameters:	attributeName (str) – The attribute name to set for this column. callCallback (bool) – An optional flag (default: True) indicating whether the column changed callback should be called if the given attribute name is different to the currently set attribute name for this column.

setAttributeNames(*attributeNames, **kwargs)¶

Sets the attribute names associated with this column.

Specifying callCallback=False as a keyword argument will prevent the column changed callback from being called.

Parameters:	attributeNames (list of str) – The attribute names to set for this column.

setDataType(dataType)¶

Sets the type of data that the column represents to the given column data type.

Parameters:	dataType (cls) – The type of data that the column is to represent.

setEditable(editable)¶

Sets the editable state of this column to the given editable state.

Parameters:	editable (bool) – The editable state to set for the column.

setFixedWidth(fixedWidth)¶

Sets or resets the fixed width used for the column.

Parameters:	fixedWidth (int or None) – The fixed width to use for the column, or None to reset the fixed width.

setIsLocationName(isLocationName)¶

Sets whether this column is intended for displaying location names.

Parameters:	isLocationName (bool) – True if this column is intended for displaying location names, otherwise False.

setLookFileMaterialCallback(lookFileMaterialAssignmentCallback)¶

Sets the callback used to assign a Look File Material to a given package.

Parameters:	lookFileMaterialAssignmentCallback (callable or None) – The callback to use when assigning a Look File Material to a package.
Raises:	ValueError – If the given callback object is not callable.

setMasterMaterialCallbacks(masterMaterialsRequestCallback, masterMaterialAssignmentCallback)¶

Sets the callbacks to use for obtaining a list of paths of scene graph locations that represent Master Materials and for assigning a Master Material to a light to the given callbacks.

Parameters:	masterMaterialsRequestCallback (callable or None) – The callback to use for obtaining a list of paths of Master Material scene graph locations. masterMaterialAssignmentCallback (callable or None) – The callback to use for assigning a Master Material to a light.
Raises:	ValueError – If one of the given callback objects is not callable.

setMaximumWidth(maximumWidth)¶

Sets or resets the maximum width used for the column.

Parameters:	maximumWidth (int or None) – The maximum width to use for the column, or None to reset the maximum width.

setMinimumWidth(minimumWidth)¶

Sets or resets the minimum width used for the column.

Parameters:	minimumWidth (int or None) – The minimum width to use for the column, or None to reset the minimum width.

setProperty(propertyName, propertyValue)¶

Sets the column property with the given name to the given value.

Parameters:	propertyName (str) – The name of the column property to set. propertyValue (object or None) – The value to set for the column property.
Raises:	RuntimeError – When an attempt is made to set a property when the data type of the column has not been set. ValueError – When the column’s data type doesn’t declare the name of the property valid.

setTitleClickStyle(titleClickStyle)¶

Parameters:	titleClickStyle (str) – The style in which the title behaves in response to click events. Must be one of SceneGraphColumnTitle.ClickStyles.MenuIndicator or SceneGraphColumnTitle.ClickStyles.Toggle. By default it is MenuIndicator.

setTitleClickedCallback(callback)¶

Sets a callback to be triggered when the title of this column is clicked.

Parameters:	callback (callable or None) – The callback to be triggered when the header of the column is clicked, or None to reset the callback.
Raises:	ValueError – If the given callback object is not callable.

setTitleIcon(icon)¶

Parameters:	icon (QtGui.QIcon or None) – The icon to show in the column title, or None if no icon is to be shown.

setTitleIconName(titleIconName)¶

Sets the name of the icon to use for the title of this column to the given title icon name.

For convenience, also sets the title style to TextAndIcon if it is currently set to TextOnly. If you would like only the icon to be shown, set the title style to IconOnly using setTitleStyle.

Parameters:	titleIconName (str) – The name of the title icon to use for the column.
Note:	The title icon may or may not be displayed in the header for the column, depending on its title style.

setTitleStyle(titleStyle)¶

Sets the title style for this column to the given title style.

Parameters:	titleStyle (str) – The new title style for the column. Must be one of SceneGraphColumnTitle.TextOnly, IconOnly or TextAndIcon.

setTitleText(titleText)¶

Sets the title text for this column to the given title text.

Parameters:	titleText (str) – The new title text for the column.
Note:	The title text may or may not be displayed in the header for the column, depending on its title style.

setTitleToggledOn(titleToggledOn)¶

Parameters:	titleToggledOn (bool) – Whether the title is turned on or off.

setTitleToolTip(toolTip)¶

Sets the tooltip text to display for the title.

Parameters:	toolTip (str) – The tooltip text to display for the title.

setValueComparisonEnabled(valueComparisonEnabled)¶

Sets the flag that controls whether the item delegate instance is to check if the value of a parameter that corresponds to a cell in the column for which the instance is used matches the value of the corresponding attribute in the scene that is produced at the currently viewed node. Item delegate classes can evaluate the flag in initStyleOption() functions to determine whether to alter the appearance and editing behaviour of cells for which the values differ.

Parameters:	valueComparisonEnabled (bool) – The flag value.

setWidth(width)¶

Parameters:	width (int) – The desired width of the column in pixels. This is -1 by default, indicating no preference for the width of the column.

titleClicked(columnTitleRect)¶

Called when the title of this column is clicked by the user.

Parameters:	columnTitleRect (QtCore.QRect) – The global screen position and size of the column title that was clicked.