fr.inria.zvtm.glyphs

Class VText<T>

java.lang.Object

fr.inria.zvtm.glyphs.Glyph

fr.inria.zvtm.glyphs.ClosedShape

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

All Implemented Interfaces:

Translucent, Cloneable

Direct Known Subclasses:

AdaptiveText, MultilineText, VTextLayout, VTextOr

public class VText<T>
extends ClosedShape

Standalone Text. This version is the most efficient, but it cannot be reoriented (see VTextOr*).
Font properties are set globally in the view, but can be changed on a per-instance basis using setSpecialFont(Font f).
(vx, vy) are the coordinates of the lower-left corner, or lower middle point, or lower-right corner depending on the text anchor (start, middle, end).

Author:

Emmanuel Pietriga

See Also:

VTextLayout, VTextOr

Field Summary

Fields

Modifier and Type	Field and Description
protected Font	font
protected float	fontSize Font size in pixels (read-only).
protected double	lcoef
protected static Font	mainFont
protected double	oldcoef
protected double	oldlcoef
int	paddingX Offset between text and vertical borders
int	paddingY Offset betwenn text and horizontal borders
protected fr.inria.zvtm.glyphs.projection.ProjText[]	pc For internal use.
protected float	scaleFactor
protected String	text
protected short	text_anchor
static short	TEXT_ANCHOR_END Text alignment (for text anchor) used to align a VText (vx,vy coordinates coincides with end of String).
static short	TEXT_ANCHOR_MIDDLE Text alignment (for text anchor) used to align a VText (vx,vy coordinates coincides with middle of String).
static short	TEXT_ANCHOR_START Text alignment (for text anchor) used to align a VText (vx,vy coordinates coincides with start of String).
protected boolean	zoomSensitive

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
VText(double x, double y, int z, Color c, Color bkg, String t, short ta, float scale, float alpha)
VText(double x, double y, int z, Color c, String t)
VText(double x, double y, int z, Color c, String t, short ta)
VText(double x, double y, int z, Color c, String t, short ta, float scale)
VText(double x, double y, int z, Color c, String t, short ta, float scale, float alpha)
VText(String t)

Method Summary

Modifier and Type	Method and Description
void	addCamera(int verifIndex) Create new projected coordinates.
Object	clone()
boolean	containedInRegion(double wb, double nb, double eb, double sb, int i) Method used internally to find out if it is necessary to project and draw the glyph through a lens for a given camera.
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) not implemented for VText.
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.
Color	getBorderColor() Get the text's background color.
Point2D.Double	getBounds(int i) Get the width and height of the bounding box in virtual space.
Font	getFont() Get the Font used to display this specific text object.
Shape	getJava2DShape() Get the Java2D Shape corresponding to this Glyph.
static Font	getMainFont() returns default font used by glyphs
double	getOrient() Get the glyph's orientation.
Point	getPadding()
float	getScale() Get the scale factor for this text.
double	getSize() Get glyph's size (size of bounding circle).
String	getText() Get text painted by this glyph.
short	getTextAnchor() Get text anchor.
static float	getTextDisplayedAsSegCoef() Get the value under which a VText is drawn as a point/segment instead of an actual text (considered too small to be read).
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.
void	invalidate() Force computation of text's bounding box at next call to draw().
boolean	isScaleIndependent() Indicates whether the text is scaled according to camera's altitude.
void	orientTo(double angle) Cannot be reoriented.
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) No effect.
void	setBorderColor(Color c) Set the text's background color.
void	setFont(Font f) Change the Font used to display this specific text object.
static void	setMainFont(Font f) set default font used by glyphs
void	setPadding(int x, int y)
void	setScale(float s) Set the scale factor for this text.
void	setScaleIndependent(boolean b) Set to true if the text should not be scaled according to camera's altitude.
void	setText(String t) Set text that should be painted.
void	setTextAnchor(short ta) Set the text anchor
static void	setTextDisplayedAsSegCoef(float f) Set the value under which a VText is drawn as a point/segment instead of an actual text (considered too small to be read).
void	sizeTo(double factor) No effect.
boolean	usesSpecificFont() Indicates whether this glyph is using a special font.
boolean	validBounds(int i) Indicates whether the bounds of the text are valid at this time or not.
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.
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, getDefaultBorderColor, getHSVbColor, isBorderDrawn, isFilled, setCursorInsideFillColor, setDrawBorder, setFilled, setHSVbColor

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

