com.gwidgets.api.leaflet

Class Point

java.lang.Object

com.gwidgets.api.leaflet.Point

@JsType(isNative=true)
public class Point
extends java.lang.Object

Represents a point with x and y coordinates in pixels.

Author:

Zakaria Amine

Constructor Summary

Constructors

Constructor and Description
Point(java.lang.Number newX, java.lang.Number newY) Instantiates a new point.

Method Summary

Modifier and Type	Method and Description
Point	add(Point otherPoint) Returns the result of addition of the current and the given points.
Point	clone()
java.lang.Boolean	contains(Point point) Returns true if the both coordinates of the given point are less than the corresponding current point coordinates (in absolute values).
java.lang.Number	distanceTo(Point otherPoint) Returns the distance between the current and the given points.
Point	divideBy(java.lang.Number number, java.lang.Boolean round) Returns the result of division of the current point by the given number.
java.lang.Boolean	equals(Point otherPoint) Returns true if the given point has the same coordinates.
Point	floor() Returns a copy of the current point with floored coordinates (rounded down).
Point	multiplyBy(java.lang.Number number) Returns the result of multiplication of the current point by the given number.
Point	round() Returns a copy of the current point with rounded coordinates.
Point	subtract(Point otherPoint) Returns the result of subtraction of the given point from the current.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Point

@JsConstructor
public Point(java.lang.Number newX,
                             java.lang.Number newY)

Instantiates a new point.

Parameters:

newX - the new X

newY - the new Y

Method Detail

add

@JsMethod
public Point add(Point otherPoint)

Returns the result of addition of the current and the given points.

Parameters:

otherPoint - the other point

Returns:

the point

subtract

@JsMethod
public Point subtract(Point otherPoint)

Returns the result of subtraction of the given point from the current.

Parameters:

otherPoint - the other point

Returns:

the point

multiplyBy

@JsMethod
public Point multiplyBy(java.lang.Number number)

Returns the result of multiplication of the current point by the given number.

Parameters:

number - the number

Returns:

the point

divideBy

@JsMethod
public Point divideBy(java.lang.Number number,
                                 java.lang.Boolean round)

Returns the result of division of the current point by the given number. If optional round is set to true, returns a rounded result.

Parameters:

number - the number

round - the round

Returns:

the point

distanceTo

@JsMethod
public java.lang.Number distanceTo(Point otherPoint)

Returns the distance between the current and the given points.

Parameters:

otherPoint - the other point

Returns:

the number

clone

@JsMethod
public Point clone()

Overrides:

clone in class java.lang.Object

round

@JsMethod
public Point round()

Returns a copy of the current point with rounded coordinates.

Returns:

the point

floor

@JsMethod
public Point floor()

Returns a copy of the current point with floored coordinates (rounded down).

Returns:

the point

contains

@JsMethod
public java.lang.Boolean contains(Point point)

Returns true if the both coordinates of the given point are less than the corresponding current point coordinates (in absolute values).

Parameters:

point - the point

Returns:

true/false

equals

@JsMethod
public java.lang.Boolean equals(Point otherPoint)

Returns true if the given point has the same coordinates.

Parameters:

otherPoint - the other point

Returns:

true/false

toString

@JsMethod
public java.lang.String toString()

Overrides:

toString in class java.lang.Object