Package nuke :: Class File_Knob
[hide private]
[frames] | no frames]

Class File_Knob

  object --+            
           |            
   nuke.Knob --+        
               |        
nuke.String_Knob --+    
                   |    
nuke.EvalString_Knob --+
                       |
                      nuke.File_Knob

A knob which holds a filename. When it appears in a Node panel it provides a text field to show the filename and a button which opens the file chooser dialog.

Instance Methods [hide private]
 
__init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
a new object with type S, a subtype of T
__new__(T, S, ...)
None
fromScript(self, s)
Assign string to knob.
None
fromUserText(self, s)
Assign string to knob, parses frame range off the end and opens file to get set the format.
String
getEvaluatedValue(self, oc)
Returns the string on this knob, will be normalized to technical notation if sequence (%4d).
String
getValue(self)
Returns the string on this knob, will be normalized to technical notation if sequence (%4d).
None
setValue(self, s)
Assign string to knob.
String
value(self)
Returns the string on this knob, will be normalized to technical notation if sequence (%4d).

Inherited from EvalString_Knob: evaluate

Inherited from String_Knob: getText, setText, splitView, unsplitView

Inherited from Knob: Class, clearAnimated, clearFlag, critical, debug, enabled, error, fullyQualifiedName, getDerivative, getFlag, getIntegral, getKeyIndex, getKeyTime, getNthDerivative, getNumKeys, 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 x.__class__.__doc__ for signature

Overrides: object.__init__

__new__(T, S, ...)

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

fromScript(self, s)

 

Assign string to knob.

Parameters:
  • s - String to assign.
Returns: None
None.
Overrides: Knob.fromScript

fromUserText(self, s)

 

Assign string to knob, parses frame range off the end and opens file to get set the format.

Parameters:
  • s - String to assign.
Returns: None
None.

getEvaluatedValue(self, oc)

 

Returns the string on this knob, will be normalized to technical notation if sequence (%4d). Will also evaluate the string for any tcl expressions

Returns: String
String.

getValue(self)

 

Returns the string on this knob, will be normalized to technical notation if sequence (%4d).

Parameters:
  • oc - Optional parameter specifying the output context.
Returns: String
String.
Overrides: Knob.getValue

setValue(self, s)

 

Assign string to knob.

Parameters:
  • s - String to assign.
Returns: None
None.
Overrides: Knob.setValue

value(self)

 

Returns the string on this knob, will be normalized to technical notation if sequence (%4d).

Parameters:
  • oc - Optional parameter specifying the output context.
Returns: String
String.
Overrides: Knob.value