View Javadoc

1   /**
2    * Copyright (c) 2011, The University of Southampton and the individual contributors.
3    * All rights reserved.
4    *
5    * Redistribution and use in source and binary forms, with or without modification,
6    * are permitted provided that the following conditions are met:
7    *
8    *   * 	Redistributions of source code must retain the above copyright notice,
9    * 	this list of conditions and the following disclaimer.
10   *
11   *   *	Redistributions in binary form must reproduce the above copyright notice,
12   * 	this list of conditions and the following disclaimer in the documentation
13   * 	and/or other materials provided with the distribution.
14   *
15   *   *	Neither the name of the University of Southampton nor the names of its
16   * 	contributors may be used to endorse or promote products derived from this
17   * 	software without specific prior written permission.
18   *
19   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
20   * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21   * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
23   * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24   * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25   * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
26   * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27   * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
28   * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29   */
30  package org.openimaj.image.renderer;
31  
32  /**
33   * Hints for {@link ImageRenderer} implementations to (optionally) 
34   * use when drawing.
35   * 
36   * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
37   *
38   */
39  public class RenderHints {
40  	/**
41  	 * Different approaches to drawing
42  	 */
43  	public static enum DrawingAlgorithm {
44  		/**
45  		 * Fast drawing, no anti-aliasing
46  		 */
47  		FAST,
48  		/**
49  		 * Anti-aliased drawing 
50  		 */
51  		ANTI_ALIASED
52  	}
53  	
54  	/**
55  	 * Fast drawing 
56  	 */
57  	public static final RenderHints FAST = new RenderHints(DrawingAlgorithm.FAST);
58  
59  	/**
60  	 * Anti-aliased drawing
61  	 */
62  	public static final RenderHints ANTI_ALIASED = new RenderHints(DrawingAlgorithm.ANTI_ALIASED);
63  	
64  	protected DrawingAlgorithm drawingAlgorithm = DrawingAlgorithm.FAST;
65  	
66  	/**
67  	 * Default constructor. Uses fastest drawing algorithm.
68  	 */
69  	public RenderHints() {
70  		
71  	}
72  	
73  	/**
74  	 * Construct with the given drawing algorithm
75  	 * @param drawingAlgorithm the drawing algorithm 
76  	 */
77  	public RenderHints(DrawingAlgorithm drawingAlgorithm) {
78  		this.drawingAlgorithm = drawingAlgorithm;
79  	}
80  }