vnn

Go to: Synopsis. Return value. Keywords. Flags. Python examples.

Synopsis

vnn([flushProxies=string], [libraries=string], [listPortTypes=string], [nodes=[string, string]], [runTimes=boolean], [useNiceName=boolean])

Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.

vnn is NOT undoable, queryable, and NOT editable.

Return value

In query mode, return type is based on queried flag.

Keywords

Flags

Long name (short name)	Argument types	Properties
flushProxies(fp)	string
Flush proxies for the named VNN runtime, for example "BifrostGraph". This is a flag used for developers to ask a given runtime to release all of its proxy VNN nodes so that they can be re-created the next time they are requested. This is used to verify that the VNN graph corresponds to the graph that is being virtualized, or "proxied". The maya node editor or any other UI that uses VNN should be closed before this called is made. Failure to do so will result in that UI failure to recongnize changes made to the VNN graph, because the changes will be made on another set of proxies.
libraries(lib)	string
List of the libraries in runTime.
listPortTypes(lpt)	string
List all the possible port types for the given VNN runtime, for example "BifrostGraph". The list of port types is not fixed and could grow as new definitions are added to the runtime.
nodes(nd)	[string, string]
List of the nodes from the runTime library. First argument is the name of the runtime, like "BifrostGraph", second is the name of the library, obtained with -libraries
runTimes(rt)	boolean
List all the runTimes registered with VNN.
useNiceName(unn)	boolean
Used with "libraries" and "nodes" to return nice names (fit for UI) instead of the raw names.

Flag can appear in Create mode of command	Flag can appear in Edit mode of command
Flag can appear in Query mode of command	Flag can have multiple arguments, passed either as a tuple or a list.

Python examples

import maya.cmds as cmds

# List all the runTimes registered with VNN.
print cmds.vnn( runTimes=1)

# List all the libraries associated with particular runTime.
allLibraries = cmds.vnn( libraries="BifrostGraph" )
print "List of libraries: " + str(allLibraries)

allLibrariesUIName = cmds.vnn( libraries="BifrostGraph", useNiceName=True )

for lib in allLibrariesUIName:
    print "In Lib " + lib + ":"  + str( cmds.vnn( nodes=["BifrostGraph",lib]) )