net.sf.jaxodraw.object.line
Class JaxoPLine

java.lang.Object
  net.sf.jaxodraw.object.JaxoObject
      net.sf.jaxodraw.object.JaxoExtendedObject
          net.sf.jaxodraw.object.JaxoParticleObject
              net.sf.jaxodraw.object.line.JaxoLineObject
                  net.sf.jaxodraw.object.line.JaxoPLine

All Implemented Interfaces:

Shape, PropertyChangeListener, Serializable, Cloneable, EventListener, JaxoSymmetricObject, JaxoWiggleObject

public class JaxoPLine
extends JaxoLineObject
implements JaxoWiggleObject, JaxoSymmetricObject

A photon line.

Since:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class net.sf.jaxodraw.object.line.JaxoLineObject

SELECT_P0

Fields inherited from class net.sf.jaxodraw.object.JaxoParticleObject

GHOST_DASH, GLUON_FREQ, PHOTON_FREQ, SCALAR_DASH

Fields inherited from class net.sf.jaxodraw.object.JaxoExtendedObject

SELECT_DX, SELECT_DY, SELECT_P2

Fields inherited from class net.sf.jaxodraw.object.JaxoObject

D_FORMAT, GRAY_SCALE_FORMAT, SELECT_NONE, SELECT_P1

Constructor Summary

JaxoPLine()

Method Summary

void	copyFrom(JaxoPLine temp) Sets all parameters from the given object to the current one.
protected String	getAxo4JOptions(float scale) Return the option part of the LaTeX command for this line.
float	getFrequency() Gets the current frequency (number of wiggles per unit length) of this WiggleObject.
protected GeneralPath	getObjectPath() Get the GeneralPath that paints this line.
boolean	isCopy(JaxoObject comp) Determines if this JaxoObject is a copy of the specified one.
boolean	isSymmetric() Returns the symmetric property of this JaxoPLine.
String	latexCommand(float scale, Dimension canvasDim) The LaTeX command that is necessary to draw the given JaxoObject using the axodraw.sty package.
void	prepareEditPanel(JaxoObjectEditPanel editPanel) Initializes the given editPanel to edit properties of this JaxoObject.
void	setFrequencyFromWiggles(int wiggles) Sets the number of wiggles to the given value and derives the frequency from it.
void	setPreferences() Applies default values to this JaxoObject.
void	setState(JaxoObject o) Restore state to the values of 'o'.
void	setSymmetric(boolean newSymm) Sets the symmetric property of this line object.
void	setWigglesFromFrequency() Sets the number of wiggles from the current frequency.
void	setWigglesFromFrequency(float frequency) Sets the frequency to the given value and derives the number of wiggles from it.

Methods inherited from class net.sf.jaxodraw.object.line.JaxoLineObject

arrowCoordinates, canBeSelected, getBounds, getGrabbedHandle, getLatexDLOffSet, getLaTexEndPoint, getLaTexStartPoint, length, paint, paintHandles, rescaleObject, smallestDistanceTo

Methods inherited from class net.sf.jaxodraw.object.JaxoParticleObject

arrowPositionIs, copy, copyFrom, dashIs, dlSepIs, getAmp, getArrow, getArrowPosition, getDash, getDLSeparation, getWiggles, isDoubleLine, isFlip, isPaintArrow, paintArrow, setAmp, setArrow, setArrowPosition, setDash, setDLSeparation, setDoubleLine, setFlip, setPaintArrow, setWiggles

Methods inherited from class net.sf.jaxodraw.object.JaxoExtendedObject

copyFrom, getHeight, getPointCount, getRadius, getRelh, getRelSize, getRelw, getSize, getStroke, getStrokeWidth, getWidth, getX, getX2, getY, getY2, latexWidth, moveBy, resetStroke, setLocation, setRadius, setRelativeHeight, setRelativeWidth, setRelWAndH, setStroke, setStrokeWidth, setX, setX2, setY, setY2, strokeIs

