nuke.String_Knob

class nuke.String_Knob

Bases: Knob

A knob which holds a string value. Appears as a text entry field in a Node panel.

Methods

Class

return

Class name.

clearAnimated

Clear animation for channel 'c'.

clearFlag

Clear flag.

critical

param message

message to put the knob in error, and do a popup.

debug

param message

message to put out to the error console, attached to the knob, if the verbosity level is set high enough.

enabled

return

True if the knob is enabled, False if it's disabled.

error

param message

message to put the knob in error.

fromScript

Initialise from script.

fullyQualifiedName

Returns the fully-qualified name of the knob within the node.

getAuthorMode

Returns the authoring mode currently set on the knob.

getAuthorModes

Returns the names of the authoring modes of the knob if the knob is an authoring knob, otherwise an empty list.

getDerivative

Return derivative at time 't' for channel 'c'.

getFlag

Returns whether the input flag is set.

getIntegral

Return integral at the interval [t1, t2] for channel 'c'.

getKeyIndex

Return keyframe index at time 't' for channel 'c'.

getKeyList

Get all unique keys on the knob.

getKeyTime

Return index of the keyframe at time 't' for channel 'c'.

getNthDerivative

Return nth derivative at time 't' for channel 'c'.

getNumKeys

Return number of keyframes for channel 'c'.

getText

Get the non-evaluated value of this knob - also see value() :param oc: Optional parameter specifying the output context.

getValue

self.value(oc) -> str

getValueAt

Return value at time 't' for channel 'c'.

hasExpression

Return True if animation at index 'index' has an expression.

isAnimated

Return True if channel 'c' is animated.

isKey

Return True if there is a keyframe at the current frame for channel 'c'.

isKeyAt

Return True if there is a keyframe at time 't' for channel 'c'.

label

return

label.

name

return

name.

node

Return the node that this knob belongs to.

removeKey

Remove key for channel 'c'.

removeKeyAt

Remove key at time 't' for channel 'c'.

setAnimated

Set channel 'c' to be animated.

setAuthorMode

Sets the authoring mode on the knob.

setEnabled

Enable or disable the knob.

setExpression

Set the expression for a knob.

setFlag

Logical OR of the argument and existing knob flags.

setLabel

param s

New label.

setName

param s

New name.

setText

self.setValue(val, view='default') -> None

setTooltip

param s

New tooltip.

setValue

Set value of knob.

setValueAt

Sets the value 'val' at channel 'chan' for time 'time'.

setVisible

Show or hide the knob.

splitView

Split the view away from the current knob value.

toScript

Return the value of the knob in script syntax.

tooltip

return

tooltip.

unsplitView

Unsplit the view so that it shares a value with other views.

value

Get the evaluated value of this knob as a string - also see getText().

visible

return

True if the knob is visible, False if it's hidden.

warning

param message

message to put a warning on the knob.

Class() Class name.
Returns

Class name.

clearAnimated()

Clear animation for channel ‘c’. Return True if successful.

clearFlag(f) None.

Clear flag. :param f: Flag. :return: None.

critical(message) None.
Parameters

message – message to put the knob in error, and do a popup.

Returns

None.

debug(message) None.
Parameters

message – message to put out to the error console, attached to the knob, if the verbosity level is set high enough.

Returns

None.

enabled() Boolean.
Returns

True if the knob is enabled, False if it’s disabled.

error(message) None.
Parameters

message – message to put the knob in error.

Returns

None.

fromScript()

Initialise from script.

fullyQualifiedName(channel=- 1) string

Returns the fully-qualified name of the knob within the node. This can be useful for expression linking.

Parameters

channel – Optional parameter, specifies the channel number of the sub-knob (for example, channels of 0 and 1 would refer to the x and y of a XY_Knob respectively), leave blank or set to -1 to get the qualified name of the knob only.

Returns

The string of the qualified knob or sub-knob, which can be used directly in expression links.

getAuthorMode() Integer.

Returns the authoring mode currently set on the knob. This is a unique string identifier of the option, which is also used for serialisation and deserialisation. It is not meant to change,thus one can rely on it. :return: The string identifier of the current authoring mode set.

getAuthorModes() List.

Returns the names of the authoring modes of the knob if the knob is an authoring knob, otherwise an empty list. :return: The names of the authoring modes of the knob if the knob is an authoring knob, otherwise an empty list. This is a list of strings.

