org.geotools.renderer.geom
Class Arrow2D

java.lang.Object
  java.awt.geom.RectangularShape
      org.geotools.renderer.geom.Arrow2D

All Implemented Interfaces:

java.lang.Cloneable, java.awt.Shape

public class Arrow2D

extends java.awt.geom.RectangularShape

Arrow oriented toward positives x values (0? arithmetic). This shape doesn't have direct support for rotation. To rotate the arrow toward an other direction, use AffineTransform.

The Arrow2D shape

Version:

$Id: Arrow2D.java 17672 2006-01-19 00:25:55Z desruisseaux $

Author:

Martin Desruisseaux

Constructor Summary

Arrow2D()
Construit une fl?che donc la surface initiale est nulle.

Arrow2D(double x, double y, double width, double height)
Construit une fl?che situ?e aux coordonn?es (x,y) avec une longueur selon x de width et une hauteur selon y de height.

Method Summary

boolean	contains(double x, double y) Indique si cette fl?che contient le point sp?cifi?.
boolean	contains(double x, double y, double width, double height) Indique si la fl?che contient enti?rement le rectangle sp?cifi?.
boolean	equals(java.lang.Object obj) Indique si cette fl?che est identique ? la fl?che sp?cifi?e.
java.awt.geom.Rectangle2D	getBounds2D() Renvoie les dimensions de cette fl?che.
double	getHeight() Retourne la largeur de la partie la plus large de la fl?che.
double	getHeight(double x) Renvoie la largeur de la fl?che ? la position x.
java.awt.geom.PathIterator	getPathIterator(java.awt.geom.AffineTransform at) Retourne un it?rateur permettant de balayer les segments formant la fl?che.
java.awt.geom.PathIterator	getPathIterator(java.awt.geom.AffineTransform at, double flatness) Retourne un it?rateur permettant de balayer les segments formant la fl?che.
double	getTailLength() Renvoie la longueur de la queue de la fl?che,
double	getWidth() Retourne la longueur de la fl?che, de la base jusqu'? sa pointe.
double	getX() Retourne la coordonn?e x.
double	getY() Retourne la coordonn?e y.
int	hashCode() Retourne un code "hash value" pour cette fl?che.
boolean	intersects(double x, double y, double width, double height) Indique si la fl?che intersepte le rectangle sp?cifi?.
boolean	isEmpty() D?termine si la superficie de cette fl?che est nulle.
void	setFrame(double x, double y, double width, double height) Affecte une nouvelle position et une nouvelle largeur ? la fl?che.
void	setTailProportion(double sx, double sy1, double sy0) Modifie la largeur et hauteur de la queue de la fl?che, en proportion avec les dimensions totales de cette fl?che.

Methods inherited from class java.awt.geom.RectangularShape

clone, contains, contains, getBounds, getCenterX, getCenterY, getFrame, getMaxX, getMaxY, getMinX, getMinY, intersects, setFrame, setFrame, setFrameFromCenter, setFrameFromCenter, setFrameFromDiagonal, setFrameFromDiagonal

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Arrow2D

public Arrow2D()

Construit une fl?che donc la surface initiale est nulle.

Arrow2D

public Arrow2D(double x,
               double y,
               double width,
               double height)

Construit une fl?che situ?e aux coordonn?es (x,y) avec une longueur selon x de width et une hauteur selon y de height.

Parameters:

x - Coordonn?e x minimale.

y - Coordonn?e y minimale.

width - Longueur selon l'axe des x, de la base ? la pointe de la fl?che.

height - Largeur maximale de la fl?che, mesur?e selon l'axe des y.

Method Detail

setTailProportion

public void setTailProportion(double sx,
                              double sy1,
                              double sy0)

Modifie la largeur et hauteur de la queue de la fl?che, en proportion avec les dimensions totales de cette fl?che. Ces facteurs doivent ?tre compris entre 0 et 1. Les valeurs par d?faut sont de 1/3 selon y et 2/3 selon x, ce qui signifie que la queue de la fl?che aura le tiers de la largeur totale disponible et les deux tiers de la longueur disponible. La pointe de la fl?che aura le reste. Ces proportions donnent d'assez bons r?sultats lorsque la fl?che est deux fois plus longue que large.