Methods inherited from class net.sf.jaxodraw.object.JaxoObject

addPropertyChangeListener, contains, contains, contains, contains, copyFrom, firePropertyChange, getBounds2D, getBoundsWithHandles, getColor, getGeneralPath, getLaTexLocation, getName, getPathIterator, getPathIterator, getPoints, getX, getY, intersects, intersects, isAround, isMarked, paintVisualAid, propertyChange, removePropertyChangeListener, setAsMarked, setColor, setLocation, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setPointCount, setPoints, setTransient, setX, setXPosition, setY, setYPosition

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.jaxodraw.object.JaxoWiggleObject

getAmp, getWiggles, setAmp, setWiggles

Constructor Detail

JaxoPLine

public JaxoPLine()

Method Detail

isSymmetric

public final boolean isSymmetric()

Returns the symmetric property of this JaxoPLine. This determines whether the wiggles of this photon line start and end in the same direction.

Specified by:

isSymmetric in interface JaxoSymmetricObject

Returns:

The symmetric property of this JaxoPLine.

setSymmetric

public final void setSymmetric(boolean newSymm)

Sets the symmetric property of this line object.

Specified by:

setSymmetric in interface JaxoSymmetricObject

Parameters:

newSymm - The symmetric property of this line object.

copyFrom

public void copyFrom(JaxoPLine temp)

Sets all parameters from the given object to the current one.

Parameters:

temp - The object to copy from.

setState

public void setState(JaxoObject o)

Restore state to the values of 'o'. The object 'o' must be an object of the same "type" obtained by JaxoObject.copy().

Overrides:

setState in class JaxoLineObject

Parameters:

o - the object to copy from.

isCopy

public boolean isCopy(JaxoObject comp)

Determines if this JaxoObject is a copy of the specified one.

Overrides:

isCopy in class JaxoLineObject

Parameters:

comp - The JaxoObject to compare against.

Returns:

True if the JaxoObjects are identical.

latexCommand

public final String latexCommand(float scale,
                                 Dimension canvasDim)

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

Overrides:

latexCommand in class JaxoLineObject

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.

getFrequency

public float getFrequency()

Gets the current frequency (number of wiggles per unit length) of this WiggleObject.

Specified by:

getFrequency in interface JaxoWiggleObject

Returns:

The frequency.

setWigglesFromFrequency

public void setWigglesFromFrequency(float frequency)

Sets the frequency to the given value and derives the number of wiggles from it.

Specified by:

setWigglesFromFrequency in interface JaxoWiggleObject

Parameters:

frequency - The frequency to set.

setWigglesFromFrequency

public void setWigglesFromFrequency()

Sets the number of wiggles from the current frequency.

Specified by:

setWigglesFromFrequency in interface JaxoWiggleObject

setFrequencyFromWiggles

public void setFrequencyFromWiggles(int wiggles)

Sets the number of wiggles to the given value and derives the frequency from it.

Specified by:

setFrequencyFromWiggles in interface JaxoWiggleObject

Parameters:

wiggles - The number of wiggles to set.

setPreferences

public void setPreferences()

Applies default values to this JaxoObject. All fields except location points are initialized with values taken from the preferences.

Overrides:

setPreferences in class JaxoParticleObject

prepareEditPanel

public void prepareEditPanel(JaxoObjectEditPanel editPanel)

Initializes the given editPanel to edit properties of this JaxoObject.

Specified by:

prepareEditPanel in class JaxoObject

Parameters:

editPanel - the panel to prepare.

getObjectPath

protected GeneralPath getObjectPath()

Get the GeneralPath that paints this line.

Specified by:

getObjectPath in class JaxoLineObject

Returns:

GeneralPath.

getAxo4JOptions

protected String getAxo4JOptions(float scale)

Return the option part of the LaTeX command for this line.

Specified by:

getAxo4JOptions in class JaxoLineObject

Parameters:

scale - the axodraw4j scale factor.

Returns:

the option String.