fr.inria.zvtm.glyphs

Class VShape<T>

java.lang.Object

fr.inria.zvtm.glyphs.Glyph

fr.inria.zvtm.glyphs.ClosedShape

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

All Implemented Interfaces:

Translucent, Cloneable

public class VShape<T>
extends ClosedShape

Custom shape implementing Jean-Yves Vion-Dury's graphical object model. Defined by its N vertices (every vertex is between 0 (distance from shape's center=0) and 1.0 (distance from shape's center equals bounding circle radius)). Angle between each vertices is 2*Pi/N - can be reoriented.

Author:

Emmanuel Pietriga

Field Summary

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
VShape(double x, double y, int z, double s, float[] v, Color c, Color bc, double or)
VShape(double x, double y, int z, double s, float[] v, Color c, Color bc, double or, float alpha)
VShape(double x, double y, int z, double s, float[] v, Color c, double or)
VShape(float[] v)

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.
double	getArea() Get the shape's area.
Point2D.Double	getCentroid() Get the double precision coordinates of this shape's centroid.
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).
float[]	getVertices() Get the list of vertex distances to the shape's center in the [0-1.0] range (relative to bounding circle).
String	getVerticesAsText() Get a serialization of the list of vertex distances to the shape's center in the [0-1.0] range.
void	initCams(int nbCam) Initialize projected coordinates.
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	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.

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, getBounds, 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, visibleInRegion, visibleInViewport

Methods inherited from class java.lang.Object

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

Constructor Detail

VShape

public VShape(float[] v)

Parameters:

v - Vertex distances to the shape's center in the [0-1.0] range (relative to bounding circle). Vertices are laid out counter clockwise, with the first vertex placed at the same X coordinate as the shape's center (provided orient=0).

VShape

public VShape(double x,
              double y,
              int z,
              double s,
              float[] v,
              Color c,
              double or)

Parameters:

x - coordinate in virtual space

y - coordinate in virtual space

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

s - size in virtual space

v - Vertex distances to the shape's center in the [0-1.0] range (relative to bounding circle). Vertices are laid out counter clockwise, with the first vertex placed at the same X coordinate as the shape's center (provided orient=0).

c - fill color

or - shape's orientation in [0, 2Pi[

VShape

public VShape(double x,
              double y,
              int z,
              double s,
              float[] v,
              Color c,
              Color bc,
              double or)

Parameters:

x - coordinate in virtual space

y - coordinate in virtual space

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

s - size in virtual space

v - Vertex distances to the shape's center in the [0-1.0] range (relative to bounding circle). Vertices are laid out counter clockwise, with the first vertex placed at the same X coordinate as the shape's center (provided orient=0).

c - fill color

bc - border color

or - shape's orientation in [0, 2Pi[

VShape

public VShape(double x,
              double y,
              int z,
              double s,
              float[] v,
              Color c,
              Color bc,
              double or,
              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)

s - size in virtual space

v - Vertex distances to the shape's center in the [0-1.0] range (relative to bounding circle). Vertices are laid out counter clockwise, with the first vertex placed at the same X coordinate as the shape's center (provided orient=0).

c - fill color

bc - border color

or - shape's orientation in [0, 2Pi[

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)

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

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)

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)

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

getVertices

public float[] getVertices()

Get the list of vertex distances to the shape's center in the [0-1.0] range (relative to bounding circle). Vertices are laid out counter clockwise, with the first vertex placed at the same X coordinate as the shape's center (provided orient=0).

getVerticesAsText

public String getVerticesAsText()

Get a serialization of the list of vertex distances to the shape's center in the [0-1.0] range.

Returns:

a comma-separated string representation of the vertex distance to the shape's center.

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

getArea

public double getArea()

Get the shape's area.

getCentroid

public Point2D.Double getCentroid()

Get the double precision coordinates of this shape's centroid.

See Also:

getCentroid()

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