Trees       Indices       Help   
Nuke Python API
Package nuke :: Class Channel_Knob
[hide private]
[frames] | no frames]

Class Channel_Knob

object --+    
         |    
 nuke.Knob --+
             |
            nuke.Channel_Knob
Known Subclasses:

A knob which lets you select a layer and enable or disable individual channels. self.__init__(s, label, depth) -> None Constructor.

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
channelSelector(self)
bool
checkMarks(self)
int
depth(self)
Get the channel depth.
None
enableChannel(self, name, b)
Enable or disable a channel.
bool
inputKnob(self)
int
inputNumber(self)
bool
isChannelEnabled(self, name)
Test if a channel is enabled.
bool
layerSelector(self)
None
setEnable(self, name)
Enable a channel.
None
setInput(self, num)
Set the input number for this knob.@param num: The number of the new input.
None
setValue(self, name)
Set the selected channel using the channel name.
str
value(self)
Get the name of the selected channel.

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

Parameters:
  • s - name.
  • label - Optional name to appear in GUI. Defaults to the knob's name.
  • depth - Optional number of channels with zero being the Nuke default number of channels. Defaults to 0.
Overrides: object.__init__

__new__(T, S, ...)

 
Returns: a new object with type S, a subtype of T
Overrides: object.__new__

depth(self)

 

Get the channel depth.

Returns: int
The depth of the channel as an int.

enableChannel(self, name, b)

 

Enable or disable a channel.

Parameters:
  • name - The name of the channel.
  • b - True to enable the channel, False to disable it.
Returns: None
None

isChannelEnabled(self, name)

 

Test if a channel is enabled.

Parameters:
  • name - The name of the channel.@return: True if the channel is enabled, False otherwise.
Returns: bool

setEnable(self, name)

 

Enable a channel.

Parameters:
  • name - The name of the channel to enable.
Returns: None
None

setInput(self, num)

 

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

Returns: None
None

setValue(self, name)

 

Set the selected channel using the channel name.

Parameters:
  • name - The name of the new channel as a string.
Returns: None
None @raise ValueError exception if the channel doesn't exist.
Overrides: Knob.setValue

value(self)

 

Get the name of the selected channel.

Returns: str
The name of the channel as a string.
Overrides: Knob.value

   Trees       Indices       Help   
Nuke Python API
Generated by Epydoc 3.0.1 on Fri Jun 30 18:46:41 2017 http://epydoc.sourceforge.net