ilog.views.maps

Class IlvScaleVisibilityFilter

java.lang.Object

ilog.views.IlvLayerVisibilityFilter

ilog.views.IlvZoomFactorVisibilityFilter

ilog.views.maps.IlvScaleVisibilityFilter

All Implemented Interfaces:

IlvPersistentObject, Serializable

public class IlvScaleVisibilityFilter
extends IlvZoomFactorVisibilityFilter

Controls the visibility of a layer according to its scale. A scale visibility filter allows a layer to be visible between a minimum scale and a maximum scale. Both limit scales can have the NO_LIMIT value if the layer should be visible for any scale smaller than a minimum scale (this could be the case for layers containing low-resolution map data), or conversely, for any scale larger than a maximum scale (this could be the case for layers containing high-resolution map data).

Since:

JViews 3.0

See Also:

Serialized Form

Field Summary

Fields inherited from class ilog.views.IlvZoomFactorVisibilityFilter

NO_LIMIT

Constructor Summary

Constructors

Constructor and Description
IlvScaleVisibilityFilter(double minScale, double maxScale, IlvLinearUnit managerUnit) Initializes an IlvScaleVisibilityFilter object.
IlvScaleVisibilityFilter(IlvInputStream stream) Initializes an IlvScaleVisibilityFilter from an IlvInputStream.

Method Summary

Modifier and Type	Method and Description
double	getMaxScale() Returns the maximum scale.
double	getMinScale() Returns the minimum scale.
IlvLinearUnit	getUnit() Returns the linear unit.
boolean	isVisible(IlvManagerLayer layer, IlvManagerView view) Returns true if the scale of the layer in the argument view is between the maximum and the minimum scales.
void	setMaxScale(double maxScale) Sets the maximal scale at which the filtered layer is visible.
void	setMinScale(double minScale) Sets the minimal scale at which the filtered layer is visible.
void	write(IlvOutputStream stream) Writes the filter to an IlvOutputStream.

Methods inherited from class ilog.views.IlvZoomFactorVisibilityFilter

getMaxZoomFactor, getMinZoomFactor, isPersistent, setMaxZoomFactor, setMinZoomFactor, setPersistent

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvScaleVisibilityFilter

public IlvScaleVisibilityFilter(double minScale,
                                double maxScale,
                                IlvLinearUnit managerUnit)

Initializes an IlvScaleVisibilityFilter object. The layer will be visible if its scale is between minScale and maxScale.

Parameters:

minScale - The minimum scale at which the layer will be visible (for instance, 1/100000). If no minimum scale is required, you must pass the value NO_LIMIT.

maxScale - The maximum scale at which the layer will be visible (for instance, 1/20000). If no maximum scale is required, you must pass the value NO_LIMIT.

managerUnit - The unit of the manager. Specifies the equivalence between manager coordinates and meters.

Since:

JViews 5.0

See Also:

IlvZoomFactorVisibilityFilter.NO_LIMIT

IlvScaleVisibilityFilter

public IlvScaleVisibilityFilter(IlvInputStream stream)
                         throws IlvReadFileException

Initializes an IlvScaleVisibilityFilter from an IlvInputStream.

Throws:

IlvReadFileException

Method Detail

isVisible

public boolean isVisible(IlvManagerLayer layer,
                         IlvManagerView view)

Returns true if the scale of the layer in the argument view is between the maximum and the minimum scales.

Overrides:

isVisible in class IlvZoomFactorVisibilityFilter

write

public void write(IlvOutputStream stream)
           throws IOException

Writes the filter to an IlvOutputStream.

Specified by:

write in interface IlvPersistentObject

Overrides:

write in class IlvZoomFactorVisibilityFilter

Parameters:

stream - The output stream.

Throws:

IOException - standard IO error.

getUnit

public IlvLinearUnit getUnit()

Returns the linear unit.

Since:

JViews 6.0

getMinScale

public double getMinScale()

Returns the minimum scale.

setMinScale

public void setMinScale(double minScale)

Sets the minimal scale at which the filtered layer is visible.

Parameters:

minScale - The minimum scale

getMaxScale

public double getMaxScale()

Returns the maximum scale.

setMaxScale

public void setMaxScale(double maxScale)

Sets the maximal scale at which the filtered layer is visible.

Parameters:

maxScale - The maximum scale