IGameScreen.java :  » Game » Arianne-RPG-0.83 » games » stendhal » client » Java Open Source

package games.stendhal.client;

import games.stendhal.client.entity.IEntity;
import games.stendhal.client.gui.j2d.Text;
import games.stendhal.client.gui.j2d.entity.EntityView;
import games.stendhal.client.gui.wt.core.WtPanel;
import games.stendhal.client.sprite.Sprite;
import games.stendhal.common.NotificationType;

import java.awt.Graphics;
import java.awt.Point;
import java.awt.geom.Point2D;

public interface IGameScreen {

  /** The width / height of one tile. */
  int SIZE_UNIT_PIXELS = 32;

  /** Prepare screen for the next frame to be rendered and move it if needed .*/
  void nextFrame();

  /**
   * Add a legacy dialog to the screen.
   *
   * @param panel
   *            The dialog to add.
   */
  void addDialog(final WtPanel panel);

  /**
   * Add an entity.
   *
   * @param entity
   *            An entity.
   */
  void addEntity(IEntity entity);

  /**
   * Remove an entity.
   *
   * @param entity
   *            An entity.
   */
  void removeEntity(final IEntity entity);

  /**
   * Center the view.
   */
   void center();

  /**
   * Draw the screen.
   */
  void draw();

  /**
   * Sets the world size.
   *
   * @param width
   *            The world width.
   * @param height
   *            The height width.
   */
  void setMaxWorldSize(double width, double height);

  /**
   * Set the offline indication state.
   *
   * @param offline
   *            <code>true</code> if offline.
   */
  void setOffline(boolean offline);

  /**
   * Adds a text bubble at a give position of the specified type.
   * 
   * @param x The screen X coordinate.
   * @param y The screen Y coordinate.
   * @param text The textual content
   * @param type The notificationType 
   * @param isTalking Is it a talking text bubble
   * @see games.stendhal.common.NotificationType
   * 
   */
  void addText(double x, double y, String text,
      NotificationType type, boolean isTalking);

  /**
   * Removes a text bubble.
   * @param entity The text to be removed.
   */
  void removeText(Text entity);

  /**
   * Removes all objects from the screen.
   */
  void removeAll();

  /**
   * Removes all the text entities.
   */
  void clearTexts();
  
  /**
   * Get the graphics buffer context for the sreen
   * @return The graphics context
   */
  Graphics getGraphics();

  /**
   * Gets an entity view at given coordinates.
   *
   * @param x
   *            The X world coordinate.
   * @param y
   *            The Y world coordinate.
   *
   * @return The entity view, or <code>null</code> if none found.
   */
  EntityView getEntityViewAt(double x, double y);

  /**
   * Get a movable entity view at given coordinates.
   *
   * @param x
   *            The X world coordinate.
   * @param y
   *            The Y world coordinate.
   *
   * @return The entity view, or <code>null</code> if none found.
   */
  EntityView getMovableEntityViewAt(final double x,
      final double y);

  /**
   * Get the text bubble at specific coordinates.
   *
   * @param x
   *            The X world coordinate.
   * @param y
   *            The Y world coordinate.
   * @return the text bubble at the given coorodinate or <code>null</code> if not found.
   *
   */
  Text getTextAt(double x, double y);

  /**
   * Convert world coordinates to screen view coordinates.
   *
   * This does have some theorical range limits. Assuming a tile size of
   * 256x256 pixels (very high def), world coordinates are limited to a little
   * over +/-8 million, before the int (31-bit) values returned from this are
   * wrapped. So I see no issues, even if absolute world coordinates are used.
   *
   * @param wx
   *            World X coordinate.
   * @param wy
   *            World Y coordinate.
   *
   * @return Screen view coordinates (in integer values).
   */
  Point convertWorldToScreenView(double wx, double wy);

  /**
   * Draws a sprite in screen given its world coordinates.
   * 
   * @param sprite
   *            to be drawn
   * @param wx
   *            x in world coordinates
   * @param wy
   *            y in world coordinates
   * 
   */
  void draw(Sprite sprite, double wx, double wy);

  void drawInScreen(Sprite sprite, int sx, int sy);

  /**
   * Convert screen view coordinates to world coordinates.
   *
   * @param p
   *            The screen view coordinates.
   *
   * @return World coordinates.
   */
  Point2D convertScreenViewToWorld(final Point p);

  /**
   * Convert screen view coordinates to world coordinates.
   *
   * @param x
   *            The screen view X coordinate.
   * @param y
   *            The screen view Y coordinate.
   *
   * @return World coordinates.
   */
  Point2D convertScreenViewToWorld(final int x, final int y);

  /**
   * Get the view X screen coordinate.
   *
   * @return The X coordinate of the left side.
   */
  int getScreenViewX();

  /**
   * Get the view Y screen coordinate.
   *
   * @return The Y coordinate of the left side.
   */
  int getScreenViewY();

  /**
   * The user position changed. This sets the target coordinates that the
   * screen centers on.
   *
   * @param x
   *            The X coordinate (in world units).
   * @param y
   *            The Y coordinate (in world units).
   */
  void positionChanged(final double x, final double y);
}