Detangle is one part of the Vellum collision pipeline. It adjusts point positions to try to avoid any collisions, both external and self, that occur as a result of a deformation. It requires a good configuration for its starting setup, however.
It can handle line and surface collisions. All polygons are converted to triangles internally, however, so the collision surface may not be what is drawn in the viewport. Collisions with external objects also allows the use of some types of packed primitives.
Several physically inspired attributes are also respected if
mass controls how self collision restoration is shared
stopped can be used to freeze certain points.
Two attributes are used to adjust the raw
pscale attribute for
store the initial overlap of neighboring points avoiding explosions
when the initial configuration doesn’t respect the full
collisionignore string point attribute is also used to cull
collision detection. This uses the
collisiongroup string point
attribute to determine if a collision is valid. If a point’s
collisionignore pattern matches the other point
collision detection will be skipped. Triangle and edge detection
will be skipped if any of the pairs of points between them would
be skipped. Note collisionignore
is not used from the external
collision geometry. If the external geometry is packed primitives,
string primitive attribute will be used to define
objectnames for culling with collisionignore
. If not, the parent's
objectname, or if there is none, external` is used.
P attribute is considered the new deformed version
of the geometry. The Previous Position attribute stores the undeformed
version which is assumed to be collision free.
Disable Self Attr.
This integer attribute will prevent points from engaging in self collisions if it is non-zero.
Disable External Attr.
This integer attribute will prevent points from engaging in external collisions if it is non-zero.
It is often useful to fuse points together logically without
actually fusing the point numbers. The weld attribute is an
integer attribute on points giving which point they should weld to.
If -1 or their own number, they are unwelded. The weld number
refers to a point number, unless an
id attribute is present, then
it refers to an
pscale is present, the
pscale attribute is used for the point
thickness and can vary per point. This parameter is the default when it is
absent, either in the external or self collision geometry.
Enable self collision detection.
Collide with Tetrahedral Open Faces
The unshared faces of a tetrahedral mesh will generate collision geometry if this is set. Sometimes one wishes to use both a triangle shell and a tetrahedral mesh, making this operation redundant.
Update Overlap Distances
overlap_external will be updated to reflect
the current configuration. They only decrease with this operation,
so to initialize set to a large initial value.
Require Paired Disabling for Automatic
Points that are disabled automatically for self collisions will only be disabled if both points involved in the collision are disabled. This allows tangled pieces of cloth to pull free (as their mutual collisions are disabled) without other pieces of cloth being free to pass through.
Update Disabled Points
Because not all collisions may have been properly handled, this will set the disabled point attributes on those points which are now colliding. This can be used to avoid trying to enforce them in their now incorrect positions, allowing them to eventually return to the right side of the surface.
When points are set to be disabled their value will be or-ed with
Reset Detangled Points
If a disabled point resolves its colliding relationship and is no longer detangled, reset its disabled status so it will start colliding again.
When points are reset, they are and-ed with not-
2. This ensures if
you manually disable a point by setting its value to 1, it won’t be
removed by the reset pass, but only those points disabled by the
auto-disable will be reset.
Any point altered by detangle will have this attribute set to 1.
Enable adjustment of
P by collisions. You may not want to do this if
updating disabled status, as adjusting positions can cause other points
to start to fail that might not be detected.
A point may often be moved by multiple collision events at once. All these adjustments are averaged together. This is the total weight to apply. Larger values will over-relax and may cause instabilities, but may also lead to faster convergence.
Maximum amount to move a point. If it has to move farther than this, it will clamp to this displacement and likely be disabled for failing to resolve the collision.
Resolve All Collisions
An initial gather pass is done across all potential collisions. These are resolved individually, but averaging the results may not fully resolve the collision. This will repeat the resolution on colliding pairs until max passes is reached or they are resolved. Note it does not detect any collisions created in this process.
Resolve All Max Passes
Maximum number of passes to resolve the collision list.
Resolve All Free Edges
Open curves, like hairs, tend to not resolve well in a pair-wise fashion. So applying the resolve all collisions to them just increasingly tangles them. This option will enable resolve-all for such open curves if your situation allows it.
An integer point attribute providing a layer count for the geometry. Higher numbers are considered higher layers; ie; will stack on top of the lower numbers.
If two points of different layer numbers collide, their relative mass is adjusted by this layershock factor. This causes the higher layer to get out of the way of the lower layer. Note the total layer difference is not used, merely whether it is greater or less. A value of 2 will cause the lower layer numbers to be effectively twice as heavy as higher numbers for the purpose of collisions.
A scale factor on the amount of friction effect to apply for collisions with external geometry.
A scale factor on the amount of friction effect to apply for collisions with self geometry.
A threshold at which to apply full friction. When the ratio of the tangential velocity and the normal impulse is less than this, the tangential velocity will be fully eliminated through friction. This is roughly tan() of the slope angle that will allow sliding under gravity.
If the static threshold fails, this controls what percentage the tangential velocity will be reduced in the dynamic friction case.
Assume Constant Collision Topology
Most cases of constant topology (ie, polygons are wired to the same point) will be automatically detected. However, this will avoid checking the topology at all and assume the points are wired up the same way they were when first encountered.
Cache Reset Key
A collision tree can often be re-used for different point positions if they have not changed over much. If this parameter evaluates to the same value, the tree will only be reset if the topology changed. This will not result in missed collisions, only possibly in slow down as the tree stops representing the geometry. Negative values will always reset the tree.