io.github.interacto.jfx.interaction.InputEventTransition Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of interacto-javafx Show documentation

The JavaFX implementation of the Interacto library

The newest version!

/*
 * Interacto
 * Copyright (C) 2020 Arnaud Blouin
 * 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 3 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, see .
 */
package io.github.interacto.jfx.interaction;

import io.github.interacto.fsm.InputState;
import io.github.interacto.fsm.OutputState;
import io.github.interacto.fsm.Transition;
import javafx.event.Event;
import javafx.scene.input.InputEvent;

/**
 * This abstract transition defines a model for transitions based on input events.
 * @author Arnaud Blouin
 */
public abstract class InputEventTransition extends Transition {
	protected T event;

	/**
	 * Creates a transition.
	 * @param srcState The source state of the transition.
	 * @param tgtState The srcObject state of the transition.
	 * @throws IllegalArgumentException If one of the given parameters is null or not valid.
	 */
	public InputEventTransition(final OutputState srcState, final InputState tgtState) {
		super(srcState, tgtState);
	}

	/**
	 * @return The events at the origin of the transition. Cannot be null.
	 */
	public T getEvent() {
		return event;
	}

	/**
	 * Sets the event of the transition.
	 * @param evt The new transition. Cannot be null.
	 */
	public void setEvent(final T evt) {
		if(evt != null) {
			event = evt;
		}
	}

	@Override
	protected boolean isGuardOK(final T t) {
		return true;
	}
}