shrinkWrap

Show frames

Go to: Related nodes. Attributes.

Description:

The shrinkwrap deformer node projects a geometry's vertices onto another surface (the 'target'), using either raycasting or by finding the closest point on the target surface. Another object can optionally be specified (the 'inner' object) to help define the direction of the rays cast. There are five main projection modes: "Toward Inner Object" - the ray from a vertex is cast towards the corresponding vertex on the inner object. (If no inner object is connected, falls back to "Toward Center".) "Toward Center" - rays are cast towards either the center of the target object's bounding box, or the world origin, depending on the boundingBoxCenter attribute. "Parallel To Axes" - rays are cast along the x/y/z axis of a space defined by the axisReference attribute. "Vertex Normals" - the ray from a vertex is cast along the (inverted) vertex normal. "Closest" - no raycasting is done; instead the closest point (in worldspace) on the inner object (if present) or target object is used.

At present, only poly meshes are supported as target and inner objects.

Related nodes

lattice, cluster, jointCluster, nonLinear, blendShape, skinCluster, boneLattice, wire, ffd, jointFfd, sculpt, jointLattice, flexorShape, deformFunc, deformSquash, deformTwist, deformBend, deformWave, deformFlare, deformSine, baseLattice, clusterHandle, wrap

Attributes (32)

alongX, alongY, alongZ, axisReference, bidirectional, boundaryRule, boundingBoxCenter, cachedInflatedTarget, cachedSmoothTarget, closestIfNoIntersection, continuity, falloff, falloffIterations, innerGeom, innerGroupId, inputEnvelope, keepBorder, keepHardEdge, keepMapBorders, offset, projection, propagateEdgeHardness, reverse, shapePreservationEnable, shapePreservationIterations, shapePreservationMethod, shapePreservationReprojection, shapePreservationSteps, smoothUVs, targetGeom, targetInflation, targetSmoothLevel

Long name (short name)	Type	Default	Flags
alongX (ax)	bool	false
If projection mode is Parallel To Axes, enables the x component of the axis.
alongY (ay)	bool	false
If projection mode is Parallel To Axes, enables the y component of the axis.
alongZ (az)	bool	false
If projection mode is Parallel To Axes, enables the z component of the axis.
axisReference (ar)	enum	0
Space to use for the axes in Parallel To Axes mode.
bidirectional (bi)	bool	false
Tests rays in both directions.
boundaryRule (bnr)	enum	1
Controls how boundary edges and vertices are creased. By default, creases are automatically applied to all boundary edges and all vertices that have only 2 incident edges prior to converted to a smooth mesh. Users can control this behavior by modifying this enum. The options are 0 - use the original legacy algorithm which did not automatically crease boundary edges and vertices. 1 - default setting, apply creasing 2 - apply creasing to edges only
boundingBoxCenter (bbc)	bool	false
Use the bounding box center for 'towards center' projections.
cachedInflatedTarget (cit)	mesh	NULL
A cached inflated version of the target, when targetInflation is non-zero.
cachedSmoothTarget (cst)	mesh	NULL
A cached smoothed version of the target, when targetSmoothLevel is non-zero.
closestIfNoIntersection (cni)	bool	false
If there is no ray intersection, fallback to 'closest' projection mode.
continuity (co)	float	1
The smoothness parameter. Range is [0,1]. Default value of 1 smooths the faces as much as possible. Value of 0 subdivides faces only.
falloff (fo)	distance (double)	0.0cm
Falloff of the deformation into points where there was no intersection with the target surface.
falloffIterations (fi)	short	1
Number of internal iterations when calculating falloff.
innerGeom (in)	geometry	NULL
Inner geometry
innerGroupId (igi)	integer	0
The group id of the inner geometry
inputEnvelope (ien)	float	1
How much of the deformation should be applied. 0.0 means no deformation at all; 1.0 means the full deformation. This per-input attribute is multiplied by the deformer's overall envelope.
keepBorder (kb)	bool	false
If true: border edges will not be smoothed.
keepHardEdge (khe)	bool	false
If true: hard edges will not be smoothed.
keepMapBorders (kmb)	enum	1
Treatment of UV map borders 0 - all map border edges will be smoothed 1 - map borders that are also geometry borders will be smoothed 2 - no map borders will be smoothed
offset (o)	distance (double)	0.0cm
The offset of the shrinkwrapped surface along the target surface normal.
projection (prj)	enum	0
Projection mode
propagateEdgeHardness (peh)	bool	false
If true: The smooth mesh preview edges which are a result of edges from the base cage will share the same hardness value.
reverse (rev)	bool	false
Reverse the ray direction.
shapePreservationEnable (spe)	bool	false
Enable shape preservation.
shapePreservationIterations (spi)	short	1
Number of shape preservation iterations per step.
shapePreservationMethod (spm)	enum	0
What information to use when calculating the shape preservation.
shapePreservationReprojection (spr)	enum	1
When to reproject to the target surface during shape preservation.
shapePreservationSteps (sps)	short	1
Number of steps of shape preservation to apply.
smoothUVs (suv)	bool	true
If true: UVs as well as geometry will be smoothed
targetGeom (tgt)	geometry	NULL
Target geometry
targetInflation (ti)	distance (double)	0.0cm
Inflates the target shape along its surface normals before projecting.
targetSmoothLevel (tsl)	short	0
The smoothing level to use when the target is a poly mesh.