fr.inria.zvtm.engine

Class PickerVS

java.lang.Object

fr.inria.zvtm.engine.PickerVS

Direct Known Subclasses:

Picker

public class PickerVS
extends Object

A picker that requires VirtualSpace coordinates only.

List of Glyphs that can be picked by PickerVS at this time:

• AdaptiveText
• DPath
• FPolygon
• FRectangle
• MultilineText
• PCircle
• PRectangle
• RImage
• SICircle
• SIRectangle
• VCircle
• VCross
• VEllipse
• VImage
• VImageOr
• VPoint
• VPolygon
• VPolygonOr
• VRectangle
• VRectangleOr
• VRing
• VRoundRect
• VShape
• VSwingComponent
• VText
• VTextLayout

When instantiating a Picker manually, that picker should be registered with the VirtualSpace in which it is going to perform picking operations so that it gets notified whenever glyphs get removed from the VirtualSpace and updates itself accordingly. This is not necessary for the picker associated with a View's VCursor, that gets created automatically.

VirtualSpace vs = ...;
PickerVS pvs = new PickerVS();
vs.registerPicker(pvs);
...
pvs.setVSCoordinates(vx, vy);
// setting new VS coordinates does not trigger the update of the list of picked glyphs
// one also needs to call computePickedGlyphList(Camera c)
// where c is the camera through which the candidate glyphs are observed
pvs.computePickedGlyphList(c);
// or, if all glyphs should be considered, not only those that are visible within the camera's current viewport:
pvs.computePickedGlyphList(c, false);
// this can be useful, e.g, when picking in a VirtualSpace managed with zvtm-cluster.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	maxIndex
protected double	pvx
protected double	pvy
protected Glyph	tmpGlyph
protected short	tmpRes
protected double	vx coord in virtual space
protected double	vy coord in virtual space

Constructor Summary

Constructors

Constructor and Description
PickerVS() Picker constructor.
PickerVS(int stackSize) Picker constructor.

Method Summary

Modifier and Type	Method and Description
boolean	computePickedGlyphList(Camera c) Compute the list of glyphs currently picked.
boolean	computePickedGlyphList(Camera c, boolean onlyGlyphsInViewport) Compute the list of glyphs currently picked.
Glyph[]	getDrawOrderedPickedGlyphList(VirtualSpace v) The list of glyphs under the picker, ordered according to the drawing stack
Vector<Glyph>	getIntersectingGlyphs(Camera c) Get a list of all Glyphs (including segments and paths) picked.
Vector<Glyph>	getIntersectingGlyphs(Camera c, boolean onlyGlyphsInViewport, String type) Get a list of all Glyphs (including segments and paths) picked.
Vector<DPath>	getIntersectingPaths(Camera c) Get a list of all DPaths picked at the picker's current coordinates.
Vector<DPath>	getIntersectingPaths(Camera c, int tolerance) Get a list of all DPaths picked at the picker's current coordinates.
static Vector<DPath>	getIntersectingPaths(Camera c, int tolerance, double x, double y, boolean onlyGlyphsInViewport) Get a list of all DPaths picked at a given set of coordinates.
PickerListener	getListener()
Glyph[]	getPickedGlyphList() Get the list of glyphs currently picked.
Glyph[]	getPickedGlyphList(String type) Get the list of glyphs currently picked.
Glyph[]	getStickedGlyphArray() Get list of glyphs sticked to picker.
int	getStickedGlyphsNumber() Get the number of glyphs sticked to the picker.
static boolean	intersectsPath(DPath p, int tolerance, double x, double y, Graphics2D g2d) Tells whether the picker is hovering a particular DPath or not.
boolean	intersectsPath(DPath p, int tolerance, Graphics2D g2d) Tells whether the picker is hovering a particular DPath or not.
boolean	isPicked(Glyph g) Tells whether a given glyph is under this picker or not.
Glyph	lastGlyphEntered() Get the last Glyph this picker entered.
Glyph	pickOnTop(VirtualSpace v) Returns the glyph under the picker (drawing order)
void	printList() Print list of glyphs under cursor on System.err for debugging.
void	propagateMove(double dx, double dy) Propagate picker movements to sticked glyphs.
void	setListener(PickerListener pl)
void	setVSCoordinates(double x, double y) Set picker's coordinates (virtual space coordinates system).
void	stickGlyph(Glyph g) Attach glyph g to picker.
void	unstickGlyph(Glyph g) Unstick glyph from picker.
Glyph	unstickLastGlyph() Unstick glyph that was last sticked to this picker.

