org.eclipse.eavp.viz.modeling

Class Edge

java.lang.Object

org.eclipse.eavp.viz.modeling.base.BasicMesh

org.eclipse.eavp.viz.modeling.Edge

All Implemented Interfaces:

IManagedUpdateable, IManagedUpdateableListener, IMesh

Direct Known Subclasses:

DetailedEdge, LinearEdge

public class Edge
extends BasicMesh

A mesh component representing a line between two Vertices.

Author:

Robert Smith

Constructor Summary

Constructors

Constructor and Description
Edge() The default constructor.
Edge(VertexController start, VertexController end) The default constructor.

Method Summary

Modifier and Type	Method and Description
void	addEntityToCategory(IController entity, IMeshCategory category) Adds a new child entity under the given category.
double	calculateLength() Calculates the length of the edge, saving the value in this object as well as returning it to the caller.
java.lang.Object	clone()
void	copy(IMesh otherObject) Deep copies the contents of another AbstractMeshComponent into this one.
double[]	getEndLocation() Gets the location for the edge's second vertex
double	getLength() Gets the edge's length
double[]	getStartLocation() Gets the location for the edge's first vertex.
void	register(IManagedUpdateableListener listener) Register a listener to receive managed updates.
void	setController(IController controller) Setter method for the controller.

Methods inherited from class org.eclipse.eavp.viz.modeling.base.BasicMesh

addEntity, equals, getAllEntities, getController, getEntities, getEntitiesFromCategory, getEntitiesFromCategory, getEntityCategories, getProperties, getProperty, getPropertyMap, getRotation, getScale, getSize, getSkew, getSubscriptions, getTransformation, getTranslation, getType, hashCode, removeEntity, setEntities, setProperties, setProperty, setTransformation, setType, unregister, update

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Edge

public Edge()

The default constructor.

Edge

public Edge(VertexController start,
            VertexController end)

The default constructor. It creates an edge between the two specified vertices.

Parameters:

start -

end -

Method Detail

getLength

public double getLength()

Gets the edge's length

Returns:

The edge's length

addEntityToCategory

public void addEntityToCategory(IController entity,
                                IMeshCategory category)

Description copied from interface: IMesh

Adds a new child entity under the given category.

Specified by:

addEntityToCategory in interface IMesh

Overrides:

addEntityToCategory in class BasicMesh

Parameters:

entity - The new child entity to be added

category - The new entity's category

calculateLength

public double calculateLength()

Calculates the length of the edge, saving the value in this object as well as returning it to the caller. This method does nothing by default, and is intended to be overwritten by subclasses.

Returns:

The edge's current length

register

public void register(IManagedUpdateableListener listener)

Description copied from interface: IManagedUpdateable

Register a listener to receive managed updates.

Specified by:

register in interface IManagedUpdateable

Overrides:

register in class BasicMesh

Parameters:

listener - The object which will receive future updates

setController

public void setController(IController controller)

Description copied from interface: IMesh

Setter method for the controller.

Specified by:

setController in interface IMesh

Overrides:

setController in class BasicMesh

Parameters:

controller - The IController which manages this component

clone

public java.lang.Object clone()

Overrides:

clone in class BasicMesh

copy

public void copy(IMesh otherObject)

Description copied from interface: IMesh

Deep copies the contents of another AbstractMeshComponent into this one. This does not copy the reference to any parent IController, as an IController should have exactly one AbstractMesh as a model.

Specified by:

copy in interface IMesh

Overrides:

copy in class BasicMesh

Parameters:

otherObject - The object which will be copied into this.

getStartLocation

public double[] getStartLocation()

Gets the location for the edge's first vertex.

Returns:

A list of the vertex's 3D coordinates

getEndLocation

public double[] getEndLocation()

Gets the location for the edge's second vertex

Returns:

A list of the vertex's 3D coordinates