visualizations.stdlayout

Class VertexVisualData<VertexType,EdgeType>

java.lang.Object

visualizations.stdlayout.VertexVisualData<VertexType,EdgeType>

Type Parameters:

VertexType - the vertex type of the graph

EdgeType - the edge type of the graph

All Implemented Interfaces:

VertexArealData

Direct Known Subclasses:

StdLayout.VisVertex

public class VertexVisualData<VertexType,EdgeType>
extends java.lang.Object
implements VertexArealData

Stores data for visual location and dimension of a vertex

Field Summary

Fields

Modifier and Type	Field and Description
static double	NOTINITIALIZED

Constructor Summary

Constructors

Constructor and Description
VertexVisualData(VertexType vertex, boolean directed) Creates an instance with an uninitialized position
VertexVisualData(VertexType vertex, double positionX, double positionY, boolean directed) Creates an instance with the given data

Method Summary

Modifier and Type	Method and Description
void	addIngoingEdge(EdgeVisualData<VertexType,EdgeType> edge) Adds a visual edge to the list of ingoing edges.
void	addOutgoingEdge(EdgeVisualData<VertexType,EdgeType> edge) Adds a visual edge to the list of outgoing edges.
void	addX(float x) Adds the given value to the x position of the vertex
void	addY(float y) Adds the given value to the y position of the vertex
java.util.LinkedList<EdgeVisualData<VertexType,EdgeType>>	getIngoingEdges() Returns the list of the visual dates of all ingoing edges
java.util.LinkedList<EdgeVisualData<VertexType,EdgeType>>	getOutgoingEdges() Returns the list of the visual dates of all outgoing edges
DimensionD	getScale() Returns the dimensions of the visual vertex appearance
VertexType	getVertex() Returns the vertex associated with this visual data
double	getX() Returns the x position of the vertex
double	getY() Returns the y position of the vertex
boolean	hasAutosizeData() Tells whether or not this instance has data to automatically adjust the dimensions
boolean	hasScale() Tells whether or not the dimensions were set for this visual data
boolean	isDirected() Returns true, if and only if, the vertex is of a directed graph
boolean	isPositionSet() Returns true, if and only if, the position was initialized before
void	resize(java.awt.Graphics gfx, GraphLibrary<VertexType,EdgeType> graph, ProjectionPlane projectionPlane) Resizes the dimensions according to the content of the vertex
void	setAutosizeData(java.awt.Graphics gfx, java.awt.Font font, java.lang.String caption) Sets the data to automatically adjust the dimensions.
void	setPosition(double x, double y) Sets the position of the vertex to the given x and y values
void	setScale(DimensionD scale) Sets the dimensions of the visual vertex appearance
void	setScale(double scale) Sets the x and y dimensions of the visual appearance both to the given value
void	setScale(double scaleX, double scaleY) Sets the x and y dimensions of the visual appearance
void	setX(double positionX) Sets the x position of the vertex to the given value
void	setY(double positionY) Sets the y position of the vertex to the given value
void	updateIncidentEdges(GraphLibrary<VertexType,EdgeType> graph) Refreshes the visual positions and appearance of the incident visual edges of the vertex

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NOTINITIALIZED

public static final double NOTINITIALIZED

See Also:

Constant Field Values

Constructor Detail

VertexVisualData

public VertexVisualData(VertexType vertex,
                        double positionX,
                        double positionY,
                        boolean directed)

Creates an instance with the given data

Parameters:

vertex - the vertex to associate with

positionX - the x position of the vertex

positionY - the y position of the vertex

directed - if true, ingoing as well as outgoing edges are stored

VertexVisualData

public VertexVisualData(VertexType vertex,
                        boolean directed)

Creates an instance with an uninitialized position

Parameters:

vertex - the vertex to associate with

directed - if true, then ingoing as well as outgoing edges are stored

Method Detail

isDirected

public final boolean isDirected()

Returns true, if and only if, the vertex is of a directed graph

isPositionSet

public final boolean isPositionSet()

Returns true, if and only if, the position was initialized before

getIngoingEdges

public java.util.LinkedList<EdgeVisualData<VertexType,EdgeType>> getIngoingEdges()

Returns the list of the visual dates of all ingoing edges

getOutgoingEdges

public java.util.LinkedList<EdgeVisualData<VertexType,EdgeType>> getOutgoingEdges()

Returns the list of the visual dates of all outgoing edges

addIngoingEdge

public void addIngoingEdge(EdgeVisualData<VertexType,EdgeType> edge)

Adds a visual edge to the list of ingoing edges. This is independent of actual edges of the graph

addOutgoingEdge

public void addOutgoingEdge(EdgeVisualData<VertexType,EdgeType> edge)

Adds a visual edge to the list of outgoing edges. This is independent of actual edges of the graph

getVertex

public VertexType getVertex()

Returns the vertex associated with this visual data

getScale

public DimensionD getScale()

Returns the dimensions of the visual vertex appearance

Specified by:

getScale in interface VertexArealData

setScale

public void setScale(DimensionD scale)

Sets the dimensions of the visual vertex appearance

setScale

public void setScale(double scale)

Sets the x and y dimensions of the visual appearance both to the given value

hasScale

public boolean hasScale()

Tells whether or not the dimensions were set for this visual data

setScale

public void setScale(double scaleX,
                     double scaleY)

Sets the x and y dimensions of the visual appearance

getX

public double getX()

Returns the x position of the vertex

Specified by:

getX in interface VertexArealData

setX

public void setX(double positionX)

Sets the x position of the vertex to the given value

getY

public double getY()

Returns the y position of the vertex

Specified by:

getY in interface VertexArealData

setY

public void setY(double positionY)

Sets the y position of the vertex to the given value

addX

public void addX(float x)

Adds the given value to the x position of the vertex

addY

public void addY(float y)

Adds the given value to the y position of the vertex

setPosition

public void setPosition(double x,
                        double y)

Sets the position of the vertex to the given x and y values

hasAutosizeData

public boolean hasAutosizeData()

Tells whether or not this instance has data to automatically adjust the dimensions

setAutosizeData

public void setAutosizeData(java.awt.Graphics gfx,
                            java.awt.Font font,
                            java.lang.String caption)

Sets the data to automatically adjust the dimensions. The dimensions are not actually set when calling this method, only the data is provided

Parameters:

gfx - the graphics surface on which the vertex is drawn

font - the font which is used when drawing the vertex

caption - the string which is output within the vertex when the vertex is drawn

resize

public void resize(java.awt.Graphics gfx,
                   GraphLibrary<VertexType,EdgeType> graph,
                   ProjectionPlane projectionPlane)

Resizes the dimensions according to the content of the vertex

Parameters:

gfx - the graphics surface on which the vertex is drawn

graph - the graph of the vertex

projectionPlane - the plane which is used to calculate the visual properties

updateIncidentEdges

public void updateIncidentEdges(GraphLibrary<VertexType,EdgeType> graph)

Refreshes the visual positions and appearance of the incident visual edges of the vertex