Insets.java

/**
 * Copyright 2011 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.nativewindow.util;

/**
 * Mutable insets representing rectangular window decoration insets on all four edges
 * in window units.
 */
public class Insets implements Cloneable, InsetsImmutable {
    static final InsetsImmutable zeroInsets = new Insets();
    public static final InsetsImmutable getZero() { return zeroInsets; }

    private int l, r, t, b;

    public Insets() {
        this(0, 0, 0, 0);
    }

    public Insets(final int left, final int right, final int top, final int bottom) {
        this.l=left;
        this.r=right;
        this.t=top;
        this.b=bottom;
    }

    @Override
    public Object cloneMutable() {
      return clone();
    }

    @Override
    protected Object clone() {
        try {
            return super.clone();
        } catch (final CloneNotSupportedException ex) {
            throw new InternalError();
        }
    }

    @Override
    public final int getLeftWidth() { return l; }
    @Override
    public final int getRightWidth() { return r; }
    @Override
    public final int getTotalWidth() { return l + r; }
    @Override
    public final int getTopHeight() { return t; }
    @Override
    public final int getBottomHeight() { return b; }
    @Override
    public final int getTotalHeight() { return t + b; }

    /**
     * Set the inset values of this instance in window units.
     * @param left left inset width in window units.
     * @param right right inset width in window units.
     * @param top top inset width in window units.
     * @param bottom bottom inset width in window units.
     */
    public final void set(final int left, final int right, final int top, final int bottom) {
        l = left; r = right; t = top; b = bottom;
    }
    /**
     * Set the left inset value of this instance in window units.
     * @param left left inset width in window units.
     */
    public final void setLeftWidth(final int left) { l = left; }
    /**
     * Set the right inset value of this instance in window units.
     * @param right right inset width in window units.
     */
    public final void setRightWidth(final int right) { r = right; }
    /**
     * Set the top inset value of this instance in window units.
     * @param top top inset width in window units.
     */
    public final void setTopHeight(final int top) { t = top; }
    /**
     * Set the bottom inset value of this instance in window units.
     * @param bottom bottom inset width in window units.
     */
    public final void setBottomHeight(final int bottom) { b = bottom; }

    @Override
    public boolean equals(final Object obj) {
        if(this == obj)  { return true; }
        if (obj instanceof Insets) {
            final Insets insets = (Insets)obj;
            return (r == insets.r) && (l == insets.l) &&
                   (b == insets.b) && (t == insets.t);
        }
        return false;
    }

    @Override
    public int hashCode() {
        final int sum1 = l + b;
        final int sum2 = t + r;
        final int val1 = sum1 * (sum1 + 1)/2 + l;
        final int val2 = sum2 * (sum2 + 1)/2 + r;
        final int sum3 = val1 + val2;
        return sum3 * (sum3 + 1)/2 + val2;
    }

    @Override
    public String toString() {
        return "[ l "+l+", r "+r+" - t "+t+", b "+b+" - "+getTotalWidth()+"x"+getTotalHeight()+"]";
    }
}