Telogis.GeoBase.MathUtil

Finds the initial bearing that one would have to travel in to move in a straight line along a great-circle arc from one location to another.

var bearing = Telogis.GeoBase.MathUtil.bearing(
    new Telogis.GeoBase.LatLon(33.587137,-117.742878),
    new Telogis.GeoBase.LatLon(33.575037,-117.724762)
);
alert('Heading from->to is '+bearing+' degrees');

• from (LatLon) - The latitude-longitude coordinates to take the bearing from.

• to (LatLon) - The latitude-longitude coordinates to take the bearing to.

Number - The bearing (degrees true) to initially travel in from MathUtil.bearing.from to MathUtil.bearing.to. That is, 0 degrees indicates direct north, 90 degrees due east, and so on.

Finds the compass point represented by a certain bearing angle.

var bearing = 135;
var compass = Telogis.GeoBase.MathUtil.bearingToCompass(bearing);
alert(bearing+' degrees converts to a compass direction of '+compass);

• bearing (Number) - The bearing to convert to a compass direction, in degrees true (clockwise from north).

String - The compass direction closest to MathUtil.bearingToCompass.bearing. This may be any of "N", "NE", "E", "SE", "S", "SW", "W", or "NW".

Finds the closest value to a specified integer that falls within a specified range.

• x (Number) - The value to clamp.

• minValue (Number) - The minimum value that can be returned.

• maxValue (Number) - The maximum value that can be returned.

Number - If MathUtil.clamp.x lies between MathUtil.clamp.minValue and MathUtil.clamp.maxValue, the result is MathUtil.clamp.x. Otherwise, the result is MathUtil.clamp.minValue if MathUtil.clamp.x is less than MathUtil.clamp.minValue, or MathUtil.clamp.maxValue if MathUtil.clamp.x is greater than MathUtil.clamp.maxValue.

Converts between one kind of SpeedUnit and another.

var val = 10;
var conv = Telogis.GeoBase.MathUtil.convertSpeedUnits(
    val,
    Telogis.GeoBase.SpeedUnit.MilesPerHour,
    Telogis.GeoBase.SpeedUnit.KilometersPerHour
);
alert(val + ' mph equates to ' + conv + ' kmh');

• value (Number) - The value to convert.

• fromUnits (String) - The string abbreviation of the type of units to convert from, which should be a SpeedUnit code.

• toUnits (String) - The string abbreviation of the type of units to convert to, which should be a SpeedUnit code.

Number - MathUtil.convertSpeedUnits.value represented in MathUtil.convertSpeedUnits.toUnits.

Converts between one kind of TimeUnit and another.

var val = 10;
var conv = Telogis.GeoBase.MathUtil.convertTimeUnits(
    val,
    Telogis.GeoBase.TimeUnit.MINUTES,
    Telogis.GeoBase.TimeUnit.SECONDS
);
alert(val + ' minutes equates to ' + conv + ' seconds');

• value (Number) - The value to convert.

• fromUnits (String) - The string abbreviation of the type of units to convert from, which should be a TimeUnit code.

• toUnits (String) - The string abbreviation of the type of units to convert to, which should be a TimeUnit code.

Number - MathUtil.convertTimeUnits.value represented in MathUtil.convertTimeUnits.toUnits.

Converts between one kind of DistanceUnit and another.

var val = 10;
var conv = Telogis.GeoBase.MathUtil.convertUnits(
    val,
    Telogis.GeoBase.DistanceUnit.MILES,
    Telogis.GeoBase.DistanceUnit.KILOMETERS
);
alert(val + ' Miles equates to ' + conv + ' Kilometers');

• value (Number) - The value to convert.

• fromUnits (String) - The string abbreviation of the type of units to convert from, which should be a DistanceUnit code.

• toUnits (String) - The string abbreviation of the type of units to convert to, which should be a DistanceUnit code.

Number - MathUtil.convertUnits.value represented in MathUtil.convertUnits.toUnits.

Constructs the coordinate point that is located at a displacement of a certain distance (along a shortest great-circle arc) and bearing from a given LatLon.

//    Locate a point 10 miles from the specified LatLon at a bearing
//    of 90 degrees
var displace = Telogis.GeoBase.MathUtil.displace(
    new Telogis.GeoBase.LatLon(33.587137,-117.742878),
    10,
    90,
    Telogis.GeoBase.DistanceUnit.MILES
);
alert(displace);

• from (LatLon) - The latitude-longitude coordinate point to perform the displacement calculation from.

• dist (Number) - The distance from MathUtil.displace.from, in the specified MathUtil.displace.units, to construct the second location from.

• bearing (Number) - The bearing relative to MathUtil.displace.from, in degrees true, to construct the second location at.

• units (String) - The string abbreviation of the units that MathUtil.displace.dist is specified in, which should be a DistanceUnit code.

LatLon - A new LatLon location the specified distance from MathUtil.displace.from and at the specified bearing relative to it.

Finds the distance covered by traveling in a great-circle from one latitude-longitude location to another, in the specified units.

var dist = Telogis.GeoBase.MathUtil.distance(
    new Telogis.GeoBase.LatLon(33.587137,-117.742878),
    new Telogis.GeoBase.LatLon(33.575037,-117.724762),
    Telogis.GeoBase.DistanceUnit.KILOMETERS
);
alert('Point-to-point distance is ' + dist + ' Kilometers');

• from (LatLon) - The location to measure the distance from.

• to (LatLon) - The location to measure the distance to.

• (Optional) units (String) - The string abbreviation of the units that the calculated distance should be given in, which should be a DistanceUnit code. Defaults to DistanceUnit.MILES.

Number - The great-circle distance of MathUtil.distance.to from MathUtil.distance.from, measured in MathUtil.distance.units.

Finds the positive modulo value of a given number with respect to a certain base. This differs from the built-in modulo operation in that using the % will return a negative number when used with negative values.

• value (Number) - The value to take the modulo of.

• base (Number) - The base of the modulo operation.

Number - The smallest positive number congruent to MathUtil.positiveModulo.value, relative to MathUtil.positiveModulo.base.

Converts an angle from radians to degrees.

• radians (Number) - The value of the angle in radians.

Number - MathUtil.toDegrees.radians represented in degrees.

Converts an angle from degrees to radians.

• degrees (Number) - The value of the angle in degrees.

Number - MathUtil.toRadians.degrees represented in radians.