pymel.core.modeling.polyColorBlindData

polyColorBlindData(*args, **kwargs)

This command applies false color to the selected polygonal components and objects, depending on whether or not blind data exists for the selected components (or, in the case of poly objects, dynamic attributes), and, depending on the color mode indicated, what the values are. It is possible to color objects based on whether or not the data exists, if the data matches a specific value or range of values, or grayscale color the data according to what the actual value is in relation to the specified min and max. This command also has a query mode in which the components and/or objects are returned in a string array to allow for selection filtering.

Flags:
Long name (short name) Argument Types Properties
aboveMaxColorBlue (amb) float ../../../_images/create.gif
 
Specifies blue component of color to use for data that is above max
aboveMaxColorGreen (amg) float ../../../_images/create.gif
 
Specifies green component of color to use for data that is above max
aboveMaxColorRed (amr) float ../../../_images/create.gif
 
Specifies red component of color to use for data that is above max
attrName (n) unicode ../../../_images/create.gif
 
Specifies the name of the data that is being examined by this command.
belowMinColorBlue (bmb) float ../../../_images/create.gif
 
Specifies blue component of color to use for data that is below min
belowMinColorGreen (bmg) float ../../../_images/create.gif
 
Specifies green component of color to use for data that is below min
belowMinColorRed (bmr) float ../../../_images/create.gif
 
Specifies red component of color to use for data that is below min
clashColorBlue (ccb) float ../../../_images/create.gif
 
Specifies blue component color to use for data which clashes
clashColorGreen (ccg) float ../../../_images/create.gif
 
Specifies green component color to use for data which clashes
clashColorRed (ccr) float ../../../_images/create.gif
 
Specifies red component color to use for data which clashes
colorBlue (cb) float ../../../_images/create.gif
 
Specifies blue component of color to use for given data
colorGreen (cg) float ../../../_images/create.gif
 
Specifies green component of color to use for given data
colorRed (cr) float ../../../_images/create.gif
 
Specifies red component of color to use for given data
dataType (dt) unicode ../../../_images/create.gif
 
Specifies the type for this id
enableFalseColor (efc) bool ../../../_images/create.gif
 
Turns false coloring on or off for all poly objects in the scene
maxColorBlue (mxb) float ../../../_images/create.gif
 
Specifies blue component of color to use for max value for grayscale
maxColorGreen (mxg) float ../../../_images/create.gif
 
Specifies green component of color to use for max value for grayscale
maxColorRed (mxr) float ../../../_images/create.gif
 
Specifies red component of color to use for max value for grayscale
maxValue (mxv) float ../../../_images/create.gif
 
Specifies the max value for grayscale or discrete range data
minColorBlue (mnb) float ../../../_images/create.gif
 
Specifies blue component of color to use for min value for grayscale
minColorGreen (mng) float ../../../_images/create.gif
 
Specifies green component of color to use for min value for grayscale
minColorRed (mnr) float ../../../_images/create.gif
 
Specifies red component of color to use for min value for grayscale
minValue (mnv) float ../../../_images/create.gif
 
Specifies the min value for grayscale or discrete range data
mode (m) int ../../../_images/create.gif
 

Specifies the mode: 0 : binary - only components and objects that have the data will be colored1 : discrete value - a value is specified. Data that matches this value will be colored2 : discrete range - values that fall within the given range will be colored3 : unsigned set mode - if ( givenValue actualValue ) then data will be colored4 : unsigned not set mode - if ( !(givenValue actualValue) ) then data will be colored5 : unsigned equal mode - if ( givenValue == actualValue ) then data will be colored6 : 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

noColorBlue (ncb) float ../../../_images/create.gif
 
Specifies blue component of color to use for no data assigned
noColorGreen (ncg) float ../../../_images/create.gif
 
Specifies green component of color to use for no data assigned
noColorRed (ncr) float ../../../_images/create.gif
 
Specifies red component of color to use for no data assigned
numIdTypes (num) int ../../../_images/create.gif
 
Specifies how many attrs are in this id type
queryMode (q) bool ../../../_images/create.gif
 

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

typeId (id) int ../../../_images/create.gif
 
Specifies the typeId of the BlindData type being created
useMax (umx) bool ../../../_images/create.gif
 

Specifies whether the max should be used for discrete rangesFlag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.

useMin (umn) bool ../../../_images/create.gif
 
Specifies whether the min should be used for discrete ranges
value (v) unicode ../../../_images/create.gif
 
The value of the data

Derived from mel command maya.cmds.polyColorBlindData

Example:

import pymel.core as pm

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:
pm.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:
pm.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):
pm.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:
pm.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)
pm.polyColorBlindData( 1000, '-num', 1, '-m', 0, '-n', 'fluffy', query=True, id=True )
# Now if we have 2 attributes:
pm.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
pm.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 )

Previous topic

pymel.core.modeling.polyCollapseFacet

Next topic

pymel.core.modeling.polyColorDel

Core

Core Modules

Other Modules

This Page