polyColorBlindData

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

Synopsis

polyColorBlindData([aboveMaxColorBlue=double], [aboveMaxColorGreen=double], [aboveMaxColorRed=double], [attrName=string], [belowMinColorBlue=double], [belowMinColorGreen=double], [belowMinColorRed=double], [clashColorBlue=double], [clashColorGreen=double], [clashColorRed=double], [colorBlue=double], [colorGreen=double], [colorRed=double], [dataType=string], [enableFalseColor=boolean], [maxColorBlue=double], [maxColorGreen=double], [maxColorRed=double], [maxValue=double], [minColorBlue=double], [minColorGreen=double], [minColorRed=double], [minValue=double], [mode=int], [noColorBlue=double], [noColorGreen=double], [noColorRed=double], [numIdTypes=int], [queryMode=boolean], [typeId=int], [useMax=boolean], [useMin=boolean], [value=string])

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

polyColorBlindData is undoable, queryable, and editable.

Flags

Long name (short name)	[argument types]	Properties
enableFalseColor(efc)	boolean
Turns false coloring on or off for all poly objects in the scene In query mode, this flag needs a value.
queryMode(q)	boolean
If on, do not color and return selection as string array instead. Any data that would be colored normally (except for 'no color' and out of range colors) is returned In query mode, this flag needs a value.
typeId(id)	int
Specifies the typeId of the BlindData type being created In query mode, this flag needs a value.
numIdTypes(num)	int
Specifies how many attrs are in this id type In query mode, this flag needs a value.
mode(m)	int
Specifies the mode: 0 : binary - only components and objects that have the data will be colored 1 : discrete value - a value is specified. Data that matches this value will be colored 2 : discrete range - values that fall within the given range will be colored 3 : unsigned set mode - if ( givenValue & actualValue ) then data will be colored 4 : unsigned not set mode - if ( !(givenValue & actualValue) ) then data will be colored 5 : unsigned equal mode - if ( givenValue == actualValue ) then data will be colored 6 : grayscale mode - a min value, max value, min color, max color, below min color, and above max color are given. Data is colored according to how it relates to these values. 7 : as color mode - if the blind data consists of 3 doubles, ranged 0-1, the components are colored as the data specifies In query mode, this flag needs a value.
dataType(dt)	string
Specifies the type for this id In query mode, this flag needs a value.
attrName(n)	string
Specifies the name of the data that is being examined by this command. In query mode, this flag needs a value.
value(v)	string
The value of the data In query mode, this flag needs a value.
noColorRed(ncr)	double
Specifies red component of color to use for no data assigned In query mode, this flag needs a value.
noColorGreen(ncg)	double
Specifies green component of color to use for no data assigned In query mode, this flag needs a value.
noColorBlue(ncb)	double
Specifies blue component of color to use for no data assigned In query mode, this flag needs a value.
clashColorRed(ccr)	double
Specifies red component color to use for data which clashes In query mode, this flag needs a value.
clashColorGreen(ccg)	double
Specifies green component color to use for data which clashes In query mode, this flag needs a value.
clashColorBlue(ccb)	double
Specifies blue component color to use for data which clashes In query mode, this flag needs a value.
belowMinColorRed(bmr)	double
Specifies red component of color to use for data that is below min In query mode, this flag needs a value.
belowMinColorGreen(bmg)	double
Specifies green component of color to use for data that is below min In query mode, this flag needs a value.
belowMinColorBlue(bmb)	double
Specifies blue component of color to use for data that is below min In query mode, this flag needs a value.
aboveMaxColorRed(amr)	double
Specifies red component of color to use for data that is above max In query mode, this flag needs a value.
aboveMaxColorGreen(amg)	double
Specifies green component of color to use for data that is above max In query mode, this flag needs a value.
aboveMaxColorBlue(amb)	double
Specifies blue component of color to use for data that is above max In query mode, this flag needs a value.
colorRed(cr)	double
Specifies red component of color to use for given data In query mode, this flag needs a value.
colorGreen(cg)	double
Specifies green component of color to use for given data In query mode, this flag needs a value.
colorBlue(cb)	double
Specifies blue component of color to use for given data In query mode, this flag needs a value.
minColorRed(mnr)	double
Specifies red component of color to use for min value for grayscale In query mode, this flag needs a value.
minColorGreen(mng)	double
Specifies green component of color to use for min value for grayscale In query mode, this flag needs a value.
minColorBlue(mnb)	double
Specifies blue component of color to use for min value for grayscale In query mode, this flag needs a value.
maxColorRed(mxr)	double
Specifies red component of color to use for max value for grayscale In query mode, this flag needs a value.
maxColorGreen(mxg)	double
Specifies green component of color to use for max value for grayscale In query mode, this flag needs a value.
maxColorBlue(mxb)	double
Specifies blue component of color to use for max value for grayscale In query mode, this flag needs a value.
useMin(umn)	boolean
Specifies whether the min should be used for discrete ranges In query mode, this flag needs a value.
minValue(mnv)	double
Specifies the min value for grayscale or discrete range data In query mode, this flag needs a value.
maxValue(mxv)	double
Specifies the max value for grayscale or discrete range data In query mode, this flag needs a value.
useMax(umx)	boolean
Specifies whether the max should be used for discrete ranges In query mode, this flag needs a value.

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.

