pyfeyn is hosted by Hepforge, IPPP Durham

Package pyfeyn :: Module lines :: Class Vector
[hide private]
[frames] | no frames]

Class Vector




A line with a sinoid deformation

Instance Methods [hide private]
  __init__(self, point1, point2, amplitude=0.25, frequency=1.0)
  invert(self)
Reflect the decoration in the line itself.
  getFrequency(self)
Get the rate of occurance of the oscillation.
  setFrequency(self, freq)
Set the rate of occurance of the oscillation.
  getAmplitude(self)
Get the size of the oscillation.
  setAmplitude(self, amplitude)
Set the size of the oscillation.
  setExtraHalfCycles(self, extras)
Add some extra half cycles to the oscillation on top of those determined from the frequency.
  getDeformedPath(self)
Get the path with the decorative deformation.
  draw(self, canvas)
Draw the line on the supplied canvas.

Inherited from DecoratedLine: getNumHalfCycles

Inherited from Line: addArrow, addLabel, addParallelArrow, addStyle, addStyles, arcThru, bend, fracpoint, getPath, getStyles, getVisiblePath, removeArrows, removeLabels, set3D, setArrows, setStyles, straighten

Inherited from utils.Visible: __cmp__, getDepth, isVisible, setDepth


Method Details [hide private]

__init__(self, point1, point2, amplitude=0.25, frequency=1.0)
(Constructor)

 
None
Overrides: Line.__init__

invert(self)

 
Reflect the decoration in the line itself.
Overrides: DecoratedLine.invert

getFrequency(self)

 
Get the rate of occurance of the oscillation.

setFrequency(self, freq)

 
Set the rate of occurance of the oscillation.

getAmplitude(self)

 
Get the size of the oscillation.

setAmplitude(self, amplitude)

 
Set the size of the oscillation.

setExtraHalfCycles(self, extras)

 
Add some extra half cycles to the oscillation on top of those determined from the frequency.

getDeformedPath(self)

 
Get the path with the decorative deformation.
Overrides: DecoratedLine.getDeformedPath

draw(self, canvas)

 
Draw the line on the supplied canvas.
Overrides: Line.draw