PenEvent.java

package edu.stanford.hci.r3.events;

import edu.stanford.hci.r3.pen.PenSample;
import edu.stanford.hci.r3.units.coordinates.PercentageCoordinates;
import edu.stanford.hci.r3.units.coordinates.StreamedPatternCoordinates;

public class PenEvent {

        public enum PenEventModifier {
                // a pen down event
                DOWN,

                // a regular sample event
                SAMPLE,

                // a pen up event
                UP
        }

        private transient boolean consumed = false;

        private PenEventModifier eventModifier = PenEventModifier.SAMPLE;

        private PercentageCoordinates locationOnRegion;

        private int penID;

        private String penName = "Digital Pen";

        private PenSample penSample;

        private long timestamp;

        public PenEvent(int thePenID, String thePenName, long time, PenSample sample) {
                penID = thePenID;
                timestamp = time;
                penSample = sample;
                penName = thePenName;
        }

        public void consume() {
                consumed = true;
        }

        public PenSample getOriginalSample() {
                return penSample;
        }

        public int getPenID() {
                return penID;
        }

        public String getPenName() {
                return penName;
        }

        public PercentageCoordinates getPercentageLocation() {
                return locationOnRegion;
        }

        public StreamedPatternCoordinates getStreamedPatternCoordinate() {
                return new StreamedPatternCoordinates(penSample);
        }

        public long getTimestamp() {
                return timestamp;
        }

        public PenEventModifier getType() {
                return eventModifier;
        }

        public boolean isConsumed() {
                return consumed;
        }

        public boolean isTypePenDown() {
                return eventModifier.equals(PenEventModifier.DOWN);
        }

        public boolean isTypePenUp() {
                return eventModifier.equals(PenEventModifier.UP);
        }

        public void setModifier(PenEventModifier modifier) {
                eventModifier = modifier;
        }

        public void setOriginalSample(PenSample sample) {
                penSample = sample;
        }

        public void setPenName(String name) {
                penName = name;
        }

        public void setPercentageLocation(PercentageCoordinates location) {
                locationOnRegion = location;
        }

        /*
         * (non-Javadoc)
         * 
         * @see java.lang.Object#toString()
         */
        public String toString() {
                return "PenEvent {Pen " + penID + " (" + penName + ") " + penSample + "}";
        }
}

---