com.hfg.svg.path.SvgPathClosePathCmd Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of com_hfg Show documentation

com.hfg xml, html, svg, and bioinformatics utility library

There is a newer version: 20240423

package com.hfg.svg.path;

import com.hfg.util.collection.CollectionUtil;

import java.awt.geom.Path2D;
import java.awt.geom.Point2D;
import java.util.List;

//------------------------------------------------------------------------------
/**
 * Object representation of an SVG (Scalable Vector Graphics) path closePath ('z') command.
 *
 * @author J. Alex Taylor, hairyfatguy.com
 */
//------------------------------------------------------------------------------
// com.hfg XML/HTML Coding Library
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
// J. Alex Taylor, President, Founder, CEO, COO, CFO, OOPS hairyfatguy.com
// [email protected]
//------------------------------------------------------------------------------

public class SvgPathClosePathCmd extends SvgPathCmd
{

   //---------------------------------------------------------------------------
   public SvgPathClosePathCmd()
   {
      super('Z');
      setNumSteps(0);
   }


   //---------------------------------------------------------------------------
   @Override
   public SvgPathClosePathCmd setRawNumbers(List inValue)
   {
      if (CollectionUtil.hasValues(inValue))
      {
         throw new SvgPathDataException("No numbers should be specified for a closePath command!");
      }

      super.setRawNumbers(inValue);
      return this;
   }


   //--------------------------------------------------------------------------
   // From http://www.w3.org/TR/SVG/paths.html
   //
   // Close the current subpath by drawing a straight line from the current point to current subpath's initial point.
   // Since the Z and z commands take no parameters, they have an identical effect.
   public Point2D.Float draw(Path2D.Float inPolyline)
   {
      inPolyline.closePath();

      // Return the last point.
      return null;
   }
}