/*

   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
   this work for additional information regarding copyright ownership.
   The ASF licenses this file to You under the Apache License, Version 2.0
   (the "License"); you may not use this file except in compliance with
   the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   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.

 */
package org.apache.batik.svggen;

import java.awt.Rectangle;
import java.awt.image.BufferedImageOp;
import java.util.List;

Defines the interface for classes that are able to convert
a BufferedImageOp filter.
Author:
Vincent Hardy
See Also:
SVGFilterDescriptor
Version:
$Id: SVGFilterConverter.java 1733416 2016-03-03 07:07:13Z gadams $/**
 * Defines the interface for classes that are able to convert
 * a BufferedImageOp filter.
 *
 * @author <a href="mailto:vincent.hardy@eng.sun.com">Vincent Hardy</a>
 * @version $Id: SVGFilterConverter.java 1733416 2016-03-03 07:07:13Z gadams $
 * @see           org.apache.batik.svggen.SVGFilterDescriptor
 */
public interface SVGFilterConverter extends SVGSyntax {
    
Converts a Java 2D API BufferedImageOp into
a set of attribute/value pairs and related definitions
Params:
filter – BufferedImageOp filter to be converted
filterRect – Rectangle, in device space, that defines the area
       to which filtering applies. May be null, meaning that the
       area is undefined.
See Also:
SVGFilterDescriptor
Returns:
descriptor of the attributes required to represent
        the input filter/**
     * Converts a Java 2D API BufferedImageOp into
     * a set of attribute/value pairs and related definitions
     *
     * @param filter BufferedImageOp filter to be converted
     * @param filterRect Rectangle, in device space, that defines the area
     *        to which filtering applies. May be null, meaning that the
     *        area is undefined.
     * @return descriptor of the attributes required to represent
     *         the input filter
     * @see org.apache.batik.svggen.SVGFilterDescriptor
     */
    SVGFilterDescriptor toSVG(BufferedImageOp filter, Rectangle filterRect);

    
Returns:
set of definitions referenced by the attribute
        values created by the implementation since its
        creation. The return value should never be null.
        If no definition is needed, an empty set should be
        returned./**
     * @return set of definitions referenced by the attribute
     *         values created by the implementation since its
     *         creation. The return value should never be null.
     *         If no definition is needed, an empty set should be
     *         returned.
     */
    List getDefinitionSet();
}