IlvMapUtil (Perforce JViews 10.0 API)

java.lang.Object
- ilog.views.maps.IlvMapUtil

```
public class IlvMapUtil
extends Object
```
This class contains a set of static utility methods:
- Geometric methods, such as intersection computation.
- Resources access methods.
- Generic computations on the view, such as scale.
- Garbage collecting method.
Since:

JViews 7.5

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_INTERVALS` The default number of intervals to be used in `computeTransformedBounds(IlvMathTransform, double, double, double, double)` Default value is 3 (two extremities and center)

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`addLatLonBounds(IlvRect rect, IlvMathTransform transform, IlvRect managerBounds, boolean fullComputation, int intervals)` Computes the lat/lon enclosed bounds when applying the transformation to the rectangle in manager coordinates.
`static IlvRect`	`computeLatLonBounds(IlvMathTransform transformation, IlvRect managerBounds)` Computes the lat/lon enclosed bounds when applying the transformation to the rectangle in manager coordinates.
`static IlvRect`	`computeTransformedBounds(IlvMathTransform transformation, double lon1, double lat1, double lon2, double lat2)` Computes the bounds necessary on a manager to display a lat/lon defined rectangle.
`static IlvRect`	`computeTransformedBounds(IlvMathTransform transformation, double lon1, double lat1, double lon2, double lat2, boolean fullComputation, int intervals)` Computes the bounds necessary on a manager to display a lat/lon defined rectangle.
`static double`	`computeViewScale(IlvManagerView view)` Utility to compute the view scale, i.e. the ratio between centimeters on the screen and centimeters in the real world.
`static void`	`freeMemoryNow(String msg)` Runs the garbage collector and finalizer in order to release memory.
`static ExceptionHandler`	`getExceptionHandler()` Retrieves the current `ExceptionHandler`.
`static Point2D.Double`	`getIntersection(Line2D segment1, Line2D segment2)` Computes and returns the intersection point (if it exists) between two segments.
`static String`	`getString(Class<?> objectClass, String key)` Returns the resource string for this key.
`static String`	`getString(Class<?> objectClass, String key, Locale locale)` Returns the resource string for this key.
`static void`	`handleException(Exception e)` Handles an exception using the current `ExceptionHandler`.
`static Color`	`RandomDarkColor()` Returns a random dark color.
`static Color`	`RandomLightColor()` Returns a random dark color.
`static Paint`	`readPaint(IlvInputStream stream, String fieldName)` Reads a previously saved paint
`static void`	`resetRandomColorGeneration()` Resets the random color generator to its initial state.
`static void`	`setExceptionHandler(ExceptionHandler exceptionHandler)` Sets the default `ExceptionHandler`.
`static IlvRect[]`	`splitRectangle(IlvRect rect, int regionCount)` Splits a rectangle into an array of regionCount*regionCount adjacent subrectangles.
`static IlvPoint`	`transform(IlvPoint p, IlvCoordinateTransformation transform)` Transforms an `IlvPoint`.
`static IlvRect`	`transform(IlvRect r, IlvCoordinateTransformation transform)` Transforms an `IlvRect`, that is, transform each corner and rebuild a IlvRect with these transformed corners.
`static void`	`writePaint(IlvOutputStream stream, Paint paint, String fieldName)` Writes a `Paint` on an output stream.

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

- Field Detail
  - DEFAULT_INTERVALS
```
public static int DEFAULT_INTERVALS
```
    The default number of intervals to be used in computeTransformedBounds(IlvMathTransform, double, double, double, double) Default value is 3 (two extremities and center)
- Method Detail
  - computeTransformedBounds
```
public static IlvRect computeTransformedBounds(IlvMathTransform transformation,
                                               double lon1,
                                               double lat1,
                                               double lon2,
                                               double lat2)
```
    Computes the bounds necessary on a manager to display a lat/lon defined rectangle. This method transforms points on a rectangle border, using DEFAULT_INTERVALS intervals. The returned rectangle is the enclosing rectangle of all transformed points.
    
    Parameters:
    
    transformation - Transformation to use (usually built from the coordinate system of a manager)
    
    lon1 - First longitude in radians.
    
    lat1 - First latitude in radians.
    
    lon2 - Last longitude in radians.
    
    lat2 - Last latitude in radians.
    
    Returns:
    
    The enclosing rectangle in transformed coordinates.
    
    See Also:
    
    computeTransformedBounds(IlvMathTransform, double, double, double, double, boolean, int)
  - computeTransformedBounds
```
public static IlvRect computeTransformedBounds(IlvMathTransform transformation,
                                               double lon1,
                                               double lat1,
                                               double lon2,
                                               double lat2,
                                               boolean fullComputation,
                                               int intervals)
