ilog.views.maps.beans

Class IlvMapScaleComputation

java.lang.Object

ilog.views.maps.beans.IlvMapScaleComputation

public class IlvMapScaleComputation
extends Object

This class computes the map scale in two different ways, depending on the useLocalScale parameter.

• If useLocalScale is false, the scale will be the same for every area of the map displayed. The computation uses, in this case, the equivalent unit defined in the manager coordinate system.
• If useLocalScale is true, the computation involves finding two points on the view visible area and computing their distance in meters with a IlvGeodeticComputation.
  The reference points can be either at the top, center or bottom of that area, and will be horizontally centered on the area.

Since:

JViews 8.5

Constructor Summary

Constructors

Constructor and Description
IlvMapScaleComputation() Creates a new IlvMapScaleComputation.
IlvMapScaleComputation(int verticalReference, boolean useLocalScale) Creates a new IlvMapScaleComputation.

Method Summary

Modifier and Type	Method and Description
int	getVerticalReference() Returns the vertical location of the reference points.
boolean	isUseLocalScale() Indicates whether the scale should be adapted to the visible view area.
void	setUseLocalScale(boolean useLocalScale) Indicates whether the scale should be adapted to the visible view area.
void	setVerticalReference(int verticalReference) Changes the vertical location of the reference points.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvMapScaleComputation

public IlvMapScaleComputation()

Creates a new IlvMapScaleComputation. By default, it does not use local scale computation. The scale is computed through the coordinate system equivalent unit.

IlvMapScaleComputation

public IlvMapScaleComputation(int verticalReference,
                              boolean useLocalScale)

Creates a new IlvMapScaleComputation.

Parameters:

verticalReference - Indicates where the reference points are placed. This parameter should be either:

• IlvConstants.TOP,
• IlvConstants.CENTER,
• or IlvConstants.BOTTOM

useLocalScale - true indicates that the scale can change according to the visible view area.

Method Detail

getVerticalReference

public final int getVerticalReference()

Returns the vertical location of the reference points.

Returns:

The verticalReference

• IlvConstants.TOP,
• IlvConstants.CENTER,
• or IlvConstants.BOTTOM

setVerticalReference

public final void setVerticalReference(int verticalReference)

Changes the vertical location of the reference points.

Parameters:

verticalReference - The vertical location of reference points

• IlvConstants.TOP,
• IlvConstants.CENTER,
• or IlvConstants.BOTTOM

isUseLocalScale

public final boolean isUseLocalScale()

Indicates whether the scale should be adapted to the visible view area.

Returns:

true if the scale is adapted to the visible view area.

setUseLocalScale

public final void setUseLocalScale(boolean useLocalScale)

Indicates whether the scale should be adapted to the visible view area.

Parameters:

useLocalScale - code>true if the scale must be adapted