fr.inria.zuist.engine

Class RegionPicker

java.lang.Object

fr.inria.zuist.engine.ZuistPicker

fr.inria.zuist.engine.RegionPicker

public class RegionPicker
extends ZuistPicker

A region picker that tells what regions overlap the corresponding coordinates. The picker will only test for regions that are visible in the given level range.

A RegionPicker is instantiated as follows:

SceneManager sm = ...;
// create a picker that will only consider regions visible at ZUIST levels 3 through 5 (any of these levels or all of them)
RegionPicker rPicker = sm.createRegionPicker(3,5);
rPicker.setListener(aListener);

with aListener a RegionListener that gets notified whenever the picker enters or exits a Region.

A RegionPicker is moved programmatically using setVSCoordinates(). Any VirtualSpace coordinates can be given to it.

One way to tie it to a VCursor is simply to call setVSCoordinates() in the mouseMoved listener associated with the corresponding ViewListener.

public void mouseMoved(ViewPanel v, int jpx, int jpy, MouseEvent e){
  rPicker.setVSCoordinates(v.getVCursor().getVSXCoordinate(), v.getVCursor().getVSYCoordinate());
}

Field Summary

Fields

Modifier and Type	Field and Description
protected int	maxIndex

Method Summary

Modifier and Type	Method and Description
void	computePickedRegionList() Compute the list of Regions currently picked.
RegionListener	getListener()
Region[]	getPickedRegionList() Get the list of regions currently picked.
void	reset() Reset the list of glyphs under the cursor.
void	setLevelRange(int tl, int bl) Get the picker's level range, i.e., the levels at which the picker is looking for candidates.
void	setListener(RegionListener rl)
void	setVSCoordinates(double x, double y) Set picker's coordinates (virtual space coordinates system).
void	updateCandidateRegions() This method should be called whenever regions are added/removed in the level range considered for picking.

Methods inherited from class fr.inria.zuist.engine.ZuistPicker

getLevelRange, getVSCoordinates

Methods inherited from class java.lang.Object

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

Field Detail

maxIndex

protected int maxIndex

Method Detail

updateCandidateRegions

public void updateCandidateRegions()

This method should be called whenever regions are added/removed in the level range considered for picking.

setListener

public void setListener(RegionListener rl)

getListener

public RegionListener getListener()

setVSCoordinates

public void setVSCoordinates(double x,
                             double y)

Description copied from class: ZuistPicker

Set picker's coordinates (virtual space coordinates system).

Overrides:

setVSCoordinates in class ZuistPicker

Parameters:

x - x-coordinate, in virtual space coordinates system

y - y-coordinate, in virtual space coordinates system

setLevelRange

public void setLevelRange(int tl,
                          int bl)

Description copied from class: ZuistPicker

Get the picker's level range, i.e., the levels at which the picker is looking for candidates. A higher level has a lower index. Both levels should bl >= 0. tl should be equal to or less than bl (but this is not checked).

Overrides:

setLevelRange in class ZuistPicker

Parameters:

tl - top level

bl - bottom level

reset

public void reset()

Reset the list of glyphs under the cursor.

getPickedRegionList

public Region[] getPickedRegionList()

Get the list of regions currently picked. Last entry is last region entered. This returns a copy of the actual array managed by the picker at the time the method is called. In other words, the array returned by this method is not synchronized with the actual list over time.

Returns:

an empty array if the picker is not over any region.

computePickedRegionList

public void computePickedRegionList()

Compute the list of Regions currently picked.