com.twelvemonkeys.image.AbstractImageSource Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of twelvemonkeys-core
The TwelveMonkeys Core library. Contains common utility classes.
There is a newer version: 2.3
/*
 * Copyright (c) 2008, Harald Kuhr
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name "TwelveMonkeys" nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package com.twelvemonkeys.image;

import java.awt.image.ImageProducer;
import java.awt.image.ImageConsumer;
import java.util.List;
import java.util.ArrayList;

/**
 * AbstractImageSource
 * 
 *
 * @author Harald Kuhr
 * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/image/AbstractImageSource.java#1 $
 */
public abstract class AbstractImageSource implements ImageProducer {
    private List mConsumers = new ArrayList();
    protected int mWidth;
    protected int mHeight;
    protected int mXOff;
    protected int mYOff;

    // ImageProducer interface
    public void addConsumer(ImageConsumer pConsumer) {
        if (mConsumers.contains(pConsumer)) {
            return;
        }
        mConsumers.add(pConsumer);
        try {
            initConsumer(pConsumer);
            sendPixels(pConsumer);
            if (isConsumer(pConsumer)) {
                pConsumer.imageComplete(ImageConsumer.STATICIMAGEDONE);

                // Get rid of "sticky" consumers...
                if (isConsumer(pConsumer)) {
                    pConsumer.imageComplete(ImageConsumer.IMAGEERROR);
                    removeConsumer(pConsumer);
                }
            }
        }
        catch (Exception e) {
            e.printStackTrace();
            if (isConsumer(pConsumer)) {
                pConsumer.imageComplete(ImageConsumer.IMAGEERROR);
            }
        }
    }

    public void removeConsumer(ImageConsumer pConsumer) {
        mConsumers.remove(pConsumer);
    }

    /**
     * This implementation silently ignores this instruction. If pixeldata is
     * not in TDLR order by default, subclasses must override this method.
     *
     * @param pConsumer the consumer that requested the resend
     *
     * @see ImageProducer#requestTopDownLeftRightResend(java.awt.image.ImageConsumer)
     */
    public void requestTopDownLeftRightResend(ImageConsumer pConsumer) {
        // ignore
    }

    public void startProduction(ImageConsumer pConsumer) {
        addConsumer(pConsumer);
    }

    public boolean isConsumer(ImageConsumer pConsumer) {
        return mConsumers.contains(pConsumer);
    }

    protected abstract void initConsumer(ImageConsumer pConsumer);

    protected abstract void sendPixels(ImageConsumer pConsumer);
}