rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Maps Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvMapScale Class Reference

A scale object that displays the scale of a view. More...

#include <ilviews/maps/gui/scale.h>

Inheritance diagram for IlvMapScale:
IlvSimpleGraphic IlvGraphic

List of all members.

Public Member Functions

 IlvMapScale (IlvDisplay *display, const IlvRect &rect, IlvMapScaleTextMode mode=IlvMapScaleThreeLabels, IlvGraphic *bar=0, IlvDim margin=5, IlvPalette *palette=0)
 Constructor.
IlDouble getFarLimit ()
 Retrieves the far limit.
const IlvUnitConvertergetFarUnitConverter () const
 Retrieves the far unit converter.
const IlvGraphicgetGraphic ()
 Retrieves the scale bar IlvGraphic.
IlvDim getMargin ()
 Retrieves the margin.
const IlvUnitConvertergetNearUnitConverter () const
 Retrieves the near unit converter.
IlvMapScaleTextMode getScaleTextMode ()
 Retrieves the text mode.
IlvDim getSpacing ()
 Retrieves the spacing between the text and the scale bar.
void setFarLimit (IlDouble limit)
 Sets the far limit.
void setFarUnitConverter (IlvUnitConverter *farConv)
 Sets the far unit converter.
void setGraphic (IlvGraphic *graphic)
 Sets a new IlvGraphic to represent the scale bar part of the scale.
void setMargin (IlvDim margin)
 Sets the margin.
void setNearUnitConverter (IlvUnitConverter *nearConv)
 Sets the near unit converter.
void setScaleTextMode (IlvMapScaleTextMode mode)
 Sets the label displaying mode.
void setSpacing (IlvDim spacing)
 Sets the spacing (in pixels) between the text and the scale bar.
void setView (IlvView *view)
 Attaches a view to the scale.

Detailed Description

A scale object that displays the scale of a view.

Library: ilvmaps

This component works only if the manager of the target view has an IlvMapInfo property attached. This property defines the coordinate system of the manager and its units.


Constructor & Destructor Documentation

IlvMapScale::IlvMapScale ( IlvDisplay display,
const IlvRect rect,
IlvMapScaleTextMode  mode = IlvMapScaleThreeLabels,
IlvGraphic bar = 0,
IlvDim  margin = 5,
IlvPalette palette = 0 
)

Constructor.

Parameters:
display The display.
rect The initial size and position.
barText Specifies if a unique label (barText set to IlFalse) or a set of labels (barText set to IlTrue) is to be drawn.
bar The IlvGraphic representing the bar. If no bar is specified, the scale will automatically create a IlvMapDefaultScaleBar. If an IlvGraphic is provided, it is then owned by the IlvMapScale.
margin The margin.
palette The IlvPalette.

Member Function Documentation

IlDouble IlvMapScale::getFarLimit (  ) 

Retrieves the far limit.

Returns the switch limit between a text display of the scale in a small unit (for instance, meters) and a text display in a large unit (for instance, kilometers).

Returns:
The upper limit.
const IlvUnitConverter* IlvMapScale::getFarUnitConverter (  )  const

Retrieves the far unit converter.

Returns:
The far unit converter. The scale is still owner of the returned converter.
See also:
setFarUnitConverter
const IlvGraphic* IlvMapScale::getGraphic (  ) 

Retrieves the scale bar IlvGraphic.

Returns:
The scale bar IlvGraphic. This IlvGraphic is still owned by the scale bar.
IlvDim IlvMapScale::getMargin (  ) 

Retrieves the margin.

Returns:
The minimum space between the scale bar and the border of the scale.
const IlvUnitConverter* IlvMapScale::getNearUnitConverter (  )  const

Retrieves the near unit converter.

Returns:
The near unit converter. The scale is still owner of the returned converter.
See also:
setNearUnitConverter
IlvMapScaleTextMode IlvMapScale::getScaleTextMode (  ) 

Retrieves the text mode.

Returns:
The text mode.
IlvDim IlvMapScale::getSpacing (  ) 

Retrieves the spacing between the text and the scale bar.

Returns:
The space between the tex and the scale bar.
void IlvMapScale::setFarLimit ( IlDouble  limit  ) 

Sets the far limit.

The far limit is the switch limit between a text display of the scale in a small unit (for instance, meters) and a text display in a large unit (for instance, kilometers). If the map distance represented by the scale bar exceeds the limit, expressed in the small unit system, then the scale will be displayed in the large unit.

Parameters:
limit The upper limit.
See also:
setNearUnitConverter
setFarUnitConverter
void IlvMapScale::setFarUnitConverter ( IlvUnitConverter farConv  ) 

Sets the far unit converter.

The far unit converter is the converter that specifies the unit to display the length of the scale bar for small scales.

Parameters:
far The far unit converter. The scale becomes owner of the converter. This converter must be allocated in the heap memory.
void IlvMapScale::setGraphic ( IlvGraphic graphic  ) 

Sets a new IlvGraphic to represent the scale bar part of the scale.

Parameters:
graphic The new IlvGraphic. This graphic is now owned by the IlvMapScale. The previous IlvGraphic (if any) is deleted.
void IlvMapScale::setMargin ( IlvDim  margin  ) 

Sets the margin.

Parameters:
margin The minimum space between the scale bar and the border of the scale.
void IlvMapScale::setNearUnitConverter ( IlvUnitConverter nearConv  ) 

Sets the near unit converter.

The near unit converter is the converter that specifies the unit to display the length of the scale bar for large scales.

Parameters:
near The near unit converter. The scale becomes owner of the converter. This converter must be allocated in the heap memory.
void IlvMapScale::setScaleTextMode ( IlvMapScaleTextMode  mode  ) 

Sets the label displaying mode.

Parameters:
mode The text displaying style.
void IlvMapScale::setSpacing ( IlvDim  spacing  ) 

Sets the spacing (in pixels) between the text and the scale bar.

Parameters:
spacing The space between the tex and the scale bar.
void IlvMapScale::setView ( IlvView view  ) 

Attaches a view to the scale.

Parameters:
view The IlvView whose manager defines the coordinate system.
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

© Copyright 2012, 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.