pymel.core.windows.glRenderEditor

glRenderEditor(*args, **kwargs)

Create a glRender view. This is a special view used for hardware rendering. This command is used to create and reparent the view as needed to support panels. See the glRender command for controlling the specific behavior of the hardware rendering. In query mode, return type is based on queried flag.

Flags:

Long name (short name)		Argument Types	Properties
control (ctl)		bool
	Query only. Returns the top level control for this editor. Usually used for getting a parent to attach popup menus. Caution: It is possible, at times, for an editor to exist without a control. This flag returns NONEif no control is present.
defineTemplate (dt)		unicode
	Puts a command in a mode where any other flags and args are parsed and added to the command template specified in the argument. They will be used as default arguments in any subsequent invocations of the command when templateName is set as the current template.
docTag (dtg)		unicode
	Attaches a tag to the Maya editor.
exists (ex)		bool
	Returns true|false depending upon whether the specified object exists. Other flags are ignored.
filter (f)		unicode
	Specifies the name of an itemFilter object to be placed on this editor. This filters the information coming onto the main list of the editor.
forceMainConnection (fmc)		unicode
	Specifies the name of a selectionConnection object which the editor will use as its source of content. The editor will only display items contained in the selectionConnection object. This is a variant of the -mainListConnection flag in that it will force a change even when the connection is locked. This flag is used to reduce the overhead when using the -unlockMainConnection , -mainListConnection, -lockMainConnection flags in immediate succession.
highlightConnection (hlc)		unicode
	Specifies the name of a selectionConnection object which the editor will synchronize with its highlight list. Not all editors have a highlight list. For those that do, it is a secondary selection list.
lockMainConnection (lck)		bool
	Locks the current list of objects within the mainConnection, so that only those objects are displayed within the editor. Further changes to the original mainConnection are ignored.
lookThru (lt)		unicode
	Specify which camera the glRender view should be using. Flag can have multiple arguments, passed either as a tuple or a list.
mainListConnection (mlc)		unicode
	Specifies the name of a selectionConnection object which the editor will use as its source of content. The editor will only display items contained in the selectionConnection object.
panel (pnl)		unicode
	Specifies the panel that the editor belongs to. By default if an editor is created in the create callback of a scripted panel it will belong to that panel. If an editor doesn’t belong to a panel it will be deleted when the window that it is in is deleted.
parent (p)		unicode
	Specifies the parent layout for this editor. This flag will only have an effect if the editor is currently un-parented.
selectionConnection (slc)		unicode
	Specifies the name of a selectionConnection object which the editor will synchronize with its own selection list. As the user selects things in this editor, they will be selected in the selectionConnection object. If the object undergoes changes, the editor updates to show the change.
stateString (sts)		bool
	Query only flag. Returns the MEL command that will edit an editor to match the current editor state. The returned command string uses the string variable $editorName in place of a specific name.
unParent (up)		bool
	Specifies that the editor should be removed from its layout. This cannot be used with query.
unlockMainConnection (ulk)		bool
	Unlocks the mainConnection, effectively restoring the original mainConnection (if it is still available), and dynamic updates.
updateMainConnection (upd)		bool
	Causes a locked mainConnection to be updated from the orginal mainConnection, but preserves the lock state.
useTemplate (ut)		unicode
	Force the command to use a command template other than the current one.
viewCameraName (vcn)		bool
	Returns the name of the current camera used by the glRenderPanel. This is a query only flag.

Derived from mel command maya.cmds.glRenderEditor

Example:

import pymel.core as pm

# Create a glRender editor, using the top view
window = pm.window()
pm.paneLayout()
# Result: ui.PaneLayout('window1|paneLayout5') #
pm.glRenderEditor(lookThru='top')
# Result: u'glRenderEditor1' #
pm.showWindow( window )