com.yworks.yfiles.view.input

Class CollectSnapResultsEventArgs

java.lang.Object

com.yworks.yfiles.view.input.InputModeEventArgs

com.yworks.yfiles.view.input.CollectSnapResultsEventArgs

All Implemented Interfaces:

IEventArgs

public class CollectSnapResultsEventArgs
extends InputModeEventArgs

Event arguments for the CollectSnapResults event.

Event handlers can use the addSnapResult(SnapResult) method to add snapping results for the current move operation.

Field Summary

Fields inherited from interface com.yworks.yfiles.utils.IEventArgs

EMPTY

Constructor Summary

Constructors

Constructor and Description
CollectSnapResultsEventArgs(IInputModeContext context, PointD originalLocation, PointD newLocation, double snapDistance, Collection<SnapResult> snapResults) Creates a new instance of the event arguments using the provided values for initialization.

Method Summary

Modifier and Type	Method and Description
void	addSnapResult(SnapResult snapResult) Adds a SnapResult to the collection of snap results.
PointD	getDelta() Gets the vector by which the mouse has been moved since initialization of the snapping process.
PointD	getNewLocation() Gets the new (current) location of the mouse that is going to be manipulated by the snapping process.
PointD	getOriginalLocation() Gets the original location of the mouse at the beginning of the gesture.
double	getSnapDistance() The zoom invariant snap distance.

Methods inherited from class com.yworks.yfiles.view.input.InputModeEventArgs

getContext

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectSnapResultsEventArgs

public CollectSnapResultsEventArgs(IInputModeContext context,
                                   PointD originalLocation,
                                   PointD newLocation,
                                   double snapDistance,
                                   Collection<SnapResult> snapResults)

Creates a new instance of the event arguments using the provided values for initialization.

Parameters:

context - The context for which the event is queried.

originalLocation - The original location of the mouse at the beginning of the gesture.

newLocation - The new (current) location of the mouse.

snapDistance - The zoom invariant snap distance.

snapResults - The collection to store the snap results in.

Method Detail

addSnapResult

public void addSnapResult(SnapResult snapResult)

Adds a SnapResult to the collection of snap results.

null values will be discarded.

Parameters:

snapResult - The result to add.

getDelta

public final PointD getDelta()

Gets the vector by which the mouse has been moved since initialization of the snapping process.

Returns:

The delta.

getNewLocation

public final PointD getNewLocation()

Gets the new (current) location of the mouse that is going to be manipulated by the snapping process.

Returns:

The new (current) location.

getOriginalLocation

public final PointD getOriginalLocation()

Gets the original location of the mouse at the beginning of the gesture.

Returns:

The original location.

getSnapDistance

public final double getSnapDistance()

The zoom invariant snap distance.

Returns:

The SnapDistance.