 Legend to Symbols

Class ovi.mapsapi.util.Vector3D
Class Summary
A class representing a three dimensional vector.
new ovi.mapsapi.util.Vector3D
(x, y, z)
Method Summary
add
(other)
: ovi.mapsapi.util.Vector3D
Creates the sum of this vector and the given one.
angle
([px, [py, [intertX, [intertY]]]])
: Number
Returns the angle of this vector in decimal degree to the given point within a coordinate system that goes possitive to top/right.
divide
(other)
: ovi.mapsapi.util.Vector3D
Creates the componentwise quotient of this vector and the given one.
dot
(other)
: number
Creates the dot product of this vector and the given one.
magnitude
()
: number
Calculates the length of this vector.
multiply
(other)
: ovi.mapsapi.util.Vector3D
Creates the component wise product of this vector and the one given.
normal
(other)
: ovi.mapsapi.util.Vector3D
Creates the normal vector of the plane that is spanned by this and the given vector.
normalize
()
: ovi.mapsapi.util.Vector3D
Creates normalized representation of this vector.
subtract
(other)
: ovi.mapsapi.util.Vector3D
Creates the difference of this vector and the given one.
Field Summary
Constructor Detail
Method Detail
add
(other)
: ovi.mapsapi.util.Vector3D
Creates the sum of this vector and the given one.
Parameters:
{ovi.mapsapi.util.Vector3D}  other  The vector to be added. 
Returns:
{ovi.mapsapi.util.Vector3D}  The sum of this and the given vector. 
angle
([px, [py, [intertX, [intertY]]]])
: Number
Returns the angle of this vector in decimal degree to the given point within a coordinate system that goes
possitive to top/right.
For screen coordinates the Yaxis shall be inverted. For a normalized vector the method can be called without parameters to return it's normalized angle.
For screen coordinates the Yaxis shall be inverted. For a normalized vector the method can be called without parameters to return it's normalized angle.
Parameters:
{Number}  [px]:  The xcoordinate of the point to which the angle shall be calculated, if not given zero is used. 
{Number}  [py]:  The ycoordinate of the point to which the angle shall be calculated, if not given zero is used. 
{Boolean}  [intertX]:  If given and true, the xaxis is inverted, therefore the coordinates are increasing to the left and decreasing to the right. 
{Boolean}  [intertY]:  If given and true, the yaxis is inverted, therefore the coordinates are increasing to the bottom and decreasing to the top. 
Returns:
{Number}  The angle of this vector in degree, relative to the given coordinate. 
divide
(other)
: ovi.mapsapi.util.Vector3D
Creates the componentwise quotient of this vector and the given one.
Parameters:
{ovi.mapsapi.util.Vector3D}  other  The vector to which this one should be divided. 
Returns:
{ovi.mapsapi.util.Vector3D}  The componentwise quotient of this and the given vector. 
dot
(other)
: number
Creates the dot product of this vector and the given one.
Parameters:
{ovi.mapsapi.util.Vector3D}  other  The vector this one should be dotmultiplied with. 
Returns:
{number}  The dot product of this and the given vector. 
magnitude
()
: number
Calculates the length of this vector.
Returns:
{number}  The length of this vector. 
multiply
(other)
: ovi.mapsapi.util.Vector3D
Creates the component wise product of this vector and the one given.
Parameters:
{ovi.mapsapi.util.Vector3D}  other  The vector to be multiplied. 
Returns:
{ovi.mapsapi.util.Vector3D}  The componentwise product of this and the given vector. 
normal
(other)
: ovi.mapsapi.util.Vector3D
Creates the normal vector of the plane that is spanned by this and the given vector.
Parameters:
{ovi.mapsapi.util.Vector3D}  other  The vector that spans the plane together with this. 
Returns:
{ovi.mapsapi.util.Vector3D}  The normal vector of the plane that spans between this and the given vector. 
normalize
()
: ovi.mapsapi.util.Vector3D
Creates normalized representation of this vector.
Returns:
{ovi.mapsapi.util.Vector3D}  The normalized representation (length = 1) of this vector. 
subtract
(other)
: ovi.mapsapi.util.Vector3D
Creates the difference of this vector and the given one.
Parameters:
{ovi.mapsapi.util.Vector3D}  other  The vector to be substracted. 
Returns:
{ovi.mapsapi.util.Vector3D}  The substraction of this and the given vector. 