/**
 * Copyright 2014-2023 JogAmp Community. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are
 * permitted provided that the following conditions are met:
 *
 *    1. Redistributions of source code must retain the above copyright notice, this list of
 *       conditions and the following disclaimer.
 *
 *    2. 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.
 *
 * THIS SOFTWARE IS PROVIDED BY JogAmp Community ``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 JogAmp Community 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.
 *
 * The views and conclusions contained in the software and documentation are those of the
 * authors and should not be interpreted as representing official policies, either expressed
 * or implied, of JogAmp Community.
 */
package com.jogamp.graph.ui.shapes;

import com.jogamp.opengl.GL2ES2;
import com.jogamp.graph.curve.opengl.RegionRenderer;
import com.jogamp.graph.ui.GraphShape;
import com.jogamp.opengl.util.texture.ImageSequence;

/**
 * A GraphUI {@link ImageSequence} based {@link TexSeqButton} {@link GraphShape}.
 * <p>
 * GraphUI is GPU based and resolution independent.
 * </p>
 * <p>
 * This button is rendered with a round oval shape.
 * To render it rectangular, {@link #setCorner(float)} to zero.
 * </p>
 * <p>
 * Default colors (toggle-off is full color):
 * - non-toggle: 1 * color
 * - pressed: 0.9 * color
 * - toggle-off: 1.0 * color
 * - toggle-on: 0.8 * color
 * </p>
 */
public class ImageButton extends TexSeqButton {

    public ImageButton(final int renderModes, final float width,
                       final float height, final ImageSequence texSeq) {
        super(renderModes, width, height, texSeq);

        setColor(1f, 1f, 1f, 0.0f);
        setPressedColorMod(0.9f, 0.9f, 0.9f, 0.9f);
        setToggleOffColorMod(1f, 1f, 1f, 1f);
        setToggleOnColorMod(0.8f, 0.8f, 0.8f, 1f);
    }

    public ImageSequence getImageSequence() { return (ImageSequence)texSeq; }

    public final void setCurrentIdx(final int idx) {
        ((ImageSequence)texSeq).setCurrentIdx(idx);
        markStateDirty();
    }

    @Override
    public void draw(final GL2ES2 gl, final RegionRenderer renderer) {
        super.draw(gl, renderer);
        if( ((ImageSequence)texSeq).isSequenceAnimating() ) {
            markStateDirty(); // keep on going
        }
    };
}
