com.yworks.yfiles.layout

Class GraphTransformer

java.lang.Object

com.yworks.yfiles.layout.MultiStageLayout

com.yworks.yfiles.layout.GraphTransformer

All Implemented Interfaces:

ILayoutAlgorithm, ILayoutStage

public class GraphTransformer
extends MultiStageLayout
implements ILayoutStage

This layout algorithm applies geometric transformations to (sub-)graphs.

Layout Style

There are several ways to transform the graph that include mirroring, rotating, scaling and translating.

The highlighted subgraph is rotated by 45 degrees

Features

The layout can be scaled with independent factors for the horizontal and vertical scaling. Optionally, the sizes of nodes can be scaled, too.

The layout can be mirrored either on the x-axis or the y-axis.

A rotation can be specified. Instead of defining a rotation angle the angle can be determined automatically to fit specific bounds.

The coordinates in the layout can be translated by a specific vector.

To only apply previously mentioned transformations to a subgraph, the SubgraphLayout needs to be enabled. Then the nodes in the subgraph must be marked in a IDataProvider registered with the according key.

Labels are not affected by the transformation. They will stay at the location that is defined by their label model.

Constructor Summary

Constructors

Constructor and Description
GraphTransformer() Creates a new instance of GraphTransformer with default settings.

Method Summary

Modifier and Type	Method and Description
static double	applyBestFitRotationAngle(LayoutGraph graph, double width, double height) Rotates the given graph so its resulting bounding box fits best to the given bounds.
void	applyLayoutCore(LayoutGraph graph) Applies the selected transformation to the given graph after invoking the optional core layout algorithm.
static double	findBestFitRotationAngle(LayoutGraph graph, double width, double height) Returns the rotation angle for the graph that will result in a layout that fits best to the given bounds.
ILayoutAlgorithm	getCoreLayout() Gets the core layout algorithm.
OperationType	getOperation() Gets the transformation operation.
double	getPreferredHeight() Gets the preferred height of the layout.
double	getPreferredWidth() Gets the preferred width of the layout.
double	getRotationAngle() Gets the angle of rotation.
double	getScaleFactorX() Gets the horizontal scaling factor used for the scale operation.
double	getScaleFactorY() Gets the vertical scaling factor used for the scale operation.
double	getTranslateX() Gets the horizontal translation distance.
double	getTranslateY() Gets the vertical translation distance.
boolean	isBestFitRotationEnabled() Gets whether or not to automatically choose the best fitting rotation angle.
boolean	isNodeSizeScalingEnabled() Gets whether or not to also scale node sizes when performing the scale operation.
void	preferredLayoutSize(double width, double height) Specifies the preferred size of the layout.
void	setBestFitRotationEnabled(boolean value) Sets whether or not to automatically choose the best fitting rotation angle.
void	setCoreLayout(ILayoutAlgorithm value) Sets the core layout algorithm.
static void	setMaximalBounds(LayoutGraph graph, double x, double y, double w, double h) Fits the given graph into the specified rectangular bounds.
void	setNodeSizeScalingEnabled(boolean value) Sets whether or not to also scale node sizes when performing the scale operation.
void	setOperation(OperationType value) Sets the transformation operation.
void	setPreferredHeight(double value) Sets the preferred height of the layout.
void	setPreferredWidth(double value) Sets the preferred width of the layout.
void	setRotationAngle(double value) Sets the angle of rotation.
void	setScaleFactor(double value) Sets the uniform scaling factor used for the scale operation.
void	setScaleFactors(double xFactor, double yFactor) Specifies the horizontal and vertical scaling factor used for the scale operation.
void	setScaleFactorX(double value) Sets the horizontal scaling factor used for the scale operation.
void	setScaleFactorY(double value) Sets the vertical scaling factor used for the scale operation.
void	setTranslateX(double value) Sets the horizontal translation distance.
void	setTranslateY(double value) Sets the vertical translation distance.
static void	translate(LayoutGraph graph, double dx, double dy) Translates the layout coordinates by the given vector.

Methods inherited from class com.yworks.yfiles.layout.MultiStageLayout

appendStage, applyLayout, checkNodeSize, disableAllStages, getComponentLayout, getHideGroupsStage, getLabeling, getLayoutOrientation, getOrientationLayout, getParallelEdgeRouter, getSelfLoopRouter, getSubgraphLayout, isComponentLayoutEnabled, isHideGroupsStageEnabled, isLabelingEnabled, isOrientationLayoutEnabled, isParallelEdgeRouterEnabled, isSelfLoopRouterEnabled, isSubgraphLayoutEnabled, prependStage, removeStage, setComponentLayout, setComponentLayoutEnabled, setHideGroupsStage, setHideGroupsStageEnabled, setLabeling, setLabelingEnabled, setLayoutOrientation, setOrientationLayout, setOrientationLayoutEnabled, setParallelEdgeRouter, setParallelEdgeRouterEnabled, setSelfLoopRouter, setSelfLoopRouterEnabled, setSubgraphLayout, setSubgraphLayoutEnabled

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.yworks.yfiles.layout.ILayoutAlgorithm

