com.yworks.yfiles.view.input

Class MovementInfo

java.lang.Object

com.yworks.yfiles.view.input.MovementInfo

public abstract class MovementInfo
extends Object

A helper class that is used in the context of GraphSnapContext to describe the movement of entities during the edit process.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MovementInfo(PointD originalLocation, MoveTypes moveType, IModelItem movedItem) Initializes a new instance of the MovementInfo class.

Method Summary

Modifier and Type	Method and Description
abstract IPoint	getCurrentLocation() Gets the current location as a live point.
MovementInfo	getHorizontalAnchor() Gets the horizontal movement info to which this info is anchored horizontally.
IModelItem	getMovedItem() Gets the item that is being moved.
MoveTypes	getMoveType() Indicates the type of the movement for this instance.
PointD	getOriginalLocation() Gets the original location of the element at the time the editing started.
MovementInfo	getVerticalAnchor() Gets the vertical movement info to which this info is anchored vertically.
double	getX(double dx) Gets the new x coordinate of the element if the mouse has been moved by dx during the gesture.
double	getY(double dy) Gets the new y coordinate of the element if the mouse has been moved by dy during the gesture.
boolean	isHorizontallyFixed() Gets a value indicating whether the x coordinate of the item is fixed during the move operation.
boolean	isVerticallyFixed() Gets a value indicating whether the y coordinate of the item is fixed during the move operation.
boolean	movesHorizontallySynchronizedWith(MovementInfo info) Determines whether this instances moves synchronized with the provided info.
boolean	movesVerticallySynchronizedWith(MovementInfo info) Determines whether this instances moves synchronized with the provided info.
void	setHorizontalAnchor(MovementInfo value) Sets the horizontal movement info to which this info is anchored horizontally.
void	setMoveType(MoveTypes value) Indicates the type of the movement for this instance.
void	setVerticalAnchor(MovementInfo value) Sets the vertical movement info to which this info is anchored vertically.

Methods inherited from class java.lang.Object

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

Constructor Detail

MovementInfo

protected MovementInfo(PointD originalLocation,
                       MoveTypes moveType,
                       IModelItem movedItem)

Initializes a new instance of the MovementInfo class.

Parameters:

originalLocation - The original location.

moveType - The type of the move.

movedItem - The item that is being moved.

Method Detail

getCurrentLocation

public abstract IPoint getCurrentLocation()

Gets the current location as a live point.

Returns:

The current location.

getHorizontalAnchor

public final MovementInfo getHorizontalAnchor()

Gets the horizontal movement info to which this info is anchored horizontally.

This info can be declared to be implicitly anchored to another info. Method movesHorizontallySynchronizedWith(MovementInfo) will try to match against the anchors to determine if two infos are moving synchronized.

Returns:

The horizontal anchor or null.

See Also:

setHorizontalAnchor(MovementInfo)

getMovedItem

public final IModelItem getMovedItem()

Gets the item that is being moved.

Returns:

The moved item.

getMoveType

public final MoveTypes getMoveType()

Indicates the type of the movement for this instance.

Returns:

The MoveType.

See Also:

setMoveType(MoveTypes)

getOriginalLocation

public final PointD getOriginalLocation()

Gets the original location of the element at the time the editing started.

Returns:

The original location.

getVerticalAnchor

public final MovementInfo getVerticalAnchor()

Gets the vertical movement info to which this info is anchored vertically.

This info can be declared to be implicitly anchored to another info. Method movesVerticallySynchronizedWith(MovementInfo) will try to match against the anchors to determine if two infos are moving synchronized.

Returns:

The vertical anchor or null.

See Also:

setVerticalAnchor(MovementInfo)

getX

public final double getX(double dx)

Gets the new x coordinate of the element if the mouse has been moved by dx during the gesture.

This takes the MoveType and OriginalLocation into account.

Parameters:

dx - The delta x coordinate.

Returns:

The new x coordinate.

getY

public final double getY(double dy)

Gets the new y coordinate of the element if the mouse has been moved by dy during the gesture.

This takes the MoveType and OriginalLocation into account.

Parameters:

dy - The delta y coordinate.

Returns:

The new y coordinate.

isHorizontallyFixed

public final boolean isHorizontallyFixed()

Gets a value indicating whether the x coordinate of the item is fixed during the move operation.

Returns:

The IsHorizontallyFixed.

isVerticallyFixed

public final boolean isVerticallyFixed()

Gets a value indicating whether the y coordinate of the item is fixed during the move operation.

Returns:

The IsVerticallyFixed.

movesHorizontallySynchronizedWith

public boolean movesHorizontallySynchronizedWith(MovementInfo info)

Determines whether this instances moves synchronized with the provided info.

Parameters:

info - The info to check.

Returns:

Whether this info and the given info move horizontally synchronized.

See Also:

getHorizontalAnchor()

movesVerticallySynchronizedWith

public boolean movesVerticallySynchronizedWith(MovementInfo info)

Determines whether this instances moves synchronized with the provided info.

Parameters:

info - The info to check.

Returns:

Whether this info and the given info move vertically synchronized.

See Also:

getVerticalAnchor()

setHorizontalAnchor

public final void setHorizontalAnchor(MovementInfo value)

Sets the horizontal movement info to which this info is anchored horizontally.

This info can be declared to be implicitly anchored to another info. Method movesHorizontallySynchronizedWith(MovementInfo) will try to match against the anchors to determine if two infos are moving synchronized.

Parameters:

value - The horizontal anchor or null.

See Also:

getHorizontalAnchor()

setMoveType

public final void setMoveType(MoveTypes value)

Indicates the type of the movement for this instance.

Parameters:

value - The MoveType to set.

See Also:

getMoveType()

setVerticalAnchor

public final void setVerticalAnchor(MovementInfo value)

Sets the vertical movement info to which this info is anchored vertically.

This info can be declared to be implicitly anchored to another info. Method movesVerticallySynchronizedWith(MovementInfo) will try to match against the anchors to determine if two infos are moving synchronized.

Parameters:

value - The vertical anchor or null.

See Also:

getVerticalAnchor()