addHSVColor, getBounds, getColor, getDefaultColor, getDefaultCursorInsideHighlightColor, getHSVColor, getLocation, getOwner, getStickedGlyphArray, getStroke, getTranslucencyValue, getType, getZindex, isSelected, isSensitive, isVisible, isVisibleThroughLens, move, moveTo, 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

TEXT_ANCHOR_START

public static final short TEXT_ANCHOR_START

Text alignment (for text anchor) used to align a VText (vx,vy coordinates coincides with start of String).

See Also:

Constant Field Values

TEXT_ANCHOR_MIDDLE

public static final short TEXT_ANCHOR_MIDDLE

Text alignment (for text anchor) used to align a VText (vx,vy coordinates coincides with middle of String).

See Also:

Constant Field Values

TEXT_ANCHOR_END

public static final short TEXT_ANCHOR_END

Text alignment (for text anchor) used to align a VText (vx,vy coordinates coincides with end of String).

See Also:

Constant Field Values

text_anchor

protected short text_anchor

pc

protected fr.inria.zvtm.glyphs.projection.ProjText[] pc

For internal use.

zoomSensitive

protected boolean zoomSensitive

mainFont

protected static Font mainFont

fontSize

protected float fontSize

Font size in pixels (read-only).

font

protected Font font

text

protected String text

scaleFactor

protected float scaleFactor

lcoef

protected double lcoef

oldcoef

protected double oldcoef

oldlcoef

protected double oldlcoef

paddingX

public int paddingX

Offset between text and vertical borders

paddingY

public int paddingY

Offset betwenn text and horizontal borders

Constructor Detail

VText

public VText(String t)

Parameters:

t - text string

VText

public VText(double x,
             double y,
             int z,
             Color c,
             String t)

Parameters:

x - coordinate in virtual space

y - coordinate in virtual space

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

c - fill color

t - text string

VText

public VText(double x,
             double y,
             int z,
             Color c,
             String t,
             short ta)

Parameters:

x - coordinate in virtual space

y - coordinate in virtual space

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

c - fill color

t - text string

ta - text-anchor (for alignment: one of TEXT_ANCHOR_*)

VText

public VText(double x,
             double y,
             int z,
             Color c,
             String t,
             short ta,
             float 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 - fill color

t - text string

ta - text-anchor (for alignment: one of TEXT_ANCHOR_*)

scale - scaleFactor w.r.t original image size

VText

public VText(double x,
             double y,
             int z,
             Color c,
             String t,
             short ta,
             float scale,
             float alpha)

Parameters:

x - coordinate in virtual space

y - coordinate in virtual space

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

c - fill color

t - text string

ta - text-anchor (for alignment: one of TEXT_ANCHOR_*)

scale - scaleFactor w.r.t original image size

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

VText

public VText(double x,
             double y,
             int z,
             Color c,
             Color bkg,
             String t,
             short ta,
             float scale,
             float alpha)

Parameters:

x - coordinate in virtual space

y - coordinate in virtual space

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

c - fill color

bkg - background color (null if not painted)

t - text string

ta - text-anchor (for alignment: one of TEXT_ANCHOR_*)

scale - scaleFactor w.r.t original image size

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

Method Detail

getMainFont

public static Font getMainFont()

returns default font used by glyphs

setMainFont

public static void setMainFont(Font f)

set default font used by glyphs

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)

sizeTo

public void sizeTo(double factor)

No effect. Use the glyph's scale factor.

Specified by:

sizeTo in class Glyph

See Also:

setScale(float s)

reSize

public void reSize(double factor)

No effect. Use the glyph's scale factor.

Specified by:

reSize in class Glyph

See Also:

setScale(float s)

orientTo

public void orientTo(double angle)

Cannot be reoriented.

Specified by:

orientTo in class Glyph

Parameters:

