Package nuke :: Class Format_Knob

[frames] | no frames]

Class Format_Knob

object --+    
         |    
 nuke.Knob --+
             |
            nuke.Format_Knob

Format_Knob

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

Format

actualValue()
Return value of knob.

True if succeeded, False otherwise

fromScript(s)
Initialise from script s.

string

name()
Return name of knob.

True if set to its default value, False otherwise.

notDefault()

True if succeeded, False otherwise

setValue(format)
Set value of knob to format (either a Format object or a name of a format, e.g.

string

toScript(quote, context=current)
Return the value of the knob in script syntax.

Format

value()
Return value of knob.

Inherited from Knob: Class, clearAnimated, clearFlag, critical, debug, enabled, error, fullyQualifiedName, getDerivative, getFlag, getIntegral, getKeyIndex, getKeyList, getKeyTime, getNthDerivative, getNumKeys, getValue, getValueAt, hasExpression, isAnimated, isKey, isKeyAt, label, node, removeKey, removeKeyAt, setAnimated, setEnabled, setExpression, setFlag, setLabel, setName, setTooltip, setValueAt, 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__

fromScript(s)

Initialise from script s.

Returns: True if succeeded, False otherwise
Overrides: Knob.fromScript

name()

Return name of knob.

Returns: string: name.
Overrides: Knob.name

setValue(format)

Set value of knob to format (either a Format object or a name of a format, e.g. "NTSC").

Returns: True if succeeded, False otherwise: True if successful, False if not.
Overrides: Knob.setValue

toScript(quote, context=current)

Return the value of the knob in script syntax. Pass True for quote to return results quoted in {}. Pass None for context to get results for all views and key times (as stored in a .nk file).

Returns: string
Overrides: Knob.toScript

value()

Return value of knob.

Returns: Format
Overrides: Knob.value