Viewport (vtm 0.11.0 API)

java.lang.Object
- org.oscim.map.Viewport

Direct Known Subclasses:

GLViewport, ViewController
```
public class Viewport
extends java.lang.Object
```
The Viewport class contains a MapPosition and the projection matrices. It provides functions to modify the MapPosition and translate between map and screen coordinates.
Public methods are thread safe.

Field Summary

Fields
Modifier and Type	Field and Description
`static float`	`MAX_TILT`
`static int`	`MAX_ZOOM_LEVEL`
`protected float`	`mHeight` Height and width in pixels
`static float`	`MIN_TILT`
`static int`	`MIN_ZOOM_LEVEL`
`protected float`	`mMaxBearing`
`protected float`	`mMaxRoll`
`protected double`	`mMaxScale`
`protected float`	`mMaxTilt`
`protected double`	`mMaxX`
`protected double`	`mMaxY`
`protected float`	`mMinBearing`
`protected float`	`mMinRoll`
`protected double`	`mMinScale`
`protected float`	`mMinTilt`
`protected double`	`mMinX`
`protected double`	`mMinY`
`protected Point`	`mMovePoint`
`protected MapPosition`	`mPos`
`protected GLMatrix`	`mProjMatrix`
`protected GLMatrix`	`mProjMatrixInverse`
`protected GLMatrix`	`mProjMatrixUnscaled`
`protected GLMatrix`	`mRotationMatrix`
`protected GLMatrix`	`mTmpMatrix`
`protected float[]`	`mu`
`protected GLMatrix`	`mUnprojMatrix`
`protected float[]`	`mv`
`protected float[]`	`mViewCoords`
`protected GLMatrix`	`mViewMatrix`
`protected GLMatrix`	`mViewProjMatrix`
`protected float`	`mWidth` Height and width in pixels
`static float`	`VIEW_DISTANCE`
`static float`	`VIEW_FAR`
`static float`	`VIEW_NEAR`
`static float`	`VIEW_SCALE` scale map plane at VIEW_DISTANCE to near plane

Constructor Summary

Constructors
Constructor and Description

Viewport()

Constructors
Constructor and Description
`Viewport()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`copy(Viewport viewport)`
`void`	`fromScreenPoint(double x, double y, Point out)` Get the map position for x,y in screen coordinates.
`GeoPoint`	`fromScreenPoint(float x, float y)` Get the GeoPoint for x,y in screen coordinates.
`Box`	`getBBox(Box box, int expand)` Get the minimal axis-aligned BoundingBox that encloses the visible part of the map.
`void`	`getMapExtents(float[] box, float add)` Get the inverse projection of the viewport, i.e.
`BoundingBox`	`getMapLimit()`
`boolean`	`getMapPosition(MapPosition pos)` Get the current MapPosition.
`float`	`getMaxBearing()`
`float`	`getMaxRoll()`
`double`	`getMaxScale()`
`float`	`getMaxTilt()`
`double`	`getMaxX()`
`double`	`getMaxY()`
`int`	`getMaxZoomLevel()`
`float`	`getMinBearing()`
`float`	`getMinRoll()`
`double`	`getMinScale()`
`float`	`getMinTilt()`
`double`	`getMinX()`
`double`	`getMinY()`
`int`	`getMinZoomLevel()`
`boolean`	`limitPosition(MapPosition pos)`
`double`	`limitScale(double scale)`
`float`	`limitTilt(float tilt)`
`void`	`setMapLimit(BoundingBox mapLimit)`
`void`	`setMapLimit(double minX, double minY, double maxX, double maxY)`
`void`	`setMaxBearing(float maxBearing)`
`void`	`setMaxRoll(float maxRoll)`
`void`	`setMaxScale(double maxScale)`
`void`	`setMaxTilt(float maxTilt)`
`void`	`setMaxX(double maxX)`
`void`	`setMaxY(double maxY)`
`void`	`setMaxZoomLevel(int maxZoomLevel)`
`void`	`setMinBearing(float minBearing)`
`void`	`setMinRoll(float minRoll)`
`void`	`setMinScale(double minScale)`
`void`	`setMinTilt(float minTilt)`
`void`	`setMinX(double minX)`
`void`	`setMinY(double minY)`
`void`	`setMinZoomLevel(int minZoomLevel)`
`void`	`toScreenPoint(double x, double y, boolean relativeToCenter, Point out)` Get the screen pixel for map coordinates
`void`	`toScreenPoint(double x, double y, Point out)` Get the screen pixel for map coordinates (relative to center)
`void`	`toScreenPoint(GeoPoint geoPoint, boolean relativeToCenter, Point out)` Get the screen pixel for a GeoPoint
`void`	`toScreenPoint(GeoPoint geoPoint, Point out)` Get the screen pixel for a GeoPoint (relative to center)
`protected void`	`unproject(float x, float y, float[] coords, int position)`
`protected void`	`unprojectScreen(double x, double y, float[] out)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MAX_ZOOM_LEVEL
```
public static final int MAX_ZOOM_LEVEL
```
See Also:

