GradientBevelFilter.java

/*
 * JSwiff is an open source Java API for Macromedia Flash file generation
 * and manipulation
 *
 * Copyright (C) 2004-2006 Ralf Terdic (contact@jswiff.com)
 *
 * 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.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package com.jswiff.swfrecords;

import com.jswiff.io.InputBitStream;
import com.jswiff.io.OutputBitStream;

import java.io.IOException;


/**
 * TODO: Comments
 */
public final class GradientBevelFilter extends Filter {
  private RGBA[] colors;
  private short[] ratios;
  private double x;
  private double y;
  private double angle;
  private double distance;
  private double strength;
  private boolean inner;
  private boolean knockout;
  private boolean onTop;
  private int quality;

  /**
   * Creates a new GradientBevelFilter instance.
   *
   * @param colors TODO: Comments
   * @param ratios TODO: Comments
   */
  public GradientBevelFilter(RGBA[] colors, short[] ratios) {
    setControlPoints(colors, ratios);
    initDefaults();
  }

  /**
   * Creates a new GradientBevelFilter instance.
   *
   * @param stream TODO: Comments
   *
   * @throws IOException TODO: Comments
   */
  public GradientBevelFilter(InputBitStream stream) throws IOException {
    int count = stream.readUI8();
    colors     = new RGBA[count];
    ratios     = new short[count];
    for (int i = 0; i < count; i++) {
      colors[i] = new RGBA(stream);
    }
    for (int i = 0; i < count; i++) {
      ratios[i] = stream.readUI8();
    }
    x          = stream.readFP32();
    y          = stream.readFP32();
    angle      = stream.readFP32();
    distance   = stream.readFP32();
    strength   = stream.readFP16();
    inner      = stream.readBooleanBit();
    knockout   = stream.readBooleanBit();
    stream.readBooleanBit();
    onTop     = stream.readBooleanBit();
    quality   = (int) stream.readUnsignedBits(4);
  }

  /**
   * TODO: Comments
   *
   * @param angle TODO: Comments
   */
  public void setAngle(double angle) {
    this.angle = angle;
  }

  /**
   * TODO: Comments
   *
   * @return TODO: Comments
   */
  public double getAngle() {
    return angle;
  }

  /**
   * TODO: Comments
   *
   * @param colors TODO: Comments
   * @param ratios TODO: Comments
   *
   * @throws IllegalArgumentException TODO: Comments
   */
  public void setControlPoints(RGBA[] colors, short[] ratios) {
    if (colors.length != ratios.length) {
      throw new IllegalArgumentException(
        "colors and ratios arrays must have the same length!");
    }
    this.colors   = colors;
    this.ratios   = ratios;
  }

  /**
   * TODO: Comments
   *
   * @return TODO: Comments
   */
  public RGBA[] getColors() {
    return colors;
  }

  /**
   * TODO: Comments
   *
   * @param distance TODO: Comments
   */
  public void setDistance(double distance) {
    this.distance = distance;
  }

  /**
   * TODO: Comments
   *
   * @return TODO: Comments
   */
  public double getDistance() {
    return distance;
  }

  /**
   * TODO: Comments
   *
   * @param inner TODO: Comments
   */
  public void setInner(boolean inner) {
    this.inner = inner;
  }

  /**
   * TODO: Comments
   *
   * @return TODO: Comments
   */
  public boolean isInner() {
    return inner;
  }

  /**
   * TODO: Comments
   *
   * @param knockout TODO: Comments
   */
  public void setKnockout(boolean knockout) {
    this.knockout = knockout;
  }

  /**
   * TODO: Comments
   *
   * @return TODO: Comments
   */
  public boolean isKnockout() {
    return knockout;
  }

  /**
   * TODO: Comments
   *
   * @param onTop TODO: Comments
   */
  public void setOnTop(boolean onTop) {
    this.onTop = onTop;
  }

  /**
   * TODO: Comments
   *
   * @return TODO: Comments
   */
  public boolean isOnTop() {
    return onTop;
  }

  /**
   * TODO: Comments
   *
   * @param quality TODO: Comments
   */
  public void setQuality(int quality) {
    this.quality = quality;
  }

  /**
   * TODO: Comments
   *
   * @return TODO: Comments
   */
  public int getQuality() {
    return quality;
  }

  /**
   * TODO: Comments
   *
   * @return TODO: Comments
   */
  public short[] getRatios() {
    return ratios;
  }

  /**
   * TODO: Comments
   *
   * @param strength TODO: Comments
   */
  public void setStrength(double strength) {
    this.strength = strength;
  }

  /**
   * TODO: Comments
   *
   * @return TODO: Comments
   */
  public double getStrength() {
    return strength;
  }

  /**
   * TODO: Comments
   *
   * @param x TODO: Comments
   */
  public void setX(double x) {
    this.x = x;
  }

  /**
   * TODO: Comments
   *
   * @return TODO: Comments
   */
  public double getX() {
    return x;
  }

  /**
   * TODO: Comments
   *
   * @param y TODO: Comments
   */
  public void setY(double y) {
    this.y = y;
  }

  /**
   * TODO: Comments
   *
   * @return TODO: Comments
   */
  public double getY() {
    return y;
  }

  /**
   * TODO: Comments
   *
   * @param stream TODO: Comments
   *
   * @throws IOException TODO: Comments
   */
  public void write(OutputBitStream stream) throws IOException {
    int count = colors.length;
    stream.writeUI8((short) count);
    for (int i = 0; i < count; i++) {
      colors[i].write(stream);
    }
    for (int i = 0; i < count; i++) {
      stream.writeUI8(ratios[i]);
    }
    stream.writeFP32(x);
    stream.writeFP32(y);
    stream.writeFP32(angle);
    stream.writeFP32(distance);
    stream.writeFP16(strength);
    stream.writeBooleanBit(inner);
    stream.writeBooleanBit(knockout);
    stream.writeBooleanBit(true);
    stream.writeBooleanBit(onTop);
    stream.writeUnsignedBits(quality, 4);
  }

  private void initDefaults() {
    x          = 4;
    y          = 4;
    angle      = Math.PI / 4;
    distance   = 4;
    strength   = 1;
    quality    = 1;
    inner      = true;
  }
}