ShapeFlowStickyPointGetNearest Method

Returns the number of the shapes' sticky point closest to the passed X, Y coordinate that satisfies a criteria.

Syntax

StickyPoint = FlpCAD.ShapeFlowStickyPointGetNearest ShapeNumber as Long, Criteria as Integer, X as Double, Y as Double

The ShapeFlowStickyPointGetNearest method has these parts:

Part	Description
FlpCAD	An object expression that evaluates the Flipper CAD Control object.
ShapeNumber	The number of the shape to query.
Criteria	A criteria for which sticky points are to be included.
X	A double expression for the x world coordinate of the point.
Y	A double expression for the y world coordinate of the point.

Settings

Possible settings for Criteria are:

*Criteria*	Description
1	Include male sticky points (criteria bits 4 and/or 8 must be turned on).
2	Include female sticky points.(criteria bits 4 and/or 8 must be turned on).
4	Include glued sticky points (criteria bits 1 and/or 2 must be on).
8	Include unglued sticky points (criteria bits 1 and/or 2 must be on).

Returns

This method returns the number of the sticky point that resides on the shape, is closest to the X, Y point, and satisfies the Criteria. If an invalid ShapeNumber or Criteria was passed, a -1 is returned.

Remarks

The Criteria parameter sets which sticky points are elligible to be returned by this method. Criteria is a bit value, so the numbers must be added to set the desired criteria. Note that at least one of the 1 or 2 bits of Criteria must be turned on, along with one of the 4 or 8 bits.

For instance, to make all sticky points of the shape elligible (male and female, glued and unglued), the Criteria would be 15, or 1 (male) + 2 (female) + 4 (glued) + 8 (unglued). Or, to just allow only the nearest unglued female sticky point to be returend, Criteria would be 10, or 2 (female) + 8 (unglued).