ilog.views.maps.label
Class IlvMapLineLabel.ParameterRecord

java.lang.Object
  ilog.views.maps.label.IlvMapLineLabel.ParameterRecord

Enclosing class:

IlvMapLineLabel

public static class IlvMapLineLabel.ParameterRecord
extends Object

Class holding parameters for IlvMapLineLabel instances.

Since:

JViews 7.5

Field Summary

int	candidateThreshold Internal parameter used to generate candidate labels on a path.
int	clutterDistance Minimum distance between close labels.
int	cycle Minimum distance between consecutive labels on the associated polyline.
int	distanceToPath Distance from the label baseline to its associated polyline (can be negative).
boolean	followPath Flag to make labels follow the path of the associated polyline.
double	maxAngleBreak Maximum acceptable angle break between 2 consecutive segments of the polyline for these segments to be considered as a candidate position for labels.
double	maxAngleVariation Maximum acceptable CUMULATIVE angle breaks along several segments of the polyline for these segments to be considered as a candidate position for labels.
int	minPolylineRadius Minimum enclosing circle for a polyline to be labeled.
int	polylineThreshold Polyline simplification parameter (minimum distance between consecutive points).
boolean	repeat Flag to repeat the text along its associated polyline.
double	switchOrientationAngle This angle (measured from the vertical, counter clockwise) gives the direction at which labels change their orientation on the baseline to remain readable.

Constructor Summary

IlvMapLineLabel.ParameterRecord()
Creates a new ParameterRecord.

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

repeat

public boolean repeat

Flag to repeat the text along its associated polyline.

cycle

public int cycle

Minimum distance between consecutive labels on the associated polyline.

followPath

public boolean followPath

Flag to make labels follow the path of the associated polyline.

distanceToPath

public int distanceToPath

Distance from the label baseline to its associated polyline (can be negative).

clutterDistance

public int clutterDistance

Minimum distance between close labels.

polylineThreshold

public int polylineThreshold

Polyline simplification parameter (minimum distance between consecutive points). This straightens the path the label should follow, resulting in faster computation but poorer quality.

minPolylineRadius

public int minPolylineRadius

Minimum enclosing circle for a polyline to be labeled. Smaller polylines are not taken into account.

maxAngleBreak

public double maxAngleBreak

Maximum acceptable angle break between 2 consecutive segments of the polyline for these segments to be considered as a candidate position for labels.

maxAngleVariation

public double maxAngleVariation

Maximum acceptable CUMULATIVE angle breaks along several segments of the polyline for these segments to be considered as a candidate position for labels.

candidateThreshold

public int candidateThreshold

Internal parameter used to generate candidate labels on a path. The higher, the better the label placement but also the slower.

switchOrientationAngle

public double switchOrientationAngle

This angle (measured from the vertical, counter clockwise) gives the direction at which labels change their orientation on the baseline to remain readable. Default is 0.

Constructor Detail

IlvMapLineLabel.ParameterRecord

public IlvMapLineLabel.ParameterRecord()

Creates a new ParameterRecord.