Package nuke :: Class Disable_Knob

[frames] | no frames]

Class Disable_Knob

 object --+            
          |            
  nuke.Knob --+        
              |        
nuke.Array_Knob --+    
                  |    
  nuke.Boolean_Knob --+
                      |
                     nuke.Disable_Knob

A knob which holds a boolean value representing the disabled state of a node. This appears in a Node panel as a check box.

Instance Methods

__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, b)
Set the boolean value of this knob.

bool

value(self)
Get the boolean value for this knob.

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

Inherited from object: __class__

Method Details

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, b)

Set the boolean value of this knob.

Parameters:

b - Boolean convertible object.

Returns: bool

True if modified, False otherwise.

Overrides: Knob.setValue

value(self)

Get the boolean value for this knob.

Parameters:

index - Optional index. Default is 0.
view - Optional view.
time - Optional time.

Returns: bool

True or False.

Overrides: Knob.value