getDerivative()

Return derivative at time ‘t’ for channel ‘c’.

getFlag(f) Bool.

Returns whether the input flag is set. :param f: Flag. :return: True if set, False otherwise.

getIntegral()

Return integral at the interval [t1, t2] for channel ‘c’.

getKeyIndex()

Return keyframe index at time ‘t’ for channel ‘c’.

getKeyList()

Get all unique keys on the knob. Returns list.

getKeyTime()

Return index of the keyframe at time ‘t’ for channel ‘c’.

getNthDerivative()

Return nth derivative at time ‘t’ for channel ‘c’.

getNumKeys()

Return number of keyframes for channel ‘c’.

getText(oc) string

Get the non-evaluated value of this knob - also see value() :param oc: Optional parameter specifying the output context. Return text associated with knob.

getValue()

self.value(oc) -> str

Get the evaluated value of this knob as a string - also see getText(). :param oc: Optional parameter specifying the output context. :return: String value.

getValueAt()

Return value at time ‘t’ for channel ‘c’.

hasExpression(index=- 1) bool

Return True if animation at index ‘index’ has an expression. :param index: Optional index parameter. Defaults to -1 if not specified. This can be specified as a keyword parameter if desired. :return: True if has expression, False otherwise.

isAnimated()

Return True if channel ‘c’ is animated.

isKey()

Return True if there is a keyframe at the current frame for channel ‘c’.

isKeyAt()

Return True if there is a keyframe at time ‘t’ for channel ‘c’.

label() label.
Returns

label.

name() name.
Returns

name.

node() nuke.Node

Return the node that this knob belongs to. If the node has been cloned, we’ll always return a reference to the original. :return: The node which owns this knob, or None if the knob has no owner yet.

removeKey()

Remove key for channel ‘c’. Return True if successful.

removeKeyAt()

Remove key at time ‘t’ for channel ‘c’. Return True if successful.

setAnimated()

Set channel ‘c’ to be animated.

setAuthorMode(authorMode) None.

Sets the authoring mode on the knob. This accepts both the unique string identifier, which is also used for serialisation and deserialisation, or index of the option for convenience. These values are not meant to change, thus one can rely on them. :param authorMode: The string identifier or index of the authoring mode. :return: None.

setEnabled(enabled) None.

Enable or disable the knob. :param enabled: True to enable the knob, False to disable it.

setExpression(expression, channel=- 1, view=None) bool

Set the expression for a knob. You can optionally specify a channel to set the expression for.

Parameters
  • expression – The new expression for the knob. This should be a string.

  • channel – Optional parameter, specifying the channel to set the expression for. This should be an integer.

  • view – Optional view parameter. Without, this command will set the expression for the current view theinterface is displaying. Can be the name of the view or the index.

Returns

True if successful, False if not.

setFlag(f) None.

Logical OR of the argument and existing knob flags. :param f: Flag. :return: None.

setLabel(s) None.
Parameters

s – New label.

Returns

None.

setName(s) None.
Parameters

s – New name.

Returns

None.

setText()

self.setValue(val, view=’default’) -> None

Set value of knob. :param val: The new value. :param view: Optional parameter specifying which view to set the value for. If omitted, the value will be set for the default view. :return: None

setTooltip(s) None.
Parameters

s – New tooltip.

Returns

None.

setValue(val, view='default') None

Set value of knob. :param val: The new value. :param view: Optional parameter specifying which view to set the value for. If omitted, the value will be set for the default view. :return: None

setValueAt(val, time, chan) bool

Sets the value ‘val’ at channel ‘chan’ for time ‘time’. :return: True if successful, False if not.

setVisible(visible) None.

Show or hide the knob. :param visible: True to show the knob, False to hide it.

splitView(view) None.

Split the view away from the current knob value. :param view: Optional view. Default is current view. :return: None.

toScript(quote, context=current) string.

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

tooltip() tooltip.
Returns

tooltip.

unsplitView(view) None.

Unsplit the view so that it shares a value with other views. :param view: Optional view. Default is current view. :return: None.

value(oc) str

Get the evaluated value of this knob as a string - also see getText(). :param oc: Optional parameter specifying the output context. :return: String value.

visible() Boolean.
Returns

True if the knob is visible, False if it’s hidden.

warning(message) None.
Parameters

message – message to put a warning on the knob.

Returns

None.