1 /*

     2  * Copyright (c) 2007, Oracle and/or its affiliates. All rights reserved.

     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

     4  *

     5  * This code is free software; you can redistribute it and/or modify it

     6  * under the terms of the GNU General Public License version 2 only, as

     7  * published by the Free Software Foundation.  Oracle designates this

     8  * particular file as subject to the "Classpath" exception as provided

     9  * by Oracle in the LICENSE file that accompanied this code.

    10  *

    11  * This code is distributed in the hope that it will be useful, but WITHOUT

    12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

    13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

    14  * version 2 for more details (a copy is included in the LICENSE file that

    15  * accompanied this code).

    16  *

    17  * You should have received a copy of the GNU General Public License version

    18  * 2 along with this work; if not, write to the Free Software Foundation,

    19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

    20  *

    21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

    22  * or visit www.oracle.com if you need additional information or have any

    23  * questions.

    24  */

    25 

    26 package sun.java2d.pisces;

    27 

    28 /**

    29  * The <code>LineSink</code> interface accepts a series of line

    30  * drawing commands: <code>moveTo</code>, <code>lineTo</code>,

    31  * <code>close</code> (equivalent to a <code>lineTo</code> command

    32  * with an argument equal to the argument of the last

    33  * <code>moveTo</code> command), and <code>end</code>.

    34  *

    35  * <p> A <code>Flattener</code> may be used to connect a general path

    36  * source to a <code>LineSink</code>.

    37  *

    38  * <p> The <code>Renderer</code> class implements the

    39  * <code>LineSink</code> interface.

    40  *

    41  */

    42 public interface LineSink {

    43 

    44     /**

    45      * Moves the current drawing position to the point <code>(x0,

    46      * y0)</code>.

    47      *

    48      * @param x0 the X coordinate

    49      * @param y0 the Y coordinate

    50      */

    51     public void moveTo(float x0, float y0);

    52 

    53     /**

    54      * Provides a hint that the current segment should be joined to

    55      * the following segment using an explicit miter or round join if

    56      * required.

    57      *

    58      * <p> An application-generated path will generally have no need

    59      * to contain calls to this method; they are typically introduced

    60      * by a <code>Flattener</code> to mark segment divisions that

    61      * appear in its input, and consumed by a <code>Stroker</code>

    62      * that is responsible for emitting the miter or round join

    63      * segments.

    64      *

    65      * <p> Other <code>LineSink</code> classes should simply pass this

    66      * hint to their output sink as needed.

    67      */

    68     public void lineJoin();

    69 

    70     /**

    71      * Draws a line from the current drawing position to the point

    72      * <code>(x1, y1)</code> and sets the current drawing position to

    73      * <code>(x1, y1)</code>.

    74      *

    75      * @param x1 the X coordinate

    76      * @param y1 the Y coordinate

    77      */

    78     public void lineTo(float x1, float y1);

    79 

    80     /**

    81      * Closes the current path by drawing a line from the current

    82      * drawing position to the point specified by the moset recent

    83      * <code>moveTo</code> command.

    84      */

    85     public void close();

    86 

    87     /**

    88      * Ends the current path.  It may be necessary to end a path in

    89      * order to allow end caps to be drawn.

    90      */

    91     public void end();

    92 

    93 }