Package nuke :: Class SceneView_Knob
[hide private]
[frames] | no frames]

Class SceneView_Knob

 object --+            
          |            
  nuke.Knob --+        
              |        
nuke.Array_Knob --+    
                  |    
 nuke.Unsigned_Knob --+
                      |
                     nuke.SceneView_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 x.__class__.__doc__ for signature
a new object with type S, a subtype of T
__new__(T, S, ...)
None
addItems(self)
Adds a list of string items to the knob.
list
getAllItems(self)
Returns a list of strings containing all items that the knob can import.
string
getHighlightedItem(self)
Returns a string containing the item which is currently highlighted.
list
getImportedItems(self)
Returns a list of strings containing all items imported into the knob.
list
getSelectedItems(self)
Returns a list of strings containing all currently selected items in the knob.
None
removeItems(self)
Removes a list of string items from the knob.
None
setAllItems(self, items, autoSelect)
Sets a list of strings containing all items that the knob can import.
None
setImportedItems(self, items)
Sets a list of strings containing all items imported into the knob.
None
setSelectedItems(self)
Takes a list of strings of items contained in the knob and sets them as selected.

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, 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 x.__class__.__doc__ for signature

Overrides: object.__init__

__new__(T, S, ...)

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

addItems(self)

 

Adds a list of string items to the knob. New items are automatically set as imported and selected.

Returns: None

setAllItems(self, items, autoSelect)

 

Sets a list of strings containing all items that the knob can import. After calling this function, only items from this list can be imported into the nosde.

Parameters:
  • items - List of imported items.
  • autoSelect - If True, all items are automatically set as imported and selected.
Returns: None
None.

setImportedItems(self, items)

 

Sets a list of strings containing all items imported into the knob. This will overwrite the current imported items list.@param items: List of imported items.

Returns: None
None.