Package nuke :: Class Viewer

[frames] | no frames]

Class Viewer

object --+    
         |    
 nuke.Node --+
             |
            nuke.Viewer

Instance Methods

__getitem__(x, y)
x[y]

__len__(x)
len(x)

__repr__(x)
repr(x)

__str__(x)
str(x)

FrameRange

playbackRange(self)
Return the frame range that's currently set to be played back in the viewer.@return: FrameRange.

dict

roi(self)
Region of interest set in the viewer in pixel space coordinates.

bool

roiEnabled(self)
Whether the viewing of just a region of interest is enabled.

None

setRoi(self, box)
Set the region of interest in pixel space.

Inherited from Node: Class, __new__, __reduce_ex__, addKnob, allKnobs, autoplace, bbox, canSetInput, channels, clones, connectInput, deepSample, deepSampleCount, dependencies, dependent, error, firstFrame, forceValidate, format, frameRange, fullName, getNumKnobs, hasError, height, help, hideControlPanel, input, inputs, isSelected, knob, knobs, lastFrame, linkableKnobs, maxInputs, maxOutputs, maximumInputs, maximumOutputs, metadata, minInputs, minimumInputs, name, numKnobs, opHashes, optionalInput, pixelAspect, proxy, readKnobs, redraw, removeKnob, resetKnobsToDefault, running, sample, screenHeight, screenWidth, setInput, setName, setSelected, setXYpos, setXpos, setYpos, showControlPanel, showInfo, shown, treeHasError, width, writeKnobs, xpos, ypos

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __init__, __reduce__, __setattr__, __sizeof__, __subclasshook__

Properties

Inherited from object: __class__

Method Details

getitem(x, y)
(Indexing operator)

x[y]

Overrides: Node.__getitem__

len(x)
(Length operator)

len(x)

Overrides: Node.__len__

repr(x)
(Representation operator)

repr(x)

Overrides: object.__repr__

str(x)
(Informal representation operator)

str(x)

Overrides: object.__str__

roi(self)

Region of interest set in the viewer in pixel space coordinates. Returns None if the Viewer has no window yet.

Returns: dict: Dict with keys x, y, r and t or None.

roiEnabled(self)

Whether the viewing of just a region of interest is enabled. Returns None if the Viewer has no window yet.

Returns: bool: Boolean or None.

setRoi(self, box)

Set the region of interest in pixel space.

Parameters:

box - A dictionary with the x, y, r and t keys.@return: None.

Returns: None