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

Synopsis

vnnWatchPoint( string string , [create=boolean], [deleteAll=boolean], [disableAll=boolean], [enable=boolean], [enableAll=boolean], [queryHasWatchPoint=boolean], [queryIsEnabled=boolean], [queryParameterDescription=string], [queryParameterValue=string], [queryParameterValueDescription=[string, string]], [queryParameterValues=string], [queryParameters=boolean], [queryRecordedValues=string], [remove=boolean], [setParameterValue=[string, string]])

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

vnnWatchPoint is undoable, NOT queryable, and NOT editable.

The vnnWatchpoint command is used to operate vnn watchpoints. The first argument is the full name of the DG node that the VNN node is in. The second argument is the name of the full path of the VNN node. Then third argument is the name of the VNN port.

Return value

stringThe result of the operation

Related

vnn, vnnCompound, vnnNode

Flags

create, deleteAll, disableAll, enable, enableAll, queryHasWatchPoint, queryIsEnabled, queryParameterDescription, queryParameterValue, queryParameterValueDescription, queryParameterValues, queryParameters, queryRecordedValues, remove, setParameterValue
Long name (short name) Argument types Properties
create(c) boolean create
Create a new watchpoint on the specified port.
deleteAll(dla) boolean create
Delete all watchpoints in all editable compounds.
disableAll(dba) boolean create
Disable all watchpoints in all editable compounds.
enable(e) boolean create
Enable or disable the watchpoint set on the specified port.
enableAll(eba) boolean create
Enable all watchpoints in all editable compounds.
queryHasWatchPoint(qw) boolean create
Query if specified port has a watchpoint set.
queryIsEnabled(qe) boolean create
Query if the watchpoint set on specified port is enabled.
queryParameterDescription(qpd) string create
Query the description of the watchpoint's parameter.
queryParameterValue(qpv) string create
Query the value currenlty set on the given watchpoint's parameter.
queryParameterValueDescription(qvd) [string, string] create
Query the description of the given watchpoint's parameter's value.
queryParameterValues(qvs) string create
Query the list of values that can be set for the given watchpoint's parameter.
queryParameters(qps) boolean create
Query the list of parameters that can be recorded by the watchpoint.
queryRecordedValues(qrv) string create
Query the recorded values of the given watchpoint's parameter.
remove(r) boolean create
Remove the watchpoint set on the specified port.
setParameterValue(spv) [string, string] create
Set the value of the given watchpoint's parameter.
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

# Set a new watchpoint on port "input" of node "myNode"
cmds.vnnWatchPoint("bifrostGraphShape1", "/myNode", "input", create=True)

# Remove a watchpoint set on port "input" of node "myNode"
cmds.vnnWatchPoint("bifrostGraphShape1", "/myNode", "input", remove=True)

# Remove all watchpoints
cmds.vnnWatchPoint("bifrostGraphShape1", deleteAll=True)

# Disable all watchpoints
cmds.vnnWatchPoint("bifrostGraphShape1", disableAll=True)

# Enable all watchpoints
cmds.vnnWatchPoint("bifrostGraphShape1", enableAll=True)

# Query if port "input" of node "myNode" has a watchpoint set
hasWatchPoint = cmds.vnnWatchPoint("bifrostGraphShape1", "/myNode", "input", queryHasWatchPoint=True)
print hasWatchPoint
# True

# Query if watchpoint on port "input" of node "myNode" is enabled
isEnabled = cmds.vnnWatchPoint("bifrostGraphShape1", "/myNode", "input", queryIsEnabled=True)
print isEnabled
# True

# Query the parameters of watchpoint set on port "input" of node "myNode"
wpParameters = cmds.vnnWatchPoint("bifrostGraphShape1", "/myNode", "input", queryParameters=True)
print wpParameters
# [u'max', u'min', u'last']

# Query the description of parameter "max" of watchpoint set on port "input" of node "myNode"
maxDesc = cmds.vnnWatchPoint("bifrostGraphShape1", "/myNode", "input", queryParameterDescription="max")
print maxDesc
# Record the maximum value

# Query the values of parameter "max" of watchpoint set on port "input" of node "myNode"
maxValues = cmds.vnnWatchPoint("bifrostGraphShape1", "/myNode", "input", queryParameterValues="max")
print maxValues
# [u'enable', u'disable']

# Query the description of value "enable" of parameter "max" of watchpoint set on port "input" of node "myNode"
maxEnableDesc = cmds.vnnWatchPoint("bifrostGraphShape1", "/myNode", "input", queryParameterValueDescription=["max","enable"])
print maxEnableDesc
# Enable

# Query the value currenly set on parameter "max" of watchpoint set on port "input" of node "myNode"
maxValue = cmds.vnnWatchPoint("bifrostGraphShape1", "/myNode", "input", queryParameterValue="max")
print maxValue
# enable

# Query the value recorded for parameter "max" of watchpoint set on port "input" of node "myNode"
maxRecordedValue = cmds.vnnWatchPoint("bifrostGraphShape1", "/myNode", "input", queryRecordedValues="max")
print maxRecordedValue
# [u'-1.0298']