```
    Computes the bounds necessary on a manager to display a lat/lon defined rectangle. This method transforms points on a rectangle border (or the whole rectangle if fullComputation is chosen), dividing the area into the number of intervals specified. The returned rectangle is the enclosing rectangle of all transformed points.
    
    Parameters:
    
    transformation - Transformation to use (usually built from the coordinate system of a manager)
    
    lon1 - First longitude in radians.
    
    lat1 - First latitude in radians.
    
    lon2 - Last longitude in radians.
    
    lat2 - Last latitude in radians.
    
    fullComputation - if true, takes also into account the rectangle interior.
    
    intervals - Number of intervals into which to divide the rectangle.
    
    Returns:
    
    The enclosing rectangle in transformed coordinates.
  - computeViewScale
```
public static double computeViewScale(IlvManagerView view)
```
    Utility to compute the view scale, i.e. the ratio between centimeters on the screen and centimeters in the real world. For example a ratio of 10000 means 1cm on screen is 10000cm (100m) on the ground. Measurement is taken on the horizontal median of the view using the coordinate system of the view manager.
    
    Parameters:
    
    view - The view for which to compute the ratio.
    
    Returns:
    
    The ratio (or 0 if parameters are incorrect, such as null view, a view with no coordinate system or a 0 sized view).
    
    See Also:
    
    Toolkit.getScreenResolution(), IlvCoordinateSystemProperty.GetCoordinateSystem(ilog.views.IlvManager), IlvGeographicCoordinateSystem.equivalentLinearUnit(), IlvCoordinateSystem.getUnit(int)
  - freeMemoryNow
```
public static final void freeMemoryNow(String msg)
```
    Runs the garbage collector and finalizer in order to release memory. A message may be passed to this method. If the message is null, nothing is printed otherwise the specified message and the available memory is displayed.
    
    Parameters:
    
    msg - The message to be displayed.
  - getIntersection
```
public static Point2D.Double getIntersection(Line2D segment1,
                                             Line2D segment2)
```
    Computes and returns the intersection point (if it exists) between two segments.
    
    Parameters:
    
    segment1 - First segment.
    
    segment2 - Second segment.
    
    Returns:
    
    null or the exact intersection point.
  - getString
```
public static String getString(Class<?> objectClass,
                               String key)
```
    Returns the resource string for this key. This method internally fills a HashMap of ResourceBundle classes, for each package known.
    For example, using getString(ilog.views.maps.IlvMapUtil.class,"IlvMapUtils.title") will try to locate a resource at URL ilog/views/maps/messages.properties, or any localized file at the same place. This resource bundle, if found, will be reused for each getString call for the same package. This method will use the default locale to retrieve the string.
    
    Parameters:
    
    objectClass - Object class
    
    key - name of the resource
    
    Returns:
    
    the resource found or the key name if the resource is not found.
  - getString
```
public static String getString(Class<?> objectClass,
                               String key,
                               Locale locale)
```
    Returns the resource string for this key. This method internally fills a HashMap of ResourceBundle classes, for each package known.
    For example, using getString(ilog.views.maps.IlvMapUtil.class,"IlvMapUtils.title") will try to locate a resource at URL ilog/views/maps/messages.properties, or any localized file at the same place. This resource bundle, if found, will be reused for each getString call for the same package.
    
    Parameters:
    
    objectClass - Object class
    
    key - name of the resource
    
    locale - locale used to retrieve the bundle.
    
    Returns:
    
    the resource found or the key name if the resource is not found.
    
    Since:
    
    JViews 8.7
  - splitRectangle
```
public static IlvRect[] splitRectangle(IlvRect rect,
                                       int regionCount)
```
    Splits a rectangle into an array of regionCount*regionCount adjacent subrectangles.
    
    Parameters:
    
    rect - Rectangle to split into subrectangles.
    
    regionCount - Number of subrectangles on each dimension.
    
    Returns:
    
    The array of subrectangles.
  - transform
```
public static IlvPoint transform(IlvPoint p,
                                 IlvCoordinateTransformation transform)
                          throws IlvCoordinateTransformationException
```
    Transforms an IlvPoint. This point is supposed to be in manager coordinate (descending y coordinate).
    
    Parameters:
    
    p - The point to transform.
    
    transform - The transformation.
    
    Returns:
    
    The transformed Point.
    
    Throws:
    
    IlvCoordinateTransformationException
  - transform
```
public static IlvRect transform(IlvRect r,
                                IlvCoordinateTransformation transform)
                         throws IlvCoordinateTransformationException
