bundles/common/org.eclipse.apogy.common.topology.ui/src/org/eclipse/apogy/common/topology/ui/SceneObject.java

/*******************************************************************************
 * Copyright (c) 2018 Agence spatiale canadienne / Canadian Space Agency
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Pierre Allard, 
 *     Regent L'Archeveque,
<<<<<<< HEAD
 *     Sebastien Gemme
 * 
=======
 *     Sebastien Gemme  - initial API and implementation
 *     
>>>>>>> refs/heads/eclipse_pa
 * SPDX-License-Identifier: EPL-1.0
 *     
 *******************************************************************************/
package org.eclipse.apogy.common.topology.ui;

import javax.vecmath.Point3d;
import javax.vecmath.Tuple3d;

import org.eclipse.apogy.common.topology.Node;
import org.eclipse.swt.graphics.RGB;

/**
 * Defined the interface that an object representing a Node in a 3D viewer
 * should implement.
 * 
 * @author pallard
 *
 */
public interface SceneObject {

	/**
	 * Returns the Topology node associated to this object.
	 * 
	 * @return the topology node listened by this object.
	 */
	public Node getTopologyNode();

	/**
	 * Gets the current color of the object.
	 * 
	 * @return The RBG color of the object.
	 */
	public RGB getColor();

	/**
	 * Sets the color of the object.
	 * 
	 * @param rgb The RBG color to be used to render the object.
	 */
	public void setColor(RGB rgb);

	/**
	 * This method is called when the object is selected.
	 */
	public void objectSelected();

	/**
	 * Returns whether the current object is shown.
	 * 
	 * @return True is object is visible, false otherwise.
	 */
	public boolean isVisible();

	/**
	 * Set the object visibility.
	 * 
	 * @param visible True make the object visible, false makes it invisible.
	 */
	public void setVisible(boolean visible);

	/**
	 * Sets the shadow mode of the scene object.
	 * 
	 * @param shadowMode The new ShadowMode.
	 */
	public void setShadowMode(ShadowMode shadowMode);

	/**
	 * Returns the current shadow mode of the object.
	 * 
	 * @return the ShadowMode.
	 */
	public ShadowMode getShadowMode();

	/**
	 * Returns the minimum coordinates of the bounding box of the Node 3D
	 * representation.
	 * 
	 * @return The coordinates of the lower corner of the bounding box.
	 */
	public Tuple3d getMin();

	/**
	 * Returns the maximum coordinates of the bounding box of the Node 3D
	 * representation.
	 * 
	 * @return The coordinates of the upper corner of the bounding box.
	 */
	public Tuple3d getMax();

	/**
	 * Set the transparency of the object.
	 * 
	 * @param transparency The transparency, from 0.0 to 1.0, where 0.0 is fully
	 *                     opaque, 1.0 fully transparent.
	 */
	public void setTransparency(float transparency);

	/**
	 * The coordinates of the centroid of the 3D representation.
	 * 
	 * @return The coordinate of the centroid.
	 */
	public Point3d getCentroid();

	/**
	 * Set the ID pole height.
	 * 
	 * @param idHeight, in meters.
	 */
	public void setIDPoleHeight(float idPoleHeight);

	/**
	 * Set whether or not the ID is visible.
	 * 
	 * @param visible True makes ID visible, false invisible.
	 */
	public void setIDVisible(boolean visible);

	public void setSelected(boolean selected);

	public boolean isSelected();
}