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.processor.connectedcomponent.render;
031
032import org.openimaj.image.Image;
033import org.openimaj.image.pixel.ConnectedComponent;
034
035/**
036 *      Renders the bounding box into the image.
037 * 
038 *  @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
039 *      
040 *  @param <T> The type of image into which to draw 
041 */
042public class BoundingBoxRenderer<T> extends AbstractRenderer<T> 
043{
044        protected boolean fill;
045        
046        /**
047         *      Default constructor that takes the image to draw into and the colour
048         *      in which to draw the bounding box.
049         * 
050         *  @param image The image into which to draw
051         *  @param colour The colour in which to draw the box.
052         *  @param fill Fill the box. 
053         */
054        public BoundingBoxRenderer(Image<T,?> image, T colour, boolean fill) {
055                super(image, colour);
056                this.fill = fill;
057        }
058        
059        /**
060         *      Constructor that creates an image to draw into and takes the colour
061         *      in which to draw the bounding box.
062         * @param width The width of the image to create
063         * @param height The height of the image to create
064         * @param colour The colour in which to draw the box.
065         * @param fill Fill the box.
066         */
067        public BoundingBoxRenderer(int width, int height, T colour, boolean fill) {
068                super(width, height, colour);
069                this.fill = fill;
070        }
071        
072        /**
073         *  {@inheritDoc}
074         *  @see org.openimaj.image.processor.connectedcomponent.ConnectedComponentProcessor#process(org.openimaj.image.pixel.ConnectedComponent)
075         */
076        @Override
077        public void process(ConnectedComponent cc) {
078                if (fill)
079                        image.drawShapeFilled(cc.calculateRegularBoundingBox(), colour);
080                else
081                        image.drawShape(cc.calculateRegularBoundingBox(), colour);              
082        }
083}