ruleBehavior

Describes how SnapRules affect the interactive snapping behavior of this SnapSourceSettings. This value indicates how interactive snapping behavior is affected by SnapRules, which may allow, limit, or prevent snapping to this SnapSourceSettings. Rule-based snapping is configured by calling SnapSettings.syncSourceSettings - see SnapRules for more information about configuring a GeometryEditor with rule-based snapping.

If rule-based snapping is not configured (if snap sources were synchronized by calling SnapSettings.syncSourceSettings), then this value will be SnapRuleBehavior.None for all SnapSourceSettings in the SnapSettings.sourceSettings collection.

This information can be used to provide UI feedback to end users about which SnapSourceSettings can be snapped to. For example if your app presents a list of snap sources to the end user to enable or disable, you may wish to exclude SnapRuleBehavior.RulesPreventSnapping snap sources because they cannot actually be snapped to, regardless of the value of SnapSourceSettings.isEnabled.

See also