pymel.core.uitypes.Visor

Inheritance diagram of Visor

class Visor

class counterpart of mel function visor

Command for the creation and manipulation of a Visor UI element. The Visor is used to display the contents of a scene (rendering related nodes in particular), as well as files on disk which the user may wish to bring into the scene (shader and texture libraries for example).

getAddFolder(**kwargs)

Add a new folder to the current visual browser

Derived from mel command maya.cmds.visor

getAddNodes(**kwargs)

Add dependency graph nodes by name to a user defined custom folder. The argument is a string encolsed in quotes with 1 one more node names seperated by blanks

Derived from mel command maya.cmds.visor

getAllowPanningInX(**kwargs)

Specifies whether or not the user should be able to pan the contents of the visor horizontally. Default is true.

Derived from mel command maya.cmds.visor

getAllowPanningInY(**kwargs)

Specifies whether or not the user should be able to pan the contents of the visor vertically. Default is true.

Derived from mel command maya.cmds.visor

getAllowZooming(**kwargs)

Specifies whether or not the user should be able to zoom the contents of the visor. Default is true.

Derived from mel command maya.cmds.visor

getCommand(**kwargs)

Mel command which will return a list of nodes to add to a folder

Derived from mel command maya.cmds.visor

getDeleteFolder(**kwargs)

Delete the specified folder and all of its children

Derived from mel command maya.cmds.visor

getEditFolder(**kwargs)

Edit the name and MEL command for an existing folder

Derived from mel command maya.cmds.visor

getFolderList(**kwargs)

Return a string array of the folders in the visor.

Derived from mel command maya.cmds.visor

getMenu(**kwargs)

Set the name of the script to run to get a popup menu

Derived from mel command maya.cmds.visor

getName(**kwargs)

Name of the new folder

Derived from mel command maya.cmds.visor

getNodeType(**kwargs)

A node type used by folders of type nodeTypeInDAG

Derived from mel command maya.cmds.visor

getOpenDirectories(**kwargs)

When adding a new folder indicate if it sub directories will be show. The default is to not show sub directories.

Derived from mel command maya.cmds.visor

getOpenFolder(**kwargs)

When adding a new folder indicate if it will be open or closed by default. The default is closed.

Derived from mel command maya.cmds.visor

getPath(**kwargs)

Path to a file system directory to be displayed in the folder

Derived from mel command maya.cmds.visor

getPopupMenuScript(**kwargs)

Specifies the script to be called when the right mouse button is pressed in the visor. The name of the editor in which the right mouse button was pressed will be appended to the script at the time the script is called.

Derived from mel command maya.cmds.visor

getRebuild(**kwargs)

Rebuild the visor after interactively adding a folder

Derived from mel command maya.cmds.visor

getRefreshAllSwatches(**kwargs)

Refresh the swatches of all files currently displayed in this visor.

Derived from mel command maya.cmds.visor

getRefreshSelectedSwatches(**kwargs)

Refresh the swatches of all files currently selected in any visor.

Derived from mel command maya.cmds.visor

getRefreshSwatch(**kwargs)

Refresh the swatch of the file with the specified path.Flag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.visor

getReset(**kwargs)

Clear all previously loaded folder descriptions in preperation for building a new visual browser

Derived from mel command maya.cmds.visor

getRestrictPanAndZoom(**kwargs)

Specifies whether the panning and zooming of the visor should be restricted to keep the contents in the top left corner of the visor when they are smaller than the visible area within the visor. Default is true.

Derived from mel command maya.cmds.visor

getSaveSwatches(**kwargs)

Save swatches to disk for currently displayed image files.

Derived from mel command maya.cmds.visor

getScrollBar(**kwargs)

Set the name of the scroll bar associated with visor

Derived from mel command maya.cmds.visor

getScrollPercent(**kwargs)

Set the percentage value for the scroll bar. Typicly called from a a scroll bars callback.

Derived from mel command maya.cmds.visor

getSelectedGadgets(**kwargs)

Return a string array of the currently selected gadgets (files, folders, nodes) in the visor.

Derived from mel command maya.cmds.visor

getShowDividers(**kwargs)

Specifies whether or not the visor should show dividers. The default is true. If -showDividers is set to false, dividers will be drawn as folders instead.

Derived from mel command maya.cmds.visor

getShowFiles(**kwargs)

Specifies whether or not the visor should show files. The default is true.

Derived from mel command maya.cmds.visor

getShowFolders(**kwargs)

Specifies whether or not the visor should show folders. The default is true.

Derived from mel command maya.cmds.visor

getShowNodes(**kwargs)

Specifies whether or not the visor should show nodes. The default is true.

Derived from mel command maya.cmds.visor

getStateString(**kwargs)

Return the MEL command string to save the folder setup in visor

Derived from mel command maya.cmds.visor

getStyle(**kwargs)

Set display style for the browser. Options are: outliner A single column with an outliner style icon and a text label singleColumn A single column with an image style icon and a text label multiColumn A multiple column grid of swatches with the text label below the swatch

Derived from mel command maya.cmds.visor

getTransform(**kwargs)

Name of a transform node used by folders of type nodeTypeInDAG

Derived from mel command maya.cmds.visor

getType(**kwargs)

Type of the new folder. Options are: commandA mel command that will return a list of depend nodes that will be displayed in the folderconnectedNodesThe nodes connected to the specified node name will be displayed in the folderdefaultNodesA mel command that will generate default node types. These nodes will not be part of the scene and are used for drag and drop creation of new nodes that are in the scene. The mel command use with this type is usually “listNodetypes”.directoryA directory name in the file systemdirectoryCommandA mel command that will return a directory name in the file systemfolderAn empty folder(the default value). Empty folders can be used as user defined folders by dropping dependency graph nodes in to themnodeTypeInDAGList all nodes of a given type under a specified transforms in the DAG. For example list all the shaders for a character by specifying the top transform of the charactershelfItemsA directory containing mel files to use as shelf items

Derived from mel command maya.cmds.visor

Previous topic

pymel.core.uitypes.VectorFieldGrp

Next topic

pymel.core.uitypes.Window

Core

Core Modules

Other Modules

This Page