polyGeoSampler

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

Synopsis

polyGeoSampler [-alphaBlend string] [-averageColor] [-clampAlphaMax float] [-clampAlphaMin float] [-clampRGBMax float float float] [-clampRGBMin float float float] [-colorBlend string] [-colorDisplayOption] [-computeShadows] [-displaceGeometry] [-flatShading] [-ignoreDoubleSided] [-lightingOnly] [-reuseShadows] [-sampleByFace] [-scaleFactor float] [-shareUV] [-useLightShadows]

polyGeoSampler is undoable, NOT queryable, and editable.

        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,

Return value

Keywords

Related

Flags

Long name (short name)	Argument types	Properties
-alphaBlend(-abl)	string
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.
-averageColor(-ac)
When used, will mean to force the storage of shared colors for vertex level sampling. By default vertex level sampling stores unshared colors.
-clampAlphaMax(-amx)	float
When used, will mean to clamp the storage of alpha to a maximum
-clampAlphaMin(-amn)	float
When used, will mean to clamp the storage of alpha to a minimum
-clampRGBMax(-cmx)	float float float
When used, will mean to clamp the storage of RGB color to a maximum
-clampRGBMin(-cmn)	float float float
When used, will mean to clamp the storage of RGB color to a minimum
-colorBlend(-cbl)	string
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.
-colorDisplayOption(-cdo)
Change the display options on the mesh to display the vertex colors.
-computeShadows(-cs)
When used, shadow maps will be computed, saved, and reused during the sampling process.
-displaceGeometry(-dg)
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.
-flatShading(-fs)
When used, flat shaded sampling will be computed. The default is smooth shading.
-ignoreDoubleSided(-ids)
When specified, the double sided flag will be ignored for prelighting.
-lightingOnly(-lo)
When used, incoming illumination will be computed as opposed to surface color an tranparency
-reuseShadows(-rs)
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.
-sampleByFace(-bf)
When used, sample will occur at a per face level versus a per vertex level, which is the default behaviour
-scaleFactor(-sf)	float
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)
When used, UVs are shared at a vertex when sampled. By default UVs are forced to be unshared.
-useLightShadows(-ul)
When used, will use each lights shadow map options. Otherwise these options will be overrridden when the computeShadows, and/or reusedShadows option is enabled.

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 be used more than once in a command.

MEL examples

// Example 1. Sample for color values.
//	a. No arguments. Will perform sampling of color + transparency at
//     the vertex level, and store color values for affected vertices.
//     No shadows will be computed.
polyGeoSampler;
// b. With shadows and illumination only
polyGeoSampler -lightingOnly -computeShadows;
// c. Sampling only complete selected faces
polyGeoSampler -sampleByFace;
// d. "Flat shading".
// Example 2. Sample for displacement values.
// a. Using displace option
polyGeoSampler -displaceGeometry;
// Example 3. Scaling the sampled data.
// a. Scaling option
polyGeoSampler -scaleFactor 0.1;
// Example 4. Don't force unshared UV value usage, and force
// the storage of shared colors for vertices.
polyGeoSampler -shareUV -averageColor;
// Example 5. Clamping colors. In this example the alpha and
// RGB channels of the colors are clamped between a min of 0,0,0,1
// and a max of 1,2,1,0.5 .
polyGeomSampler -amn 0.0 -amx 0.5 -cmn 0.0 0.0 0.0 -cmx 1.0 2.0 1.0;
// Example 6. Multiply the new sample color values	with the existing
// colors stored on the geometry, but leave the alpha values
// as they were on the geometry.
polyGeomSampler -colorBlend "multiply" -alphaBlend "none";