fr.inria.zvtm.lens

Class RouteLens

java.lang.Object

fr.inria.zvtm.lens.RouteLens

public class RouteLens
extends Object

A utility class implementing the RouteLens motor behavior. The RouteLens motor behavior is described in J. Alvina, C. Appert, O. Chapuis, E. Pietriga, RouteLens: Easy Route Following for Map Applications, AVI '14: Proceedings of the 12th working conference on Advanced visual interfaces. It can be coupled with any type of ZVTM lens. When moving a lens, simply call RouteLens.moveLens(x, y) instead of Lens.setAbsolutePosition(x, y);

Example of use, specifying that Lens l's position should stick to the route whose geometry is encoded by a DPath:

DPath route1 = ...;
DPath route2 = ...;
Lens l = ...;
Camera c = ...;
RouteLens rl = new RouteLens(l, c);
rl.addRoute(route1);
rl.addRoute(route2);
...

public void mouseMoved(ViewPanel v,int jpx,int jpy, MouseEvent e){
    rl.moveLens(jpx, jpy);
}

Since:

0.11.2

Author:

Caroline Appert

Constructor Summary

Constructors

Constructor and Description
RouteLens(Lens l, Camera c)
RouteLens(Lens l, Camera c, double mad, int p)

Method Summary

Modifier and Type	Method and Description
void	addRoute(DPath route) *@param route a route that should influence the lens' position.
static GeneralPath	concatPath(GeneralPath path1, GeneralPath path2)
static ArrayList<GeneralPath>	cutPath(GeneralPath path)
static Point2D	getClosestPoint(Point2D pt, GeneralPath path, double maxSegmentLength)
static Point2D	getLensPosition(ArrayList<GeneralPath> routeSegments, Point2D C, double delta, int p)
static Point2D	getLensPosition(GeneralPath route, Point2D C, double delta, int p)
double	getMad()
int	getP()
static ArrayList<Point2D>	getPoints(GeneralPath path, double maxSegmentLength)
boolean	isEnabled() Is RouteLens attraction enabled or disabled.
void	moveLens(int x, int y) Move the lens to coordinates x,y, possibly adjusting its actual position depending on attraction forces exterted by the route.
void	removeRoute(DPath route)
static ArrayList<Point2D>	resample(Point2D pt1, Point2D pt2, double maxSegmentLength)
void	setEnabled(boolean b) Enabled/disable RouteLens attraction.
void	setMad(double mad)
void	setP(int p)
protected void	updateGeneralPath()

Methods inherited from class java.lang.Object

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

Constructor Detail

RouteLens

public RouteLens(Lens l,
                 Camera c,
                 double mad,
                 int p)

Parameters:

l - the lens whose position will be influenced by route dp.

c - the camera observing the route in the View that holds the lens.

mad - the maximum attraction distance, beyond which a route segment will not exert any influence on the lens.

p - power parameter used to fine-tune the attraction effect. Default is 2, typically in range [2,6].

RouteLens

public RouteLens(Lens l,
                 Camera c)

Parameters:

l - the lens whose position will be influenced by route dp.

c - the camera observing the route in the View that holds the lens.

Method Detail

cutPath

public static ArrayList<GeneralPath> cutPath(GeneralPath path)

concatPath

public static GeneralPath concatPath(GeneralPath path1,
                                     GeneralPath path2)

getClosestPoint

public static Point2D getClosestPoint(Point2D pt,
                                      GeneralPath path,
                                      double maxSegmentLength)

getPoints

public static ArrayList<Point2D> getPoints(GeneralPath path,
                                           double maxSegmentLength)

getLensPosition

public static Point2D getLensPosition(GeneralPath route,
                                      Point2D C,
                                      double delta,
                                      int p)

getLensPosition

public static Point2D getLensPosition(ArrayList<GeneralPath> routeSegments,
                                      Point2D C,
                                      double delta,
                                      int p)

resample

public static ArrayList<Point2D> resample(Point2D pt1,
                                          Point2D pt2,
                                          double maxSegmentLength)

moveLens

public void moveLens(int x,
                     int y)

Move the lens to coordinates x,y, possibly adjusting its actual position depending on attraction forces exterted by the route.

Parameters:

x - x-coord of the default lens center position. Usually the mouse cursor's x-coord in screen space (JPanel coord sys).

y - y-coord of the default lens center position. Usually the mouse cursor's y-coord in screen space (JPanel coord sys).

updateGeneralPath

protected void updateGeneralPath()

addRoute

public void addRoute(DPath route)

*@param route a route that should influence the lens' position.

See Also:

removeRoute(DPath route)

removeRoute

public void removeRoute(DPath route)

Parameters:

route - a route that does not influence anymore the lens' position.

See Also:

addRoute(DPath route)

setEnabled

public void setEnabled(boolean b)

Enabled/disable RouteLens attraction.

isEnabled

public boolean isEnabled()

Is RouteLens attraction enabled or disabled.

getMad

public double getMad()

Returns:

the maximum attraction distance, beyond which a route segment will not exert any influence on the lens.

setMad

public void setMad(double mad)

Parameters:

mad - the maximum attraction distance, beyond which a route segment will not exert any influence on the lens.

getP

public int getP()

Returns:

power parameter used to fine-tune the attraction effect. Default is 2, typically in range [2,6].

setP

public void setP(int p)

Parameters:

p - power parameter used to fine-tune the attraction effect. Default is 2, typically in range [2,6].