Go to: Attributes.

Converts an image into planar geometry.

Node nameParentsMFn typeCompatible function sets

Attributes (31)

colorRange, fitTolerance, hardCornerDetect, hardCornerMaxLength, imageFile, inputMesh, inputMeshUVSet, maxColorDiff, maxPointsAdded, meshQuality, minSegmentSize, outAlpha, outColor, outColorB, outColorData, outColorG, outColorR, outSegFace, output, pointsOnBoundary, quantize, quantizeLevels, segGroupIds, segmentCount, shaderScript, simplifyBoundary, simplifyThreshold, smoothBoundary, smoothFactor, spatialRadius, surfaceOffset

Long name (short name)TypeDefaultFlags
segmentCount (sc) integer0outputconnectablehidden
Output attribute indicates the number of segments found.
output (out) meshNULLoutputconnectablehidden
Output mesh data.
outColorData (ocd) compoundn/aarrayoutputconnectable
Output attribute for color information.
outColor (oc) float3outputconnectable
Colors from the segmented mesh
outColorR (ocr) float0.0outputconnectable
Output color R component
outColorG (ocg) float0.0outputconnectable
Output color G component
outColorB (ocb) float0.0outputconnectable
Output color B component
outAlpha (oa) float0.0outputconnectable
Output alpha component
outSegFace (ofm) intArrayemptyarrayoutputconnectable
Maps the segments to the faces of the generated mesh. Index i corresponds to segment i in aOutColor.
segGroupIds (sgi) integer-1arrayoutputinputconnectablestorable
Used to map segments to shaders. We need input component ids to properly assign the shaders.
inputMesh (im) meshNULLoutputinputconnectablestorable
Used to drive the tessellation. Since the objective is to place the converted geometry onto the surface. We need to tessellate the geometry so that when we lift the surface to 3d it will be exactly on it without intersections.
inputMeshUVSet (iuv) stringNULLoutputinputconnectablestorable
Specifies the UVset to use when an input mesh is specified.
quantize (qut) bool0outputinputconnectablestorable
Forces a quantization of the image before segmentation. This helps find segments in gradient shaded areas. If this attribute is set to true then quantizeLevels is used to determine the number of levels the image should quantized into.
quantizeLevels (qutl) unsigned char10outputinputconnectablestorable
If 'quantize' is set to true then quantizeLevels attribute is used to determine the number of levels of quantization.
maxColorDiff (mcd) float0.125outputinputconnectablestorable
The maximum color difference between two pixels. This value is used to determine if a new pixel should be added to a segment.
minSegmentSize (msz) float0.005outputinputconnectablestorable
The minimum segment size expressed as a percentage of a total image size.
spatialRadius (spr) integer7outputinputconnectablestorable
The search radius used to detect features in the image.
colorRange (crng) float4.5outputinputconnectablestorable
The range of colors we admit into a feature.
imageFile (if) stringNULLoutputinputconnectablestorable
Image file to extract geometry from.
meshQuality (mq) double0.1outputinputconnectablestorable
Determines the quality of the mesh produced. Zero is the poorest quality and one represents the highest quality.
surfaceOffset (so) float0.01outputinputconnectablestorablekeyable
If a constraint mesh is defined, then this will offset the wrapped surface by using the surface normals of the constraint mesh.
smoothBoundary (smbd) bool1outputinputconnectablestorable
Toggles the smoothing of the mesh boundary. Smoothing is done by averaging the points together.
smoothFactor (smf) float0.5outputinputconnectablestorable
If smoothBoundary is toggled then the value in smooth factor is used to determine how much the boundary of each segment is smoothed. A value of 0.5 would half the number of points along a mesh segment.
fitTolerance (ft) float0.007outputinputconnectablestorable
Attempts to fit lines to the gathered pixel data. This tolerance value indicates how closely lines much match. This value corresponds to the pixel size. The tolerance is pixelSize * fitTolerance
hardCornerDetect (hcd) bool1outputinputconnectablestorable
Attempts to detect sharp corners in segments before simplification and smoothing. It finds hard corners by walking around a segment boundary and finding a group of points whose slope does not change and length is equal to hardCornerMaxLength/100.0 * MAX(imgWidth,imgHeight).
hardCornerMaxLength (hcml) float10.0outputinputconnectablestorable
Used when hardCornerDetect is enabled.
simplifyBoundary (smpl) bool1outputinputconnectablestorable
Tries to remove points along segment boundary that have similar slope. That is, if the slope of line xy is equivalent to the slope of the line to line xz then y can be removed.
simplifyThreshold (smpt) double0outputinputconnectablestorablehidden
Used when simplifyBoundary is enabled.
pointsOnBoundary (pob) bool0outputinputconnectablestorable
The mesh generating can insert points to acheive a higher quality tessellation. This flag allows the point inserter to add points on segment boundaries.
maxPointsAdded (mpa) integer0outputinputconnectablestorable
The mesh generator can insert points to acheive a higher quality tessellation (i.e. a tessellation without skinny triangles). This attribute controls how many points are allowed to be added. This attribute can also be used to control the number of triangles.
shaderScript (shs) stringNULLoutputinputconnectablestorablehidden
Script to be called when shader assignment needs to be done.