Package nuke :: Class BBox_Knob

[frames] | no frames]

Class BBox_Knob

 object --+        
          |        
  nuke.Knob --+    
              |    
nuke.Array_Knob --+
                  |
                 nuke.BBox_Knob

A knob which holds a bounding box.

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

None

fromDict(self, box)
Set the bounding box from the given box.

names(...)
Return name for dimension 'i'

r(...)
Return value for R extent.

setR(...)
Set value for R extent.

setT(...)
Set value for T extent.

setX(...)
Set value for X position.

setY(...)
Set value for Y position.

t(...)
Return value for T extent.

dict

toDict(self)
Returns the bounding box as a dict with x, y, r, and t keys.

Floating point or List of floating point values (in case some are different)

value(self, index, view, time)
Return value for dimension 'i'

x(...)
Return value for X position.

y(...)
Return value for Y position.

Inherited from Array_Knob: animation, animations, array, arraySize, clearAnimated, copyAnimation, copyAnimations, defaultValue, deleteAnimation, dimensions, frame, fromScript, getDerivative, getIntegral, getKeyIndex, getKeyTime, getNthDerivative, getNumKeys, getValue, getValueAt, hasExpression, height, isAnimated, isKey, isKeyAt, max, maximum, min, minimum, notDefault, removeKey, removeKeyAt, resize, setAnimated, setDefaultValue, setExpression, setKeyAt, setRange, setSingleValue, setValue, setValueAt, singleValue, splitView, toScript, unsplitView, valueAt, vect, width

Inherited from Knob: Class, clearFlag, critical, debug, enabled, error, fullyQualifiedName, getFlag, getKeyList, label, name, node, setEnabled, setFlag, setLabel, setName, setTooltip, 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__

fromDict(self, box)

Set the bounding box from the given box.

Parameters:

box - Dictionary containing the x, y, r and t keys.

Returns: None

None

toDict(self)

Returns the bounding box as a dict with x, y, r, and t keys.

Returns: dict: dict with x, y, r and t keys

value(self, index, view, time)

Return value for dimension 'i'

Parameters:

index - Optional index. Default is 0.
view - Optional view.
time - Optional time.

Returns: Floating point or List of floating point values (in case some are different)

Floating point or List of floating point values (in case some are different).

Overrides: Knob.value