org.gvsig.fmap.mapcontext.rendering.symbols

Interface CartographicSupport

All Known Subinterfaces:

ComplexLabelClass, IAttrInTableLabelingStrategy, IChartSymbol, IFillSymbol, ILabelClass, ILineSymbol, IMarkerFillSymbol, IMarkerSymbol, IMultiChartSymbol, IMultiLayerFillSymbol, IMultiLayerLineSymbol, IMultiLayerMarkerSymbol, IPictureFillSymbol, IPictureLineSymbol, IPictureMarkerSymbol, ISimpleFillSymbol, ISimpleLineSymbol, ISimpleMarkerSymbol

All Known Implementing Classes:

AbstractFillSymbol, AbstractLineSymbol, AbstractMarkerSymbol, AbstractSymbol, ArrowMarkerSymbol, AttrInTableLabelingStrategy, CharacterMarkerSymbol, ChartSymbol, DefaultComplexLabelClass, GeneralLabelingStrategy, LabelClass, LinkedChartSymbol, MarkerFillSymbol, MultiLayerFillSymbol, MultiLayerLineSymbol, MultiLayerMarkerSymbol, MultiShapeSymbol, PictureFillSymbol, PictureLineSymbol, PictureMarkerSymbol, SimpleFillSymbol, SimpleLineStyle, SimpleLineSymbol, SimpleMarkerSymbol, SimpleTextSymbol, SmartTextSymbol, SmartTextSymbolLabelClass, WarningSymbol

public interface CartographicSupport

This interface enables Cartographic support for those graphical elements that require additional runtime information rather than the feature itself geometric definitions.

It allows to realworld's measure units dimensioning.

It also supplies a toolkit to perform operations with centralized static methods.

See Also:

inner class' methods

Field Summary

Fields

Modifier and Type	Field and Description
static int	PAPER
static int	WORLD

Method Summary

Methods

Modifier and Type	Method and Description
double	getCartographicSize(ViewPort viewPort, double dpi, Geometry geom) Gets the size (in pixels) of the cartographic element according to the current rendering context (output dpi, map scale, map units) and the symbol cartgraphic settings (unit, size, and unit reference system).
int	getReferenceSystem() Returns the Reference System used to draw the elements of the image.
int	getUnit() Returns the unit used to express measures.
void	setCartographicSize(double cartographicSize, Geometry geom) Sets the size of the cartographic element in pixels.
void	setReferenceSystem(int referenceSystem) Sets the Reference System that defines how this units have to be handled.
void	setUnit(int unitIndex) Defines the unit used to express measures.
double	toCartographicSize(ViewPort viewPort, double dpi, Geometry geom) Computes and sets the size (in pixels) of the cartographic element according to the current rendering context (output dpi, map scale, map units) and the symbol cartgraphic settings (unit, size, and unit reference system).

Field Detail

WORLD

static final int WORLD

See Also:

Constant Field Values

PAPER

static final int PAPER

See Also:

Constant Field Values

Method Detail

setUnit

void setUnit(int unitIndex)

Defines the unit used to express measures. It is the position of the unit in the MapContext.NAMES array.

Parameters:

unitIndex, - the index of the unit in the MapContext.NAMES array

getUnit

int getUnit()

Returns the unit used to express measures. It is the position of the unit in the MapContext.NAMES array.

getReferenceSystem

int getReferenceSystem()

Returns the Reference System used to draw the elements of the image.

The elements have to be scaled to pixel when the image is bein drawn in order to compose the map. The elements of the map may define its size in other units than pixel.

CartographicSupport enables the elements to define the size in measure units but these units may refer to different reference system. Two kinds of Reference Systems are allowed in this context: CartographicSupport.WORLD, and CartographicSupport.PAPER.

Depending on which Reference System is used the unit used by this element refers to distances in the real world (then they are map's CRS-dependant) or screen or printer output (then they are output DPI-dependant)

In case the unit used is pixel then the reference system does not have any effect since the source unit is the same than the target unit.

Returns:

setReferenceSystem

void setReferenceSystem(int referenceSystem)

Sets the Reference System that defines how this units have to be handled. Possible values are:

1. CartographySupport.WORLD: Defines that the unit values refer to distances in the world. So, the size of the element displayed depends directly on the scale and CRS used by the map. The size of the elements defined to use CartographicSupport.WORLD will match exactly to their actual size in the real world.
2. CartographySupport.PAPER: Defines that the unit values refer to the length that the element will have regardless where it appears. If ReferenceSystem is CartographySupport.PAPER, and the length is (e.g.) millimeters the element will be displayed with the same amount of millimeters of length whether in the screen or the printer (screen DPI and printer DPI must be correctly configured).

toCartographicSize

double toCartographicSize(ViewPort viewPort,
                        double dpi,
                        Geometry geom)

Computes and sets the size (in pixels) of the cartographic element according to the current rendering context (output dpi, map scale, map units) and the symbol cartgraphic settings (unit, size, and unit reference system).

Parameters:

viewPort, - the ViewPort containing the symbol.

dpi, - current output dpi (screen or printer)

shp, - used only for MultiShapeSymbols in order to discriminate the internal symbol to be applied

Returns:

a double containing the previous defined size

setCartographicSize

void setCartographicSize(double cartographicSize,
                       Geometry geom)

Sets the size of the cartographic element in pixels.

Parameters:

cartographicSize, - the size in pixels of the element

shp, - used only for MultiShapeSymbols in order to discriminate the internal symbol to be applied

getCartographicSize

double getCartographicSize(ViewPort viewPort,
                         double dpi,
                         Geometry geom)

Gets the size (in pixels) of the cartographic element according to the current rendering context (output dpi, map scale, map units) and the symbol cartgraphic settings (unit, size, and unit reference system).

Parameters:

viewPort -

dpi -

shp -

Returns:

double containing the size in [screen/printer] pixels for the current symbol