/*
 * The MIT License
 *
 * Copyright 2013 Dra0211.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package kinugasa.game.logic;

import java.awt.Graphics2D;
import kinugasa.contents.resource.Freeable;
import kinugasa.contents.resource.Nameable;
import kinugasa.game.Game;
import kinugasa.object.Drawable;
import kinugasa.util.annotations.CastReturnValue;

/**
 * ゲームのある場面でのロジックをカプセル化します.
 * <br>
 * ゲームロジックは、ゲームのある場面での処理を定義し、ロジックマネージャによって
 * 切り替えます。<br>
 * <br>
 *
 * @version 1.0.0 - 2013/01/14_14:34:42<br>
 * @author Dra0211<br>
 */
public abstract class GameLogic implements Nameable, Drawable, Freeable {

	/** このロジックの一意的な名前です. */
	public final String name;
	/** このロジックが所属するマネージャです. */
	protected final LogicManager logicManager;
	/** このロジックが実行されるゲームです. */
	protected final Game game;

	/**
	 * 新しいロジックを作成します.
	 * @param name ロジックを識別する名前を指定します。<br>
	 * @param logicManager このロジックが所属するマネージャを指定します。<br>
	 * @param game このロジックが実行されるゲームクラスを指定します。<br>
	 */
	public GameLogic(String name, LogicManager logicManager, Game game) {
		this.name = name;
		this.logicManager = logicManager;
		this.game = game;
	}

	/**
	 * ロジックの初期化を行います.
	 * <br>
	 * {@inheritDoc }
	 * <br>
	 * このメソッドは、ロジックが実行される前にロジックマネージャから呼ばれます。<br>
	 * @return thisインスタンスを戻します。具象クラス型にキャストしてください。<br>
	 */
	@CastReturnValue
	@Override
	public abstract GameLogic load();

	/**
	 * ロジックの破棄を行います.
	 * <br>
	 * {@inheritDoc }
	 * <br>
	 * このメソッドは、ロジックが切り替えられるときに、ロジックマネージャから呼ばれます。<br>
	 * @return thisインスタンスを戻します。具象クラス型にキャストしてください。<br>
	 */
	@CastReturnValue
	@Override
	public abstract GameLogic free();

	@Override
	public abstract boolean isLoaded();

	/**
	 * このロジックのメインの処理を定義します.
	 */
	public abstract void update();

	/**
	 * このロジックの描画処理を定義します.
	 *
	 * @param g 書き込むグラフィックスコンテキストを送信します。<br>
	 */
	@Override
	public abstract void draw(Graphics2D g);

	@Override
	public final String getName() {
		return name;
	}

	@Override
	public String toString() {
		return "GameLogic{" + "name=" + name + ", logicManager=" + logicManager + ", game=" + game + '}';
	}
}
