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

Synopsis

polyGeoSampler([alphaBlend=string], [averageColor=boolean], [clampAlphaMax=float], [clampAlphaMin=float], [clampRGBMax=[float, float, float]], [clampRGBMin=[float, float, float]], [colorBlend=string], [colorDisplayOption=boolean], [computeShadows=boolean], [displaceGeometry=boolean], [flatShading=boolean], [ignoreDoubleSided=boolean], [lightingOnly=boolean], [reuseShadows=boolean], [sampleByFace=boolean], [scaleFactor=double], [shareUV=boolean], [useLightShadows=boolean])

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

polyGeoSampler is undoable, NOT queryable, and editable.

This command performs a render sampling of surface color and transparency for each selected vertex or face and stores the sampled data as either the color value, or uses the sampled data to displace the affected vertices or faces by a sampled data value. Transparency is not used for displacement, and displacement is performed along vertex normals. The sampled data value used can be pre-scaled by a user defined amount. Additionally, the normals chosen for sampling can be overridden using a "flat" shading option. This option basically means to always use the normals of the faces when computing sampling values. This may be a desired if the user wishes to override an edge smoothness factor. Basically with the "flat" shading option on, edges are always considered to be hard. Note that displacement sampling will result in the -sampleByFace option to be turned off, since a displacement of a vertex always affects the faces the vertex is connected to. Finally, it is possible to force the storage of shared colors per vertex, and / or force the usage of unshared UV values. The computation of the resulting color is as follows:
        resulting-RGB = (sampled-RGB * scale-factor);
        if (color blend is none)
                resulting-RGB = geometry-RGB
        else if (color blend is add)
                resulting-RGB = geometry-RGB + sampled-RGB;
        else if (color blend is subtract)
                resulting-RGB = geometry-RGB - sampled-RGB;
        else if (color blend is multiply)
                resulting-RGB = geometry-RGB * sampled-RGB;
        else if (color blend is divide)
                resulting-RGB = geometry-RGB / sampled-RGB;
        else if (color blend is average)
                resulting-RGB = (geometry-RGB * 1/2) + (sampled-RGB * 1/2);
        if (clamp option set)
                clamp resulting-RGB between minimum-RGB and maximum-RGB,
The analogous computation is done for computing the resulting alpha value. The command requires that there be a camera selected in your scene in order to work properly in -batch or -prompt mode.

Flags

alphaBlend, averageColor, clampAlphaMax, clampAlphaMin, clampRGBMax, clampRGBMin, colorBlend, colorDisplayOption, computeShadows, displaceGeometry, flatShading, ignoreDoubleSided, lightingOnly, reuseShadows, sampleByFace, scaleFactor, shareUV, useLightShadows
Long name (short name) [argument types] Properties
sampleByFace(bf) boolean createedit
When used, sample will occur at a per face level versus a per vertex level, which is the default behaviour
computeShadows(cs) boolean createedit
When used, shadow maps will be computed, saved, and reused during the sampling process.
useLightShadows(ul) boolean createedit
When used, will use each lights shadow map options. Otherwise these options will be overrridden when the computeShadows, and/or reusedShadows option is enabled.
reuseShadows(rs) boolean createedit
When used, if shadow maps were previosly computed and saved, then they will be reused during the sampling process. The computeShadows option must be enabled for this option to apply.
lightingOnly(lo) boolean createedit
When used, incoming illumination will be computed as opposed to surface color an tranparency
flatShading(fs) boolean createedit
When used, flat shaded sampling will be computed. The default is smooth shading.
displaceGeometry(dg) boolean createedit
When used, geometry will be displaced along the normals at the sampling positions, as opposed to storing color values. The default is to store colors.
scaleFactor(sf) double createedit
When used, will scale the sampled value by the specified amount. The default scale factor is 1.0. Negative values are acceptable for displacement, but not for color values.
shareUV(su) boolean createedit
When used, UVs are shared at a vertex when sampled. By default UVs are forced to be unshared.
averageColor(ac) boolean createedit
When used, will mean to force the storage of shared colors for vertex level sampling. By default vertex level sampling stores unshared colors.
clampRGBMin(cmn) [float, float, float] createedit
When used, will mean to clamp the storage of RGB color to a minimum
clampRGBMax(cmx) [float, float, float] createedit
When used, will mean to clamp the storage of RGB color to a maximum
clampAlphaMin(amn) float createedit
When used, will mean to clamp the storage of alpha to a minimum
clampAlphaMax(amx) float createedit
When used, will mean to clamp the storage of alpha to a maximum
colorBlend(cbl) string createedit
When specified, indicates the type of color blend to be applied. Options are: "none", "overwrite", "add", "subtract", "multiply", "divide", "average". This option only applies when colors are being set. The default if this argument is not specified is "overwrite". The "none" options to not overwrite the existing value.
alphaBlend(abl) string createedit
When specified, indicates the type of alpha blend to be applied. Options are: "none", "overwrite", "add", "subtract", "multiply", "divide", "average". This option only applies when colors are being set. The default if this argument is not specified is "overwrite". The "none" options to not overwrite the existing value.
ignoreDoubleSided(ids) boolean createedit
When specified, the double sided flag will be ignored for prelighting.
colorDisplayOption(cdo) boolean createedit
Change the display options on the mesh to display the vertex colors.

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


boolean Success or Failure

Keywords

poly, sampling, GeoSampler

Related

polyColorPerVertex

Return to Autodesk Index