Methods inherited from class java.lang.Object

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

Field Detail

vx

protected double vx

coord in virtual space

vy

protected double vy

coord in virtual space

pvx

protected double pvx

pvy

protected double pvy

tmpGlyph

protected Glyph tmpGlyph

tmpRes

protected short tmpRes

maxIndex

protected int maxIndex

Constructor Detail

PickerVS

public PickerVS()

Picker constructor. Instantiated with a default stack size of 50.

PickerVS

public PickerVS(int stackSize)

Picker constructor.

Parameters:

stackSize - start picked glyph stack size. Will double capacity if overflows.

Method Detail

lastGlyphEntered

public Glyph lastGlyphEntered()

Get the last Glyph this picker entered.

setVSCoordinates

public void setVSCoordinates(double x,
                             double y)

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

Parameters:

x - x-coordinate, in virtual space coordinates system

y - y-coordinate, in virtual space coordinates system

setListener

public void setListener(PickerListener pl)

getListener

public PickerListener getListener()

getIntersectingPaths

public static Vector<DPath> getIntersectingPaths(Camera c,
                                                 int tolerance,
                                                 double x,
                                                 double y,
                                                 boolean onlyGlyphsInViewport)

Get a list of all DPaths picked at a given set of coordinates.

Parameters:

c - should be the active camera (can be obtained by VirtualSpaceManager.getActiveCamera())

tolerance - the rectangular area's half width/height considered as the cursor intersecting region, in virtual space units (default tolerance is 5)

x - picker x-coordinate, in virtual space coordinates system

y - picker y-coordinate, in virtual space coordinates system

onlyGlyphsInViewport - only perform picking test on glyphs that are drawn. Default value is true, as it limits the number of Glyphs to consider to those that fall within the camera's viewport.

Returns:

an empty vector if none

See Also:

getIntersectingPaths(Camera c)

getIntersectingPaths

public Vector<DPath> getIntersectingPaths(Camera c)

Get a list of all DPaths picked at the picker's current coordinates.

Parameters:

c - should be the active camera (can be obtained by VirtualSpaceManager.getActiveCamera())

Returns:

an empty vector if none

See Also:

getIntersectingPaths(Camera c, int tolerance, double cursorX, double cursorY, boolean onlyGlyphsInViewport)

getIntersectingPaths

public Vector<DPath> getIntersectingPaths(Camera c,
                                          int tolerance)

Get a list of all DPaths picked at the picker's current coordinates.

Parameters:

c - should be the active camera (can be obtained by VirtualSpaceManager.getActiveCamera())

tolerance - the rectangular area's half width/height considered as the cursor intersecting region, in virtual space units (default tolerance is 5)

Returns:

an empty vector if none

See Also:

getIntersectingPaths(Camera c, int tolerance, double cursorX, double cursorY, boolean onlyGlyphsInViewport)

intersectsPath

public static boolean intersectsPath(DPath p,
                                     int tolerance,
                                     double x,
                                     double y,
                                     Graphics2D g2d)

Tells whether the picker is hovering a particular DPath or not.

Parameters:

p - DPath instance to be tested

tolerance - the rectangular area's half width/height considered as the cursor intersecting region, in virtual space units (default tolerance is 5)

x - picker x-coordinate, in virtual space coordinates system

y - picker y-coordinate, in virtual space coordinates system

See Also:

intersectsPath(DPath p, int tolerance, Graphics2D g2d)

intersectsPath

public boolean intersectsPath(DPath p,
                              int tolerance,
                              Graphics2D g2d)

Tells whether the picker is hovering a particular DPath or not.

Parameters:

p - DPath instance to be tested

tolerance - the rectangular area's half width/height considered as the cursor intersecting region, in virtual space units (default tolerance is 5)

See Also:

intersectsPath(DPath p, int tolerance, double x, double y, Graphics2D g2d)

getIntersectingGlyphs

public Vector<Glyph> getIntersectingGlyphs(Camera c,
                                           boolean onlyGlyphsInViewport,
                                           String type)

