effect.java

非常好的java collapse游戏代码

/*
 * JCollapse - Java Collapse Game
 * Copyright (C) 2005 Erico Gon鏰lves Rimoli
 * 
 * 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */

package sourceforge.net.projects.jcollapse.game.effects;

import java.awt.Image;

/**
 * This is an abstract class that must be extended by class do effects in game
 * 
 * @author erico
 *
 */
public abstract class Effect {
	private EffectObserver m_EffectObserver;
	
	private boolean m_Stoped = true;
	private boolean m_Persistent = true;
	
	public Effect( boolean persistent ) {
		setPersistent( persistent );
	}
	
	/**
	 * Set the EffectObserver that fire Effect events
	 * @param effectObserver the EffectObserver object that listen for effect actions
	 */
	public void SetEffectObserver( EffectObserver effectObserver ) {
		m_EffectObserver = effectObserver;
	}
	
	/**
	 * Remove an EffectObserver that fire Effect events
	 */
	public void removeEffectObserver() {
		m_EffectObserver = null;
	}
	
	protected void fireImageEffect( Image image ) {
		if( m_EffectObserver != null )
			m_EffectObserver.drawImageEffect( image );
	}
	
	protected void fireEndImageEffect() {
		if( m_EffectObserver != null )
			m_EffectObserver.endImageEffect();
	}
	
	/**
	 * Stop the effect process 
	 */
	public void stop() {
		m_Stoped = true;
	}
	
	protected void setRunning( boolean running ) {
		m_Stoped = !running;
	}
	
	/**
	 * If effect is not running, return true
	 * @return if effect is not running, return true, otherwise, false
	 */
	public boolean isStoped() {
		return m_Stoped;
	}

	/**
	 * Effects can be persistent or not, in other words, can stay
	 * on screen when is over or not
	 * @param persistent if true if Effect is persistent on screen, otherwise, false
	 */
	public void setPersistent( boolean persistent ) {
		m_Persistent = persistent;
	}
	
	/**
	 * Effects can be persistent or not, in other words, can stay
	 * on screen when is over or not
	 * @return true if Effect is persistent on screen, otherwise, false
	 */
	public boolean isPersistent() {
		return m_Persistent;
	}
	
	
	
	/**
	 * Draw an special effect to screen
	 * @param width the width of graphic context
	 * @param height the height of graphic context
	 */
	public abstract void draw( int width, int height );
}