Parameters:

sx - Proportion de la longueur occup?e par la queue de la fl?che, entre 0 et 1.

sy1 - Proportion de la largeur occup?e par la queue de la fl?che pr?s de la base, entre 0 et 1.

sy0 - Proportion de la largeur occup?e par le bout de la queue de la fl?che, entre 0 et 1.

getTailLength

public double getTailLength()

Renvoie la longueur de la queue de la fl?che,

Returns:

La longueur de la queue, compris de 0 ? getWidth.

getX

public double getX()

Retourne la coordonn?e x. Il s'agira du x le plus bas de la superficie couverte par la fl?che.

Returns:

La coordonn?e x minimale.

getY

public double getY()

Retourne la coordonn?e y. Il s'agira du y le plus bas de la superficie couverte par la fl?che.

Returns:

La coordonn?e y minimale.

getWidth

public double getWidth()

Retourne la longueur de la fl?che, de la base jusqu'? sa pointe. Cette longueur est mesur?e selon l'axe des x.

getHeight

public double getHeight()

Retourne la largeur de la partie la plus large de la fl?che. Cette largeur est mesur?e selon l'axe des y.

getHeight

public double getHeight(double x)

Renvoie la largeur de la fl?che ? la position x. Si cette position n'est pas comprise de getMinX() ? getMaxX(), alors cette m?thode retourne 0. Sinon elle retourne la largeur de la fl?che ? la position sp?cifi?e.

Parameters:

x - Coordonn?e x ? laquelle on veut la largeur.

Returns:

La largeur de la fl?che, comprise entre 0 et getHeight.

isEmpty

public boolean isEmpty()

D?termine si la superficie de cette fl?che est nulle.

Returns:

true si la superficie de cette fl?che est nulle.

setFrame

public void setFrame(double x,
                     double y,
                     double width,
                     double height)

Affecte une nouvelle position et une nouvelle largeur ? la fl?che.

Parameters:

x - Coordonn?ex x minimale.

y - Coordonn?ex y minimale.

width - Longueur, de la base ? la pointe de la fl?che.

height - Largeur de la partie la plus large de la fl?che.

getBounds2D

public java.awt.geom.Rectangle2D getBounds2D()

Renvoie les dimensions de cette fl?che.

contains

public boolean contains(double x,
                        double y)

Indique si cette fl?che contient le point sp?cifi?.

Parameters:

x - Coordonn?e x du point ? v?rifier.

y - Coordonn?e y du point ? v?rifier.

contains

public boolean contains(double x,
                        double y,
                        double width,
                        double height)

Indique si la fl?che contient enti?rement le rectangle sp?cifi?. Ce sera le cas si la fl?che contient chacun des quatre coins du rectangle.

Parameters:

x - Coordonn?e x minimale du rectangle.

y - Coordonn?e y minimale du rectangle.

width - Largeur du rectangle.

height - Hauteur du rectangle.

Returns:

true si la fl?che contient le rectangle.

intersects

public boolean intersects(double x,
                          double y,
                          double width,
                          double height)

Indique si la fl?che intersepte le rectangle sp?cifi?.

Parameters:

x - Coordonn?e x minimale du rectangle.

y - Coordonn?e y minimale du rectangle.

width - Largeur du rectangle.

height - Hauteur du rectangle.

Returns:

true si la fl?che intersepte le rectangle.

getPathIterator

public java.awt.geom.PathIterator getPathIterator(java.awt.geom.AffineTransform at,
                                                  double flatness)

Retourne un it?rateur permettant de balayer les segments formant la fl?che. Comme cette fl?che ne contient pas de portion arrondie, cette m?thode retourne la m?me chose que l'autre m?thode getPathIterator.

Parameters:

at - Une transformation affine facultative.

flatness - Ignor?.

getPathIterator

public java.awt.geom.PathIterator getPathIterator(java.awt.geom.AffineTransform at)

Retourne un it?rateur permettant de balayer les segments formant la fl?che.

Parameters:

at - Une transformation affine facultative.

equals

public boolean equals(java.lang.Object obj)

Indique si cette fl?che est identique ? la fl?che sp?cifi?e.

hashCode

public int hashCode()

Retourne un code "hash value" pour cette fl?che.