applyLayout

Constructor Detail

GraphTransformer

public GraphTransformer()

Creates a new instance of GraphTransformer with default settings.

Method Detail

applyBestFitRotationAngle

public static final double applyBestFitRotationAngle(LayoutGraph graph,
                                                     double width,
                                                     double height)

Rotates the given graph so its resulting bounding box fits best to the given bounds.

Parameters:

graph - the graph that is rotated

width - the width of the preferred layout bounds

height - the height of the preferred layout bounds

Returns:

the rotation angle

See Also:

setBestFitRotationEnabled(boolean)

applyLayoutCore

public void applyLayoutCore(LayoutGraph graph)

Applies the selected transformation to the given graph after invoking the optional core layout algorithm.

Specified by:

applyLayoutCore in class MultiStageLayout

Parameters:

graph - the input graph

findBestFitRotationAngle

public static final double findBestFitRotationAngle(LayoutGraph graph,
                                                    double width,
                                                    double height)

Returns the rotation angle for the graph that will result in a layout that fits best to the given bounds.

Parameters:

graph - the graph that is rotated

width - the width of the preferred layout bounds

height - the height of the preferred layout bounds

Returns:

the rotation angle

See Also:

applyBestFitRotationAngle(LayoutGraph, double, double)

getCoreLayout

public ILayoutAlgorithm getCoreLayout()

Description copied from interface: ILayoutStage

Gets the core layout algorithm.

This algorithm is wrapped by this stage. It is invoked in ILayoutAlgorithm.applyLayout(com.yworks.yfiles.layout.LayoutGraph). The ILayoutStage may add pre- and post-processing steps before and after calling the core layout algorithm.

Specified by:

getCoreLayout in interface ILayoutStage

Returns:

the core layout algorithm

See Also:

ILayoutStage.setCoreLayout(ILayoutAlgorithm)

getOperation

public OperationType getOperation()

Gets the transformation operation.

Throws:

IllegalArgumentException - if the specified operation is unknown

Default Value:

The default value is OperationType.SCALE

Returns:

one of the valid operation specifiers

See Also:

setOperation(OperationType)

getPreferredHeight

public double getPreferredHeight()

Gets the preferred height of the layout.

This value will be used for fitting the rotation to preferred bounds.

The preferred height needs to be non-negative.

Throws:

IllegalArgumentException - if the specified height is negative

This option only has an effect if performing a rotation and the rotation is fitted to the bounds.

Default Value:

The default value is 1.0.

Returns:

the preferred height of the layout

See Also:

getPreferredWidth(), setBestFitRotationEnabled(boolean), setOperation(OperationType), OperationType.ROTATE, setPreferredHeight(double)

getPreferredWidth

public double getPreferredWidth()

Gets the preferred width of the layout.

This value will be used for fitting the rotation to preferred bounds.

The preferred width needs to be non-negative.

Throws:

IllegalArgumentException - if the specified width is negative

This option only has an effect if performing a rotation and the rotation is fitted to the bounds.

Default Value:

The default value is 1.41.

Returns:

the preferred width of the layout

See Also:

getPreferredHeight(), setBestFitRotationEnabled(boolean), setOperation(OperationType), OperationType.ROTATE, setPreferredWidth(double)

getRotationAngle

public double getRotationAngle()

Gets the angle of rotation.

The angle must be given in degrees.

This option only has an effect if the layout is rotated.

Default Value:

The default value is 0.0.

Returns:

the rotation angle in degrees

See Also:

setOperation(OperationType), OperationType.ROTATE, setRotationAngle(double)

getScaleFactorX

public double getScaleFactorX()

Gets the horizontal scaling factor used for the scale operation.

Only positive scaling factors are allowed.

Throws:

IllegalArgumentException - if the specified scaling factor is negative or 0

This option only has an effect if the layout is scaled.

Default Value:

The default value is 1.0.

Returns:

the horizontal scaling factor

See Also:

getScaleFactorY(), setOperation(OperationType), OperationType.SCALE, setScaleFactorX(double)

getScaleFactorY

public double getScaleFactorY()

Gets the vertical scaling factor used for the scale operation.

Only positive scaling factors are allowed.

Throws:

IllegalArgumentException - if the specified scaling factor is negative or 0

This option only has an effect if the layout is scaled.

Default Value:

The default value is 1.0.

Returns:

the vertical scaling factor

See Also:

