org.opensourcephysics.cabrillo.tracker
Interface Footprint

All Known Implementing Classes:
ArrowFootprint, CircleFootprint, DoubleArrowFootprint, DoubleCrosshairFootprint, LineFootprint, OutlineFootprint, PointShapeFootprint, PositionVectorFootprint, ProtractorFootprint

public interface Footprint

A Footprint creates a mark for a track step.

Author:
Douglas Brown

Method Summary
 java.awt.Color getColor()
          Gets the color.
 java.lang.String getDisplayName()
          Gets the display name of the footprint.
 java.awt.Shape[] getHitShapes()
          Gets the hit shapes associated with the footprint.
 javax.swing.Icon getIcon(int w, int h)
          Gets an icon representing the footprint.
 int getLength()
          Gets the point array length required by this footprint.
 Mark getMark(java.awt.Point[] points)
          Gets the footprint mark.
 java.lang.String getName()
          Gets the name of the footprint.
 java.awt.Shape getShape(java.awt.Point[] points)
          Gets the footprint shape.
 java.awt.BasicStroke getStroke()
          Gets the stroke.
 void setColor(java.awt.Color color)
          Sets the color.
 void setStroke(java.awt.BasicStroke stroke)
          Sets the stroke.
 

Method Detail

getName

java.lang.String getName()
Gets the name of the footprint.

Returns:
the name

getDisplayName

java.lang.String getDisplayName()
Gets the display name of the footprint.

Returns:
the name

getLength

int getLength()
Gets the point array length required by this footprint.

Returns:
the length

getIcon

javax.swing.Icon getIcon(int w,
                         int h)
Gets an icon representing the footprint.

Parameters:
w - width of the icon
h - height of the icon
Returns:
the icon

getHitShapes

java.awt.Shape[] getHitShapes()
Gets the hit shapes associated with the footprint.

Returns:
an array of hit shapes

getMark

Mark getMark(java.awt.Point[] points)
Gets the footprint mark.

Parameters:
points - a Point array
Returns:
the mark

getShape

java.awt.Shape getShape(java.awt.Point[] points)
Gets the footprint shape.

Parameters:
points - a Point array
Returns:
the shape

setStroke

void setStroke(java.awt.BasicStroke stroke)
Sets the stroke. Accepts only basic strokes.

Parameters:
stroke - the desired stroke

getStroke

java.awt.BasicStroke getStroke()
Gets the stroke.

Returns:
the basic stroke

setColor

void setColor(java.awt.Color color)
Sets the color.

Parameters:
color - the desired color

getColor

java.awt.Color getColor()
Gets the color.

Returns:
the color