ViewPort

java.lang.Object
- org.gvsig.fmap.mapcontext.ViewPort

All Implemented Interfaces:

Cloneable, Persistent
```
public class ViewPort
extends Object
implements Persistent, Cloneable
```
ViewPort class represents the logic needed to transform a rectangular area of a map to the available area in screen to display it.

Includes an affine transformation, between the rectangular area selected of the external map, in its own map coordinates, to the rectangular area available of a view in screen coordinates.

Elements:
- extent: the area selected of the map, in map coordinates.
- imageSize: width and height in pixels (screen coordinates) of the area available in screen to display the area selected of the map.
- adjustedExtent: the area selected must be an scale of imageSize.
  This implies adapt the extent, preserving and centering it, and adding around the needed area to fill all the image size. That added area will be extracted from the original map, wherever exists, and filled with the background color wherever not.
- scale: the scale between the adjusted extent and the image size.
- backColor: the default background color in the view, if there is no map.
- trans: the affine transformation.
- proj: map projection used in this view.
- distanceUnits: distance measurement units, of data in screen.
- mapUnits: measurement units, of data in map.
- extents: an ExtentHistory with the last previous extents.
- offset: position in pixels of the available rectangular area, where start drawing the map.
- dist1pixel: the distance in world coordinates equivalent to 1 pixel in the view with the current extent.
- dist3pixel: the distance in world coordinates equivalent to 3 pixels in the view with the current extent.
- listeners: list with the ViewPortListener registered.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ViewPort.RegisterPersistence

Nested Classes
Modifier and Type	Class and Description
`static class`	`ViewPort.RegisterPersistence`

Field Summary

Fields
Modifier and Type	Field and Description
`protected Rectangle2D`	`adjustedExtent` Location and dimensions of the extent adjusted to the image size.
`protected Rectangle2D`	`extent` Area selected by user using some tool.
`protected ExtentHistory`	`extentsHistory` History with the last extents of the view.
`protected Time`	`time`

Constructor Summary