Constant Field Values

MIN_ZOOM_LEVEL
```
public static final int MIN_ZOOM_LEVEL
```
See Also:

Constant Field Values

MIN_TILT
```
public static final float MIN_TILT
```
See Also:

Constant Field Values

MAX_TILT
```
public static final float MAX_TILT
```
See Also:

Constant Field Values

mMaxScale
```
protected double mMaxScale
```

mMinScale
```
protected double mMinScale
```

mMinTilt
```
protected float mMinTilt
```

mMaxTilt
```
protected float mMaxTilt
```

mMinBearing
```
protected float mMinBearing
```

mMaxBearing
```
protected float mMaxBearing
```

mMinRoll
```
protected float mMinRoll
```

mMaxRoll
```
protected float mMaxRoll
```

mMinX
```
protected double mMinX
```

mMaxX
```
protected double mMaxX
```

mMinY
```
protected double mMinY
```

mMaxY
```
protected double mMaxY
```

mPos
```
protected final MapPosition mPos
```

mProjMatrix
```
protected final GLMatrix mProjMatrix
```

mProjMatrixUnscaled

protected final GLMatrix mProjMatrixUnscaled

mProjMatrixInverse

protected final GLMatrix mProjMatrixInverse

mRotationMatrix

protected final GLMatrix mRotationMatrix

mViewMatrix
```
protected final GLMatrix mViewMatrix
```

mViewProjMatrix

protected final GLMatrix mViewProjMatrix

mUnprojMatrix
```
protected final GLMatrix mUnprojMatrix
```

mTmpMatrix
```
protected final GLMatrix mTmpMatrix
```

mMovePoint
```
protected final Point mMovePoint
```

mv
```
protected final float[] mv
```

mu
```
protected final float[] mu
```

mViewCoords
```
protected final float[] mViewCoords
```

mHeight
```
protected float mHeight
```
Height and width in pixels

mWidth
```
protected float mWidth
```
Height and width in pixels

VIEW_DISTANCE
```
public static final float VIEW_DISTANCE
```
See Also:

Constant Field Values

VIEW_NEAR
```
public static final float VIEW_NEAR
```
See Also:

Constant Field Values

VIEW_FAR
```
public static final float VIEW_FAR
```
See Also:

Constant Field Values

VIEW_SCALE
```
public static final float VIEW_SCALE
```
scale map plane at VIEW_DISTANCE to near plane

See Also:

Constant Field Values

Constructor Detail
- Viewport
```
public Viewport()
```

Method Detail

limitScale

public double limitScale(double scale)

limitTilt
```
public float limitTilt(float tilt)
```

limitPosition

public boolean limitPosition(MapPosition pos)

getMapPosition
```
public boolean getMapPosition(MapPosition pos)
```
Get the current MapPosition.

Parameters:

pos - MapPosition to be updated.

Returns:

true iff current position is different from passed position.

getMapExtents
```
public void getMapExtents(float[] box,
                          float add)
```
Get the inverse projection of the viewport, i.e. the coordinates with z==0 that will be projected exactly to screen corners by current view-projection-matrix.

Parameters:

box - float[8] will be set.

add - increase extents of box

unproject

protected void unproject(float x,
                         float y,
                         float[] coords,
                         int position)

getBBox
```
public Box getBBox(Box box,
                   int expand)
```
Get the minimal axis-aligned BoundingBox that encloses the visible part of the map. Sets box to map coordinates: xmin,ymin,xmax,ymax

fromScreenPoint
```
public GeoPoint fromScreenPoint(float x,
                                float y)
```
Get the GeoPoint for x,y in screen coordinates.

Parameters:

x - screen coordinate

y - screen coordinate

Returns:

the corresponding GeoPoint

unprojectScreen

protected void unprojectScreen(double x,
                               double y,
                               float[] out)

fromScreenPoint