angle - in [0:2Pi[

getSize

public double getSize()

Get glyph's size (size of bounding circle). Will return 0 if bounds of this VText have never been validated (through painting).

Specified by:

getSize in class Glyph

See Also:

getBounds(int i), validBounds(int i), invalidate()

getOrient

public double getOrient()

Description copied from class: Glyph

Get the glyph's orientation.

Specified by:

getOrient in class Glyph

setScaleIndependent

public void setScaleIndependent(boolean b)

Set to true if the text should not be scaled according to camera's altitude. Its apparent size will always be the same, no matter the camera's altitude.

Parameters:

b - false by default.

See Also:

isScaleIndependent()

isScaleIndependent

public boolean isScaleIndependent()

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

Returns:

true if it is scale independent (text is not scaled according to camera altitude).

See Also:

setScaleIndependent(boolean b)

setTextDisplayedAsSegCoef

public static void setTextDisplayedAsSegCoef(float f)

Set the value under which a VText is drawn as a point/segment instead of an actual text (considered too small to be read).

Parameters:

f - value compared to the product of the font size by the projection value. Default is 0.5. Raising this value implies that more text that was still displayed as a string will be displayed as a segment and conversely.

getTextDisplayedAsSegCoef

public static float getTextDisplayedAsSegCoef()

Get the value under which a VText is drawn as a point/segment instead of an actual text (considered too small to be read).

Returns:

the value compared to the product of the font size by the projection value. Default is 0.5. Raising this value implies that more text that was still displayed as a string will be displayed as a segment and conversely.

setBorderColor

public void setBorderColor(Color c)

Set the text's background color.

Overrides:

setBorderColor in class ClosedShape

Parameters:

c - background fill color. null if background should not be painted.

See Also:

Glyph.setColor(Color c)

getBorderColor

public Color getBorderColor()

Get the text's background color.

Overrides:

getBorderColor in class ClosedShape

Returns:

background fill color. null if background is not painted.

See Also:

ClosedShape.getDefaultBorderColor()

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

containedInRegion

public boolean containedInRegion(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 the glyph through a lens for a given camera.

Overrides:

containedInRegion 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 intersects the region delimited by wb, nb, eb, sb

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)

not implemented for VText.

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)

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

setText

public void setText(String t)

Set text that should be painted.

setScale

public void setScale(float s)

Set the scale factor for this text. The actual size of the text will be that defined by the font size multiplied by this scale factor.

Parameters:

s - scale factor

getScale

public float getScale()

Get the scale factor for this text. The actual size of the text is that defined by the font size multiplied by the scale factor returned by this method.

invalidate

public void invalidate()

Force computation of text's bounding box at next call to draw().

See Also:

validBounds(int i), getBounds(int i)

getBounds

public Point2D.Double getBounds(int i)

Get the width and height of the bounding box in virtual space.

Parameters:

i - index of camera (Camera.getIndex())

Returns:

the width and height of the text's bounding box, as a Point2D

See Also:

validBounds(int i), invalidate()

validBounds

public boolean validBounds(int i)

Indicates whether the bounds of the text are valid at this time or not. The bounds can be invalid if the thread in charge of painting has not dealt with this glyph since invalidate() was last called on it. It is advisable to test this before calling getBounds(int i)

See Also:

getBounds(int i), invalidate()

setFont

public void setFont(Font f)

Change the Font used to display this specific text object.

Parameters:

f - set to null to use the default font

See Also:

usesSpecificFont(), getFont()

getFont

public Font getFont()

Get the Font used to display this specific text object.

Returns:

the main ZVTM font if no specific Font is used to draw this text

See Also:

usesSpecificFont(), setFont(Font f)

usesSpecificFont

public boolean usesSpecificFont()

Indicates whether this glyph is using a special font. Special means different from the default one declared in the VirtualSpaceManager.

See Also:

setFont(Font f), getFont()

getText

public String getText()

Get text painted by this glyph.

setTextAnchor

public void setTextAnchor(short ta)

Set the text anchor

Parameters:

ta - one of TEXT_ANCHOR_START, TEXT_ANCHOR_MIDDLE, TEXT_ANCHOR_END

getTextAnchor

public short getTextAnchor()

Get text anchor.

Returns:

one of TEXT_ANCHOR_START, TEXT_ANCHOR_MIDDLE, TEXT_ANCHOR_END

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.

Overrides:

highlight in class ClosedShape

setPadding

public void setPadding(int x,
                       int y)

getPadding

public Point getPadding()