fr.inria.zvtm.glyphs

Class VSegment<T>

java.lang.Object

fr.inria.zvtm.glyphs.Glyph

fr.inria.zvtm.glyphs.VSegment<T>

All Implemented Interfaces:

RectangularShape, Translucent, Cloneable

public class VSegment<T>
extends Glyph
implements RectangularShape

Segment (straight line).

Author:

Emmanuel Pietriga

Field Summary

Fields

Modifier and Type	Field and Description
double	vh Height in virtual space.
double	vw Width in virtual space.

Fields inherited from class fr.inria.zvtm.glyphs.Glyph

alphaC, coef, color, cursorInsideColor, ENTERED_GLYPH, EXITED_GLYPH, fColor, HSV, NO_CURSOR_EVENT, orient, sensit, size, stickedTo, stroke, visible, vx, vy, vz

Fields inherited from interface fr.inria.zvtm.glyphs.Translucent

acO

Constructor Summary

Constructors

Constructor and Description
VSegment(double x1, double y1, double x2, double y2, int z, Color c) give the end points of segment
VSegment(double x1, double y1, double x2, double y2, int z, Color c, float alpha) give the end points of segment
VSegment(double x, double y, int z, Color c, double lgth, double angle) give the centre of segment and half its length and orient
VSegment(double x, double y, int z, Color c, float alpha, double lgth, double angle) give the centre of segment and half its length and orient

Method Summary

Modifier and Type	Method and Description
void	addCamera(int verifIndex) Create new projected coordinates.
Object	clone()
boolean	coordInside(int jpx, int jpy, Camera c, double cvx, double cvy) Not implemented for VSegment.
boolean	coordInsideP(int jpx, int jpy, Camera c) Not implemented for VSegment.
boolean	coordInsideV(double cvx, double cvy, Camera c) Not implemented for VSegment.
void	draw(Graphics2D g, int vW, int vH, int i, Stroke stdS, AffineTransform stdT, int dx, int dy) Draw this glyph.
void	drawForLens(Graphics2D g, int vW, int vH, int i, Stroke stdS, AffineTransform stdT, int dx, int dy) Draw this glyph through a lens.
boolean	fillsView(double w, double h, int camIndex) Find out if this glyph completely fills a view.
double[]	getBounds() Get the bounding box of this Glyph in virtual space coordinates.
Point2D.Double[]	getEndPoints() Get the segment's two endpoints
double	getHeight() Get width in virtual space.
Shape	getJava2DShape() Get the Java2D Shape corresponding to this Glyph.
double	getOrient() Get the glyph's orientation.
double	getSize() Get glyph's size (diameter of bounding circle).
double	getWidth() Get width in virtual space.
void	highlight(boolean b, Color selectedColor) Highlight this glyph to give visual feedback when the cursor is inside it.
void	initCams(int nbCam) Initialize projected coordinates.
boolean	intersects(int x, int y, int camIndex) Detects whether the point (x,y) lies on the segment or not.
boolean	intersects(int x, int y, int tolerance, int camIndex) Detects whether the point (x,y) lies on the segment or not.
boolean	intersectsV(double cvx, double cvy, double tolerance) Detects whether the point (x,y) lies on the segment or not.
void	orientTo(double angle) Set the glyph's absolute orientation.
void	project(Camera c, Dimension d) Project glyph w.r.t a given camera's coordinate system, prior to actual painting.
void	projectForLens(Camera c, int lensWidth, int lensHeight, float lensMag, double lensx, double lensy) Project glyph w.r.t a given camera's coordinate system, prior to actual painting through a lens.
void	removeCamera(int index) Dispose of projected coordinates.
void	reSize(double factor) Set glyph's size by multiplying its bounding circle diameter by a factor.
void	setEndPoints(double x1, double y1, double x2, double y2) Change the segment's location, size and orientation by giving its two endpoints (absolute coordinates).
void	setHeight(double h) Set height in virtual space.
void	setWidth(double w) Set width in virtual space.
void	setWidthHeight(double w, double h)
void	sizeTo(double s) Set glyph's size by setting its bounding circle's diameter.
boolean	visibleInDisc(double dvx, double dvy, double dvr, Shape dvs, int camIndex, int jpx, int jpy, int dpr) Find out if a glyph is visible in a circular area.

Methods inherited from class fr.inria.zvtm.glyphs.Glyph

