jhplot.jadraw

Class JaVertex

java.lang.Object

jhplot.jadraw.JaObject

jhplot.jadraw.JaVertex

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

JaVertexT1, JaVertexT2, JaVertexT3, JaVertexT4, JaVertexT6

public abstract class JaVertex
extends JaObject

A vertex object.

See Also:

Serialized Form

Field Summary

Fields inherited from class jhplot.jadraw.JaObject

BB_MAX_X, BB_MAX_Y, BB_MIN_X, BB_MIN_Y, COPY, D_FORMAT, INIT_SIZE, LENGTH, MOVE, RESIZE, SELECT_BODY, SELECT_LL, SELECT_LR, SELECT_NONE, SELECT_P1, SELECT_P2, SELECT_P3, SELECT_UL, SELECT_UR

Constructor Summary

Constructors

Constructor and Description
JaVertex() Constructor: sets the width, height, relative width and height, and stroke to a default value of 2.

Method Summary

Modifier and Type	Method and Description
JaObject	copy(JaVertex temp) Returns an exact copy of this JaVertex.
void	drawHandles(org.freehep.graphics2d.VectorGraphics g2) Draws the handles of this vertex object.
void	drawVisualAid(org.freehep.graphics2d.VectorGraphics g2) Draws a visual aid during the dragging of a vertex object, which is a red cross at the center.
abstract boolean	editPanel() Brings up the edit panel that allows to change the parameters of this object.
int	getGrabbedHandle(int clickX, int clickY, int editmode) Determines which handle the user has selected to move/resize/edit this vertex.
float	getStroke() Returns the stroke property of this line object.
boolean	isCopy(JaObject comp) Returns true if all serializable variables of this JaObject and those of the specified one are equal.
abstract void	jaxoDraw(org.freehep.graphics2d.VectorGraphics g2, boolean drawToScreen) The method that draws the JaObject.
abstract java.lang.String	latexCommand(float scale, java.awt.Dimension canvasDim) The LaTeX command that is necessary to draw the given JaObject using the axodraw.sty package.
java.lang.String	latexWidth() Returns the line width of this JaVertex.
void	rescaleObject(int orx, int ory, float scale) Rescales this JaVertex by the scale factor scale, keeping the point (orx, ory) fixed.
void	setStroke(float newStroke) Sets the stroke property of this line object.

Methods inherited from class jhplot.jadraw.JaObject

copy, getBoundingBox, getColor, getGeneralPath, getHeight, getRelh, getRelHndc, getRelHuser, getRelSize, getRelw, getRelWndc, getRelWuser, getSize, getWidth, getX, getXndc, getXuser, getY, getYndc, getYuser, isMarked, isUser, moveBy, scalePoint, setAsMarked, setBoundingBox, setColor, setLocation, setLocation, setRelh, setRelw, setRelWAndH, setRelWH, setSize, setX, setY, updateCoor, updateNDC

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JaVertex

public JaVertex()

Constructor: sets the width, height, relative width and height, and stroke to a default value of 2.

Method Detail

getStroke

public final float getStroke()

Returns the stroke property of this line object.

Returns:

The stroke property of this line object.

setStroke

public final void setStroke(float newStroke)

Sets the stroke property of this line object.

Parameters:

newStroke - The stroke property of this line object.

copy

public final JaObject copy(JaVertex temp)

Returns an exact copy of this JaVertex.

Parameters:

temp - An instance of the vertex to copy to.

Returns:

A copy of this JaVertex.

isCopy

public boolean isCopy(JaObject comp)

Returns true if all serializable variables of this JaObject and those of the specified one are equal.

Specified by:

isCopy in class JaObject

Parameters:

comp - A JaObject to compare with.

Returns:

True if the objects are equal, false otherwise.

getGrabbedHandle

public final int getGrabbedHandle(int clickX,
                                  int clickY,
                                  int editmode)

Determines which handle the user has selected to move/resize/edit this vertex.

Specified by:

getGrabbedHandle in class JaObject

Parameters:

clickX - The x coordinate where the mouse click has ocurred.

clickY - The y coordinate where the mouse click has ocurred.

editmode - The current edit mode.

Returns:

One of the static variables SELECT_* defined in JaObject that specifies the handle which the user has clicked.

drawHandles

public final void drawHandles(org.freehep.graphics2d.VectorGraphics g2)

Draws the handles of this vertex object.

Specified by:

drawHandles in class JaObject

Parameters:

g2 - The current graphics context.

drawVisualAid

public final void drawVisualAid(org.freehep.graphics2d.VectorGraphics g2)

Draws a visual aid during the dragging of a vertex object, which is a red cross at the center.

Overrides:

drawVisualAid in class JaObject

Parameters:

g2 - The graphics context to draw to

latexWidth

public final java.lang.String latexWidth()

Returns the line width of this JaVertex.

Specified by:

latexWidth in class JaObject

Returns:

The line width of this JaVertex.

rescaleObject

public final void rescaleObject(int orx,
                                int ory,
                                float scale)

Rescales this JaVertex by the scale factor scale, keeping the point (orx, ory) fixed.

Specified by:

rescaleObject in class JaObject

Parameters:

orx - The x-coordinate of the fixed point

ory - The y-coordinate of the fixed point

scale - The scale parameter

jaxoDraw

public abstract void jaxoDraw(org.freehep.graphics2d.VectorGraphics g2,
                              boolean drawToScreen)

The method that draws the JaObject.

Specified by:

jaxoDraw in class JaObject

Parameters:

g2 - The graphics context where the object has to be drawn.

drawToScreen - A boolean variable that indicates whether the drawing is done on the screen or somewhere else. This is used for exporting/printing, where the object handles should not be painted, even if they are visible on the screen.

latexCommand

public abstract java.lang.String latexCommand(float scale,
                                              java.awt.Dimension canvasDim)

The LaTeX command that is necessary to draw the given JaObject using the axodraw.sty package.

Specified by:

latexCommand in class JaObject

Parameters:

scale - A scale factor to translate Java coordinates to LaTeX coordinates.

canvasDim - The current dimension of the canvas.

Returns:

The corresponding axodraw LaTeX command.

editPanel

public abstract boolean editPanel()

Brings up the edit panel that allows to change the parameters of this object.

Specified by:

editPanel in class JaObject

Returns:

True if the editing actually changed the object, false if the object has not been changed.