//
// $Id: CharacterComponent.java,v 1.9 2004/02/25 14:39:34 mdb Exp $

package com.threerings.cast;

import java.io.Serializable;

import com.samskivert.util.StringUtil;

/**
 * The character component represents a single component that can be
 * composited with other character components to generate an image
 * representing a complete character displayable in any of the eight
 * compass directions as detailed in the {@link Sprite} class direction
 * constants.
 */
public class CharacterComponent implements Serializable
{
    /** The unique component identifier. */
    public int componentId;

    /** The component's name. */
    public String name;

    /** The class of components to which this one belongs. */
    public ComponentClass componentClass;

    /**
     * Constructs a character component with the specified id of the
     * specified class.
     */
    public CharacterComponent (int componentId, String name,
                               ComponentClass compClass, FrameProvider fprov)
    {
        this.componentId = componentId;
        this.name = name;
        this.componentClass = compClass;
        _frameProvider = fprov;
    }

    /**
     * Returns the image frames for the specified action animation or null
     * if no animation for the specified action is available for this
     * component.
     */
    public ActionFrames getFrames (String action)
    {
        return _frameProvider.getFrames(this, action);
    }

    /**
     * Returns true if this component is equal to the other component. The
     * comparison is made on <code>componentId</code>.
     */
    public boolean equals (Object other)
    {
        if (other instanceof CharacterComponent) {
            return componentId == ((CharacterComponent)other).componentId;
        } else {
            return false;
        }
    }

    /**
     * Returns a string representation of this character component.
     */
    public String toString ()
    {
        return StringUtil.fieldsToString(this);
    }

    /** The entity from which we obtain our animation frames. */
    protected FrameProvider _frameProvider;

    /** Increase this value when object's serialized state is impacted by
     * a class change (modification of fields, inheritance). */
    private static final long serialVersionUID = 1;
}