Constructors
Constructor and Description
`ViewPort()`
`ViewPort(IProjection proj)` Creates a new view port with the information of the projection in `proj` argument, and default configuration: `distanceUnits` = meters `mapUnits` = meters `backColor` = undefined `offset` = `new Point2D.Double(0, 0);`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`addViewPortListener(ViewPortListener arg0)` Appends the specified `ViewPortListener` listener if weren't.
`protected void`	`callExtentChanged(Envelope newRect)` Notifies to all view port listeners registered, that the adjusted extent of this view port has changed.
`protected void`	`callTimeChanged(Time newTime)` Notifies to all view port listeners registered, that the time of this view port has changed.
`Object`	`clone()` Clone the view port without clone the listeners nor the extent history.
`Point`	`convertToMapPoint(int x, int y)`
`Point`	`convertToMapPoint(Point2D pScreen)`
`double`	`distanceWorld(Point2D pt1, Point2D pt2)` Returns the real distance (in world coordinates) at the graphic layers of two 2D points (in map coordinates) of the plane where is selected the extent.
`int`	`fromMapDistance(double d)` Converts and returns the distance `d`, that is in map coordinates to screen coordinates using a delta transform with the transformation affine information in the `#trans` attribute.
`Point2D`	`fromMapPoint(double x, double y)` Converts and returns the 2D point `(x,y)`, that is in map coordinates to screen coordinates (pixels) using the affine transformation in the `#trans` attribute.
`Point2D`	`fromMapPoint(Point2D point)` Converts and returns the 2D point argument, that is in map coordinates to screen coordinates (pixels) using the affine transformation in the `#trans` attribute.
`Rectangle2D`	`fromMapRectangle(Rectangle2D r)` Converts and returns the `Rectangle2D`, that is in map coordinates to screen coordinates (pixels) using an inverse transform with the transformation affine information in the `#trans` attribute.
`Envelope`	`getAdjustedEnvelope()` Returns the envelope currently covered by the view adjusted (scaled) to the image size aspect.
`Envelope`	`getAdjustedExtent()` Deprecated. use `getAdjustedEnvelope()` instead
`AffineTransform`	`getAffineTransform()` Affine transformation between map 2D coordinates to screen 2D coordinates (pixels), preserving the "straightness" and "parallelism" of the lines.
`Color`	`getBackColor()` Gets the background color.
`double`	`getDist1pixel()` Gets the distance in world coordinates equivalent to 1 pixel in the view with the current extent.
`double`	`getDist3pixel()` Gets the distance in world coordinates equivalent to 3 pixels in the view with the current extent.
`int`	`getDistanceArea()` Returns the measurement unit of this view port used for measuring areas and displaying information.
`int`	`getDistanceUnits()` Returns the measurement unit of this view port used for measuring distances and displaying information.
`double`	`getDPI()`
`long`	`getDrawVersion()`
`Envelope`	`getEnvelope()` Gets the envelope selected by user using some tool.
`ExtentHistory`	`getEnvelopes()` Returns the last previous extents of this view port.
`Rectangle2D`	`getExtent()` Deprecated. use `getEnvelope()`
`ExtentHistory`	`getExtents()` Deprecated. use `getEnvelopes()`
`int`	`getImageHeight()` Gets the height in screen coordinates of the rectangle where the image is displayed.
`Dimension`	`getImageSize()` Returns the size of the image projected.
`int`	`getImageWidth()` Gets the width in screen coordinates of the rectangle where the image is displayed.
`int`	`getMapUnits()` Gets the measurement unit used by this view port for the map.
`Point2D`	`getOffset()` Gets the offset.
`IProjection`	`getProjection()` Gets the projection used in this view port.
`Time`	`getTime()`
`void`	`loadFromState(PersistentState state)` Set the state of the object from the state passed as parameter.
`void`	`refreshExtent()` Changes the extent and adjusted extent of this view port: Executes calculateAffineTransform(): getting the new scale, adjusted extent, affine transformation between map and screen coordinates, the real world coordinates equivalent to 1 pixel, and the real world coordinates equivalent to 3 pixels.
`boolean`	`removeViewPortListener(ViewPortListener arg0)` Removes the specified `ViewPortListener` listener, if existed.
`void`	`saveToState(PersistentState state)` Returns an XML entity that represents this view port instance: Properties: className: name of this class.
`void`	`setAdjustable(boolean adjustable)` Changes the status of the "adjustable extent" option to enabled or disabled.
`void`	`setAffineTransform(AffineTransform at)` Sets only the affine transform to this view port, without updating dependent attributes.
`void`	`setBackColor(Color c)` Sets the background color.
`void`	`setClipRect(Rectangle2D rectView)` Sets the position and size of the clipping rectangle.
`void`	`setDist1pixel(double dist1pixel)` Sets the distance in world coordinates equivalent to 1 pixel in the view with the current extent.
`void`	`setDist3pixel(double dist3pixel)` Sets the distance in world coordinates equivalent to 3 pixels in the view with the current extent.
`void`	`setDistanceArea(int distanceArea)` Sets the measurement unit of this view port used for measuring areas and displaying information.
`void`	`setDistanceUnits(int distanceUnits)` Sets the measurement unit of this view port used for measuring distances and displaying information.
`void`	`setDPI(double dpi)`
`void`	`setDPIToScreenDPI()`
`void`	`setEnvelope(Envelope r)` Changes the extent and adjusted extent of this view port: Stores the previous extent.
`void`	`setImageSize(Dimension imageSize)` Sets the size of the image projected, recalculating the parameters of this view port.
`void`	`setMapUnits(int mapUnits)` Sets the measurement unit used by this view port for the map.
`void`	`setNextEnvelope()` Sets as envelope and adjusted envelope of this view port, the next.
`void`	`setOffset(Point2D p)` Sets the offset.
`void`	`setPreviousEnvelope()` Sets as envelope and adjusted envelope of this view port, the previous.
`void`	`setPreviousExtent()` Deprecated. use `setPreviousEnvelope()`
`void`	`setProjection(IProjection proj)` Sets the projection to this view port.
`void`	`setScale(long s)` Deprecated. since 07/09/07, use MapContext.setScaleView(long)
`void`	`setTime(Time time)`
`double`	`toMapDistance(int d)` Converts and returns the distance `d`, that is in screen coordinates to map coordinates using the transformation affine information in the `#trans` attribute.
`Point2D`	`toMapPoint(int x, int y)` Deprecated. use `convertToMapPoint(int, int)`
`Point2D`	`toMapPoint(Point2D pScreen)` Deprecated. use `convertToMapPoint(Point2D)`
`Rectangle2D`	`toMapRectangle(Rectangle2D r)` Converts and returns the `Rectangle2D`, that is in screen coordinates (pixels) to map coordinates using toMapDistance(int), and toMapPoint(int, int).
`String`	`toString()` Returns a `String` representation of the main values of this view port: `extent`, `adjustedExtent`, `imageSize`, `scale`, and `trans`.
`protected void`	`updateDrawVersion()`

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

