de.cau.cs.kieler.kiml.klayoutdata
Interface KEdgeLayout

All Superinterfaces:
EMapPropertyHolder, EObject, IPropertyHolder, KGraphData, Notifier
All Known Implementing Classes:
KEdgeLayoutImpl

public interface KEdgeLayout
extends KGraphData

A representation of the model object 'Edge Layout'. This layout data contains special information for edges, such as bend points. Each graph element has either a shape layout or an edge layout attached.

All layout coordinates for edges are defined to be relative to the parent of the source node, except when the target node is directly or indirectly contained in the source node, in which case all coordinates are relative to the source node itself. The insets of the reference node are not included in relative coordinates.

The following features are supported:

See Also:
KLayoutDataPackage.getKEdgeLayout()
Rating yellow
(2011-03-14) reviewed by cmot, cds
Generated:
This code was automatically generated.
Model element

Method Summary
 void applyVectorChain(KVectorChain points)
          Set the source point, bend points, and target point of this edge layout from the given vector chain.
 KVectorChain createVectorChain()
          Create a vector chain from the points of this edge layout.
 EList<KPoint> getBendPoints()
          Returns the value of the 'Bend Points' containment reference list.
 KPoint getSourcePoint()
          Returns the value of the 'Source Point' containment reference.
 KPoint getTargetPoint()
          Returns the value of the 'Target Point' containment reference.
 void setSourcePoint(KPoint value)
          Sets the value of the 'Source Point' containment reference.
 void setTargetPoint(KPoint value)
          Sets the value of the 'Target Point' containment reference.
 
Methods inherited from interface de.cau.cs.kieler.core.kgraph.EMapPropertyHolder
getPersistentEntries, getProperties, makePersistent
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 
Methods inherited from interface de.cau.cs.kieler.core.properties.IPropertyHolder
copyProperties, getAllProperties, getProperty, setProperty
 

Method Detail

getBendPoints

EList<KPoint> getBendPoints()
Returns the value of the 'Bend Points' containment reference list. The list contents are of type KPoint. The coordinates of bend points must obey the general rules for edge coordinates defined above.

Returns:
the value of the 'Bend Points' containment reference list.
See Also:
KLayoutDataPackage.getKEdgeLayout_BendPoints()
Generated:
This code was automatically generated.
Model element:
containment=true

getSourcePoint

KPoint getSourcePoint()
Returns the value of the 'Source Point' containment reference. The source point is the point at which the edge touches the source node or source port. The coordinates of source points must obey the general rules for edge coordinates defined above.

Returns:
the value of the 'Source Point' containment reference.
See Also:
setSourcePoint(KPoint), KLayoutDataPackage.getKEdgeLayout_SourcePoint()
Generated:
This code was automatically generated.
Model element:
containment=true
required=true

setSourcePoint

void setSourcePoint(KPoint value)
Sets the value of the 'Source Point' containment reference.

Parameters:
value - the new value of the 'Source Point' containment reference.
See Also:
getSourcePoint()
Generated:
This code was automatically generated.

getTargetPoint

KPoint getTargetPoint()
Returns the value of the 'Target Point' containment reference. The target point is the point at which the edge touches the target node or target port. The coordinates of target points must obey the general rules for edge coordinates defined above.

Returns:
the value of the 'Target Point' containment reference.
See Also:
setTargetPoint(KPoint), KLayoutDataPackage.getKEdgeLayout_TargetPoint()
Generated:
This code was automatically generated.
Model element:
containment=true
required=true

setTargetPoint

void setTargetPoint(KPoint value)
Sets the value of the 'Target Point' containment reference.

Parameters:
value - the new value of the 'Target Point' containment reference.
See Also:
getTargetPoint()
Generated:
This code was automatically generated.

applyVectorChain

void applyVectorChain(KVectorChain points)
Set the source point, bend points, and target point of this edge layout from the given vector chain. The vector chain should contain at least two points; the first point is taken as source point, while the last one is taken as target point.

Parameters:
points - the new points for this edge layout
Generated:
This code was automatically generated.
Model element:
pointsType=de.cau.cs.kieler.kiml.klayoutdata.KVectorChain

createVectorChain

KVectorChain createVectorChain()
Create a vector chain from the points of this edge layout. The resulting vector chain contains at least two points; the first point is the source point, while the last one is the target point.

Returns:
the points of this edge layout
Generated:
This code was automatically generated.
Model element:
type=de.cau.cs.kieler.kiml.klayoutdata.KVectorChain