smile.plot.swing.Point Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of smile-plot Show documentation
smile-plot
The newest version!
/*
 * Copyright (c) 2010-2021 Haifeng Li. All rights reserved.
 *
 * Smile is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Smile is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Smile.  If not, see .
 */

package smile.plot.swing;

import java.awt.Color;

/**
 * One more more points in the plot.
 *
 * @author Haifeng Li
 */
public class Point extends Shape {

    /** The marks of point. */
    public static char[] MARKS = {'.', '+', '-', '|', '*', 'x', 'o', 'O', '@', '#', 's', 'S', 'q', 'Q'};

    /**
     * The coordinate of points.
     */
    final double[][] points;
    /**
     * The mark of points.
     */
    final char mark;

    /**
     * Constructor.
     * @param points a n-by-2 or n-by-3 matrix that are the coordinates of points.
     * @param mark the mark of points.
     * 
     *  . : dot
     * 
 + : +
     * 
 - : -
     * 
 | : |
     * 
 * : star
     * 
 x : x
     * 
 o : circle
     * 
 O : large circle
     * 
 @ : solid circle
     * 
 # : large solid circle
     * 
 s : square
     * 
 S : large square
     * 
 q : solid square
     * 
 Q : large solid square
     * 
 others : dot
     * 
     * @param color the color of points.
     */
    public Point(double[][] points, char mark, Color color) {
        super(color);
        this.points = points;
        this.mark = mark;
    }

    @Override
    public void paint(Graphics g) {
        g.setColor(color);

        for (double[] point : points) {
            g.drawPoint(mark, point);
        }
    }

    /**
     * Creates a Point with circle mark and black color.
     */
    public static Point of (double[][] points) {
        return new Point(points, 'o', Color.BLACK);
    }

    /**
     * Creates a Point with circle mark.
     */
    public static Point of (double[][] points, Color color) {
        return new Point(points, 'o', color);
    }

    /**
     * Creates a Point with black color.
     */
    public static Point of (double[][] points, char mark) {
        return new Point(points, mark, Color.BLACK);
    }
}