- Field Detail
  - extent
```
protected Rectangle2D extent
```
    Area selected by user using some tool.
    
    When the zoom changes (for instance when using the zoom in or zoom out tools, but also zooming to a selected feature or shape) the extent that covers that area is the value returned by this method. It is not the actual area shown in the view because it does not care about the aspect ratio of the available area. However, any part of the real world contained in this extent is shown in the view.
    
    Probably this is not what you are looking for. If you are looking for the complete extent currently shown, you must use getAdjustedExtent() method which returns the extent that contains this one but regarding the current view's aspect ratio.
    
    See Also:
    
    getExtent(), setEnvelope(Envelope)
  - time
```
protected Time time
```
  - adjustedExtent
```
protected Rectangle2D adjustedExtent
```
    Location and dimensions of the extent adjusted to the image size.
    
    See Also:
    
    getAdjustedExtent()
  - extentsHistory
```
protected ExtentHistory extentsHistory
```
    History with the last extents of the view.
    
    See Also:
    
    setPreviousExtent(), getExtents()
- Constructor Detail
  - ViewPort
```
public ViewPort()
```
  - ViewPort
```
public ViewPort(IProjection proj)
```
    Creates a new view port with the information of the projection in proj argument, and default configuration:
    - distanceUnits = meters
    - mapUnits = meters
    - backColor = undefined
    - offset = new Point2D.Double(0, 0);
    Parameters:
    
    proj - information of the projection for this view port
- Method Detail
  - setAdjustable
