fr.inria.zvtm.glyphs

Class VSwingComponent<T>

java.lang.Object

fr.inria.zvtm.glyphs.Glyph

fr.inria.zvtm.glyphs.ClosedShape

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

All Implemented Interfaces:

RectangularShape, Translucent, Cloneable

public class VSwingComponent<T>
extends ClosedShape
implements RectangularShape

Wrapper for Swing components.

Example:

JButton b = new JButton("Button 1");
b.setSize(100,50);
vs.addGlyph(new VSwingComponent(200, 0, 0, b));

Author:

Emmanuel Pietriga

Field Summary

Fields

Modifier and Type	Field and Description
double	ar Aspect ratio: width divided by height (read-only).
AffineTransform	at For internal use.
fr.inria.zvtm.glyphs.projection.RProjectedCoordsP[]	pc For internal use.
double	scaleFactor For internal use.
double	trueCoef For internal use.
double	vh Height in virtual space (read-only).
double	vw Width in virtual space (read-only).
boolean	zoomSensitive For internal use.

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

bColor, borderColor, cursorInsideFColor, HSVb

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
VSwingComponent(double x, double y, int z, JComponent c) Instantiate a Swing component at (x, y) with original scale.
VSwingComponent(double x, double y, int z, JComponent c, double scale) Instantiate a Swing component at (x, y) with a custom scale.
VSwingComponent(double x, double y, int z, JComponent c, double scale, double or, float alpha) Instantiate a Swing component at (x, y) with a custom scale.
VSwingComponent(double x, double y, int z, JComponent c, double scale, float alpha) Instantiate a Swing component at (x, y) with a custom scale.
VSwingComponent(JComponent c) Instantiate a Swing component at (0, 0) with original scale.

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) Detect whether the given point is inside this glyph or not.
boolean	coordInsideP(int jpx, int jpy, Camera c) Detect whether the given point is inside this glyph or not.
boolean	coordInsideV(double cvx, double cvy, Camera c) Detect whether the given point is inside this glyph or not.
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.
static void	forceLayout(Container container) Utility function: to ensure proper display, it is necessary to set the size of 'standalone' Components, or to force the layout of Containers.
double[]	getBounds() Get the bounding box of this Glyph in virtual space coordinates.
JComponent	getComponent() Get the Swing component displayed.
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	initCams(int nbCam) Initialize projected coordinates.
boolean	isZoomSensitive() Indicates whether the Swing component is scaled according to camera's altitude.
void	move(double x, double y) Translate the glyph by (x,y) - relative translation.
void	moveTo(double x, double y) Translate the glyph to (x,y) - absolute translation.
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	setComponent(JComponent c) Set Swing component to be displayed.
void	setHeight(double h) Set height in virtual space.
static void	setSizeToPreferred(Component cmp) Utility function: to ensure proper display, it is necessary to set the size of 'standalone' Components, or to force the layout of Containers.
void	setWidth(double w) Set width in virtual space.
void	setZoomSensitive(boolean b) Set to false if the Swing component should not be scaled according to camera's altitude.
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) The disc is actually approximated to its bounding box here.
boolean	visibleInRegion(double wb, double nb, double eb, double sb, int i) Method used internally to find out if it is necessary to project and draw this glyph for a given camera.

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

addHSVbColor, getBorderColor, getDefaultBorderColor, getHSVbColor, highlight, isBorderDrawn, isFilled, setBorderColor, setCursorInsideFillColor, setDrawBorder, setFilled, setHSVbColor

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

addHSVColor, containedInRegion, getColor, getDefaultColor, getDefaultCursorInsideHighlightColor, getHSVColor, getLocation, getOwner, getStickedGlyphArray, getStroke, getTranslucencyValue, getType, getZindex, isSelected, isSensitive, isVisible, isVisibleThroughLens, propagateMove, select, setColor, setCursorInsideHighlightColor, setDefaultCursorInsideHighlightColor, setHSVColor, setOwner, setSensitivity, setStroke, setTranslucencyValue, setType, setVisible, setZindex, stick, stickToGlyph, toString, unstick, unstickAllGlyphs, unstickAllGlyphs, unstickFromGlyph, 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 (read-only).

vh

public double vh

Height in virtual space (read-only).

ar

public double ar

Aspect ratio: width divided by height (read-only).

at

public AffineTransform at

For internal use. Made public for easier outside package subclassing.

pc

public fr.inria.zvtm.glyphs.projection.RProjectedCoordsP[] pc

