001/**
002 * Copyright (c) 2011, The University of Southampton and the individual contributors.
003 * All rights reserved.
004 *
005 * Redistribution and use in source and binary forms, with or without modification,
006 * are permitted provided that the following conditions are met:
007 *
008 *   *  Redistributions of source code must retain the above copyright notice,
009 *      this list of conditions and the following disclaimer.
010 *
011 *   *  Redistributions in binary form must reproduce the above copyright notice,
012 *      this list of conditions and the following disclaimer in the documentation
013 *      and/or other materials provided with the distribution.
014 *
015 *   *  Neither the name of the University of Southampton nor the names of its
016 *      contributors may be used to endorse or promote products derived from this
017 *      software without specific prior written permission.
018 *
019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
020 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
021 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
022 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
023 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
026 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
028 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 */
030package org.openimaj.image.typography;
031
032import org.openimaj.image.renderer.ImageRenderer;
033
034/**
035 * Class representing a Font that can be rendered with
036 * a {@link FontRenderer} with an associated {@link FontStyle}.
037 * 
038 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
039 *
040 * @param <F> the actual type of implementing class
041 */
042public interface Font<F extends Font<F>> {
043        /**
044         * Get a font renderer suitable for rendering this font to the given image renderer.  
045         * @param <T> type of pixel.
046         * @param <Q> type of {@link FontStyle}.
047         * @param renderer the target image renderer.
048         * @return the FontRenderer
049         */
050        public <T, Q extends FontStyle<T>> FontRenderer<T, Q> getRenderer(ImageRenderer<T,?> renderer);
051        
052        /**
053         * Create an instance of a FontStyle with the default parameters for the given
054         * image.
055         * @param <T> type of pixel.
056         * @param renderer the image renderer
057         * @return the FontStyle
058         */
059        public <T> FontStyle<T> createStyle(ImageRenderer<T, ?> renderer);
060        
061        /**
062         * Get the name of this font
063         * @return the name of the font
064         */
065        public String getName();
066}