MapPos

java.lang.Object
- com.nutiteq.core.MapPos

```
public class MapPos
extends java.lang.Object
```
A double precision map position defined using three coordinates. X and y coordinates denote positions on the map,
while z coordinate is height from the ground plane. Actual units for x, y and z depend on map projection.
For example, in EPSG:4326 x is used for latitude, y for longitude and z for height in meters.

Field Summary

Fields
Modifier and Type Field and Description

protected boolean swigCMemOwn

Fields
Modifier and Type	Field and Description
`protected boolean`	`swigCMemOwn`

Constructor Summary

Constructors
Constructor and Description
`MapPos()` Constructs a MapPos object.
`MapPos(double x, double y)` Constructs a MapPos object from 2 coordinates.
`MapPos(double x, double y, double z)` Constructs a MapPos object from 3 coordinates.
`MapPos(long cPtr, boolean cMemoryOwn)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MapPos`	`add(MapVec v)` Creates a new map position by adding a map vector to this map position.
`void`	`delete()`
`double`	`distanceFromLine(MapPos a, MapPos b)` Calculates the distance between this map position and an infinte line defined by two points.
`double`	`distanceFromLineSegment(MapPos a, MapPos b)` Calculates the distance between this map position and a line segment.
`double`	`distanceFromPoint(MapPos p)` Calculates the distance between this and another map position.
`double`	`distanceSqrFromLine(MapPos a, MapPos b)` Calculates the square distance between this map position and an infinte line defined by two points.
`double`	`distanceSqrFromLineSegment(MapPos a, MapPos b)` Calculates the square distance between this map position and a line segment.
`double`	`distanceSqrFromPoint(MapPos p)` Calculates the square distance between this and another map position.
`boolean`	`equals(java.lang.Object obj)` Checks if this object is equal to the specified object.
`protected void`	`finalize()`
`static long`	`getCPtr(MapPos obj)`
`MapPos`	`getRotated2D(double sin, double cos)` Creates a new map position by rotating this map position around the z axis by an angle.
`double`	`getX()` Returns the x coordinate of this map position.
`double`	`getY()` Returns the y coordinate of this map position.
`double`	`getZ()` Returns the z coordinate of this map position.
`int`	`hashCode()` Returns the hash value of this object.
`MapPos`	`nearestPointOnLineSegment(MapPos a, MapPos b)` Calculates the nearest point from this map position on a line segment.
`MapVec`	`subPos(MapPos p)` Creates a new map vector by subtracting a map position from this map position.
`MapPos`	`subVec(MapVec v)` Creates a new map position by subtracting a map vector from this map position.
`java.lang.String`	`toString()` Creates a string representation of this map position, useful for logging.

Methods inherited from class java.lang.Object
clone, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - swigCMemOwn
```
protected boolean swigCMemOwn
```
- Constructor Detail
  - MapPos
```
public MapPos(long cPtr,
              boolean cMemoryOwn)
```
  - MapPos
```
public MapPos()
```
    Constructs a MapPos object. All coordinates will be 0.
  - MapPos
```
public MapPos(double x,
              double y)
```
    Constructs a MapPos object from 2 coordinates. The z coordinate will be 0.
    
    Parameters:
    
    x - The x coordinate.
    
    y - The y coordinate.
  - MapPos
```
public MapPos(double x,
              double y,
              double z)
```
    Constructs a MapPos object from 3 coordinates.
    
    Parameters:
    
    x - The x coordinate.
    
    y - The y coordinate.
    
    z - The z coordinate.
- Method Detail
  - getCPtr
```
public static long getCPtr(MapPos obj)
```
  - finalize
```
protected void finalize()
```
    Overrides:
    
    finalize in class java.lang.Object
  - delete
```
public void delete()
```
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Checks if this object is equal to the specified object.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Returns:
    
    True when objects are equal, false otherwise.
  - hashCode
```
public int hashCode()
```
    Returns the hash value of this object.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    The hash value of this object.
  - getX
```
public double getX()
```
    Returns the x coordinate of this map position.
    
    Returns:
    
    The x coordinate of this map position.
  - getY
