com.atakmap.android.maps

Class Wedge

java.lang.Object

com.atakmap.android.maps.FilterMetaDataHolder

com.atakmap.android.maps.MapItem

com.atakmap.android.maps.Shape

com.atakmap.android.maps.Polyline

com.atakmap.android.maps.Wedge

All Implemented Interfaces:

URIContent, HashtagContent, Capturable, MetaDataHolder, VisibilityListener

public class Wedge
extends Polyline

A wedge describes a triangle (drawn below) with vertex points (X, Y, Y'). There is an offset triangle (labeled "off") below, that allows you to skip an angleX (labeled "x") before drawing your desired wedge with angle "angleXprime" (labeled x' in the diagram below). Y' /| label0 / | / | / | / |Y label2 / /| / / | /x'/ | / /x off| X ---------- Z label1 Upper-case letters are points, (e.g., X, Y, Z, Y'). In code, we denote them as "pointX" or "pointYprime". Lower-case letters are angles, (e.g., x, x', y, y') In code, we denote them as "angleX" or "angleXprime". when labeling

Nested Class Summary

Nested classes/interfaces inherited from class com.atakmap.android.maps.Polyline

Polyline.OnAltitudeModeChangedListener, Polyline.OnHeightStyleChangedListener, Polyline.OnLabelsChangedListener, Polyline.OnLabelTextSizeChanged

Nested classes/interfaces inherited from class com.atakmap.android.maps.Shape

Shape.OnBasicLineStyleChangedListener, Shape.OnFillColorChangedListener, Shape.OnPointsChangedListener, Shape.OnStrokeColorChangedListener, Shape.OnStrokeWeightChangedListener, Shape.OnStyleChangedListener

Nested classes/interfaces inherited from class com.atakmap.android.maps.MapItem

MapItem.OnClickableChangedListener, MapItem.OnGroupChangedListener, MapItem.OnHeightChangedListener, MapItem.OnMetadataChangedListener, MapItem.OnTypeChangedListener, MapItem.OnVisibleChangedListener, MapItem.OnZOrderChangedListener

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TAG

Fields inherited from class com.atakmap.android.maps.Polyline

_points, DEFAULT_MAX_LABEL_RENDER_RESOLUTION, DEFAULT_MAX_LINE_RENDER_RESOLUTION, DEFAULT_MIN_LABEL_RENDER_RESOLUTION, DEFAULT_MIN_LINE_RENDER_RESOLUTION, HEIGHT_EXTRUDE_CENTER_ALT, HEIGHT_EXTRUDE_DEFAULT, HEIGHT_EXTRUDE_MAX_ALT, HEIGHT_EXTRUDE_MIN_ALT, HEIGHT_EXTRUDE_PER_POINT, HEIGHT_STYLE_NONE, HEIGHT_STYLE_OUTLINE, HEIGHT_STYLE_OUTLINE_SIMPLE, HEIGHT_STYLE_POLYGON, HEIGHT_STYLE_TOP_ONLY, minimumBoundingBox, PARTITION_SIZE, STYLE_CLOSED_MASK, STYLE_OUTLINE_HALO_MASK, STYLE_OUTLINE_STROKE_MASK

Fields inherited from class com.atakmap.android.maps.Shape

BASIC_LINE_STYLE_DASHED, BASIC_LINE_STYLE_DOTTED, BASIC_LINE_STYLE_OUTLINED, BASIC_LINE_STYLE_SOLID, STYLE_FILLED_MASK, STYLE_STROKE_MASK

Fields inherited from class com.atakmap.android.maps.MapItem

CLICKABLE_DEFAULT, EDITABLE_DEFAULT, EMPTY_TYPE, HIT_RATIO_DEFAULT, MOVABLE_DEFAULT, VISIBLE_DEFAULT, ZORDER_DEFAULT, ZORDER_HITTEST_COMPARATOR, ZORDER_RENDER_COMPARATOR

Fields inherited from class com.atakmap.android.maps.FilterMetaDataHolder

metadata

Constructor Summary

Constructors

Constructor and Description
Wedge(long serialId, MetaDataHolder metadata, java.lang.String uid)
Wedge(java.lang.String uid) Default constructor.

Method Summary

Modifier and Type	Method and Description
double	getAngle()
double	getDistanceMultiplier()
GeoPoint	getEndPoint()
double	getOffsetAngle()
GeoPoint	getSourcePoint()
Wedge	setAngle(java.lang.Double angleXprime) Sets the primary interior angle for the Wedge.
Wedge	setAngle(double angleXprime, boolean showLabel) Sets the primary interior angle for the Wedge.
Wedge	setAngle(double angleXprime, java.lang.String label0, java.lang.String label1, java.lang.String label2) Sets the primary interior angle for the Wedge.
Wedge	setDistanceMultiplier(java.lang.Double multiplier) The multiplier to place the wedge past the z point.
Wedge	setEndPoint(GeoPoint pointZ) Sets the end point for the wedge.
Wedge	setOffsetAngle(java.lang.Double angleX) Sets the offset angle for this Wedge.
Wedge	setSourcePoint(GeoPoint pointX) Sets the originating point for the wedge.
java.lang.String	toString() Default string conversion which contains the UID, type, and title

Methods inherited from class com.atakmap.android.maps.Polyline

addHeightStyle, addOnHeightStyleChangedListener, addOnLabelsChangedListener, addOnLabelTextSizeChangedListener, drawCanvas, getBounds, getCenter, getHeightExtrudeMode, getHeightStyle, getLabels, getLabelTextSize, getLabelTypeface, getLineLabel, getMetaDataPoints, getPerimeterOrLength, getPoints, getPoints, getPoints, getRelativeBounds, getTotalDistance, onHeightStyleChanged, onLabelsChanged, onLabelTextSizeChanged, onMetadataChanged, onPointsChanged, preDrawCanvas, removeHeightStyle, removeOnHeightStyleChangedListener, removeOnLabelsChangedListener, removeOnLabelTextSizeChangedListner, setHeightExtrudeMode, setHeightStyle, setLabels, setLabelTextSize, setLabelTextSize, setLabelTextTypeface, setLineLabel, setMaxLabelRenderResolution, setMaxRenderResolution, setMinLabelRenderResolution, setMinRenderResolution, setPoints, setPoints, setPoints, setPoints

Methods inherited from class com.atakmap.android.maps.Shape

addOnBasicLineStyleChangedListener, addOnFillColorChangedListener, addOnPointsChangedListener, addOnStrokeColorChangedListener, addOnStrokeWeightChangedListener, addOnStyleChangedListener, addStyleBits, findTouchPoint, getArea, getBasicLineStyle, getClickPoint, getFillColor, getGeoPointMetaData, getIconColor, getStrokeColor, getStrokeStyle, getStrokeWeight, getStyle, getTitle, onBasicLineStyleChanged, onFillColorChanged, onStrokeColorChanged, onStrokeStyleChanged, onStrokeWeightChanged, onStyleChanged, removeOnBasicLineStyleChangedListener, removeOnFillColorChangedListener, removeOnPointsChangedListener, removeOnStrokeColorChangedListener, removeOnStrokeWeightChangedListener, removeOnStyleChangedListener, removeStyleBits, setBasicLineStyle, setColor, setColor, setFillAlpha, setFillColor, setStrokeColor, setStrokeStyle, setStrokeWeight, setStyle, setTitle, setTouchPoint, wrap180

Methods inherited from class com.atakmap.android.maps.MapItem

addOnAltitudeModeChangedListener, addOnClickableChangedListener, addOnGroupChangedListener, addOnHeightChangedListener, addOnMetadataChangedListener, addOnMetadataChangedListener, addOnTypeChangedListener, addOnVisibleChangedListener, addOnZOrderChangedListener, computeDistance, copyMetaData, createSerialId, dispose, getAltitudeMode, getClickable, getEditable, getGroup, getHashtags, getHeight, getHitRadius, getIconDrawable, getMetaBoolean, getMetaString, getMovable, getRadialMenuPath, getRemarks, getRemarksKey, getSerialId, getTag, getType, getUID, getUniqueMapItemName, getURI, getVisible, getVisible, getZOrder, isTouchable, notifyMetadataChanged, onAdded, onAltitudeModeChanged, onClickableChanged, onGroupChanged, onHeightChanged, onRemoved, onTypeChanged, onVisibilityConditions, onVisibleChanged, onZOrderChanged, persist, refresh, removeFromGroup, removeMetaData, removeOnAltitudeModeChangedListener, removeOnClickableChangedListener, removeOnGroupChangedListener, removeOnHeightChangedListener, removeOnMetadataChangedListener, removeOnMetadataChangedListener, removeOnTypeChangedListener, removeOnVisibleChangedListener, removeOnZOrderChangedListener, setAltitudeMode, setClickable, setClickPoint, setEditable, setHashtags, setHeight, setMetaBoolean, setMetaData, setMetaDouble, setMetaIntArray, setMetaInteger, setMetaLong, setMetaMap, setMetaParcelable, setMetaSerializable, setMetaString, setMetaStringArrayList, setMovable, setRadialMenu, setRemarks, setTag, setTouchable, setType, setVisible, setVisible, setZOrder, testOrthoHit

Methods inherited from class com.atakmap.android.maps.FilterMetaDataHolder

get, getMetaData, getMetaDouble, getMetaIntArray, getMetaInteger, getMetaLong, getMetaMap, getMetaParcelable, getMetaSerializable, getMetaStringArrayList, hasMetaValue, setMetaDataImpl, toggleMetaData

Methods inherited from class java.lang.Object

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

Field Detail

TAG

public static final java.lang.String TAG

See Also:

Constant Field Values

Constructor Detail

Wedge

public Wedge(java.lang.String uid)

Default constructor.

Wedge

public Wedge(long serialId,
             MetaDataHolder metadata,
             java.lang.String uid)

Method Detail

setSourcePoint

public Wedge setSourcePoint(GeoPoint pointX)

Sets the originating point for the wedge.

Parameters:

pointX - A valid GeoPoint denoting the start of the Wedge.

Returns:

- A new immutable Wedge instance with the source point set. If pointX is null, a default Wedge instance is returned.

setEndPoint

public Wedge setEndPoint(GeoPoint pointZ)

Sets the end point for the wedge. See class documentation for how the Wedge is computed.

Parameters:

pointZ - A valid GeoPoint denoting the end of the Wedge.

Returns:

- A new immutable Wedge instance with its end point set. If poinZ is null, a default Wedge instance is returned.

setDistanceMultiplier

public Wedge setDistanceMultiplier(java.lang.Double multiplier)

The multiplier to place the wedge past the z point. Defaults to a value of 1.0. So the wedge would be the exact same distance as Point X to Point Z.

Parameters:

multiplier - A double representing the distance multiplier

Returns:

- A new immutable Wedge instance with the multiplier value.

setOffsetAngle

public Wedge setOffsetAngle(java.lang.Double angleX)

Sets the offset angle for this Wedge. Setting this angle will rotate the Wedge by the supplied value when drawing to screen.

Parameters:

angleX - The desired offset angle expressed in degrees

Returns:

A new immutable Wedge instance with the offset angle set.

setAngle

public Wedge setAngle(java.lang.Double angleXprime)

Sets the primary interior angle for the Wedge.

Parameters:

angleXprime - The desired primary interior angle expressed in degrees. The sum of all interior angles must be less than 180 degrees.

Returns:

A new immutable Wedge instance with the primary angle set. If the angleXPrime angle is invalid then a default Wedge instance is returned.

setAngle

public Wedge setAngle(double angleXprime,
                      boolean showLabel)

Sets the primary interior angle for the Wedge.

Parameters:

angleXprime - The desired primary interior angle expressed in degrees. The sum of all interior angles must be less than 180 degrees.

showLabel - Indicate whether or not the Wedge should have a Label indicating the primary interior angle.

Returns:

A new immutable Wedge instance with the primary angle set. If the angleXPrime angle is invalid then a default Wedge instance is returned.

setAngle

public Wedge setAngle(double angleXprime,
                      java.lang.String label0,
                      java.lang.String label1,
                      java.lang.String label2)

Sets the primary interior angle for the Wedge.

Parameters:

angleXprime - The desired primary interior angle expressed in degrees. The sum of all interior angles must be less than 180 degrees.

label0 - the label to be displayed for label0 described in the header of this class X->Y' which can be null or empty.

label1 - the label to be displayed for label1 described in the header of this class X->Z which can be null or empty.

label2 - the label to be displayed for label2 described in the header of this class Z->Y' which can be null or empty.

Returns:

A new immutable Wedge instance with the primary angle set. If the angleXPrime angle is invalid then a default Wedge instance is returned.

getSourcePoint

public GeoPoint getSourcePoint()

getEndPoint

public GeoPoint getEndPoint()

getDistanceMultiplier

public double getDistanceMultiplier()

getOffsetAngle

public double getOffsetAngle()

getAngle

public double getAngle()

toString

public java.lang.String toString()

Description copied from class: MapItem

Default string conversion which contains the UID, type, and title

Overrides:

toString in class MapItem

Returns:

Title, type, UID