pedviz.view
Class Symbol

java.lang.Object
  extended by pedviz.view.Symbol
All Implemented Interfaces:
java.lang.Comparable
Direct Known Subclasses:
Symbol2D, Symbol3D

public abstract class Symbol
extends java.lang.Object
implements java.lang.Comparable

This class is the super class for symbols. If you write your own symbols, don't extend this class. Use Symbol2D and Symbol3D as super classes.

Author:
lukas forer

Constructor Summary
Symbol()
           
 
Method Summary
 int compareTo(java.lang.Object o)
          Compares two symbols.
 java.lang.Float getHeight()
           
abstract  int getPriority()
          Returns the priority of the symbol.
 void setColors(java.awt.Color[] colors)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Symbol

public Symbol()
Method Detail

getPriority

public abstract int getPriority()
Returns the priority of the symbol. Symbols like SymbolSexMale and SymbolSexFemale have a low priority (0) however the SymbolDeceased has a higher priority (5). The priorities define the sequence for drawing the symbols.

Returns:
priority of the symbol

setColors

public void setColors(java.awt.Color[] colors)
Parameters:
colors -

compareTo

public int compareTo(java.lang.Object o)
Compares two symbols.

Specified by:
compareTo in interface java.lang.Comparable

getHeight

public java.lang.Float getHeight()