```
    Transforms an IlvRect, that is, transform each corner and rebuild a IlvRect with these transformed corners. This rectangle is supposed to be in manager coordinate (descending y coordinate).
    
    Parameters:
    
    r - The rect to transform.
    
    transform - The transformation.
    
    Returns:
    
    The transformed Point.
    
    Throws:
    
    IlvCoordinateTransformationException
    
    Since:
    
    JViews 7.5
  - computeLatLonBounds
```
public static IlvRect computeLatLonBounds(IlvMathTransform transformation,
                                          IlvRect managerBounds)
```
    Computes the lat/lon enclosed bounds when applying the transformation to the rectangle in manager coordinates.
    
    Parameters:
    
    transformation - Transformation to apply. It will first compute the lat/lon bounds of the 4 corners.
    If the transformation throws exceptions, points along the border will be computed. If there are still errors, this method will try ^points inside the rectangle, to find the biggest enclosed lat/lon rectangle.
    
    managerBounds - Manager bounds used.
    
    Returns:
    
    The biggest enclosed lat/lon rect for the rectangle.
  - addLatLonBounds
```
public static boolean addLatLonBounds(IlvRect rect,
                                      IlvMathTransform transform,
                                      IlvRect managerBounds,
                                      boolean fullComputation,
                                      int intervals)
```
    Computes the lat/lon enclosed bounds when applying the transformation to the rectangle in manager coordinates. It will first compute the lat/lon bounds of the 4 corners.
    If the transformation throws exceptions, points along the border will be computed. If there are still errors, this method will try ^points inside the rectangle, to find the biggest enclosed lat/lon rectangle.
    
    Parameters:
    
    rect - lat/lon rectangle containing bounds after method call.
    
    transform - Transformation to apply.
    
    managerBounds - Manager bounds used.
    
    fullComputation - indicate if points in the inside of the area should be checked for lat/lon bounds.
    
    intervals - number of points taken in each direction.
    
    Returns:
    
    true if enough points can be transformed to determine the bounds.
  - writePaint
```
public static void writePaint(IlvOutputStream stream,
                              Paint paint,
                              String fieldName)
                       throws IOException
```
    Writes a Paint on an output stream. This static method is used when saving parameters in the style of components that can be either colors, paints, gradients, ...
    
    Parameters:
    
    stream - Stream to write to.
    
    paint - Paint to save.
    
    fieldName - Base name of the field.
    
    Throws:
    
    IOException
  - readPaint
```
public static Paint readPaint(IlvInputStream stream,
                              String fieldName)
                       throws IlvReadFileException
```
    Reads a previously saved paint
    
    Parameters:
    
    stream - Stream to read from.
    
    fieldName - Base field name.
    
    Returns:
    
    A reconstructed Paint.
    
    Throws:
    
    IlvReadFileException
    
    See Also:
    
    writePaint(IlvOutputStream, Paint, String)
  - getExceptionHandler
```
public static ExceptionHandler getExceptionHandler()
```
    Retrieves the current ExceptionHandler.
    
    Returns:
    
    The ExceptionHandler.
  - setExceptionHandler
```
public static void setExceptionHandler(ExceptionHandler exceptionHandler)
```
    Sets the default ExceptionHandler. By default, the exception is thrown.
    
    Parameters:
    
    exceptionHandler - The ExceptionHandler.
    
    Since:
    
    JViews 8.1
  - handleException
```
public static void handleException(Exception e)
                            throws Exception
```
    Handles an exception using the current ExceptionHandler.
    
    Parameters:
    
    e - The exception.
    
    Throws:
    
    Exception
  - RandomDarkColor
```
public static Color RandomDarkColor()
```
    Returns a random dark color.
    
    Returns:
    
    a random color.
  - RandomLightColor
```
public static Color RandomLightColor()
```
    Returns a random dark color.
    
    Returns:
    
    a random color.
  - resetRandomColorGeneration
```
public static void resetRandomColorGeneration()
```
    Resets the random color generator to its initial state.
    
    Since:
    
    JViews 8.0

Class IlvMapUtil

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_INTERVALS

Method Detail

computeTransformedBounds

computeTransformedBounds

computeViewScale

freeMemoryNow

getIntersection

getString

getString

splitRectangle

transform

transform

computeLatLonBounds

addLatLonBounds

writePaint

readPaint

getExceptionHandler

setExceptionHandler

handleException

RandomDarkColor

RandomLightColor

resetRandomColorGeneration