```
public double getY()
```
    Returns the y coordinate of this map position.
    
    Returns:
    
    The y coordinate of this map position.
  - getZ
```
public double getZ()
```
    Returns the z coordinate of this map position.
    
    Returns:
    
    The z coordinate of this map position.
  - add
```
public MapPos add(MapVec v)
```
    Creates a new map position by adding a map vector to this map position.
    
    Parameters:
    
    v - The map vector to be added.
    
    Returns:
    
    The new map position.
  - subVec
```
public MapPos subVec(MapVec v)
```
    Creates a new map position by subtracting a map vector from this map position.
    
    Parameters:
    
    v - The map vector to be subtracted.
    
    Returns:
    
    The new map position.
  - subPos
```
public MapVec subPos(MapPos p)
```
    Creates a new map vector by subtracting a map position from this map position.
    
    Parameters:
    
    p - The map position to be subtracted.
    
    Returns:
    
    The new map vector.
  - distanceFromPoint
```
public double distanceFromPoint(MapPos p)
```
    Calculates the distance between this and another map position.
    
    Parameters:
    
    p - The other map position.
    
    Returns:
    
    The distance between the two points.
  - distanceSqrFromPoint
```
public double distanceSqrFromPoint(MapPos p)
```
    Calculates the square distance between this and another map position.
    
    Parameters:
    
    p - The other map position.
    
    Returns:
    
    The square distance between the two points.
  - distanceFromLine
```
public double distanceFromLine(MapPos a,
                               MapPos b)
```
    Calculates the distance between this map position and an infinte line defined by two points.
    
    Parameters:
    
    a - Some point on the infinte line.
    
    b - Another point on the infinite line.
    
    Returns:
    
    The distance between this map position and the infinite line.
  - distanceSqrFromLine
```
public double distanceSqrFromLine(MapPos a,
                                  MapPos b)
```
    Calculates the square distance between this map position and an infinte line defined by two points.
    
    Parameters:
    
    a - Some point on the infinte line.
    
    b - Another point on the infinite line.
    
    Returns:
    
    The square distance between this map position and the infinite line.
  - distanceFromLineSegment
```
public double distanceFromLineSegment(MapPos a,
                                      MapPos b)
```
    Calculates the distance between this map position and a line segment.
    
    Parameters:
    
    a - Starting coordinate of the line segment.
    
    b - Ending coordinate of the line segment.
    
    Returns:
    
    The distance between this map position and the line segment.
  - distanceSqrFromLineSegment
```
public double distanceSqrFromLineSegment(MapPos a,
                                         MapPos b)
```
    Calculates the square distance between this map position and a line segment.
    
    Parameters:
    
    a - Starting coordinate of the line segment.
    
    b - Ending coordinate of the line segment.
    
    Returns:
    
    The square distance between this map position and the line segment.
  - nearestPointOnLineSegment
```
public MapPos nearestPointOnLineSegment(MapPos a,
                                        MapPos b)
```
    Calculates the nearest point from this map position on a line segment.
    
    Parameters:
    
    a - Starting coordinate of the line segment.
    
    b - Ending coordinate of the line segment.
    
    Returns:
    
    The nearest point from this map position that lies on the line segment.
  - getRotated2D
```
public MapPos getRotated2D(double sin,
                           double cos)
```
    Creates a new map position by rotating this map position around the z axis by an angle.
    
    Parameters:
    
    sin - The sine value of the rotation angle.
    
    cos - The cosine value of the rotation angle.
    
    Returns:
    
    The new rotated map position.
  - toString
```
public java.lang.String toString()
```
    Creates a string representation of this map position, useful for logging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    The string representation of this map position.

Class MapPos

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

swigCMemOwn

Constructor Detail

MapPos

MapPos

MapPos

MapPos

Method Detail

getCPtr

finalize

delete

equals

hashCode

getX

getY

getZ

add

subVec

subPos

distanceFromPoint

distanceSqrFromPoint

distanceFromLine

distanceSqrFromLine

distanceFromLineSegment

distanceSqrFromLineSegment

nearestPointOnLineSegment

getRotated2D

toString