Package nuke :: Class ViewerWindow

Class ViewerWindow

object --+
         |
        nuke.ViewerWindow

ViewerWindow

Instance Methods

[hide private]

None

activateInput(self, input, secondary=False)
Set the given viewer input to be active - i.

int

activeInput(self, secondary=False)
Returns the currently active input of the viewer - i.

True

frameControl(self, i)
i is an integer indicating viewer frame control 'button' to execute:

Matrix4

getGLCameraMatrix(self)
Return the world transformations of the current GL viewer camera.

None

getGeometryNodes(self)
Returns the a list of geometry nodes attached with this viewer

switch to next view in settings Views list.

nextView(self)

Node

node(self)
Returns the Viewer node currently associated with this window.

play(...)
Play forward (1) or reverse (0).

switch to previous view in settings Views list.

previousView(self)

set 'current' multi-view view to 's'.

setView(self, s)

stop(...)
Stop playing.

string name of 'current' multi-view view.

view(self)

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __init__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

activateInput(self, input, secondary=False)

Set the given viewer input to be active - i. e. show its image in the output window.

Parameters:

input - The viewer input number, starting with 0 for the first. If the input is not connected, a ValueError exception is raised.
secondary - True if the input should be connected as the secondary (wipe) input, or False to connect it as the primary input (the default).

Returns: None

None

activeInput(self, secondary=False)

Returns the currently active input of the viewer - i. e. the one with its image in the output window.

Parameters:

secondary - True to return the index of the active secondary (wipe) input, or False (the default) to return the primary input.

Returns: int

int: The currently active input of the viewer, starting with 0 for the first, or None if no input is active.

frameControl(self, i)

i is an integer indicating viewer frame control 'button' to execute:

   -6 go to start
   -5 play reverse
   -4 go to previous keyframe
   -3 step back by increment
   -2 go back previous keyframe or increment, whichever is closer
   -1 step back one frame

    0 stop

   +1 step forward one frame
   +2 go to next keyframe or increment, whichever is closer
   +3 step forward by increment
   +4 go to next keyframe
   +5 play forward
   +6 go to end

Returns: True

getGLCameraMatrix(self)

Return the world transformations of the current GL viewer camera.

Returns: Matrix4: Matrix4: GL camera world transformation.

getGeometryNodes(self)

Returns the a list of geometry nodes attached with this viewer

Returns: None: Nodes: a list of the geometry nodes.

node(self)

Returns the Viewer node currently associated with this window.

Returns: Node: Node.