com.luciad.view.map.multilevelgrid

LuciadLightspeedInterface ILcdMultilevelGridCoordinate

All Known Subinterfaces:

ILcdEditableMultilevelGridCoordinate

All Known Implementing Classes:

TLcdMultilevelGridCoordinate

public interface ILcdMultilevelGridCoordinate

A multilevel grid coordinate corresponds to an area of the ILcdMultilevelGrid with regard to which it is defined. A multilevel grid coordinate will specify a small or large area, depending on the number of levels to which the coordinate is specified and the grid with regard to which the coordinate is specified. The multilevel grid coordinate is expressed as a number of integer coordinates per level, usually two, one for each axis. When comparing multilevel grid coordinates defined with regard to the same multilevel grid, the multilevel grid coordinate with the least number of levels specified will always designate the larger area.

Since:

7.0

Method Summary

Modifier and Type	Method and Description
ILcdEditableMultilevelGridCoordinate	cloneAsEditableMultilevelCoordinate() Returns a copy of this object that can be edited.
int	getCoordinate(int aLevel, int aAxis) Returns the value of a coordinate at a given level, for a given axis.
int	getCoordinateLevelCount() Returns how many levels of this coordinate are taken into account.

Method Detail

getCoordinate

int getCoordinate(int aLevel,
                  int aAxis)

Returns the value of a coordinate at a given level, for a given axis.

Parameters:

aLevel - the level to retrieve the coordinate for. The level should be smaller than the count returned by getCoordinateLevelCount(). Coordinates at higher levels should not be taken into account.

aAxis - the axis to retrieve the coordinate for, either ILcdMultilevelGrid.X_AXIS or ILcdMultilevelGrid.Y_AXIS.

Returns:

the value of a coordinate at a given level, for a given axis. This value is always strictly smaller than the number of subdivisions for the given level and axis of the multilevel grid with regard to which this coordinate is defined.

getCoordinateLevelCount

int getCoordinateLevelCount()

Returns how many levels of this coordinate are taken into account. This means that all levels of this coordinate are taken into account up to, but not including, the returned value. Note that this is not necessarily the total number of levels which could be specified for this coordinate. The method getCoordinate(int, int) should only be called for levels strictly smaller than the count returned by this method.

Returns:

the number of levels taken into account for this multilevel grid coordinate.

cloneAsEditableMultilevelCoordinate

ILcdEditableMultilevelGridCoordinate cloneAsEditableMultilevelCoordinate()

Returns a copy of this object that can be edited. Changing the coordinates or number of specified levels of the copy should not change the coordinates of the original.

Returns:

a copy of this object that can be edited.