MapVec

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

```
public class MapVec
extends java.lang.Object
```
A double precision map vector defined by 3 coordinates.

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
`MapVec()` Constructs a MapVec object.
`MapVec(double x, double y)` Constructs a MapVec object from 2 coordinates.
`MapVec(double x, double y, double z)` Constructs a MapVec object from 3 coordinates.
`MapVec(long cPtr, boolean cMemoryOwn)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MapVec`	`add(MapVec v)` Creates a new map vector by adding a map vector to this map vector.
`double`	`crossProduct2D(MapVec v)` Calculates the 2D cross product between this and another map vector.
`MapVec`	`crossProduct3D(MapVec v)` Creates a new map vector that's perpendicular to the plane defined by this and another map vector.
`void`	`delete()`
`MapVec`	`div(double divider)` Creates a new map vector by dividing this map vector with a divider.
`double`	`dotProduct(MapVec v)` Calculates the dot product between this and another map vector.
`boolean`	`equals(java.lang.Object obj)` Checks if this object is equal to the specified object.
`protected void`	`finalize()`
`static long`	`getCPtr(MapVec obj)`
`MapVec`	`getNormalized()` Creates a new map vector by normalizing this map vector.
`MapVec`	`getRotated2D(double sin, double cos)` Creates a new map vector by rotating this map vector around it's back end and around z axis.
`double`	`getX()` Returns the x coordinate of this map vector.
`double`	`getY()` Returns the y coordinate of this map vector.
`double`	`getZ()` Returns the z coordinate of this map vector.
`int`	`hashCode()` Returns the hash value of this object.
`double`	`length()` Calculates the length of this map vector.
`MapVec`	`mul(double multiplier)` Creates a new map vector by multiplying this map vector with a multiplier.
`MapVec`	`sub(MapVec v)` Creates a new map vector by subtracting a map vector from this map vector.
`java.lang.String`	`toString()` Creates a string representation of this map vector, 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
  - MapVec
```
public MapVec(long cPtr,
              boolean cMemoryOwn)
```
  - MapVec
```
public MapVec()
```
    Constructs a MapVec object. All coordinates will be 0.
  - MapVec
```
public MapVec(double x,
              double y)
```
    Constructs a MapVec object from 2 coordinates. The z coordinate will be 0.
    
    Parameters:
    
    x - The x coordinate.
    
    y - The y coordinate.
  - MapVec
```
public MapVec(double x,
              double y,
              double z)
```
    Constructs a MapVec object from 3 coordinates.
    
    Parameters:
    
    x - The x coordinate.
    
    y - The y coordinate.
    
    z - The z coordinate.
- Method Detail
  - getCPtr
```
public static long getCPtr(MapVec 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 vector.
    
    Returns:
    
    The x coordinate of this map vector.
  - getY
```
public double getY()
```
    Returns the y coordinate of this map vector.
    
    Returns:
    
    The y coordinate of this map vector.
  - getZ
```
public double getZ()
```
    Returns the z coordinate of this map vector.
    
    Returns:
    
    The z coordinate of this map vector.
  - add
```
public MapVec add(MapVec v)
```
    Creates a new map vector by adding a map vector to this map vector.
    
    Parameters:
    
    v - The map vector to be added.
    
    Returns:
    
    The new map vector.
  - sub
```
public MapVec sub(MapVec v)
```
    Creates a new map vector by subtracting a map vector from this map vector.
    
    Parameters:
    
    v - The map vector to be subtracted.
    
    Returns:
    
    The new map vector.
  - mul
```
public MapVec mul(double multiplier)
```
    Creates a new map vector by multiplying this map vector with a multiplier.
    
    Parameters:
    
    multiplier - The multiplier.
    
    Returns:
    
    The new map vector.
  - div
```
public MapVec div(double divider)
```
    Creates a new map vector by dividing this map vector with a divider.
    
    Parameters:
    
    divider - The divider.
    
    Returns:
    
    The new map vector.
  - length
```
public double length()
```
    Calculates the length of this map vector.
    
    Returns:
    
    The length of this map vector.
  - getNormalized
```
public MapVec getNormalized()
```
    Creates a new map vector by normalizing this map vector.
    
    Returns:
    
    The new normalized map vector.
  - getRotated2D
```
public MapVec getRotated2D(double sin,
                           double cos)
```
    Creates a new map vector by rotating this map vector around it's back end and around z axis.
    
    Parameters:
    
    sin - The sine value of the rotation angle.
    
    cos - The cosine value of the rotation angle.
    
    Returns:
    
    The new rotated map vector.
  - crossProduct2D
```
public double crossProduct2D(MapVec v)
```
    Calculates the 2D cross product between this and another map vector. Defined as x1 * y2 - y1 * x2.
    
    Parameters:
    
    v - The other map vector.
    
    Returns:
    
    The 2D cross product between this and another map vector.
  - crossProduct3D
```
public MapVec crossProduct3D(MapVec v)
```
    Creates a new map vector that's perpendicular to the plane defined by this and another map vector.
    
    Parameters:
    
    v - The other map vector.
    
    Returns:
    
    The new perpendicular map vector.
  - dotProduct
```
public double dotProduct(MapVec v)
```
    Calculates the dot product between this and another map vector.
    
    Parameters:
    
    v - The other map vector.
    
    Returns:
    
    The dot product between this and another map vector.
  - toString
```
public java.lang.String toString()
```
    Creates a string representation of this map vector, useful for logging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    The string representation of this map vector.

Class MapVec

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

swigCMemOwn

Constructor Detail

MapVec

MapVec

MapVec

MapVec

Method Detail

getCPtr

finalize

delete

equals

hashCode

getX

getY

getZ

add

sub

mul

div

length

getNormalized

getRotated2D

crossProduct2D

crossProduct3D

dotProduct

toString