com.yworks.yfiles.view.input

Class SnapState

java.lang.Object

com.yworks.yfiles.view.input.SnapState

public final class SnapState
extends Object

Describes the state of a snapping operation.

This class is used by SnapContext to process snap results.

Constructor Summary

Constructors

Constructor and Description
SnapState(PointD location) Initializes a new instance of the SnapState class.
SnapState(PointD location, SnapTypes snapType) Initializes a new instance of the SnapState class.

Method Summary

Modifier and Type	Method and Description
PointD	getLocation() Gets the current location.
SnapTypes	getSnapType() Gets the type of the snap.
void	setSnapType(SnapTypes value) Sets the type of the snap.
void	snapTo(PointD newLocation) Sets the Location to the given point and adjusts the SnapType accordingly.
void	snapX(double newX) Modifies the X property of the Location and adjusts the SnapType accordingly.
void	snapY(double newY) Modifies the Y property of the Location and adjusts the SnapType accordingly.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SnapState

public SnapState(PointD location)

Initializes a new instance of the SnapState class.

Parameters:

location - The initial location.

SnapState

public SnapState(PointD location,
                 SnapTypes snapType)

Initializes a new instance of the SnapState class.

Parameters:

location - The initial location.

snapType - The current type of the snap.

Method Detail

getLocation

public final PointD getLocation()

Gets the current location.

Returns:

The location. The value can be adjusted using the snapX(double), snapY(double), and snapTo(PointD) methods.

getSnapType

public final SnapTypes getSnapType()

Gets the type of the snap.

Returns:

The type of the snap.

See Also:

setSnapType(SnapTypes)

setSnapType

public final void setSnapType(SnapTypes value)

Sets the type of the snap.

Parameters:

value - The type of the snap.

See Also:

getSnapType()

snapTo

public final void snapTo(PointD newLocation)

Sets the Location to the given point and adjusts the SnapType accordingly.

Parameters:

newLocation - The new location.

snapX

public final void snapX(double newX)

Modifies the X property of the Location and adjusts the SnapType accordingly.

Parameters:

newX - The new X.

snapY

public final void snapY(double newY)

Modifies the Y property of the Location and adjusts the SnapType accordingly.

Parameters:

newY - The new Y.

toString

public String toString()

Overrides:

toString in class Object