getScaleFactorX(), setOperation(OperationType), OperationType.SCALE, setScaleFactorY(double)

getTranslateX

public double getTranslateX()

Gets the horizontal translation distance.

A positive value means the graph is moved to the right while, a negative value means the graph is moved to the left.

This option only has an effect if the layout is translated.

Default Value:

The default value is 0.0.

Returns:

the translation distance along the x-axis

See Also:

getTranslateY(), setOperation(OperationType), OperationType.TRANSLATE, setTranslateX(double)

getTranslateY

public double getTranslateY()

Gets the vertical translation distance.

A positive value means the graph is moved downwards, while a negative value means the graph is moved upwards.

This option only has an effect if the layout is translated.

Default Value:

The default value is 0.0.

Returns:

the translation distance along the y-axis

See Also:

getTranslateX(), setOperation(OperationType), OperationType.TRANSLATE, setTranslateY(double)

isBestFitRotationEnabled

public boolean isBestFitRotationEnabled()

Gets whether or not to automatically choose the best fitting rotation angle.

The angle will be chosen such that the bounding box after the rotation fits best to the preferred aspect ratio.

This option only has an effect if the layout is rotated.

Default Value:

The default value is false. The layout is rotated by a specific angle.

Returns:

true if the best fitting rotation angle should be automatically determined, false if the specified angle should be used

See Also:

setOperation(OperationType), OperationType.ROTATE, setBestFitRotationEnabled(boolean)

isNodeSizeScalingEnabled

public boolean isNodeSizeScalingEnabled()

Gets whether or not to also scale node sizes when performing the scale operation.

This option only has an effect if the layout is scaled.

Default Value:

The default value is false. Nodes keep their sizes when the layout is scaled.

Returns:

true if the sizes of the nodes are also scaled, false otherwise

See Also:

setOperation(OperationType), OperationType.SCALE, setNodeSizeScalingEnabled(boolean)

preferredLayoutSize

public void preferredLayoutSize(double width,
                                double height)

Specifies the preferred size of the layout.

If performing a rotation and this rotation should be automatically fitted, then the given preferred size defines the aspect ratio that will be used for fitting the layout rotation.

The preferred width and height need to be non-negative.

Throws:

IllegalArgumentException - if the specified width or height is negative

This option only has an effect if the rotation is fitted to the bounds.

Parameters:

width - the preferred width of the layout

height - the preferred height of the layout

See Also:

setPreferredWidth(double), setPreferredHeight(double), setBestFitRotationEnabled(boolean), setOperation(OperationType), OperationType.ROTATE

setBestFitRotationEnabled

public void setBestFitRotationEnabled(boolean value)

Sets whether or not to automatically choose the best fitting rotation angle.

The angle will be chosen such that the bounding box after the rotation fits best to the preferred aspect ratio.

This option only has an effect if the layout is rotated.

Default Value:

The default value is false. The layout is rotated by a specific angle.

Parameters:

value - true if the best fitting rotation angle should be automatically determined, false if the specified angle should be used

See Also:

setOperation(OperationType), OperationType.ROTATE, isBestFitRotationEnabled()

setCoreLayout

public void setCoreLayout(ILayoutAlgorithm value)

Description copied from interface: ILayoutStage

Sets the core layout algorithm.

This algorithm is wrapped by this stage. It is invoked in ILayoutAlgorithm.applyLayout(com.yworks.yfiles.layout.LayoutGraph). The ILayoutStage may add pre- and post-processing steps before and after calling the core layout algorithm.

Specified by:

setCoreLayout in interface ILayoutStage

Parameters:

value - the core layout algorithm

See Also:

ILayoutStage.getCoreLayout()

setMaximalBounds

public static final void setMaximalBounds(LayoutGraph graph,
                                          double x,
                                          double y,
                                          double w,
                                          double h)

Fits the given graph into the specified rectangular bounds.

If the bounding box fits in the given bounds, nothing is done. Otherwise, the graph is scaled and optionally moved to fit.

The algorithm does not modify the node's sizes.

Parameters:

graph - the graph to modify

x - the upper left x-coordinate of the bounds

y - the upper left y-coordinate of the bounds

w - the width of the bounds

h - the height of the bounds

setNodeSizeScalingEnabled

public void setNodeSizeScalingEnabled(boolean value)

Sets whether or not to also scale node sizes when performing the scale operation.

This option only has an effect if the layout is scaled.

Default Value:

The default value is false. Nodes keep their sizes when the layout is scaled.

Parameters:

value - true if the sizes of the nodes are also scaled, false otherwise

See Also:

setOperation(OperationType), OperationType.SCALE, isNodeSizeScalingEnabled()

setOperation

public void setOperation(OperationType value)

Sets the transformation operation.

Throws:

