com.yworks.yfiles.view.input

Class EdgeSegmentSnapLine

java.lang.Object

com.yworks.yfiles.view.input.SnapLine

com.yworks.yfiles.view.input.EdgeSegmentSnapLine

public class EdgeSegmentSnapLine
extends SnapLine

A specialized SnapLine that is parallel to an edge segment and stores that edge.

In addition to the line itself, this class has three special nape locations the represent the source, center and end location of the related edge segment. All snap lines of this type have the SnapType SnapLineSnapTypes.CENTER and the ResourceKey SnapLine.SNAP_LINE_EDGE_SEGMENT_KEY.

Field Summary

Fields inherited from class com.yworks.yfiles.view.input.SnapLine

GRID_LINE_FIXED_LINE_KEY, SNAP_LINE_BLANK_VARIABLE_LINE_KEY, SNAP_LINE_CENTER_BETWEEN_BOUNDS_KEY, SNAP_LINE_CENTER_BETWEEN_CENTERS_KEY, SNAP_LINE_EDGE_SEGMENT_KEY, SNAP_LINE_EQUAL_DISTANCE_BETWEEN_BOUNDS_KEY, SNAP_LINE_EQUAL_DISTANCE_BETWEEN_CENTERS_KEY, SNAP_LINE_EQUAL_HEIGHT_KEY, SNAP_LINE_EQUAL_WIDTH_KEY, SNAP_LINE_EXTENDED_VARIABLE_LINE_KEY, SNAP_LINE_FIXED_DISTANCE_KEY, SNAP_LINE_FIXED_LINE_KEY, SNAP_LINE_PEN_KEY, SNAP_LINE_VARIABLE_LINE_KEY, SNAP_TO_GRID_KEY

Constructor Summary

Constructors

Constructor and Description
EdgeSegmentSnapLine(IEdge edge, PointD segmentSource, PointD segmentTarget, double distance, int segmentIndex) Initializes a new instance of the PointBasedSnapLine class.
EdgeSegmentSnapLine(IEdge edge, PointD from, PointD to, PointD segmentSource, PointD segmentTarget, double distance, int segmentIndex, Object tag, double weight) Initializes a new instance of the PointBasedSnapLine class.

Method Summary

Modifier and Type	Method and Description
PointD	getDirection() Gets the direction vector of this snap line.
double	getDistance() Gets the distance of this snap line from its related edge segment.
IEdge	getEdge() Gets the edge that is associated with this snap line.
int	getSegmentIndex() Gets the segment index of the related edge segment.
PointD	getSegmentSource() Gets the location that represents the source of the related segment on this line.
PointD	getSegmentTarget() Gets the location that represents the target of the related segment on this line.
PointD	getSourceMarker() Gets the location of the source marker of this snap line.
PointD	getTargetMarker() Gets the location of the target marker of this snap line.
void	setSourceMarker(PointD value) Sets the location of the source marker of this snap line.
void	setTargetMarker(PointD value) Sets the location of the target marker of this snap line.

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

getCoordinates, getFrom, getResourceKey, getSnapType, getTag, getTo, getWeight, setFrom, setTo

Methods inherited from class java.lang.Object

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

Constructor Detail

EdgeSegmentSnapLine

public EdgeSegmentSnapLine(IEdge edge,
                           PointD segmentSource,
                           PointD segmentTarget,
                           double distance,
                           int segmentIndex)

Initializes a new instance of the PointBasedSnapLine class.

Parameters:

edge - The edge to assign to Edge.

segmentSource - The location that represents the source of the related segment on this line. In addition, this location is used as From location.

segmentTarget - The location that represents the target of the related segment on this line. In addition, this location is used as To location.

distance - The distance of this snap line from its related edge segment.

segmentIndex - The segment index of the related edge segment.

EdgeSegmentSnapLine

public EdgeSegmentSnapLine(IEdge edge,
                           PointD from,
                           PointD to,
                           PointD segmentSource,
                           PointD segmentTarget,
                           double distance,
                           int segmentIndex,
                           Object tag,
                           double weight)

Initializes a new instance of the PointBasedSnapLine class.

Parameters:

edge - The edge to assign to Edge.

from - The first location that delimits this snap line.

to - The second location that delimits this snap line.

segmentSource - The location that represents the source of the related segment on this line.

segmentTarget - The location that represents the target of the related segment on this line.

distance - The distance of this snap line from its related edge segment.

segmentIndex - The segment index of the related edge segment.

tag - A tag that is associated with this snap line.

weight - The weight (importance) of this snap line.

Method Detail

getDirection

public final PointD getDirection()

Gets the direction vector of this snap line.

Returns:

The Direction.

getDistance

public final double getDistance()

Gets the distance of this snap line from its related edge segment.

Returns:

The Distance.

getEdge

public final IEdge getEdge()

Gets the edge that is associated with this snap line.

Returns:

The Edge.

getSegmentIndex

public final int getSegmentIndex()

Gets the segment index of the related edge segment.

Returns:

The SegmentIndex.

getSegmentSource

public final PointD getSegmentSource()

Gets the location that represents the source of the related segment on this line.

Returns:

The SegmentSource.

getSegmentTarget

public final PointD getSegmentTarget()

Gets the location that represents the target of the related segment on this line.

Returns:

The SegmentTarget.

getSourceMarker

public final PointD getSourceMarker()

Gets the location of the source marker of this snap line.

If this is null, the location of the SegmentSource is marked instead.

Returns:

The SourceMarker.

See Also:

setSourceMarker(PointD)

getTargetMarker

public final PointD getTargetMarker()

Gets the location of the target marker of this snap line.

If this is null, the location of the SegmentTarget is marked instead.

Returns:

The TargetMarker.

See Also:

setTargetMarker(PointD)

setSourceMarker

public final void setSourceMarker(PointD value)

Sets the location of the source marker of this snap line.

If this is null, the location of the SegmentSource is marked instead.

Parameters:

value - The SourceMarker to set.

See Also:

getSourceMarker()

setTargetMarker

public final void setTargetMarker(PointD value)

Sets the location of the target marker of this snap line.

If this is null, the location of the SegmentTarget is marked instead.

Parameters:

value - The TargetMarker to set.

See Also:

getTargetMarker()