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

Go to download
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 java.awt.geom.Path2D;
import java.awt.geom.Point2D;
import java.util.List;
                        
//------------------------------------------------------------------------------
/**
 * Object representation of an SVG (Scalable Vector Graphics) path quadratic curveTo ('Q' or 'q') 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 SvgPathQuadCurveToCmd extends SvgPathCmd
{
   private Point2D.Float mControlPoint;

   //---------------------------------------------------------------------------
   public SvgPathQuadCurveToCmd()
   {
      super('Q');
   }

   //---------------------------------------------------------------------------
   protected SvgPathQuadCurveToCmd(char inCmdChar)
   {
      super(inCmdChar);
   }


   //---------------------------------------------------------------------------
   @Override
   public SvgPathQuadCurveToCmd setRawNumbers(List inValue)
   {
      if (inValue.size()%getExpectedNumPoints() != 0)
      {
         throw new SvgPathDataException(getExpectedNumPoints() + " value" + (getExpectedNumPoints() != 1 ? "s" : "") + " must be given to a quadratic path " + getCmdChar() + " command!");
      }

      setNumSteps(inValue.size() /getExpectedNumPoints());

      super.setRawNumbers(inValue);
      return this;
   }

   //---------------------------------------------------------------------------
   protected int getExpectedNumPoints()
   {
      return 4;
   }


   //--------------------------------------------------------------------------
   public Point2D.Float getControlPoint()
   {
      return mControlPoint;
   }

   //--------------------------------------------------------------------------
   protected void setControlPoint(Point2D.Float inValue)
   {
      mControlPoint = inValue;
   }

   //--------------------------------------------------------------------------
   // From http://www.w3.org/TR/SVG/paths.html
   //
   // Draws a quadratic Bézier curve from the current point to (x,y) using (x1,y1) as the control point.
   // Q (uppercase) indicates that absolute coordinates will follow; q (lowercase) indicates that relative coordinates
   // will follow. Multiple sets of coordinates may be specified to draw a polybézier. At the end of the command,
   // the new current point becomes the final (x,y) coordinate pair used in the polybézier.
   public Point2D.Float draw(Path2D.Float inPolyline)
   {
      List rawNumbers = getRawNumbers();
      int numIndex = 0;

      Point2D.Float currentPoint = getStartingPoint();

      while (numIndex < rawNumbers.size() - 1)
      {
         Point2D.Float point1 = new Point2D.Float(rawNumbers.get(numIndex++), rawNumbers.get(numIndex++));
         Point2D.Float point2 = new Point2D.Float(rawNumbers.get(numIndex++), rawNumbers.get(numIndex++));

         if (isRelative())
         {
            point1.setLocation(point1.getX() + currentPoint.getX(), point1.getY() + currentPoint.getY());
            point2.setLocation(point2.getX() + currentPoint.getX(), point2.getY() + currentPoint.getY());
         }

         inPolyline.quadTo(point1.getX(), point1.getY(), point2.getX(), point2.getY());

         setControlPoint(point1);

         currentPoint = point2;
      }

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