|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@UML(identifier="CV_GridEnvelope", specification=ISO_19123) public interface GridEnvelope
Provides the grid coordinate values for the diametrically opposed corners of the grid.
Remark that both corners are inclusive. Thus the number of elements in the direction of the first
axis is getHigh(0) - getLow(0) + 1
.
This is the opposite of Java2D usage where maximal values in Rectangle
(as computed by
getMaxX() and getMaxY()) are
exclusive.
Envelope
Method Summary | |
---|---|
int |
getDimension()
Returns the number of dimensions. |
GridCoordinates |
getHigh()
Returns the maximal coordinate values for all grid points within the grid. |
int |
getHigh(int dimension)
Returns the valid maximum inclusive grid coordinate along the specified dimension. |
GridCoordinates |
getLow()
Returns the minimal coordinate values for all grid points within the grid. |
int |
getLow(int dimension)
Returns the valid minimum inclusive grid coordinate along the specified dimension. |
int |
getSpan(int dimension)
Returns the number of integer grid coordinates along the specified dimension. |
Method Detail |
---|
@Extension int getDimension()
@UML(identifier="low", obligation=MANDATORY, specification=ISO_19123) GridCoordinates getLow()
@UML(identifier="high", obligation=MANDATORY, specification=ISO_19123) GridCoordinates getHigh()
@Extension int getLow(int dimension) throws IndexOutOfBoundsException
GridCoordinates
object:
getLow().getCoordinateValue(dimension)
dimension
- The dimension for which to obtain the coordinate value.
IndexOutOfBoundsException
- If the given index is negative or is equals or greater
than the grid dimension.Rectangle.x
,
Rectangle.y
@Extension int getHigh(int dimension) throws IndexOutOfBoundsException
GridCoordinates
object:
getHigh().getCoordinateValue(dimension)
dimension
- The dimension for which to obtain the coordinate value.
IndexOutOfBoundsException
- If the given index is negative or is equals or greater
than the grid dimension.@Extension int getSpan(int dimension) throws IndexOutOfBoundsException
getHigh(dimension) - getLow(dimension) + 1
dimension
- The dimension for which to obtain the coordinate value.
IndexOutOfBoundsException
- If the given index is negative or is equals or greater
than the grid dimension.Rectangle.width
,
Rectangle.height
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |