nuke.ChannelMask_Knob

class nuke.ChannelMask_Knob

Bases: Channel_Knob

Methods

Class

return

Class name.

channelSelector

checkMarks

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.

depth

Get the channel depth.

enableChannel

Enable or disable a channel.

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.

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

getValue

Return value at the current frame for channel ‘c’.

getValueAt

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

hasExpression

Return True if animation at index ‘index’ has an expression.

inputKnob

inputNumber

isAnimated

Return True if channel ‘c’ is animated.

isChannelEnabled

Test if a channel is enabled.

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.

layerSelector

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.

setEnable

Enable a channel.

setEnabled

Enable or disable the knob.

setExpression

Set the expression for a knob.

setFlag

Logical OR of the argument and existing knob flags.

setInput

Set the input number for this knob.:param num: The number of the new input.

setLabel

param s

New label.

setName

param s

New name.

setTooltip

param s

New tooltip.

setValue

Set the selected channel using the channel name.

setValueAt

Sets the value ‘val’ at channel ‘chan’ for time ‘time’.

setVisible

Show or hide the knob.

toScript

Return the value of the knob in script syntax.

tooltip

return

tooltip.

value

Get the name of the selected channel.

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.

channelSelector() → bool
checkMarks() → bool
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.

depth() → int

Get the channel depth. :return: The depth of the channel as an int.

enableChannel(name, b) → None

Enable or disable a channel. :param name: The name of the channel. :param b: True to enable the channel, False to disable it. :return: 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.

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

getValue()

Return value at the current frame for channel ‘c’.

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.

inputKnob() → bool
inputNumber() → int
isAnimated()

Return True if channel ‘c’ is animated.

isChannelEnabled(name) → bool

Test if a channel is enabled. :param name: The name of the channel.:return: True if the channel is enabled, False otherwise.

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.

layerSelector() → bool
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.

setEnable(name) → None

Enable a channel. :param name: The name of the channel to enable. :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.

setInput(num) → None

Set the input number for this knob.:param num: The number of the new input. :return: None

setLabel(s) → None.
Parameters

s – New label.

Returns

None.

setName(s) → None.
Parameters

s – New name.

Returns

None.

setTooltip(s) → None.
Parameters

s – New tooltip.

Returns

None.

setValue(name) → None

Set the selected channel using the channel name. :param name: The name of the new channel as a string. :return: None :raise ValueError exception if the channel doesn’t exist.

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.

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.

value() → str

Get the name of the selected channel. :return: The name of the channel as a string.

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.