Eyeon:Script/Reference/Applications/Fusion/Classes/GLView

From VFXPedia

< Eyeon:Script | Reference | Applications | Fusion | Classes
Revision as of 02:10, 7 December 2009 by Daniel (Talk | contribs)
(diff) ← Older revision | Current revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Parent Class: Object

GLView

Contents

Methods:

SetBufferShow one of the A or B buffers
GetBufferReturns which buffer is shown
GetPreviewReturns the buffer's Preview object
GetViewerListReturns a list of available viewers
SetScaleSet the scale of the display
GetScaleReturns the scale of the display
SetPosSet the position of the display
GetPosReturns the position of the display
GetPosTableReturns the position of the display as a table
GetRotReturns the x,y,z rotation of the display in degrees
SetRotSet the x,y,z rotation of the display in degrees
GetRotTableReturns the x,y,z rotation of the display in degrees as a table
ResetViewResets the display to default position etc
SetSplitSet the split position of the view
GetSplitGet the split position of the view
GetSplitTableGet the split position of the view as a table
SetLockedLock or unlock the display
GetLockedReturns true if the display is locked
DisableCurrentToolsPass-through the currently selected tool
ShowSubViewEnables the inset SubView display
ShowingSubViewReturns true if the inset SubView is currently being displayed
SwapSubViewSwaps the SubView with the Main View
ShowQuadViewSplits the view into four subviews
ShowingQuadViewReturns true if the view is split into four
SavePrefsSaves the current view prefs to a named configuration
LoadPrefsLoads the current view prefs from a named configuration
GetPrefsRetrieve a table of preferences for this view
EnableLUTEnables or disables the current Buffer LUT
IsLUTEnabledReturns true if the current Buffer LUT is enabled
LoadLUTFileLoads a LUT file, setting or LUT plugin ID into the Buffer LUT
ShowLUTEditorPops up the Editor window for the current Buffer LUT
EnableStereoEnables or disables 3D stereo display
IsStereoEnabledIndicates if stereo display is currently enabled
SwapStereoSwaps left & right stereo eye views
IsStereoSwappedIndicates if the left & right stereo eyes are currently swapped
SetStereoSourceSets the source for the left & right stereo images
GetStereoSourceReturns the source being used for stereo display
SetStereoMethodSets the method for stereo display
GetStereoMethodReturns the method and options being used for stereo display


Members:

CurrentViewer [RW]The current GLViewer object


Other:



Tips for GLView (edit)

  • Each ChildFrame (i.e. composition window) has at least a left and a right view, represented by GLView objects. To reach one of these, use something like this:
-- .Left will return the left preview object, the GLView object can be reached via .View
comp:GetPreviewList().Left.View

or this:

comp.CurrentFrame.LeftView
  • The view object - as described above - has methods that deal with general properties of the view, like enabling the sub views or switching between the A & B buffers.
  • Each buffer can in turn contain a viewer, represented by either GLViewer or GLImageViewer objects. Use a view's :GetViewerList() method or .CurrentViewer to reach these objects. They provides further methods specific to a single display buffer like showing guides, enabling LUTs or switching color channels:
-- switch to A buffer and show the red channel
left = comp.CurrentFrame.LeftView
left:SetBuffer(0)
if left.CurrentViewer ~= nil then
   left.CurrentViewer:SetChannel(0)
   left.CurrentViewer:Redraw()
end