Viewer
Jump to navigation
Jump to search
The View is a global object used to interact with the viewer and tools.
Attributes
| Name | Description |
|---|---|
| angle | The current display angle, when rotate mode is enabled. |
| blend | The current blend amount, for blending between views in supported nodes. |
| channelMask | The current channel mask, as a Color. |
| colorSpace | The current OCIO display colorspace name. |
| device | The current OCIO display device name. |
| exposure | The current display exposure value. |
| gamma | The current display gamma value. |
| hand | True if viewer rotate angle edit mode is enabled. |
| lut | The current OCIO display LUT name, or None. |
| magnify | True if the magnifier is enabled. |
| maskEnabled | True if the frame mask is enabled. |
| node | The active edit Node. Setting this will change the Node being edited. |
| overlay | True if the overlay is enabled. |
| rotate | True if viewer rotate mode is enabled. |
| stabilize | True if stabilization is enabled. |
| stereo | True if the current Node generates or passes stereo data. |
| stereoAlign | True if in stereo alignment mode |
| streamMask | The current Stream Mask (read-only), indicating which streams the current Node generates or passes (ie. the available streams). |
| streamMode | The current Stream Mode. Check the streamMask attribute to determine the available streams. |
| toolName | The current tool name. |
| updateMode | The current update mode (0=Drag, 1=Adaptive, 2=Release, 3=Manual) |
| viewMode | The current view mode (the number of available view modes depends on the current edit Node) |
| viewNode | The current viewing Node. Note the view node can be different than the edit node. |
| xform | The current OCIO display transform name. |
| zoom | The current zoom level (1=1:1, -1=zoom-to-fit) |
| zoomFactor | The current 'zoom factor' preference value. |
Methods
| Name | Description |
|---|---|
| gotoEnd() | Jumps to the work range end frame. |
| gotoHome() | Jumps to the work range start frame. |
| gotoNextEdit() | Jump to the next key-frame in the selection. |
| gotoPrevEdit() | Jump to the previous key-frame in the selection. |
| play(step=1) | Begins playback with the desired step. step can be negative, to play backward. |
| setFrame(frame) | Sets the current (zero-based) frame. |
| stepBackward() | Moves to the previous frame. |
| stepForward() | Moves to the next frame. |
| stop() | Stop playback. |