Return value

Keywords

Python examples

import maya.cmds as cmds

# In these examples we have type 1000, with one double attribute
# called "fluffy", and type 1001 with attributes "grimy" and "slimy".
# Color all items of id 1000 red. Note that we must also specify
# None color (black) and Clash color(cyan). Note that we must also
# specify the names of the attributes, even if we don't care about
# the attribute values:
cmds.polyColorBlindData( ncr=0, ncg=0, ncb=0, ccr=0, ccg=1, ccb=1, id=1000, num=1, m=0, n='fluffy', cr=1, cg=0, cb=0 )
# Now color only those values of "fluffy" between 2 and 5:
cmds.polyColorBlindData( ncr=0, ncg=0, ncb=0, ccr=0, ccg=1, ccb=1, id=1000, num=1, m=2, dt='double', n='fluffy', umn=1, mnv=2, umx=1, mxv=5, cr=1, cg=0, cb=0 )
# Note for a continuous range query we must specify min, max and
# out of range color instead of just color (here values between 2 and 5
# are colored between white and gray, out of range values are yellow):
cmds.polyColorBlindData( ncr=0, ncg=0, ncb=0, ccr=0, ccg=1, ccb=1, id=1000, num=1, m=6, dt='double', n='fluffy', bmr=1, bmg=1, bmb=0, amr=1, amg=1, amb=0, mnr=0.250980407, mng=0.250980407, mnb=0.250980407, mxr=1, mxg=1, mxb=1, mnv=2, mxv=5 )
# Now, for attribute "fluffy", color values of 2 red and values of 2 green:
cmds.polyColorBlindData( ncr=0, ncg=0, ncb=0, ccr=0, ccg=1, ccb=1, id=1000, num=1, m=1, dt='double', n='fluffy', v='2', cr=1, cg=0, cb=0, id=1000, num=1, m=1, dt='double', n='fluffy', v='3', cr=0, cg=1, cb=0 )
# To just query and not color, filter the active selection list
# and return the list of components that meet the criteria (in this
# case having blind data of type 1000)
cmds.polyColorBlindData( 1000, '-num', 1, '-m', 0, '-n', 'fluffy', query=True, id=True )
# Now if we have 2 attributes:
cmds.polyColorBlindData( ncr=0, ncg=0, ncb=0, ccr=0, ccg=1, ccb=1, id=1001, num=2, m=0, n='grimy', n='slimy', cr=1, cg=0, cb=0 )
# Note that when querying for value, values of all attrs must be specified
# here we set (grimy = 22, slimy = 1) to be red, and (grimy = 55, slimy = 2)
# to be green
cmds.polyColorBlindData( ncr=0, ncg=0, ncb=0, ccr=0, ccg=1, ccb=1, id=1001, num=2, m=1, dt='double', n='grimy', v='22', cr=1, cg=0, cb=0, dt='int', n='slimy', v='1', cr=1, cg=0, cb=0, id=1001, num=2, m=1, dt='double', n='grimy', v='55', cr=0, cg=1, cb=0, dt='int', n='slimy', v='2', cr=0, cg=1, cb=0 )