Go to: Synopsis. Return value. Keywords.
Flags. Python
examples.
colorAtPoint([coordU=float], [coordV=float], [maxU=float], [maxV=float], [minU=float], [minV=float], [output=string], [samplesU=uint], [samplesV=uint])
Note: Strings representing object names and
arguments must be separated by commas. This is not depicted in the
synopsis.
colorAtPoint is NOT undoable, NOT queryable, and
NOT editable.
The colorAtPoint command is used to query textures or ocean
shaders at passed in uv coordinates. (For ocean shaders uv is x and
z in worldspace ). The return value is a floating point array whose
size is determined by either the number of input uv arguments
passed in and the the queried value. One can query alpha only, rgb
only, or rgba values. The returned array is only single indexed, so
if rgb is specified then the index for red values would be index *
3. Blue is index * 3 + 1, and green is index * 3 + 2. For rgba use
a multiple of 4 instead of 3. For alpha only one can simply use the
index. There are two basic argument formats that may be used:
colorAtPoint -u 0 -v 0 -u .2 -v .1 etc.. for all points or
colorAtPoint -mu 0 -mv 0 -xu 1 -xv 1 -su 10 -sv 10 // samples 100
points If one is sampling several points and they are all in a
regular grid formation it is more efficient to call this routine
with the latter method, which uses a min/max uv and number of
samples, rather than a long argument list of uv coords.
- return values (-o A or RGB or RGBA )
- individual UV coordinates to sample (-u float -v float
)
- (numbers of calls to -u and -v must match)
- uniform grid of points to sample (-su int -sv int)
- (may not use this in combination with -u or -v)
- bounds for sample grid (-mu float -mv float -xu float -xv
float)
None
texture, color, alpha, uv, ocean, outColor, paramUV
coordU, coordV,
maxU, maxV,
minU, minV,
output, samplesU, samplesV
| Long name (short name) |
Argument types |
Properties |
output(o) |
string |
 |
|
Type of data to output: A = alpha only RGB = color only RGBA =
color and alpha |
|
coordU(u) |
float |
 |
|
Input u coordinate to sample texture at. |
|
coordV(v) |
float |
|
|
Input v coordinate to sample texture at. |
|
minU(mu) |
float |
|
|
DEFAULT 0.0 Minimum u bounds to sample. |
|
minV(mv) |
float |
|
|
DEFAULT 0.0 Minimum v bounds to sample. |
|
maxU(xu) |
float |
|
|
DEFAULT 1.0 Maximum u bounds to sample. |
|
maxV(xv) |
float |
|
|
DEFAULT 1.0 Maximum v bounds to sample. |
|
samplesU(su) |
uint |
|
|
DEFAULT 1 The number of points to sample in the U
dimension. |
|
samplesV(sv) |
uint |
|
|
DEFAULT 1 The number of points to sample in the V
dimension. |
|
| 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. |
import maya.cmds as cmds
# The return value is the array of values determined by the number of
# coord flag uses or samplesU * samplesV. The default return value is alpha.
# If instead the return value is RGB there will be 3 times as many values returned,
# and if it is RGBA there will be 4 times as many values.
cmds.createNode( 'checker' )
cmds.colorAtPoint( 'checker1' )
# returns the alpha value at uv (0.0,0.0) for texture checker1
# The return array will have one entry corresponding to this alpha.
cmds.colorAtPoint( 'checker1', u=.5, v=.5 )
# returns the alpha value at uv (0.5,0.5) for texture checker1
# The return array will have one entry corresponding to this alpha.
cmds.colorAtPoint( 'checker1', o='RGB', u=(.5, 0.0), v=(.5, 0.1) )
# returns the colors at uv (0.5,0.5) and (0.0, 0.01) for texture checker1
# The return array will have 6 values in the following order: RGBRGB
cmds.colorAtPoint( 'checker1', o='A', su=11, sv=6 )
# returns the alpha for 50 points in a uniform 11 by 6 grid mapped across
# uv (0.0, 0.0) to uv (1.0, 1.0) The 12th point would be the first point
# in the second row of samples where uv = (0.0, 0.2)
cmds.colorAtPoint( 'checker1', o='A', su=3, sv=3, mu=0.3, mv=0.3, xu=0.4, xv=0.4 )
# returns the alpha for 9 points in a uniform 3 by 3 grid mapped across
# uv (0.3, 0.3) to uv (0.4, 0.4) The 4th point would be the first point
# in the second row of samples where uv = (0.35, 0.3).