IllegalArgumentException - if the specified operation is unknown

Default Value:

The default value is OperationType.SCALE

Parameters:

value - one of the valid operation specifiers

See Also:

getOperation()

setPreferredHeight

public void setPreferredHeight(double value)

Sets the preferred height of the layout.

This value will be used for fitting the rotation to preferred bounds.

The preferred height needs to be non-negative.

Throws:

IllegalArgumentException - if the specified height is negative

This option only has an effect if performing a rotation and the rotation is fitted to the bounds.

Default Value:

The default value is 1.0.

Parameters:

value - the preferred height of the layout

See Also:

getPreferredWidth(), setBestFitRotationEnabled(boolean), setOperation(OperationType), OperationType.ROTATE, getPreferredHeight()

setPreferredWidth

public void setPreferredWidth(double value)

Sets the preferred width of the layout.

This value will be used for fitting the rotation to preferred bounds.

The preferred width needs to be non-negative.

Throws:

IllegalArgumentException - if the specified width is negative

This option only has an effect if performing a rotation and the rotation is fitted to the bounds.

Default Value:

The default value is 1.41.

Parameters:

value - the preferred width of the layout

See Also:

getPreferredHeight(), setBestFitRotationEnabled(boolean), setOperation(OperationType), OperationType.ROTATE, getPreferredWidth()

setRotationAngle

public void setRotationAngle(double value)

Sets the angle of rotation.

The angle must be given in degrees.

This option only has an effect if the layout is rotated.

Default Value:

The default value is 0.0.

Parameters:

value - the rotation angle in degrees

See Also:

setOperation(OperationType), OperationType.ROTATE, getRotationAngle()

setScaleFactor

public void setScaleFactor(double value)

Sets the uniform scaling factor used for the scale operation.

This factor applies vertical and horizontal.

Only positive scaling factors are allowed.

Throws:

IllegalArgumentException - if the specified scaling factor is negative or 0

This option only has an effect if the layout is scaled.

Parameters:

value - the scaling factor

See Also:

setScaleFactorX(double), setScaleFactorY(double), setOperation(OperationType), OperationType.SCALE

setScaleFactors

public void setScaleFactors(double xFactor,
                            double yFactor)

Specifies the horizontal and vertical scaling factor used for the scale operation.

Only positive scaling factors are allowed.

Throws:

IllegalArgumentException - if one the specified scaling factors is negative or 0

This option only has an effect if the layout is scaled.

Parameters:

xFactor - the horizontal scaling factor

yFactor - the vertical scaling factor

See Also:

setScaleFactorX(double), setScaleFactorY(double), setOperation(OperationType), OperationType.SCALE

setScaleFactorX

public void setScaleFactorX(double value)

Sets the horizontal scaling factor used for the scale operation.

Only positive scaling factors are allowed.

Throws:

IllegalArgumentException - if the specified scaling factor is negative or 0

This option only has an effect if the layout is scaled.

Default Value:

The default value is 1.0.

Parameters:

value - the horizontal scaling factor

See Also:

getScaleFactorY(), setOperation(OperationType), OperationType.SCALE, getScaleFactorX()

setScaleFactorY

public void setScaleFactorY(double value)

Sets the vertical scaling factor used for the scale operation.

Only positive scaling factors are allowed.

Throws:

IllegalArgumentException - if the specified scaling factor is negative or 0

This option only has an effect if the layout is scaled.

Default Value:

The default value is 1.0.

Parameters:

value - the vertical scaling factor

See Also:

getScaleFactorX(), setOperation(OperationType), OperationType.SCALE, getScaleFactorY()

setTranslateX

public void setTranslateX(double value)

Sets the horizontal translation distance.

A positive value means the graph is moved to the right while, a negative value means the graph is moved to the left.

This option only has an effect if the layout is translated.

Default Value:

The default value is 0.0.

Parameters:

value - the translation distance along the x-axis

See Also:

getTranslateY(), setOperation(OperationType), OperationType.TRANSLATE, getTranslateX()

setTranslateY

public void setTranslateY(double value)

Sets the vertical translation distance.

A positive value means the graph is moved downwards, while a negative value means the graph is moved upwards.

This option only has an effect if the layout is translated.

Default Value:

The default value is 0.0.

Parameters:

value - the translation distance along the y-axis

See Also:

getTranslateX(), setOperation(OperationType), OperationType.TRANSLATE, getTranslateY()

translate

public static final void translate(LayoutGraph graph,
                                   double dx,
                                   double dy)

Translates the layout coordinates by the given vector.

Parameters:

graph - the graph that is translated

dx - the horizontal distance the given graph is moved

dy - the vertical distance the given graph is moved

See Also:

OperationType.TRANSLATE, setOperation(OperationType)