addHSVbColor, addHSVColor, containedInRegion, getBorderColor, getColor, getDefaultColor, getDefaultCursorInsideHighlightColor, getHSVbColor, getHSVColor, getLocation, getOwner, getStickedGlyphArray, getStroke, getTranslucencyValue, getType, getZindex, isBorderDrawn, isFilled, isSelected, isSensitive, isVisible, isVisibleThroughLens, move, moveTo, propagateMove, select, setBorderColor, setColor, setCursorInsideHighlightColor, setDefaultCursorInsideHighlightColor, setHSVbColor, setHSVColor, setOwner, setSensitivity, setStroke, setTranslucencyValue, setType, setVisible, setZindex, stick, stickToGlyph, toString, unstick, unstickAllGlyphs, unstickAllGlyphs, unstickFromGlyph, visibleInRegion, visibleInViewport

Methods inherited from class java.lang.Object

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

Field Detail

vw

public double vw

Width in virtual space. For internal use. Made public for easier outside package subclassing.

vh

public double vh

Height in virtual space. For internal use. Made public for easier outside package subclassing.

Constructor Detail

VSegment

public VSegment(double x1,
                double y1,
                double x2,
                double y2,
                int z,
                Color c)

give the end points of segment

Parameters:

x1 - coordinate of endpoint 1 in virtual space

y1 - coordinate of endpoint 1 in virtual space

x2 - coordinate of endpoint 2 in virtual space

y2 - coordinate of endpoint 2 in virtual space

z - z-index (pass 0 if you do not use z-ordering)

c - fill color

VSegment

public VSegment(double x1,
                double y1,
                double x2,
                double y2,
                int z,
                Color c,
                float alpha)

give the end points of segment

Parameters:

x1 - coordinate of endpoint 1 in virtual space

y1 - coordinate of endpoint 1 in virtual space

x2 - coordinate of endpoint 2 in virtual space

y2 - coordinate of endpoint 2 in virtual space

z - z-index (pass 0 if you do not use z-ordering)

c - fill color

alpha - in [0;1.0]. 0 is fully transparent, 1 is opaque

VSegment

public VSegment(double x,
                double y,
                int z,
                Color c,
                double lgth,
                double angle)

give the centre of segment and half its length and orient

Parameters:

x - coordinate in virtual space

y - coordinate in virtual space

z - z-index (pass 0 if you do not use z-ordering)

lgth - length in virtual space

angle - orientation

c - fill color

VSegment

public VSegment(double x,
                double y,
                int z,
                Color c,
                float alpha,
                double lgth,
                double angle)

give the centre of segment and half its length and orient

Parameters:

x - coordinate in virtual space

y - coordinate in virtual space

z - z-index (pass 0 if you do not use z-ordering)

lgth - length in virtual space

angle - orientation

c - fill color

alpha - in [0;1.0]. 0 is fully transparent, 1 is opaque

Method Detail

initCams

public void initCams(int nbCam)

Description copied from class: Glyph

Initialize projected coordinates. Called internally when glyph is created in order to create the initial set of projected coordinates w.r.t the number of cameras in the virtual space.

Specified by:

initCams in class Glyph

Parameters:

nbCam - current number of cameras in the virtual space

See Also:

Glyph.addCamera(int verifIndex), Glyph.removeCamera(int index)

addCamera

public void addCamera(int verifIndex)

Description copied from class: Glyph

Create new projected coordinates. Called internally to create new projected coordinates to use with the new camera.

Specified by:

addCamera in class Glyph

Parameters:

verifIndex - camera index, just to be sure that the number of projected coordinates is consistent with the number of cameras.

See Also:

Glyph.initCams(int nbCam), Glyph.removeCamera(int index)

removeCamera

public void removeCamera(int index)

Description copied from class: Glyph

Dispose of projected coordinates. If a camera is removed from the virtual space to which this glyphs belongs, the corresponding projected coordinates should be deleted. the array of projected coordinates should not be modified however, because other cameras' index remain the same. The corresponding index in the array should just be set to null.

Specified by:

removeCamera in class Glyph

See Also:

Glyph.initCams(int nbCam), Glyph.addCamera(int verifIndex)

getOrient

public double getOrient()

Description copied from class: Glyph

Get the glyph's orientation.

Specified by:

getOrient in class Glyph

orientTo

public void orientTo(double angle)

