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

Class Unsigned_Knob

 object --+        
          |        
  nuke.Knob --+    
              |    
nuke.Array_Knob --+
                  |
                 nuke.Unsigned_Knob
Known Subclasses:

A knob which holds one or more unsigned integer values.

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, ...)
bool
setValue(self, val)
Set the unsigned integer value of this knob.
int
value(self)
Get the value of this knob as an integer.

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__

setValue(self, val)

 

Set the unsigned integer value of this knob.

Parameters:
  • val - The new value for the knob. Must be an integer >= 0.
Returns: bool
True if succeeded, False otherwise.
Overrides: Knob.setValue

value(self)

 

Get the value of this knob as an integer.

Parameters:
  • index - Optional index. Default is 0.
  • view - Optional view.
  • time - Optional time.
Returns: int
int
Overrides: Knob.value