com.yworks.yfiles.layout

Class FreeEdgeLabelLayoutModel.ModelParameter

java.lang.Object

com.yworks.yfiles.layout.FreeEdgeLabelLayoutModel.ModelParameter

Enclosing class:

FreeEdgeLabelLayoutModel

public static class FreeEdgeLabelLayoutModel.ModelParameter
extends Object

This model parameter encodes a label position within FreeEdgeLabelLayoutModel.

It represents every possible location in relation to the source point of the edge. The radius describes the distance of the label center from the source point. There is an angle theta which defines the location on the circle with the given radius. It is the angle between the first segment of the underlying edge and the imaginary line to the center of the label. Finally, there is a second angle that describes the rotation of the label box.

See Also:

setPoint(double, double), setAngle(double)

Constructor Summary

Constructors

Constructor and Description
ModelParameter() Creates a new instance of FreeEdgeLabelLayoutModel.ModelParameter with radius 50 and angle 0.
ModelParameter(double radius, double theta) Creates a new instance of FreeEdgeLabelLayoutModel.ModelParameter with the given radius, angle and rotation angle.
ModelParameter(double radius, double theta, double angle) Creates a new instance of FreeEdgeLabelLayoutModel.ModelParameter with the given radius, angle and rotation angle.

Method Summary

Modifier and Type	Method and Description
double	getAngle() Gets the rotation angle of the label that is placed using this model parameter.
YPoint	getPoint() Gets a point that represents the location of the label's center in relation to the source point of the edge.
void	setAngle(double value) Sets the rotation angle of the label that is placed using this model parameter.
void	setPoint(double radius, double theta) Specifies a point that represents the location of the label's center in relation to the source point of the edge.
String	toString() Returns a String representation of this model parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModelParameter

public ModelParameter()

Creates a new instance of FreeEdgeLabelLayoutModel.ModelParameter with radius 50 and angle 0.

ModelParameter

public ModelParameter(double radius,
                      double theta)

Creates a new instance of FreeEdgeLabelLayoutModel.ModelParameter with the given radius, angle and rotation angle.

Parameters:

radius - the distance of the label from the source node of the underlying edge

theta - the angle in radians between the first segment of the underlying edge and the imaginary line to the center of the label

ModelParameter

public ModelParameter(double radius,
                      double theta,
                      double angle)

Creates a new instance of FreeEdgeLabelLayoutModel.ModelParameter with the given radius, angle and rotation angle.

Parameters:

radius - the distance of the label from the source node of the underlying edge

theta - the angle in radians between the first segment of the underlying edge and the imaginary line to the center of the label

angle - the rotation angle of the label

Method Detail

getAngle

public double getAngle()

Gets the rotation angle of the label that is placed using this model parameter.

Default Value:

The default value is 0. The label is placed paraxial.

Returns:

the rotation angle of the label

See Also:

setAngle(double)

getPoint

public YPoint getPoint()

Gets a point that represents the location of the label's center in relation to the source point of the edge.

The x-coordinate corresponds to the radius which describes the distance of the label to the source point. The y-coordinate corresponds to the angle between the first segment of the underlying edge and the imaginary line to the center of the label.

Returns:

the location of the label in relation to the edge's source point

setAngle

public void setAngle(double value)

Sets the rotation angle of the label that is placed using this model parameter.

Default Value:

The default value is 0. The label is placed paraxial.

Parameters:

value - the rotation angle of the label

See Also:

getAngle()

setPoint

public void setPoint(double radius,
                     double theta)

Specifies a point that represents the location of the label's center in relation to the source point of the edge.

The x-coordinate corresponds to the radius which describes the distance of the label to the source point. The y-coordinate corresponds to the angle between the first segment of the underlying edge and the imaginary line to the center of the label.

Parameters:

radius - the distance to the source point

theta - the location on the radius

toString

public String toString()

Returns a String representation of this model parameter.

The String contains the radius around the source node on which the label is placed and the angle that describes the location on said radius.

Overrides:

toString in class Object

Returns:

the String representation