Rogue Wave Views
Maps Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Member Functions | Static Public Member Functions
IlvScaleVisibilityFilter Class Reference

Controls the visibility of a layer according to the scale. More...

#include <ilviews/maps/scalefilter.h>

Inheritance diagram for IlvScaleVisibilityFilter:
IlvLayerVisibilityFilter

Public Member Functions

 IlvScaleVisibilityFilter (IlDouble minScale, IlDouble maxScale)
 Initializes an IlvScaleVisibilityFilter object. More...
 
IlDouble getMaxScale () const
 Returns the maximum scale at which the layer is visible. More...
 
IlDouble getMinScale () const
 Returns the minimum scale at which the layer is visible. More...
 
void setMaxScale (IlDouble maxScale)
 Sets the maximum scale at which the layer is visible. More...
 
void setMinScale (IlDouble minScale)
 Sets the minimum scale at which the layer is visible. More...
 

Static Public Member Functions

static IlDouble NoLimit ()
 The value meaning that a scale limit is undefined.
 

Detailed Description

Controls the visibility of a layer according to the scale.

Library: ilvmaps

A scale visibility filter allows a layer to be visible between a minimum scale and a maximum scale. Both limit scales can have the IlvScaleVisibilityFilter::NoLimit() 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).

Constructor & Destructor Documentation

IlvScaleVisibilityFilter::IlvScaleVisibilityFilter ( IlDouble  minScale,
IlDouble  maxScale 
)

Initializes an IlvScaleVisibilityFilter object.

The layer will be visible if its scale is between minScale and maxScale.

Parameters
minScaleThe minimum scale at which the layer will be visible (for instance, 1/100000). If no minimum scale is required, you must pass the value IlvScaleVisibilityFilter::NoLimit().
maxScaleThe maximum scale at which the layer will be visible (for instance, 1/20000). If no maximum scale is required, you must pass the value IlvScaleVisibilityFilter::NoLimit().
See also
IlvScaleVisibilityFilter::NoLimit().

Member Function Documentation

IlDouble IlvScaleVisibilityFilter::getMaxScale ( ) const

Returns the maximum scale at which the layer is visible.

Returns
The maximum scale.
IlDouble IlvScaleVisibilityFilter::getMinScale ( ) const

Returns the minimum scale at which the layer is visible.

Returns
The minimum scale.
void IlvScaleVisibilityFilter::setMaxScale ( IlDouble  maxScale)

Sets the maximum scale at which the layer is visible.

Parameters
maxScaleThe maximum scale.
void IlvScaleVisibilityFilter::setMinScale ( IlDouble  minScale)

Sets the minimum scale at which the layer is visible.

Parameters
minScaleThe minimum scale.

© Copyright 2016, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.