Get a list of all Glyphs (including segments and paths) picked. This method is especially useful when the camera of interest is not the active camera for the associated view (i.e. another layer is active). Beware of the fact that this method returns glyphs of any kind, not just ClosedShape instances. It can thus be much more computationaly expensive than getpickedGlyphList()

Parameters:

c - a camera (the active camera can be obtained by VirtualSpaceManager.getActiveCamera())

onlyGlyphsInViewport - only perform picking test on glyphs that are drawn. Default value is true, as it limits the number of Glyphs to consider to those that fall within the camera's viewport.

type - the type of glyph to look for (pass null to look for any type of glyph). Type of glyph as specified with Glyph.setType().

Returns:

a list of glyphs under the mouse cursor, sorted by drawing order.

See Also:

getIntersectingGlyphs(Camera c), getPickedGlyphList()

getIntersectingGlyphs

public Vector<Glyph> getIntersectingGlyphs(Camera c)

Get a list of all Glyphs (including segments and paths) picked. This method is especially useful when the camera of interest is not the active camera for the associated view (i.e. another layer is active). Beware of the fact that this method returns glyphs of any kind, not just ClosedShape instances. It can thus be much more computationaly expensive than getpickedGlyphList()

Parameters:

c - a camera (the active camera can be obtained by VirtualSpaceManager.getActiveCamera())

Returns:

a list of glyphs under the mouse cursor, sorted by drawing order; null if no object under the cursor.

See Also:

getIntersectingGlyphs(Camera c, boolean onlyGlyphsInViewport, String type), getPickedGlyphList()

computePickedGlyphList

public boolean computePickedGlyphList(Camera c)

Compute the list of glyphs currently picked.

Parameters:

c - camera observing the glyphs of potential interest in the View.

computePickedGlyphList

public boolean computePickedGlyphList(Camera c,
                                      boolean onlyGlyphsInViewport)

Compute the list of glyphs currently picked.

Parameters:

c - camera observing the glyphs of potential interest in the View.

onlyGlyphsInViewport - only perform picking test on glyphs that are drawn. Default value is true, as it limits the number of Glyphs to consider to those that fall within the camera's viewport.

getPickedGlyphList

public Glyph[] getPickedGlyphList()

Get the list of glyphs currently picked. Last entry is last glyph 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 object.

See Also:

getPickedGlyphList(String type), getIntersectingGlyphs(Camera c), getIntersectingGlyphs(Camera c, boolean onlyGlyphsInViewport, String type)

getPickedGlyphList

public Glyph[] getPickedGlyphList(String type)

Get the list of glyphs currently picked. Last entry is last glyph 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.

Parameters:

type - the type of glyph to look for. Type of glyph as specified with Glyph.setType().

Returns:

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

See Also:

getPickedGlyphList(), getIntersectingGlyphs(Camera c), getIntersectingGlyphs(Camera c, boolean onlyGlyphsInViewport, String type)

isPicked

public boolean isPicked(Glyph g)

Tells whether a given glyph is under this picker or not.

printList

public void printList()

Print list of glyphs under cursor on System.err for debugging.

getDrawOrderedPickedGlyphList

public Glyph[] getDrawOrderedPickedGlyphList(VirtualSpace v)

The list of glyphs under the picker, ordered according to the drawing stack

pickOnTop

public Glyph pickOnTop(VirtualSpace v)

Returns the glyph under the picker (drawing order)

propagateMove

public void propagateMove(double dx,
                          double dy)

Propagate picker movements to sticked glyphs.

stickGlyph

public void stickGlyph(Glyph g)

Attach glyph g to picker.

unstickLastGlyph

public Glyph unstickLastGlyph()

Unstick glyph that was last sticked to this picker. The glyph is automatically made sensitive to mouse events. The number of glyphs sticked to this picker can be obtained by calling getStickedGlyphsNumber().

getStickedGlyphsNumber

public int getStickedGlyphsNumber()

Get the number of glyphs sticked to the picker.

unstickGlyph

public void unstickGlyph(Glyph g)

Unstick glyph from picker.

getStickedGlyphArray

public Glyph[] getStickedGlyphArray()

Get list of glyphs sticked to picker.

Returns:

the actual list, not a copy.