Michael Bayne
b6f5317ad2
git-svn-id: svn+ssh://src.earth.threerings.net/nenya/trunk@158 ed5b42cb-e716-0410-a449-f6a68f950b19
78 lines
2.2 KiB
Java
78 lines
2.2 KiB
Java
//
|
|
// $Id$
|
|
//
|
|
// Nenya library - tools for developing networked games
|
|
// Copyright (C) 2002-2007 Three Rings Design, Inc., All Rights Reserved
|
|
// http://www.threerings.net/code/nenya/
|
|
//
|
|
// This library is free software; you can redistribute it and/or modify it
|
|
// under the terms of the GNU Lesser General Public License as published
|
|
// by the Free Software Foundation; either version 2.1 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// This library 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
|
|
// Lesser General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU Lesser General Public
|
|
// License along with this library; if not, write to the Free Software
|
|
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
|
|
|
package com.threerings.media.util;
|
|
|
|
import java.awt.Rectangle;
|
|
|
|
import com.threerings.util.DirectionCodes;
|
|
|
|
/**
|
|
* Used in conjunction with a {@link Path}.
|
|
*/
|
|
public interface Pathable
|
|
{
|
|
/**
|
|
* Returns the pathable's current x coordinate.
|
|
*/
|
|
public int getX ();
|
|
|
|
/**
|
|
* Returns the pathable's current y coordinate.
|
|
*/
|
|
public int getY ();
|
|
|
|
/**
|
|
* Returns the rectangle that bounds the pathable.
|
|
*/
|
|
public Rectangle getBounds ();
|
|
|
|
/**
|
|
* Updates the pathable's current coordinates.
|
|
*/
|
|
public void setLocation (int x, int y);
|
|
|
|
/**
|
|
* Will be called by a path when it moves the pathable in the
|
|
* specified direction. Pathables that wish to face in the direction
|
|
* they are moving can take advantage of this callback.
|
|
*
|
|
* @see DirectionCodes
|
|
*/
|
|
public void setOrientation (int orient);
|
|
|
|
/**
|
|
* Should return the orientation of the pathable, or {@link
|
|
* DirectionCodes#NONE} if the pathable does not support orientation.
|
|
*/
|
|
public int getOrientation ();
|
|
|
|
/**
|
|
* Called by a path when this pathable is made to start along a path.
|
|
*/
|
|
public void pathBeginning ();
|
|
|
|
/**
|
|
* Called by a path when this pathable finishes moving along its path.
|
|
*/
|
|
public void pathCompleted (long timestamp);
|
|
}
|