public void fromScreenPoint(double x,
                            double y,
                            Point out)

Get the map position for x,y in screen coordinates.

Parameters:: x - screen coordinate; y - screen coordinate

toScreenPoint
```
public void toScreenPoint(GeoPoint geoPoint,
                          Point out)
```
Get the screen pixel for a GeoPoint (relative to center)

Parameters:

geoPoint - the GeoPoint

out - Point projected to screen pixel relative to center

toScreenPoint

public void toScreenPoint(GeoPoint geoPoint,
                          boolean relativeToCenter,
                          Point out)

Get the screen pixel for a GeoPoint

Parameters:: geoPoint - the GeoPoint; out - Point projected to screen pixel

toScreenPoint
```
public void toScreenPoint(double x,
                          double y,
                          Point out)
```
Get the screen pixel for map coordinates (relative to center)

Parameters:

out - Point projected to screen coordinate relative to center

toScreenPoint

public void toScreenPoint(double x,
                          double y,
                          boolean relativeToCenter,
                          Point out)

Get the screen pixel for map coordinates

Parameters:: out - Point projected to screen coordinate

copy

protected boolean copy(Viewport viewport)

getMaxScale
```
public double getMaxScale()
```

setMaxScale

public void setMaxScale(double maxScale)

getMinScale
```
public double getMinScale()
```

setMinScale

public void setMinScale(double minScale)

getMaxZoomLevel
```
public int getMaxZoomLevel()
```

setMaxZoomLevel

public void setMaxZoomLevel(int maxZoomLevel)

getMinZoomLevel
```
public int getMinZoomLevel()
```

setMinZoomLevel

public void setMinZoomLevel(int minZoomLevel)

getMaxTilt
```
public float getMaxTilt()
```

setMaxTilt

public void setMaxTilt(float maxTilt)

getMinTilt
```
public float getMinTilt()
```

setMinTilt

public void setMinTilt(float minTilt)

getMaxBearing
```
public float getMaxBearing()
```

setMaxBearing

public void setMaxBearing(float maxBearing)

getMinBearing
```
public float getMinBearing()
```

setMinBearing

public void setMinBearing(float minBearing)

getMaxRoll
```
public float getMaxRoll()
```

setMaxRoll

public void setMaxRoll(float maxRoll)

getMinRoll
```
public float getMinRoll()
```

setMinRoll

public void setMinRoll(float minRoll)

getMaxX
```
public double getMaxX()
```

setMaxX
```
public void setMaxX(double maxX)
```

getMinX
```
public double getMinX()
```

setMinX
```
public void setMinX(double minX)
```

getMaxY
```
public double getMaxY()
```

setMaxY
```
public void setMaxY(double maxY)
```

getMinY
```
public double getMinY()
```

setMinY
```
public void setMinY(double minY)
```

setMapLimit

public void setMapLimit(double minX,
                        double minY,
                        double maxX,
                        double maxY)

getMapLimit
```
public BoundingBox getMapLimit()
```

setMapLimit

public void setMapLimit(BoundingBox mapLimit)

Class Viewport

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MAX_ZOOM_LEVEL

MIN_ZOOM_LEVEL

MIN_TILT

MAX_TILT

mMaxScale

mMinScale

mMinTilt

mMaxTilt

mMinBearing

mMaxBearing

mMinRoll

mMaxRoll

mMinX

mMaxX

mMinY

mMaxY

mPos

mProjMatrix

mProjMatrixUnscaled

mProjMatrixInverse

mRotationMatrix

mViewMatrix

mViewProjMatrix

mUnprojMatrix

mTmpMatrix

mMovePoint

mv

mu

mViewCoords

mHeight

mWidth

VIEW_DISTANCE

VIEW_NEAR

VIEW_FAR

VIEW_SCALE

Constructor Detail

Viewport

Method Detail

limitScale

limitTilt

limitPosition

getMapPosition

getMapExtents

unproject

getBBox

fromScreenPoint

unprojectScreen

fromScreenPoint

toScreenPoint

toScreenPoint

toScreenPoint

toScreenPoint

copy

getMaxScale

setMaxScale

getMinScale

setMinScale

getMaxZoomLevel

setMaxZoomLevel

getMinZoomLevel

setMinZoomLevel

getMaxTilt

setMaxTilt

getMinTilt

setMinTilt

getMaxBearing

setMaxBearing

getMinBearing

setMinBearing

getMaxRoll

setMaxRoll

getMinRoll

setMinRoll

getMaxX