com.atakmap.coremap.conversions

Class AngleUtilities

java.lang.Object

com.atakmap.coremap.conversions.AngleUtilities

public class AngleUtilities
extends java.lang.Object

Provides common utilities for formatting and converting Angles within ATAK.

Constructor Summary

Constructors

Constructor and Description
AngleUtilities()

Method Summary

Modifier and Type	Method and Description
static double	convert(double value, Angle from, Angle to) /**
static java.lang.String	format(double value) Wrap degree value to range 1 - 360 and add degree sign
static java.lang.String	format(double value, Angle units)
static java.lang.String	format(double value, Angle from, Angle to)
static java.lang.String	format(double value, Angle from, Angle to, boolean isBearing)
static java.lang.String	format(double value, Angle from, Angle to, int decimalPoints)
static java.lang.String	format(double value, Angle units, boolean isBearing)
static java.lang.String	format(double value, Angle units, int decimalPoints)
static java.lang.String	format(double value, int decimalPoints)
static java.lang.String	formatNoUnitsNoDecimal(double value, Angle from, Angle to)
static int	roundDeg(double deg) Return rounded degree value
static int	roundDeg(double deg, boolean isBearing) Return rounded degree value
static double	roundDeg(double deg, int dec) Return rounded degree value
static double	roundDeg(double deg, int dec, boolean isBearing) Return rounded degree value
static double	wrapDeg(double deg) Wrap degree value to range

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AngleUtilities

public AngleUtilities()

Method Detail

format

public static java.lang.String format(double value)

Wrap degree value to range 1 - 360 and add degree sign

Parameters:

value - Angle degree value

Returns:

Angle as string

format

public static java.lang.String format(double value,
                                      Angle units)

Parameters:

value - The value as a raw number

units - The unit unit for the raw number

Returns:

a properly formatted string representing the raw number in the correct units.

format

public static java.lang.String format(double value,
                                      Angle units,
                                      boolean isBearing)

Parameters:

value - The value as a raw number

units - The unit unit for the raw number

isBearing - if the value is used for bearing 1-360 for the range (isBearing = true)

Returns:

a properly formatted string representing the raw number in the correct units.

format

public static java.lang.String format(double value,
                                      Angle from,
                                      Angle to)

Parameters:

value - The value as a raw number

from - The unit unit for the raw number

to - is the unit to convert to prior to formatting.

Returns:

a properly formatted string representing the raw number in the correct units.

formatNoUnitsNoDecimal

public static java.lang.String formatNoUnitsNoDecimal(double value,
                                                      Angle from,
                                                      Angle to)

Parameters:

value - The value as a raw number

from - The unit unit for the raw number

to - is the unit to convert to prior to formatting.

Returns:

a properly formatted string in the correct units without any unit label or decimal places.

format

public static java.lang.String format(double value,
                                      Angle from,
                                      Angle to,
                                      boolean isBearing)

Parameters:

value - a value as a raw number

from - the unit for the value

to - the units to convert to prior to formatting

isBearing - if the unit is used for bearing

Returns:

formatted the value in the requested new unit.

format

public static java.lang.String format(double value,
                                      int decimalPoints)

Parameters:

value - a raw number in Angle.DEGREE

decimalPoints - the number of decimal points to use when formatting

Returns:

the properly formated string of the DEGREE with the requested number of decimal points.

format

public static java.lang.String format(double value,
                                      Angle units,
                                      int decimalPoints)

Parameters:

value - a raw number described by the units

units - The unit describing the value

decimalPoints - the number of decimal points to use when formatting

Returns:

the properly formatted string of the DEGREE with the requested number of decimal points.

format

public static java.lang.String format(double value,
                                      Angle from,
                                      Angle to,
                                      int decimalPoints)

Parameters:

value - a raw number describe by the supplied from field

from - the units describing the value

to - the unit to convert to prior to formatting

decimalPoints - the number of decimal points to use during formatting where it is no greater than 4.

Returns:

the properly string in the requested units with the correct number of decimal points.

convert

public static double convert(double value,
                             Angle from,
                             Angle to)

/**

Parameters:

value - a raw number describe by the supplied from field

from - the units describing the value

to - the unit to convert to prior to formatting

Returns:

a raw number representing the angle in the new units.

wrapDeg

public static double wrapDeg(double deg)

Wrap degree value to range

Parameters:

deg - Degree value

Returns:

Degree between range using 1-360 for the range (isBearing = true)

roundDeg

public static double roundDeg(double deg,
                              int dec,
                              boolean isBearing)

Return rounded degree value

Parameters:

deg - Degree value

dec - Number of decimal places to round to

Returns:

Degree between 1 and 360

roundDeg

public static double roundDeg(double deg,
                              int dec)

Return rounded degree value

Parameters:

deg - Degree value

dec - Number of decimal places to round to

roundDeg

public static int roundDeg(double deg,
                           boolean isBearing)

Return rounded degree value

Parameters:

deg - Degree value

isBearing - 1-360 for the range (isBearing = true)

Returns:

the rounded degree value with no decimal places.

roundDeg

public static int roundDeg(double deg)

Return rounded degree value

Parameters:

deg - Degree value

Returns:

Degree between 1 and 360 with no decimal places.