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

Class Pulldown_Knob

 object --+                
          |                
  nuke.Knob --+            
              |            
nuke.Array_Knob --+        
                  |        
 nuke.Unsigned_Knob --+    
                      |    
  nuke.Enumeration_Knob --+
                          |
                         nuke.Pulldown_Knob

Pulldown_Knob

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, ...)
string
commands(n)
Return command n.
string
itemName(n)
Return name of item n.
int
numValues()
Return number of values.
None
setValues(self, items)
(Re)initialise knob to the list of items.
String
value(self)
Current value.

Inherited from Enumeration_Knob: enumName, setValue, values

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

Parameters:
  • name - Name.
  • label - Label.
  • items - List of strings. Example: k = nuke.Enumeration_Knob('MyEnumKnobName', 'MyEnumKnobLabel', ['label1', 'label2'])
Overrides: object.__init__

__new__(T, S, ...)

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

commands(n)

 

Return command n. The argument n is an integer and in the range of 0 and numValues.

Returns: string

itemName(n)

 

Return name of item n. The argument n is an integer and in the range of 0 and numValues.

Returns: string

numValues()

 

Return number of values.

Returns: int
Overrides: Enumeration_Knob.numValues

setValues(self, items)

 

(Re)initialise knob to the list of items.

Parameters:
  • items - Dictionary of name/value pairs.
  • sort - Optional parameter as to whether to sort the names.
Returns: None
None. Example: w = nuke.nodes.NoOp() k = nuke.Pulldown_Knob('kname', 'klabel') k.setValues({'label/command' : 'eval("3*2")'}) w.addKnob(k) k = w['kname']
Overrides: Enumeration_Knob.setValues

value(self)

 

Current value.

Parameters:
  • index - Optional index. Default is 0.
  • view - Optional view.
  • time - Optional time.
Returns: String
String. Example: w = nuke.nodes.Write() k = w['file_type'] k.value()
Overrides: Knob.value
(inherited documentation)