Package nuke :: Class Viewer

Class Viewer

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

Instance Methods

[hide private]

__getitem__(x, y)
x[y]

__len__(x)
len(x)

__repr__(x)
repr(x)

__str__(x)
str(x)

None

capture(file)
Capture the viewer image to a file.

Bool

frameCached(f)
Determine whether frame /f/ is known to be in the memory cache.

Bool

isPlayingOrRecording()
Returns: Is a recording being made or played?

FrameRange

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

Bool

recordMouse()
Start viewer window mouse recording.@return: Recording started?

recordMouseStop()
Stop viewer window mouse recording.

Bool

replayMouseAsync(xmlRecordingFilename)
Start timer based (asynchronous) playback of a viewer window mouse recording.@param: Name of recording xml file to play@return: Replay started?

Bool

replayMouseSync(xmlRecordingFilename)
Start direct (synchronous) playback of a viewer window mouse recording.@param: Name of recording xml file to play@return: Replay succeeded?

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.

Bool

sendMouseEvent()
Temporary: Post a mouse event to the viewer window.

None

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

Bool

toggleMouseTrails()
Toggle mouse trails in the viewer window on/off.@return: Trails now showing?

Bool

toggleWaitOnReplayEvents()
Toggle whether asynchronous playback waits on each event.

Inherited from Node: Class, __new__, __reduce_ex__, addCallback, addKnob, allKnobs, autoplace, bbox, canSetInput, channels, clearCallbacks, clearCustomIcon, clones, connectInput, deepSample, deepSampleCount, dependencies, dependent, error, executePythonCallback, fileDependencies, firstFrame, forceUpdateLocalization, forceValidate, format, frameRange, fullName, getNumKnobs, hasError, height, help, hideControlPanel, input, inputs, isLocalizationOutdated, isLocalized, isSelected, knob, knobs, lastFrame, linkableKnobs, localizationProgress, lock, locked, maxInputs, maxOutputs, maximumInputs, maximumOutputs, metadata, minInputs, minimumInputs, name, numKnobs, opHashes, optionalInput, performanceInfo, pixelAspect, proxy, readKnobs, redraw, removeCallback, removeKnob, resetKnobsToDefault, rootNode, running, sample, screenHeight, screenWidth, selectOnly, setCustomIcon, setInput, setName, setSelected, setTab, setXYpos, setXpos, setYpos, showControlPanel, showInfo, shown, treeHasError, unlock, upstreamFrameRange, width, writeKnobs, xpos, ypos

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

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

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__

capture(file)

Capture the viewer image to a file. Only jpg files are supported at present. The image is captured immediately even if the viewer is mid-render.To capture a fully rendered image at a frame or frame range use nuke.render passing in the viewer node you want to capture.When using nuke.render the filename is specified by the 'file' knob on the viewer node.

Returns: None

isPlayingOrRecording()

Returns: Bool: Is a recording being made or played?

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

toggleWaitOnReplayEvents()

Toggle whether asynchronous playback waits on each event. Otherwise events will be handled by the next nuke update.@return: Now waiting?

Returns: Bool

Class Viewer

__getitem__(x, y) (Indexing operator)

__len__(x) (Length operator)

__repr__(x) (Representation operator)

__str__(x) (Informal representation operator)

capture(file)

isPlayingOrRecording()

roi(self)

roiEnabled(self)

setRoi(self, box)

toggleWaitOnReplayEvents()

getitem(x, y)
(Indexing operator)

len(x)
(Length operator)

repr(x)
(Representation operator)

str(x)
(Informal representation operator)