proximityWrap

Go to: Related nodes. Attributes.

Description:

The prox wrap deformer node binds a geometry with one or more influence objects in such a way that transformations or deformations of the influence objects result in an intuitive deformation of the geometry. The amount by which the motion of a component of an influence object affects a point on the bound geometry is a function of the distance of the component from the point.

Related nodes

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

Attributes (49)

associativeGeometry, bindTagsFilter, cacheSetup, coordinateFrames, driverBindGeometry, driverClusterMatrix, driverClusterRestMatrix, driverDropoffRate, driverFalloffEnd, driverFalloffRamp, driverFalloffRamp_FloatValue, driverFalloffRamp_Interp, driverFalloffRamp_Position, driverFalloffStart, driverGeometry, driverOverrideFalloffRamp, driverOverrideSmoothInfluences, driverOverrideSmoothNormals, driverOverrideSpanSamples, driverReferenceGeometry, driverScaleCompensation, driverSmoothInfluences, driverSmoothNormals, driverSpanSamples, driverStrength, driverUseTransformAsDeformation, driverWeightFunction, driverWrapMode, drivers, dropoffRateScale, falloffRamp, falloffRamp_FloatValue, falloffRamp_Interp, falloffRamp_Position, falloffScale, maxDrivers, perDriverVertexWeights, perDriverWeights, perDriverWeightsList, perVertexDriverWeights, perVertexWeights, perVertexWeightsList, scaleCompensation, smoothInfluences, smoothNormals, softNormalization, spanSamples, useBindTags, wrapMode

