SnapState enum

The resulting snap state when snapping to or from a snap candidate.

Inheritance

Constructors

SnapState()
const

Values

unsnapped → const SnapState

The previous snap candidate is no longer suitable and the current edit position is not snapped.

snappedToFeature → const SnapState

A snap has occurred to a SnapSource.

This value will be returned in the following cases:

  • When moving from an unsnapped position to a position that's snapped to an existing snappable feature or graphic.
  • When there is a change in snap candidate. For example, moving from a snap point on a polyline segment to its end vertex. This includes moving to a multiple candidate snap where one of the candidates was part of the previous snap.

Note that if the snap contains multiple candidates, where some are from features/graphics and some are from geometry guides, then SnapState.snappedToFeature will take priority over SnapState.snappedToGeometryGuide.

This value will not be returned in these cases:

  • When there is a change in snap point but not snap candidate. For example, moving from a snap point on a polyline segment to another snap point on the same polyline segment.
  • When moving around a feature or graphic such that the snap point and snap candidate do not change.
snappedToGeometryGuide → const SnapState

A snap has occurred to a geometry guide.

This value will be returned in the following cases:

  • When moving from an unsnapped position to a position that's snapped to an existing geometry guide.
  • When there is a change in snap candidate. For example, moving from a snap point on a geometry guide to a different geometry guide, or to a multiple candidate snap that involves the same guide.

This value will not be returned in these cases:

  • When there is a change in snap point but not snap candidate. For example, moving from a snap point on a geometry guide to another snap point on the same geometry guide.
  • When moving around a geometry guide such that the snap point and snap candidate do not change.

Properties

coreValue → RT_SnapState
no setter
hashCode int
The hash code for this object.
no setterinherited
index int
A numeric identifier for the enumerated value.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited

Constants

values → const List<SnapState>
A constant List of the values in this enum, in order of their declaration.