com.yworks.yfiles.layout.radial

Class RadialLayout.NodeInfo

java.lang.Object

com.yworks.yfiles.layout.radial.RadialLayout.NodeInfo

Enclosing class:

RadialLayout

public static class RadialLayout.NodeInfo
extends Object

Info object used for retrieving information about each node from the layout algorithm.

The information can be retrieved by registering with the graph a IDataProvider (which should also implement the IDataAcceptor interface) using key RadialLayout.NODE_INFO_DPKEY. The layout algorithm will return a RadialLayout.NodeInfo object with appropriately filled fields for each Node when the layout is calculated.

This info object only delivers additional data which were calculated during the layout run and has no influence on layout calculation.

Constructor Summary

Constructors

Constructor and Description
NodeInfo() Creates a new RadialLayout.NodeInfo instance.

Method Summary

Modifier and Type	Method and Description
YPoint	getCenterOffset() Gets the offset from the center of the circle, the node is placed on, to the center of the node.
int	getCircleIndex() Gets the index of the circle the node is placed on.
double	getRadius() Gets the radius of the circle the node is placed on.
double	getSectorSize() Gets the size in degrees of the sector the node is placed in.
double	getSectorStart() Gets the start angle in degrees of the sector the node is placed in.

Methods inherited from class java.lang.Object

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

Constructor Detail

NodeInfo

public NodeInfo()

Creates a new RadialLayout.NodeInfo instance.

Method Detail

getCenterOffset

public YPoint getCenterOffset()

Gets the offset from the center of the circle, the node is placed on, to the center of the node.

Returns:

the offset from the center of the circle, the node is placed on, to the center of the node

getCircleIndex

public int getCircleIndex()

Gets the index of the circle the node is placed on.

The circles used by the RadialLayout are indexed from the innermost to the outermost circle. Index 0 represents the center, i.e. the circle with radius 0.

Returns:

the index of the circle the node is placed on

getRadius

public double getRadius()

Gets the radius of the circle the node is placed on.

Returns:

the radius of the circle the node is placed on

getSectorSize

public double getSectorSize()

Gets the size in degrees of the sector the node is placed in.

Returns:

the size in degrees of the sector the node is placed in

See Also:

getSectorStart()

getSectorStart

public double getSectorStart()

Gets the start angle in degrees of the sector the node is placed in.

The angle refers to a counter-clockwise rotation starting at the 3 o'clock position.

Returns:

the start angle in degrees of the sector the node is placed in

See Also:

getSectorSize()