jcckit.graphic.Polygon Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of plantuml-gplv2 Show documentation
PlantUML is a component that allows to quickly write diagrams from text.
There is a newer version: 1.2024.8
// THIS FILE HAS BEEN GENERATED BY A PREPROCESSOR.
/* +=======================================================================
 * |
 * |      PlantUML : a free UML diagram generator
 * |
 * +=======================================================================
 *
 * (C) Copyright 2009-2024, Arnaud Roques
 *
 * Project Info:  https://plantuml.com
 *
 * If you like this project or if you find it useful, you can support us at:
 *
 * https://plantuml.com/patreon (only 1$ per month!)
 * https://plantuml.com/liberapay (only 1€ per month!)
 * https://plantuml.com/paypal
 *
 *
 * PlantUML is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License V2.
 *
 * THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC
 * LICENSE ("AGREEMENT"). [GNU General Public License V2]
 *
 * ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES
 * RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
 *
 * You may obtain a copy of the License at
 *
 * https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * PlantUML can occasionally display sponsored or advertising messages. Those
 * messages are usually generated on welcome or error images and never on
 * functional diagrams.
 * See https://plantuml.com/professional if you want to remove them
 *
 * Images (whatever their format : PNG, SVG, EPS...) generated by running PlantUML
 * are owned by the author of their corresponding sources code (that is, their
 * textual description in PlantUML language). Those images are not covered by
 * this GPL v2 license.
 *
 * The generated images can then be used without any reference to the GPL v2 license.
 * It is not even necessary to stipulate that they have been generated with PlantUML,
 * although this will be appreciated by the PlantUML team.
 *
 * There is an exception : if the textual description in PlantUML language is also covered
 * by any license, then the generated images are logically covered
 * by the very same license.
 *
 * This is the IGY distribution (Install GraphViz by Yourself).
 * You have to install GraphViz and to setup the GRAPHVIZ_DOT environment variable
 * (see https://plantuml.com/graphviz-dot )
 *
 * Icons provided by OpenIconic :  https://useiconic.com/open
 * Archimate sprites provided by Archi :  http://www.archimatetool.com
 * Stdlib AWS provided by https://github.com/milo-minderbinder/AWS-PlantUML
 * Stdlib Icons provided https://github.com/tupadr3/plantuml-icon-font-sprites
 * ASCIIMathML (c) Peter Jipsen http://www.chapman.edu/~jipsen
 * ASCIIMathML (c) David Lippman http://www.pierce.ctc.edu/dlippman
 * CafeUndZopfli ported by Eugene Klyuchnikov https://github.com/eustas/CafeUndZopfli
 * Brotli (c) by the Brotli Authors https://github.com/google/brotli
 * Themes (c) by Brett Schwarz https://github.com/bschwarz/puml-themes
 * Twemoji (c) by Twitter at https://twemoji.twitter.com/
 *
 */
package jcckit.graphic;

import java.util.Vector;

/**
 *  A polygon or polyline.
 *
 *  @author Franz-Josef Elmer
 */
public class Polygon extends BasicGraphicalElement {
  private final Vector _points = new Vector();
  private final boolean _closed;

  /**
   * Creates an instance of the specified graphic attributes.
   * @param attributes attributes of the instance to be created
   * @param closed true if this polygon is closed.
   */
  public Polygon(GraphicAttributes attributes, boolean closed) {
    super(attributes);
    _closed = closed;
  }

  /** Returns true if this polygon is closed. */
  public boolean isClosed() {
    return _closed;
  }

  /** Returns the number points. */
  public int getNumberOfPoints() {
    return _points.size();
  }

  /** Returns the point for the specified index. */
  public GraphPoint getPoint(int index) {
    return (GraphPoint) _points.elementAt(index);
  }

  /** Adds a new point to the end of the list of points. */
  public void addPoint(GraphPoint point) {
    _points.addElement(point);
  }

  /** Removes all points. */
  public void removeAllPoints() {
    _points.removeAllElements();
  }

  /** Replaces the point at the specified index by a new one. */
  public void replacePointAt(int index, GraphPoint point) {
    _points.setElementAt(point, index);
  }

  /**
   *  Renders this line with the specified {@link Renderer}.
   *  @param renderer An instance of {@link PolygonRenderer}.
   *  @throws IllegalArgumentException if renderer is not
   *          an instance of PolygonRenderer.
   */
  public void renderWith(Renderer renderer) {
    if (renderer instanceof PolygonRenderer) {
      ((PolygonRenderer) renderer).render(this);
    } else {
      throw new IllegalArgumentException(renderer
                            + " does not implements PolygonRenderer.");
    }
  }
}