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

Synopsis

polyColorPerVertex([alpha=float], [clamped=boolean], [colorB=float], [colorDisplayOption=boolean], [colorG=float], [colorR=float], [colorRGB=[float, float, float]], [notUndoable=boolean], [relative=boolean], [remove=boolean], [representation=int])

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

polyColorPerVertex is undoable, queryable, and editable.

Command associates color(rgb and alpha) with vertices on polygonal objects. When used with the query flag, it returns the color associated with the specified components.

Return value

booleanSuccess or Failure.

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

Keywords

poly, color, colorPerVertex, vertexColor

Related

polyGeoSampler

Flags

alpha, clamped, colorB, colorDisplayOption, colorG, colorR, colorRGB, notUndoable, relative, remove, representation
Long name (short name) Argument types Properties
alpha(a) float createqueryedit
Specifies the alpha channel of color
clamped(cla) boolean createqueryedit
This flag specifies if the color set will truncate any value that is outside 0 to 1 range.
colorB(b) float createqueryedit
Specifies the B channel of color
colorDisplayOption(cdo) boolean createqueryedit
Change the display options on the mesh to display the vertex colors.
colorG(g) float createqueryedit
Specifies the G channel of color
colorR(r) float createqueryedit
Specifies the R channel of color
colorRGB(rgb) [float, float, float] createqueryedit
Specifies the RGB channels of color
notUndoable(nun) boolean createqueryedit
Execute the command, but without having the command be undoable. This option will greatly improve performance for large numbers of object. This will make the command not undoable regardless of whether undo has been enabled or not.
relative(rel) boolean createqueryedit
When used, the color values specified are added relative to the current values.
remove(rem) boolean createqueryedit
When used, the color values are removed from the selected or specified objects or components. This option only supports meshes with no construction history, or meshes whose construction history includes a recent polyColorPerVertexNode. For meshes whose construction history includes a polgon operation the polyColorPerVertexNode, consider using the polyColorDel command instead
representation(rpt) int createqueryedit
This flag corresponds to the color channels to used, for example A(alpha only), RGB, and RGBA.

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

# To set the rgb channels of selected vertices:
cmds.polyColorPerVertex( rgb=(0.8, 0.0, 0.4) )
# To set just the "g" channel of selected vertices:
cmds.polyColorPerVertex( g =0.5 )
# To add to the current value of just the "g" channel of selected vertices:
cmds.polyColorPerVertex( rel=True, g =0.2 )
# To query the "g" and "b" channels of color on selected vertices:
cmds.polyColorPerVertex( query=True, g=True, b=True )