Long name (short name)	Type	Default	Flags
associativeGeometry (associativegeom)	geometry	nullptr
Optional associative geometry to define the proximity binding
bindTagsFilter (btf)	string	TmultiSharedObject::create<TdataString>"*Prox"
Expression to filter which component tags on the geometries to use for component segmentation during the bind process. Matching tags that exist both on the driver and the driven will be used. The expression can use basic wildcards like "*Prox" or "char*Prox"
cacheSetup (csp)	ctypeData	n/a
Internal data structure, do not change
coordinateFrames (crdf)	enum	0
The method how coordinate frames in surface mode are used. Mode Driver uses coordinate frames for each of the verts of the driver. Mode Snap uses coordinate frames at the snapped location for each of the verts of the deforming geometry.
driverWeightFunction (dwfl)	weightFunction	nullptr
Specifies the weights using external falloff nodes.
drivers (drvr)	compound	n/a
Bundled list of driver info
driverBindGeometry (orgdrv) geometry nullptr Driver bind geometry
driverReferenceGeometry (refdrv) geometry nullptr Driver reference geometry
driverGeometry (curdrv) geometry nullptr Driver deformed geometry
driverClusterRestMatrix (dorgcls) matrix identity Driver cluster rest matrix, generally used in wrap mode "Cluster". It can also be used for scale compensation when the driver has an implied scaling in wrap modes "Surface" or "Offset".
driverClusterMatrix (dcurcls) matrix identity Driver cluster matrix, generally used in wrap mode "Cluster". It can also be used for scale compensation when the driver has an implied scaling in wrap modes "Surface" or "Offset".
driverFalloffStart (dfos) double 0.0 Distance from the driver at which the influence starts to fall off from 1.0
driverFalloffEnd (dfoe) double 1.0 Distance from the driver at which the influence reaches 0.0
driverDropoffRate (ddpo) double 4.0 Rate of weight value dropoff over distance (1 for linear, 2 for quadratic, etc. )
driverFalloffRamp (dfrmp) compound n/a Shape of the falloff curve of the driver driverFalloffRamp_Position (dfrmpp) float 0.0 Position of ramp value on normalized 0-1 scale driverFalloffRamp_FloatValue (dfrmpfv) float 0.0 Ramp value at the sibling position driverFalloffRamp_Interp (dfrmpi) enum 0 Ramp Interpolation controls the way the intermediate values are calculated. The values are: None: No interpolation is done; the different colors just show up as different bands in the final texture. Linear: The values are interpolated linearly in RGB color space. Smooth: The values are interpolated along a bell curve, so that each color on the ramp dominates the region around it, then blends quickly to the next color. Spline: The values are interpolated with a spline curve, taking neighboring indices into account for greater smoothness.
driverOverrideFalloffRamp (dofrmp) bool false If true, the driver overrides the global falloff ramp
driverStrength (dstrn) double 1.0 Relative strength of the driver
driverUseTransformAsDeformation (dxad) bool true If true, the matrix of the driver geometry is seen as a deformer of the driver verts If false, the matrix of the driver geometry will be used as a transform
driverScaleCompensation (dscp) double 1.0 Scale compensation for when the driver has an implied scaling. This can be used in combination with or as a replacement of hooking up a matrix to driverClusterMatrix.
driverSmoothNormals (dsnrm) integer 0 Number of smoothing iterations for the surface normals of the driver (Only applies to mesh drivers)
driverOverrideSmoothNormals (dosnrm) bool false If true, the driver overrides the global smoothNormals value
driverSpanSamples (dspns) integer 2 Number of samples per span to be used for higher accuracy (Only applies to nurbs surface drivers)
driverSmoothInfluences (dsinf) integer 0 Number of smoothing iterations to perform on influences of the driver
driverOverrideSmoothInfluences (dosinf) bool false If true, the driver overrides the global smoothInfluences value
driverOverrideSpanSamples (dospns) bool false If true, the driver overrides the global spanSamples value
driverWrapMode (dwmd) enum 0 Specifies the wrap mode of this driver. See the description for the overall wrapMode for explanation of what each mode does.
dropoffRateScale (sdpo)	double	0.0
Scales the dropoffRate of all drivers
falloffRamp (frmp)	compound	n/a
Shape of the global falloff curve of the drivers
falloffRamp_Position (frmpp) float 0.0 Position of ramp value on normalized 0-1 scale
falloffRamp_FloatValue (frmpfv) float 0.0 Ramp value at the sibling position
falloffRamp_Interp (frmpi) enum 0 Ramp Interpolation controls the way the intermediate values are calculated. The values are: None: No interpolation is done; the different colors just show up as different bands in the final texture. Linear: The values are interpolated linearly in RGB color space. Smooth: The values are interpolated along a bell curve, so that each color on the ramp dominates the region around it, then blends quickly to the next color. Spline: The values are interpolated with a spline curve, taking neighboring indices into account for greater smoothness.
falloffScale (sfo)	double	1.0
Scales the falloff distances of all drivers
maxDrivers (maxd)	integer	10
Maximum number of drivers allowed contributing to each vert
perDriverWeightsList (pdwl)	compound	n/a
The per driver output weights for each multi index of the deformer.
perDriverWeights (pdw) compound n/a Per driver list of weights as it is computed and used by this deformer. perDriverVertexWeights (pdvw) double 0.0 List of weights for one driver, only non-zero weight will be set at proper geometry matching indices.
perVertexWeightsList (pvwl)	compound	n/a
The per driver output weights for each multi index of the deformer.
perVertexWeights (pvw) compound n/a Bundle of weights for each CV, meant to be connected to a skincluster weightList For each CV it store a list of weight at the innfluence index. perVertexDriverWeights (pvdw) double 0.0 weights for each target
scaleCompensation (scp)	double	1.0
Overall scale compensation for when all drivers have an implied scaling. This is a multiplier to the per driver setting of driverScaleCompensation
smoothInfluences (sinf)	integer	0
Number of smoothing iterations to perform on influences.
smoothNormals (snrm)	integer	0
Number of smoothing iterations for the surface normals of the drivers (Only applies to mesh drivers)
softNormalization (sftn)	bool	false
When this flag is on contributions are only normalized when the total contributions are more than 1.0 This can give a soft falloff away from the drivers but it can make it hard to make sure a vert is fully moved when needed.
spanSamples (spns)	integer	2
Number of samples per span to be used for higher accuracy (Only applies to nurbs surface drivers)
useBindTags (ubt)	bool	false
When this flag is turned on componentTag segmentation will be used during the bind. When on it will only allow verts of the driven to bind to faces of the driver that are in a matching segment tag. So a vert in headProx on the driven can only bind to faces that are in a tag called headProx on the driver. Verts or faces that are not assigned to any segment tag are considered to be a member of all of them which means they can bind to anything
wrapMode (wmd)	enum	1
The global method by which drivers influence the geometry. Individual drivers will use this mode when they are set to Global Mode Offset moves the verts based on the displacment of the driver verts. Mode Surface moves the verts relative to the surface of the driver. Mode Snap moves the verts to the closest location on the surface of the driver. Mode Rigid moves the verts by only using the matrix of the driver geometry. Mode Cluster moves the verts by using the cluster matrix inputs of the driver.