com.yworks.yfiles.layout

Class SimpleProfitModel

java.lang.Object

com.yworks.yfiles.layout.SimpleProfitModel

All Implemented Interfaces:

IProfitModel

public class SimpleProfitModel
extends Object
implements IProfitModel

SimpleProfitModel implements the ranking for edge and node labels.

In this implementation node label positions have no ranking, the profit for all candidates is 1.

The ranking of edge label positions depends on the locations described in the PreferredPlacementDescriptor associated with an edge.

Constructor Summary

Constructors

Constructor and Description
SimpleProfitModel() Creates a new instance of SimpleProfitModel.

Method Summary

Modifier and Type	Method and Description
double	getProfit(LabelCandidate candidate) Returns the profit for placing a label using the given LabelCandidate.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleProfitModel

public SimpleProfitModel()

Creates a new instance of SimpleProfitModel.

Method Detail

getProfit

public double getProfit(LabelCandidate candidate)

Description copied from interface: IProfitModel

Returns the profit for placing a label using the given LabelCandidate.

Higher profit means better candidates. Hence, there is a higher probability that the candidate is chosen by a labeling algorithm.

Profits need to have a value between 0 and 1.

Specified by:

getProfit in interface IProfitModel

Parameters:

candidate - the candidate

Returns:

the profit of the candidate