```
public void setAdjustable(boolean adjustable)
```
    Changes the status of the "adjustable extent" option to enabled or disabled.
    
    If view port isn't adjustable, won't bear in mind the aspect ratio of the available rectangular area to calculate the affine transform from the original map in real coordinates. (Won't scale the image to adapt it to the available rectangular area).
    
    Parameters:
    
    boolean - the boolean to be set
  - addViewPortListener
```
public boolean addViewPortListener(ViewPortListener arg0)
```
    Appends the specified ViewPortListener listener if weren't.
    
    Parameters:
    
    arg0 - the listener to add
    
    Returns:
    
    true if has been added successfully
    
    See Also:
    
    removeViewPortListener(ViewPortListener)
  - removeViewPortListener
```
public boolean removeViewPortListener(ViewPortListener arg0)
```
    Removes the specified ViewPortListener listener, if existed.
    
    Parameters:
    
    arg0 - the listener to remove
    
    Returns:
    
    true if the contained the specified listener.
    
    See Also:
    
    addViewPortListener(ViewPortListener)
  - fromMapDistance
```
public int fromMapDistance(double d)
```
    Converts and returns the distance d, that is in map coordinates to screen coordinates using a delta transform with the transformation affine information in the #trans attribute.
    
    Parameters:
    
    d - distance in map coordinates
    
    Returns:
    
    distance equivalent in screen coordinates
    
    See Also:
    
    toMapDistance(int), AffineTransform.deltaTransform(Point2D, Point2D)S
  - fromMapPoint
```
public Point2D fromMapPoint(double x,
                            double y)
```
    Converts and returns the 2D point (x,y), that is in map coordinates to screen coordinates (pixels) using the affine transformation in the #trans attribute.
    
    Parameters:
    
    x - the x map coordinate of a 2D point
    
    y - the y map coordinate of a 2D point
    
    Returns:
    
    2D point equivalent in screen coordinates (pixels)
    
    See Also:
    
    fromMapPoint(Point2D), AffineTransform.transform(Point2D, Point2D)
  - fromMapPoint
```
public Point2D fromMapPoint(Point2D point)
```
    Converts and returns the 2D point argument, that is in map coordinates to screen coordinates (pixels) using the affine transformation in the #trans attribute.
    
    Parameters:
    
    point - the 2D point in map coordinates
    
    Returns:
    
    2D point equivalent in screen coordinates (pixels)
    
    See Also:
    
    toMapPoint(Point2D), fromMapPoint(double, double)
  - toMapPoint
```
public Point2D toMapPoint(int x,
                          int y)
```
    Deprecated. use convertToMapPoint(int, int)
    
    Converts and returns the 2D point (x,y), that is in screen coordinates (pixels) to map coordinates using the affine transformation in the #trans attribute.
    
    Parameters:
    
    x - the x screen coordinate of a 2D point
    
    y - the y screen coordinate of a 2D point
    
    Returns:
    
    2D point equivalent in map coordinates
    
    See Also:
    
    toMapPoint(Point2D), fromMapPoint(double, double)
  - toMapRectangle
```
public Rectangle2D toMapRectangle(Rectangle2D r)
```
    Converts and returns the Rectangle2D, that is in screen coordinates (pixels) to map coordinates using toMapDistance(int), and toMapPoint(int, int).
    
    Parameters:
    
    r - the 2D rectangle in screen coordinates (pixels)
    
    Returns:
    
    2D rectangle equivalent in map coordinates
    
    See Also:
    
    fromMapRectangle(Rectangle2D), toMapDistance(int), toMapPoint(int, int)
  - toMapDistance
```
public double toMapDistance(int d)
```
    Converts and returns the distance d, that is in screen coordinates to map coordinates using the transformation affine information in the #trans attribute.
    
    Parameters:
    
    d - distance in pixels
    
    Returns:
    
    distance equivalent in map coordinates
    
    See Also:
    
    fromMapDistance(double), AffineTransform
  - toMapPoint
```
public Point2D toMapPoint(Point2D pScreen)
```
    Deprecated. use convertToMapPoint(Point2D)
    
    Converts and returns the 2D point argument, that is in screen coordinates (pixels) to map coordinates using the inverse affine transformation of the #trans attribute.
    
    Parameters:
    
    pScreen - the 2D point in screen coordinates (pixels)
    
    Returns:
    
    2D point equivalent in map coordinates
    
    See Also:
    
    toMapPoint(int, int), AffineTransform.createInverse(), AffineTransform.transform(Point2D, Point2D)
  - convertToMapPoint
```
public Point convertToMapPoint(Point2D pScreen)
```
  - convertToMapPoint
```
public Point convertToMapPoint(int x,
                               int y)
```
  - distanceWorld
```
public double distanceWorld(Point2D pt1,
                            Point2D pt2)
```
    Returns the real distance (in world coordinates) at the graphic layers of two 2D points (in map coordinates) of the plane where is selected the extent.
    
    If the projection of this view is UTM, considers the Earth curvature.
    
    Parameters:
    
    pt1 - a 2D point in map coordinates
    
    pt2 - another 2D point in map coordinates
    
    Returns:
    
    the distance in meters between the two points 2D
    
    See Also:
    
    GeoCalcImpl#distanceVincenty(Point2D, Point2D)
  - setPreviousExtent
```
public void setPreviousExtent()
```
    Deprecated. use setPreviousEnvelope()
    
    Sets as extent and adjusted extent of this view port, the previous. Recalculating its parameters.
    
    See Also:
    
    getExtents(), calculateAffineTransform()
  - setPreviousEnvelope
```
public void setPreviousEnvelope()
```
    Sets as envelope and adjusted envelope of this view port, the previous. Recalculating its parameters. Stores the current extent in the next extents of the history.
    
    See Also:
    
    getExtents(), calculateAffineTransform()
  - setNextEnvelope
```
public void setNextEnvelope()
```
    Sets as envelope and adjusted envelope of this view port, the next. Recalculating its parameters. Stores the current extent in the previous extents of the history.
    
    See Also:
    
    getExtents(), calculateAffineTransform()
  - getExtent
```
public Rectangle2D getExtent()
```
    Deprecated. use getEnvelope()
    
    Gets the area selected by user using some tool.
    
    When the zoom changes (for instance using the zoom in or zoom out tools, but also zooming to a selected feature or shape) the extent that covers that area is the value returned by this method. It is not the actual area shown because it doesn't care about the aspect ratio of the image size of the view. However, any part of the real world contained in this extent is shown in the view.
    
    If you are looking for the complete extent currently shown, you must use the getAdjustedExtent() method.
    
    Returns:
    
    the current extent
    
    See Also:
    
    setEnvelope(Envelope), getAdjustedExtent(), setPreviousExtent(), getExtents()
  - getEnvelope
```
public Envelope getEnvelope()
```
    Gets the envelope selected by user using some tool.
    
    When the zoom changes (for instance using the zoom in or zoom out tools, but also zooming to a selected feature or shape) the envelope that covers that area is the value returned by this method. It is not the actual envelope shown because it doesn't care about the aspect ratio of the image size of the view. However, any part of the real world contained in this envelope is shown in the view.
    
    If you are looking for the complete extent currently shown, you must use the getAdjustedEnvelope() method.
    
    Returns:
    
    the current envelope
    
    See Also:
    
    setEnvelope(Envelope), getAdjustedEnvelope(), setPreviousEnvelope(), getEnvelopes()
  - setEnvelope
```
public void setEnvelope(Envelope r)
```
    Changes the extent and adjusted extent of this view port:
    - Stores the previous extent.
    - Calculates the new extent using r:
      extent = new Rectangle2D.Double(r.getMinX() - 0.1, r.getMinY() - 0.1, r.getWidth() + 0.2, r.getHeight() + 0.2);
    - Executes calculateAffineTransform(): getting the new scale, adjusted extent, affine transformation between map and screen coordinates, the real world coordinates equivalent to 1 pixel, and the real world coordinates equivalent to 3 pixels.
    - Notifies all ViewPortListener registered that the extent has changed.
    Parameters:
    
    r - the new extent
    
    See Also:
    
    getExtent(), getExtents(), calculateAffineTransform(), setPreviousExtent(), #clear()
  - refreshExtent
```
public void refreshExtent()
```
    Changes the extent and adjusted extent of this view port:
    - Executes calculateAffineTransform(): getting the new scale, adjusted extent, affine transformation between map and screen coordinates, the real world coordinates equivalent to 1 pixel, and the real world coordinates equivalent to 3 pixels.
    - Notifies to all ViewPortListener registered that the extent has changed.
    See Also:
    
    setEnvelope(Envelope), calculateAffineTransform()
  - getAffineTransform
```
public AffineTransform getAffineTransform()
```
    Affine transformation between map 2D coordinates to screen 2D coordinates (pixels), preserving the "straightness" and "parallelism" of the lines.
    
    Returns:
    
    the affine transformation
    
    See Also:
    
    setAffineTransform(AffineTransform), calculateAffineTransform()
  - getImageSize
```
public Dimension getImageSize()
```
    Returns the size of the image projected.
    
    Returns:
    
    the image size
    
    See Also:
    
    setImageSize(Dimension), getImageHeight(), getImageWidth()
  - setImageSize
```
public void setImageSize(Dimension imageSize)
```
    Sets the size of the image projected, recalculating the parameters of this view port.
    
    Parameters:
    
    imageSize - the image size
    
    See Also:
    
    getImageSize(), calculateAffineTransform()
  - callExtentChanged
```
protected void callExtentChanged(Envelope newRect)
```
    Notifies to all view port listeners registered, that the adjusted extent of this view port has changed.
    
    Parameters:
    
    newRect - the new adjusted extend
    
    See Also:
    
    refreshExtent(), setEnvelope(Envelope), setPreviousExtent(), ExtentEvent, ViewPortListener
  - callTimeChanged
```
protected void callTimeChanged(Time newTime)
```
    Notifies to all view port listeners registered, that the time of this view port has changed.
    
    Parameters:
    
    newTime - the new time
    
    See Also:
    
    refreshExtent(), setTime(Time), ExtentEvent, ViewPortListener
  - setOffset
```
public void setOffset(Point2D p)
```
    Sets the offset.
    
    The offset is the position where start drawing the map.
    
    Parameters:
    
    p - 2D point that represents the offset in pixels
    
    See Also:
    
    getOffset()
  - getOffset
```
public Point2D getOffset()
```
    Gets the offset.
    
    The offset is the position where start drawing the map.
    
    Returns:
    
    2D point that represents the offset in pixels
    
    See Also:
    
    setOffset(Point2D)
  - setBackColor
```
public void setBackColor(Color c)
```
    Sets the background color.
    
    Parameters:
    
    c - the new background color
    
    See Also:
    
    getBackColor()
  - getBackColor
```
public Color getBackColor()
```
    Gets the background color.
    
    Returns:
    
    the background color of the view
    
    See Also:
    
    setBackColor(Color)
  - getAdjustedExtent
```
public Envelope getAdjustedExtent()
```
    Deprecated. use getAdjustedEnvelope() instead
    
    Returns the extent currently covered by the view adjusted (scaled) to the image size aspect.
    
    Returns:
    
    extent of the view adjusted to the image size aspect
    
    See Also:
    
    setAdjustable(boolean)
  - getAdjustedEnvelope
```
public Envelope getAdjustedEnvelope()
```
    Returns the envelope currently covered by the view adjusted (scaled) to the image size aspect.
    
    Returns:
    
    envelope of the view adjusted to the image size aspect
    
    See Also:
    
    setAdjustable(boolean)
  - getDistanceUnits
```
public int getDistanceUnits()
```
    Returns the measurement unit of this view port used for measuring distances and displaying information.
    
    Returns:
    
    the measurement unit of this view used for measuring distances and displaying information
    
    See Also:
    
    setDistanceUnits(int)
  - getDistanceArea
```
public int getDistanceArea()
```
    Returns the measurement unit of this view port used for measuring areas and displaying information.
    
    Returns:
    
    the measurement unit of this view used for measuring areas and displaying information
    
    See Also:
    
    setDistanceUnits(int)
  - setDistanceUnits
```
public void setDistanceUnits(int distanceUnits)
```
    Sets the measurement unit of this view port used for measuring distances and displaying information.
    
    Parameters:
    
    distanceUnits - the measurement unit of this view used for measuring distances and displaying information
    
    See Also:
    
    getDistanceUnits()
  - setDistanceArea
```
public void setDistanceArea(int distanceArea)
```
    Sets the measurement unit of this view port used for measuring areas and displaying information.
    
    Parameters:
    
    distanceUnits - the measurement unit of this view used for measuring areas and displaying information
    
    See Also:
    
    getDistanceUnits()
  - getMapUnits
```
public int getMapUnits()
```
    Gets the measurement unit used by this view port for the map.
    
    Returns:
    
    Returns the current map measure unit
    
    See Also:
    
    setMapUnits(int)
  - setMapUnits
```
public void setMapUnits(int mapUnits)
```
    Sets the measurement unit used by this view port for the map.
    
    Parameters:
    
    mapUnits - the new map measure unit
    
    See Also:
    
    getMapUnits()
  - getImageWidth
```
public int getImageWidth()
```
    Gets the width in screen coordinates of the rectangle where the image is displayed.
    
    Used by calculateAffineTransform() to calculate:
    - The new scale .
    - The new adjustableExtent .
    - The new trans .
    - The new real world coordinates equivalent to 1 pixel ( dist1pixel) .
    - The new real world coordinates equivalent to 3 pixels ( dist3pixel) .
    See Also:
    
    getImageHeight(), getImageSize(), setImageSize(Dimension)
  - getImageHeight
```
public int getImageHeight()
```
    Gets the height in screen coordinates of the rectangle where the image is displayed.
    
    Used by calculateAffineTransform() to calculate:
    - The new scale .
    - The new adjustableExtent .
    - The new trans .
    - The new real world coordinates equivalent to 1 pixel ( dist1pixel) .
    - The new real world coordinates equivalent to 3 pixels ( dist3pixel) .
    See Also:
    
    getImageWidth(), getImageSize(), setImageSize(Dimension)
  - getDist1pixel
```
public double getDist1pixel()
```
    Gets the distance in world coordinates equivalent to 1 pixel in the view with the current extent.
    
    Returns:
    
    the distance
    
    See Also:
    
    setDist1pixel(double)
  - setDist1pixel
```
public void setDist1pixel(double dist1pixel)
```
    Sets the distance in world coordinates equivalent to 1 pixel in the view with the current extent.
    
    Parameters:
    
    dist1pixel - the distance
    
    See Also:
    
    getDist1pixel()
  - getDist3pixel
```
public double getDist3pixel()
```
    Gets the distance in world coordinates equivalent to 3 pixels in the view with the current extent.
    
    Returns:
    
    the distance
    
    See Also:
    
    setDist3pixel(double)
  - setDist3pixel
```
public void setDist3pixel(double dist3pixel)
```
    Sets the distance in world coordinates equivalent to 3 pixels in the view with the current extent.
    
    Parameters:
    
    dist3pixel - the distance
    
    See Also:
    
    getDist3pixel()
  - getExtents
```
public ExtentHistory getExtents()
```
    Deprecated. use getEnvelopes()
    
    Returns the last previous extents of this view port.
    
    Returns:
    
    the last previous extents of this view port
    
    See Also:
    
    setPreviousExtent()
  - getEnvelopes
```
public ExtentHistory getEnvelopes()
```
    Returns the last previous extents of this view port.
    
    Returns:
    
    the last previous extents of this view port
    
    See Also:
    
    setPreviousExtent()
  - getProjection
```
public IProjection getProjection()
```
    Gets the projection used in this view port.
    
    Returns:
    
    projection used in this view port
    
    See Also:
    
    setProjection(IProjection)
  - setProjection
```
public void setProjection(IProjection proj)
```
    Sets the projection to this view port.
    
    Parameters:
    
    proj - the new projection
    
    See Also:
    
    getProjection()
  - setAffineTransform
```
public void setAffineTransform(AffineTransform at)
```
    Sets only the affine transform to this view port, without updating dependent attributes.
    
    This method could be problematic!
    
    Parameters:
    
    at - the affine transform to set
    
    See Also:
    
    getAffineTransform(), calculateAffineTransform()
  - saveToState
```
public void saveToState(PersistentState state)
                 throws PersistenceException
```
    Returns an XML entity that represents this view port instance:
    - Properties:
      
      className: name of this class.
      If defined, the adjusted extent:
      
      adjustedExtentX: X coordinate of the adjusted extent.
      adjustedExtentY: Y coordinate of the adjusted extent.
      adjustedExtentW: width of the adjusted extent.
      adjustedExtentH: height of the adjusted extent.
      
      If defined, the background color:
      
      backColor: background color.
      
      If defined, the clip:
      
      clipX: X coordinate of the clip.
      clipY: Y coordinate of clip.
      clipW: width of the clip.
      clipH: height of the clip.
      
      dist1pixel: the distance in world coordinates equivalent to 1 pixel in the view.
      dist3pixel: the distance in world coordinates equivalent to 3 pixels in the view.
      distanceUnits: the distance measurement unit.
      If defined, the extent:
      
      extentX: X coordinate of the extent.
      extentY: Y coordinate of the extent.
      extentW: width of the extent.
      extentH: height of the extent.
      
      mapUnits: the map measurement unit.
      offsetX: X coordinate of the offset.
      offsetY: Y coordinate of the offset.
      If defined, the projection:
      
      If its defined, the projection:
      
      proj: the projection.
      
      scale: ratio between the size of imageSize and extent.
    - Child branches:
      
      XML entity of the internal ExtentHistory .
    Specified by:
    
    saveToState in interface Persistent
    
    Throws:
    
    PersistenceException
    
    See Also:
    
    #createFromXML(XMLEntity)
  - loadFromState
```
public void loadFromState(PersistentState state)
                   throws PersistenceException
```
    Description copied from interface: Persistent
    
    Set the state of the object from the state passed as parameter.
    
    Specified by:
    
    loadFromState in interface Persistent
    
    Throws:
    
    PersistenceException
  - clone
```
public Object clone()
             throws CloneNotSupportedException
```
    Clone the view port without clone the listeners nor the extent history.
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    the cloned view port
    
    Throws:
    
    CloneNotSupportedException - if the instance of the object cannot be cloned. As this is extending Cloneable so its sure it implements it, so this exception may be used for problems on specific object instances.
    
    See Also:
    
    Object#clone()}.
  - toString
```
public String toString()
```
    Returns a String representation of the main values of this view port: extent, adjustedExtent, imageSize, scale, and trans.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation of the main values of this view port
  - setClipRect
```
public void setClipRect(Rectangle2D rectView)
```
    Sets the position and size of the clipping rectangle.
    
    Parameters:
    
    rectView - the clipping rectangle to set
  - fromMapRectangle
```
public Rectangle2D fromMapRectangle(Rectangle2D r)
```
    Converts and returns the Rectangle2D, that is in map coordinates to screen coordinates (pixels) using an inverse transform with the transformation affine information in the #trans attribute.
    
    Parameters:
    
    r - the 2D rectangle in map coordinates
    
    Returns:
    
    2D rectangle equivalent in screen coordinates (pixels)
    
    See Also:
    
    toMapRectangle(Rectangle2D), fromMapDistance(double), fromMapPoint(Point2D)
  - setScale
```
public void setScale(long s)
```
    Deprecated. since 07/09/07, use MapContext.setScaleView(long)
    
    Recalculates the current extent using an scale. It's necessary execute refreshExtent() after.
    
    Parameters:
    
    s - the scale to set
  - getDrawVersion
```
public long getDrawVersion()
```
  - updateDrawVersion
```
protected void updateDrawVersion()
```
  - getTime
```
public Time getTime()
```
  - setTime
```
public void setTime(Time time)
```
  - getDPI
```
public double getDPI()
```
  - setDPI
```
public void setDPI(double dpi)
```
  - setDPIToScreenDPI
```
public void setDPIToScreenDPI()
```

Class ViewPort

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

extent

time

adjustedExtent

extentsHistory

Constructor Detail

ViewPort

ViewPort

Method Detail

setAdjustable

addViewPortListener

removeViewPortListener

fromMapDistance

fromMapPoint

fromMapPoint

toMapPoint

toMapRectangle

toMapDistance

toMapPoint

convertToMapPoint

convertToMapPoint

distanceWorld

setPreviousExtent

setPreviousEnvelope

setNextEnvelope

getExtent

getEnvelope

setEnvelope

refreshExtent

getAffineTransform

getImageSize

setImageSize

callExtentChanged

callTimeChanged

setOffset

getOffset

setBackColor

getBackColor

getAdjustedExtent

getAdjustedEnvelope

getDistanceUnits

getDistanceArea

setDistanceUnits

setDistanceArea

getMapUnits

setMapUnits

getImageWidth

getImageHeight

getDist1pixel

setDist1pixel

getDist3pixel

setDist3pixel

getExtents

getEnvelopes

getProjection

setProjection

setAffineTransform

saveToState

loadFromState

clone

toString

setClipRect

fromMapRectangle

setScale

getDrawVersion

updateDrawVersion

getTime

setTime

getDPI

setDPI

setDPIToScreenDPI