io.github.interacto.jfx.interaction.library.SrcTgtPointsData 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.library;

import java.util.Optional;
import javafx.beans.property.ReadOnlyObjectProperty;
import javafx.geometry.Point3D;
import javafx.scene.Node;

/**
 * Interaction data for a single pointing device that moves from a source
 * position to a target position.
 */
public interface SrcTgtPointsData extends PointData {
	/**
	 * @return The object picked at the target location.
	 */
	Optional getTgtObject();

	/**
	 * @return An observable property for the target local position.
	 */
	ReadOnlyObjectProperty tgtLocalPointProperty();

	/**
	 * @return An observable property for the target scene position.
	 */
	ReadOnlyObjectProperty tgtScenePointProperty();

	/**
	 * @return An observable property for the target object.
	 */
	ReadOnlyObjectProperty tgtObjectProperty();

	/**
	 * @return The target position.
	 */
	Point3D getTgtLocalPoint();

	/**
	 * @return The target scene position.
	 */
	Point3D getTgtScenePoint();
}