Package nuke :: Class SceneGraph_Knob

Class SceneGraph_Knob

 object --+            
          |            
  nuke.Knob --+        
              |        
nuke.Array_Knob --+    
                  |    
 nuke.Unsigned_Knob --+
                      |
                     nuke.SceneGraph_Knob

Displays a list of items as a hierarchy. The hierarchy is specified using back or forward slashes within the item names to specify their level in the tree. Handles multiple selection of items within the tree.

Instance Methods

[hide private]

__init__(...)
x.__init__(...) initializes x; see help(type(x)) for signature

a new object with type S, a subtype of T

__new__(T, S, ...)

addItems(...)
self.addItems([(name1, type1), (name2, type2), ...], autoSelect=false) -> None

tuple of strings (name, type)

getItems(self)
Returns a tuple of string tuples (name, type).

list

getSelectedItems(self)
Returns: list of strings containing all currently selected items in the knob.

None

removeItems(self, name1=..., name2=..., ...)
Removes a list of string names from the knob.

setItems(...)
self.setItems([(name1, type1), (name2, type2), ...], autoSelect=false) -> None

None

setSelectedItems(self, name1=..., name2=..., ...)
Returns: None.

Inherited from Unsigned_Knob: setValue, value

Inherited from Array_Knob: animation, animations, array, arraySize, clearAnimated, copyAnimation, copyAnimations, defaultValue, deleteAnimation, dimensions, frame, fromScript, getDerivative, getIntegral, getKeyIndex, getKeyTime, getNthDerivative, getNumKeys, getValue, getValueAt, hasExpression, height, isAnimated, isKey, isKeyAt, max, maximum, min, minimum, notDefault, removeKey, removeKeyAt, resize, setAnimated, setDefaultValue, setExpression, setKeyAt, setRange, setSingleValue, setValueAt, singleValue, splitView, toScript, unsplitView, valueAt, vect, width

Inherited from Knob: Class, clearFlag, critical, debug, enabled, error, fullyQualifiedName, getFlag, getKeyList, label, name, node, setEnabled, setFlag, setLabel, setName, setTooltip, setVisible, tooltip, visible, warning

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(...)
(Constructor)

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__

new(T, S, ...)

Returns: a new object with type S, a subtype of T
Overrides: object.__new__

addItems(...)

self.addItems([(name1, type1), (name2, type2), ...], autoSelect=false) -> None

Adds to the existing list of items that can be selected on the knob.@param items: sequence of string tuples (name, type) .

Parameters:

autoSelect - If True, all items are automatically set as selected.

Returns:

None.

getSelectedItems(self)

Returns: list: list of strings containing all currently selected items in the knob.

setItems(...)

self.setItems([(name1, type1), (name2, type2), ...], autoSelect=false) -> None

Sets the list of items that can be selected on the knob.@param items: sequence of string tuples (name, type) .

Parameters:

autoSelect - If True, all items are automatically set as imported and selected.

Returns:

None.

setSelectedItems(self, name1=..., name2=..., ...)

Parameters:

items - sequence of strings - names of the items in the list .

Returns: None

None. .

Class SceneGraph_Knob

__init__(...) (Constructor)

__new__(T, S, ...)

addItems(...)

getSelectedItems(self)

setItems(...)

setSelectedItems(self, name1=..., name2=..., ...)

init(...)
(Constructor)

new(T, S, ...)