RaiseAtom.java

/* RaiseAtom.java
 * =========================================================================
 * This file is part of the JLaTeXMath Library - http://forge.scilab.org/jlatexmath
 *
 * Copyright (C) 2011 DENIZET Calixte
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or (at
 * your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * A copy of the GNU General Public License can be found in the file
 * LICENSE.txt provided with the source distribution of this program (see
 * the META-INF directory in the source jar). This license can also be
 * found on the GNU website at http://www.gnu.org/licenses/gpl.html.
 *
 * If you did not receive a copy of the GNU General Public License along
 * with this program, contact the lead developer, or write to the Free
 * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301, USA.
 *
 * Linking this library statically or dynamically with other modules
 * is making a combined work based on this library. Thus, the terms
 * and conditions of the GNU General Public License cover the whole
 * combination.
 *
 * As a special exception, the copyright holders of this library give you
 * permission to link this library with independent modules to produce
 * an executable, regardless of the license terms of these independent
 * modules, and to copy and distribute the resulting executable under terms
 * of your choice, provided that you also meet, for each linked independent
 * module, the terms and conditions of the license of that module.
 * An independent module is a module which is not derived from or based
 * on this library. If you modify this library, you may extend this exception
 * to your version of the library, but you are not obliged to do so.
 * If you do not wish to do so, delete this exception statement from your
 * version.
 *
 */

package org.scilab.forge.jlatexmath;

/**
 * An atom representing a scaled Atom.
 */
public class RaiseAtom extends Atom {

    private Atom base;
    private int runit, hunit, dunit;
    private float r, h, d;

    public RaiseAtom(Atom base, int runit, float r, int hunit, float h, int dunit, float d) {
        this.base = base;
        this.runit = runit;
        this.r = r;
        this.hunit = hunit;
        this.h = h;
        this.dunit = dunit;
        this.d = d;
    }

    public int getLeftType() {
        return base.getLeftType();
    }

    public int getRightType() {
        return base.getRightType();
    }

    public Box createBox(TeXEnvironment env) {
        Box bbox = base.createBox(env);
        if (runit == -1) {
            bbox.setShift(0);
        } else {
            bbox.setShift(-r * SpaceAtom.getFactor(runit, env));
        }

        if (hunit == -1) {
            return bbox;
        }

        HorizontalBox hbox = new HorizontalBox(bbox);
        hbox.setHeight(h * SpaceAtom.getFactor(hunit, env));
        if (dunit == -1) {
            hbox.setDepth(0);
        } else {
            hbox.setDepth(d * SpaceAtom.getFactor(dunit, env));
        }

        return hbox;
    }
}