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.renderer;
031
032/**
033 * Hints for {@link ImageRenderer} implementations to (optionally) 
034 * use when drawing.
035 * 
036 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
037 *
038 */
039public class RenderHints {
040        /**
041         * Different approaches to drawing
042         */
043        public static enum DrawingAlgorithm {
044                /**
045                 * Fast drawing, no anti-aliasing
046                 */
047                FAST,
048                /**
049                 * Anti-aliased drawing 
050                 */
051                ANTI_ALIASED
052        }
053        
054        /**
055         * Fast drawing 
056         */
057        public static final RenderHints FAST = new RenderHints(DrawingAlgorithm.FAST);
058
059        /**
060         * Anti-aliased drawing
061         */
062        public static final RenderHints ANTI_ALIASED = new RenderHints(DrawingAlgorithm.ANTI_ALIASED);
063        
064        protected DrawingAlgorithm drawingAlgorithm = DrawingAlgorithm.FAST;
065        
066        /**
067         * Default constructor. Uses fastest drawing algorithm.
068         */
069        public RenderHints() {
070                
071        }
072        
073        /**
074         * Construct with the given drawing algorithm
075         * @param drawingAlgorithm the drawing algorithm 
076         */
077        public RenderHints(DrawingAlgorithm drawingAlgorithm) {
078                this.drawingAlgorithm = drawingAlgorithm;
079        }
080}