nuke.Enumeration_Knob

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

# Class Enumeration_Knob

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

Known Subclasses:
  - Bitmask_Knob
  - , CascadingEnumeration_Knob
  - , OneView_Knob
  - , Pulldown_Knob

Stores a single value between 0 and some maximum, and manages a set of keywords visible to the user. The words themselves are displayed on a pulldown list in the user interface, and are written to the saved scripts (so that the numerical values can change).

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, ...) |
string |
enumName(self, n) Return name of enumeration n. |
int |
numValues(self) Return number of values. |
None |
setValue(self, item) Set the current value. |
None |
setValues(self, items) (Re)initialise knob to the supplied list of items. |
String |
value(self) Current value. |
List of strings |
values(self) Return list of items. |
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`, `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__

### enumName(self, n) |
Return name of enumeration n. The argument n is an integer and in the range of 0 and numValues. Deprecated. Returns: string

### numValues(self) |
Return number of values. Deprecated. Returns: int

### setValue(self, item) |
Set the current value. If item is of an Integer type it will treat it as an index to the enum, otherwise as a value. Parameters: `item` - String or Integer. Returns: None None. Example: w = nuke.nodes.Write() k = w['file_type'] k.setValue('exr') Overrides: Knob.setValue

### setValues(self, items) |
(Re)initialise knob to the supplied list of items. Parameters: `items` - The new list of values. Returns: None None. Example: w = nuke.nodes.Write() k = w['file_type'] k.setValues(['exr'])

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

### values(self) |
Return list of items. Returns: List of strings List of strings. Example: w = nuke.nodes.Write() k = w['file_type'] k.values()