For internal use. Made public for easier outside package subclassing.

zoomSensitive

public boolean zoomSensitive

For internal use. Made public for easier outside package subclassing.

scaleFactor

public double scaleFactor

For internal use. Made public for easier outside package subclassing.

trueCoef

public double trueCoef

For internal use. Made public for easier outside package subclassing.

Constructor Detail

VSwingComponent

public VSwingComponent(JComponent c)

Instantiate a Swing component at (0, 0) with original scale.

Parameters:

c - Swing component to be displayed

VSwingComponent

public VSwingComponent(double x,
                       double y,
                       int z,
                       JComponent c)

Instantiate a Swing component at (x, y) with original scale.

Parameters:

x - coordinate in virtual space

y - coordinate in virtual space

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

c - Swing component to be displayed

VSwingComponent

public VSwingComponent(double x,
                       double y,
                       int z,
                       JComponent c,
                       double scale)

Instantiate a Swing component at (x, y) with a custom scale.

Parameters:

x - coordinate in virtual space

y - coordinate in virtual space

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

c - Swing component to be displayed

scale - scaleFactor w.r.t original component size

VSwingComponent

public VSwingComponent(double x,
                       double y,
                       int z,
                       JComponent c,
                       double scale,
                       float alpha)

Instantiate a Swing component at (x, y) with a custom scale.

Parameters:

x - coordinate in virtual space

y - coordinate in virtual space

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

c - Swing component to be displayed

scale - scaleFactor w.r.t original component size

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

VSwingComponent

public VSwingComponent(double x,
                       double y,
                       int z,
                       JComponent c,
                       double scale,
                       double or,
                       float alpha)

Instantiate a Swing component at (x, y) with a custom scale.

Parameters:

x - coordinate in virtual space

y - coordinate in virtual space

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

c - Swing component to be displayed

scale - scaleFactor w.r.t original component size

or - orientation

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)

moveTo

public void moveTo(double x,
                   double y)

Description copied from class: Glyph

Translate the glyph to (x,y) - absolute translation.

Overrides:

moveTo in class Glyph

See Also:

Glyph.move(double x, double y)

move

public void move(double x,
                 double y)

Description copied from class: Glyph

Translate the glyph by (x,y) - relative translation.

Overrides:

move in class Glyph

See Also:

Glyph.moveTo(double x, double y)

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)

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

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

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)

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.

setComponent

public void setComponent(JComponent c)

Set Swing component to be displayed.

getComponent

public JComponent getComponent()

Get the Swing component displayed.

setZoomSensitive

public void setZoomSensitive(boolean b)

Set to false if the Swing component should not be scaled according to camera's altitude. Its size can still be changed, but its apparent size will always be the same, no matter the camera's altitude.

See Also:

isZoomSensitive()

isZoomSensitive

public boolean isZoomSensitive()

Indicates whether the Swing component is scaled according to camera's altitude.

See Also:

setZoomSensitive(boolean b)

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)

Description copied from class: Glyph

Detect whether the given point is inside this glyph or not.

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)

Description copied from class: Glyph

Detect whether the given point is inside this glyph or not. Uses VirtualSpace coordinates.

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)

Description copied from class: Glyph

Detect whether the given point is inside this glyph or not. Uses projected coordinates in View.

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)

visibleInRegion

public boolean visibleInRegion(double wb,
                               double nb,
                               double eb,
                               double sb,
                               int i)

Description copied from class: Glyph

Method used internally to find out if it is necessary to project and draw this glyph for a given camera.

Overrides:

visibleInRegion in class Glyph

Parameters:

wb - west region boundary (virtual space coordinates)

nb - north region boundary (virtual space coordinates)

eb - east region boundary (virtual space coordinates)

sb - south region boundary (virtual space coordinates)

i - camera index (useuful only for some glyph classes redefining this method)

Returns:

true if the glyph is currently visible in the region delimited by wb, nb, eb, sb, symbolising the region seen through a camera

visibleInDisc

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

The disc is actually approximated to its bounding box here. Precise intersection computation would be too costly.

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

setSizeToPreferred

public static void setSizeToPreferred(Component cmp)

Utility function: to ensure proper display, it is necessary to set the size of 'standalone' Components, or to force the layout of Containers.

See Also:

forceLayout(Container container)

forceLayout

public static void forceLayout(Container container)

Utility function: to ensure proper display, it is necessary to set the size of 'standalone' Components, or to force the layout of Containers.

See Also:

setSizeToPreferred(Component cmp)