VideoScene.java

/**
 * eAdventure (formerly <e-Adventure> and <e-Game>) is a research project of the
 *    <e-UCM> research group.
 *
 *    Copyright 2005-2010 <e-UCM> research group.
 *
 *    You can access a list of all the contributors to eAdventure at:
 *          http://e-adventure.e-ucm.es/contributors
 *
 *    <e-UCM> is a research group of the Department of Software Engineering
 *          and Artificial Intelligence at the Complutense University of Madrid
 *          (School of Computer Science).
 *
 *          C Profesor Jose Garcia Santesmases sn,
 *          28040 Madrid (Madrid), Spain.
 *
 *          For more info please visit:  <http://e-adventure.e-ucm.es> or
 *          <http://www.e-ucm.es>
 *
 * ****************************************************************************
 *
 *  This file is part of eAdventure, version 2.0
 *
 *      eAdventure 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 3 of the License, or
 *      (at your option) any later version.
 *
 *      eAdventure 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 eAdventure.  If not, see <http://www.gnu.org/licenses/>.
 */

package es.eucm.ead.model.elements.scenes;

import es.eucm.ead.model.assets.multimedia.EAdVideo;
import es.eucm.ead.model.elements.effects.Effect;
import es.eucm.ead.model.elements.extra.EAdList;
import es.eucm.ead.model.interfaces.Element;
import es.eucm.ead.model.interfaces.Param;

@Element
public class VideoScene extends Scene {

	public static final String video = "video";

	@Param
	private EAdList<Effect> finalEffects;

	public VideoScene() {
		super();
		finalEffects = new EAdList<Effect>();
	}

	public void setVideo(EAdVideo v) {
		if (definition == null) {
			definition = new SceneElementDef();
		}
		definition.addAsset(VideoScene.video, v);
	}

	/**
	 * Effects launched when the video ends
	 *
	 * @return
	 */
	public EAdList<Effect> getFinalEffects() {
		return finalEffects;
	}

	public void setFinalEffects(EAdList<Effect> finalEffects) {
		this.finalEffects = finalEffects;
	}

	@Override
	public boolean getReturnable() {
		return false;
	}

	/**
	 * Adds a new a affect that will be launched after the video finishes
	 *
	 * @param e the effect
	 */
	public void addFinalEffect(Effect e) {
		this.finalEffects.add(e);
	}
}