Description copied from class: Glyph

Set the glyph's absolute orientation.

Specified by:

orientTo in class Glyph

Parameters:

angle - in [0:2Pi[

getSize

public double getSize()

Description copied from class: Glyph

Get glyph's size (diameter of bounding circle).

Specified by:

getSize in class Glyph

getBounds

public double[] getBounds()

Get the bounding box of this Glyph in virtual space coordinates.

Overrides:

getBounds in class Glyph

Returns:

west, north, east and south bounds in virtual space.

setEndPoints

public void setEndPoints(double x1,
                         double y1,
                         double x2,
                         double y2)

Change the segment's location, size and orientation by giving its two endpoints (absolute coordinates).

getEndPoints

public Point2D.Double[] getEndPoints()

Get the segment's two endpoints

Returns:

absolute coordinates.

getWidth

public double getWidth()

Description copied from interface: RectangularShape

Get width in virtual space.

Specified by:

getWidth in interface RectangularShape

getHeight

public double getHeight()

Description copied from interface: RectangularShape

Get width in virtual space.

Specified by:

getHeight in interface RectangularShape

sizeTo

public void sizeTo(double s)

Description copied from class: Glyph

Set glyph's size by setting its bounding circle's diameter.

Specified by:

sizeTo in class Glyph

See Also:

Glyph.reSize(double factor)

reSize

public void reSize(double factor)

Description copied from class: Glyph

Set glyph's size by multiplying its bounding circle diameter by a factor.

Specified by:

reSize in class Glyph

See Also:

Glyph.sizeTo(double s)

setWidth

public void setWidth(double w)

Description copied from interface: RectangularShape

Set width in virtual space.

Specified by:

setWidth in interface RectangularShape

setHeight

public void setHeight(double h)

Description copied from interface: RectangularShape

Set height in virtual space.

Specified by:

setHeight in interface RectangularShape

setWidthHeight

public void setWidthHeight(double w,
                           double h)

fillsView

public boolean fillsView(double w,
                         double h,
                         int camIndex)

Description copied from class: Glyph

Find out if this glyph completely fills a view. (In which case it is not necessary to repaint objects below it in the drawing stack). If implemented, this method should be very efficient, as it is used by an optional top-down clipping algorithm. Otherwise it might cost more time than it can potentially save. Until now it has only been implemented for non-reorientable rectangles and was activated only for treemap-like representations in which a lot of rectangles can potentially overlap each other.

Specified by:

fillsView in class Glyph

coordInside

public boolean coordInside(int jpx,
                           int jpy,
                           Camera c,
                           double cvx,
                           double cvy)

Not implemented for VSegment.

Specified by:

coordInside in class Glyph

Parameters:

jpx - provide projected JPanel coordinates of the associated view, not virtual space coordinates

jpy - provide projected JPanel coordinates of the associated view, not virtual space coordinates

c - camera through which the glyph is observed (only a few types of Glyph actually require this information: SICircle, SIRectangle, VText)

cvx - virtual space coordinates

cvy - virtual space coordinates

See Also:

Glyph.coordInsideV(double cvx, double cvy, Camera c), Glyph.coordInsideP(int jpx, int jpy, Camera c)

coordInsideV

public boolean coordInsideV(double cvx,
                            double cvy,
                            Camera c)

Not implemented for VSegment.

Specified by:

coordInsideV in class Glyph

Parameters:

cvx - virtual space coordinates

cvy - virtual space coordinates

c - camera through which the glyph is observed (only a few types of Glyph actually require this information: SICircle, SIRectangle, VText)

See Also:

Glyph.coordInside(int jpx, int jpy, Camera c, double cvx, double cvy), Glyph.coordInsideP(int jpx, int jpy, Camera c)

coordInsideP

public boolean coordInsideP(int jpx,
                            int jpy,
                            Camera c)

Not implemented for VSegment.

Specified by:

coordInsideP in class Glyph

Parameters:

jpx - provide projected JPanel coordinates of the associated view, not virtual space coordinates

jpy - provide projected JPanel coordinates of the associated view, not virtual space coordinates

c - camera through which the glyph is observed

See Also:

Glyph.coordInsideV(double cvx, double cvy, Camera c), Glyph.coordInside(int jpx, int jpy, Camera c, double cvx, double cvy)

intersects

public boolean intersects(int x,
                          int y,
                          int camIndex)

Detects whether the point (x,y) lies on the segment or not. Default tolerance of 2 pixels.

Parameters:

x - EXPECTS PROJECTED JPanel COORDINATE (obtained e.g. in ViewListener's mouse methods as jpx)

y - EXPECTS PROJECTED JPanel COORDINATE (obtained e.g. in ViewListener's mouse methods as jpy)

camIndex - camera index (obtained through Camera.getIndex())

intersects

public boolean intersects(int x,
                          int y,
                          int tolerance,
                          int camIndex)

Detects whether the point (x,y) lies on the segment or not.

Parameters:

x - EXPECTS PROJECTED JPanel COORDINATE (obtained e.g. in ViewListener's mouse methods as jpx)

y - EXPECTS PROJECTED JPanel COORDINATE (obtained e.g. in ViewListener's mouse methods as jpy)

tolerance - the segment's clickable thickness in pixels, not virtual space units

camIndex - camera index (obtained through Camera.getIndex())

intersectsV

public boolean intersectsV(double cvx,
                           double cvy,
                           double tolerance)

Detects whether the point (x,y) lies on the segment or not.

Parameters:

cvx - x-coord in virtual space

cvy - y-coord in virtual space

tolerance - the segment's clickable thickness in virtual space units

visibleInDisc

public boolean visibleInDisc(double dvx,
                             double dvy,
                             double dvr,
                             Shape dvs,
                             int camIndex,
                             int jpx,
                             int jpy,
                             int dpr)

Description copied from class: Glyph

Find out if a glyph is visible in a circular area. Not implemented yet for most glyph classes. Used for instance to implement DynaSpot picking.

Overrides:

visibleInDisc in class Glyph

project

public void project(Camera c,
                    Dimension d)

Description copied from class: Glyph

Project glyph w.r.t a given camera's coordinate system, prior to actual painting. Called internally.

Specified by:

project in class Glyph

Parameters:

c - camera

d - dimension of View using camera c

projectForLens

public void projectForLens(Camera c,
                           int lensWidth,
                           int lensHeight,
                           float lensMag,
                           double lensx,
                           double lensy)

Description copied from class: Glyph

Project glyph w.r.t a given camera's coordinate system, prior to actual painting through a lens. Called internally.

Specified by:

projectForLens in class Glyph

Parameters:

c - camera

lensWidth - width of lens activated in View using this camera

lensHeight - height of lens activated in View using this camera

lensMag - magnification factor of lens activated in View using this camera

lensx - horizontal coordinateof lens activated in View using this camera

lensy - vertical coordinate of lens activated in View using this camera

draw

public void draw(Graphics2D g,
                 int vW,
                 int vH,
                 int i,
                 Stroke stdS,
                 AffineTransform stdT,
                 int dx,
                 int dy)

Description copied from class: Glyph

Draw this glyph.

Specified by:

draw in class Glyph

Parameters:

g - graphics context in which the glyph should be drawn

vW - associated View width (used by some closed shapes to determine if it is worth painting the glyph's border)

vH - associated View height (used by some closed shapes to determine if it is worth painting the glyph's border)

i - camera index in the virtual space containing the glyph

stdS - default stroke

stdT - identity transform

dx - horizontal offset

dy - vertical offset

drawForLens

public void drawForLens(Graphics2D g,
                        int vW,
                        int vH,
                        int i,
                        Stroke stdS,
                        AffineTransform stdT,
                        int dx,
                        int dy)

Description copied from class: Glyph

Draw this glyph through a lens.

Specified by:

drawForLens in class Glyph

Parameters:

g - graphics context in which the glyph should be drawn

vW - associated View width (used by some closed shapes to determine if it is worth painting the glyph's border)

vH - associated View height (used by some closed shapes to determine if it is worth painting the glyph's border)

i - camera index in the virtual space containing the glyph

stdS - default stroke

stdT - identity transform

dx - horizontal offset

dy - vertical offset

getJava2DShape

public Shape getJava2DShape()

Description copied from class: Glyph

Get the Java2D Shape corresponding to this Glyph. Virtual Space coordinates.

Specified by:

getJava2DShape in class Glyph

clone

public Object clone()

Overrides:

clone in class Glyph

highlight

public void highlight(boolean b,
                      Color selectedColor)

Highlight this glyph to give visual feedback when the cursor is inside it.

Specified by:

highlight in class Glyph