org.jeometry.geom3D.mesh.Edge Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jeometry-api Show documentation

Jeometry, a Mathematic and Geometry library for Java

There is a newer version: 1.0.5

package org.jeometry.geom3D.mesh;

import java.util.List;

import org.jeometry.Jeometry;
import org.jeometry.geom3D.point.Point3D;
import org.jeometry.geom3D.primitive.Line3D;
import org.jeometry.geom3D.primitive.Polygon3D;

/**
 * An interface that describe an edge.  
 * An {@link Edge edge} is a {@link Line3D 3D line} that link two vertices and that delimits a polygon or that delimits faces of a polyhedron.
 * @param  The type of the underlying 3D points
 * @author Julien Seinturier - COMEX S.A. - [email protected] - https://github.com/jorigin/jeometry
 * @version {@value Jeometry#version} build {@value Jeometry#BUILD}
 * @since 1.0.0
 * @see Polygon3D
 * @see Face
 * @see Mesh
 */
public interface Edge extends Line3D{
  
  /**
   * Return the {@link Mesh mesh} to which the edge is attached
   * @return The {@link Mesh mesh} from which the edge is attached
   */
  public Mesh getMesh();

  /**
   * Set the {@link Mesh mesh} to which the edge is attached.
   * @param mesh the {@link Mesh mesh} to which attach the edge
   */
  public void setMesh(Mesh mesh);
	
  /**
   * Get the {@link Face faces} attached to the edge
   * @return the {@link Face faces} attached to this edge
   */
  List> getFaces();
}