com.atakmap.android.image.nitf.overlays

Class Overlay

java.lang.Object

com.atakmap.android.image.nitf.overlays.Overlay

Direct Known Subclasses:

CircleOverlay, EllipseOverlay, FreeformOverlay, LabelOverlay, LineOverlay, RectangleOverlay

public abstract class Overlay
extends java.lang.Object

This class stores the data needed to represent an overlay

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Overlay.LineStyle

Field Summary

Fields

Modifier and Type	Field and Description
protected android.graphics.RectF	bounds
protected int	color
protected float	dpiScale
protected int	fillColor
protected int	fontSize
static int	LINE_TYPE_DASH
static int	LINE_TYPE_DASH_DOT
static int	LINE_TYPE_DASH_DOT_DOT
static int	LINE_TYPE_DOT
static int	LINE_TYPE_SOLID
protected java.lang.String	name
protected int	strokeStyle
protected int	strokeWidth
protected static java.lang.String	TAG
protected java.lang.String	uid

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Overlay(java.lang.String name)
protected	Overlay(java.lang.String name, java.lang.String uid) Create a new overlay

Method Summary

Modifier and Type	Method and Description
void	draw(android.graphics.Canvas canvas, android.graphics.Paint paint) Draw overlay on canvas By default this sets up the paint with this overlay's attributes
android.graphics.RectF	getBounds()
int	getColor()
int	getFillColor()
int	getFontSize()
android.graphics.Rect	getIntBounds()
void	getIntBounds(android.graphics.Rect b)
java.lang.String	getName()
android.graphics.PointF[]	getPoints() Get all points that control this overlay
int	getStrokeStyle()
int	getStrokeWidth()
java.lang.String	getUID()
boolean	isFilled()
void	offset(float x, float y) Offset the entire overlay by a given x,y value
void	offset(android.graphics.PointF offset)
void	setColor(int color)
void	setDpiScale(float scale)
void	setFillColor(int color)
void	setFontSize(int size)
void	setName(java.lang.String name)
void	setStrokeStyle(int style)
void	setStrokeWidth(int inSize)
boolean	withinBounds(float x, float y, float tolerance)
static boolean	withinBounds(android.graphics.RectF bounds, float x, float y, float tolerance) Test if a point is within this overlay's boundaries

Methods inherited from class java.lang.Object

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

Field Detail

TAG

protected static final java.lang.String TAG

See Also:

Constant Field Values

LINE_TYPE_SOLID

public static final int LINE_TYPE_SOLID

See Also:

Constant Field Values

LINE_TYPE_DASH

public static final int LINE_TYPE_DASH

See Also:

Constant Field Values

LINE_TYPE_DOT

public static final int LINE_TYPE_DOT

See Also:

Constant Field Values

LINE_TYPE_DASH_DOT

public static final int LINE_TYPE_DASH_DOT

See Also:

Constant Field Values

LINE_TYPE_DASH_DOT_DOT

public static final int LINE_TYPE_DASH_DOT_DOT

See Also:

Constant Field Values

color

protected int color

fillColor

protected int fillColor

strokeWidth

protected int strokeWidth

strokeStyle

protected int strokeStyle

fontSize

protected int fontSize

dpiScale

protected float dpiScale

uid

protected java.lang.String uid

name

protected java.lang.String name

bounds

protected android.graphics.RectF bounds

Constructor Detail

Overlay

protected Overlay(java.lang.String name,
                  java.lang.String uid)

Create a new overlay

Parameters:

uid - Overlay UID

Overlay

protected Overlay(java.lang.String name)

Method Detail

draw

public void draw(android.graphics.Canvas canvas,
                 android.graphics.Paint paint)

Draw overlay on canvas By default this sets up the paint with this overlay's attributes

Parameters:

canvas - Canvas to draw onto

paint - Paint object to use

getPoints

public android.graphics.PointF[] getPoints()

Get all points that control this overlay

Returns:

Array of points

offset

public void offset(float x,
                   float y)

Offset the entire overlay by a given x,y value

Parameters:

x - X offset

y - Y offset

offset

public void offset(android.graphics.PointF offset)

withinBounds

public static boolean withinBounds(android.graphics.RectF bounds,
                                   float x,
                                   float y,
                                   float tolerance)

Test if a point is within this overlay's boundaries

Parameters:

x - Touch point X

y - Touch point Y

tolerance - Touch point tolerance

Returns:

True if within bounds

withinBounds

public boolean withinBounds(float x,
                            float y,
                            float tolerance)

setName

public void setName(java.lang.String name)

setColor

public void setColor(int color)

setFillColor

public void setFillColor(int color)

setStrokeWidth

public void setStrokeWidth(int inSize)

getStrokeWidth

public int getStrokeWidth()

setStrokeStyle

public void setStrokeStyle(int style)

getStrokeStyle

public int getStrokeStyle()

setFontSize

public void setFontSize(int size)

getFontSize

public int getFontSize()

setDpiScale

public void setDpiScale(float scale)

getColor

public int getColor()

getFillColor

public int getFillColor()

isFilled

public boolean isFilled()

getUID

public java.lang.String getUID()

getName

public java.lang.String getName()

getBounds

public android.graphics.RectF getBounds()

getIntBounds

public void getIntBounds(android.graphics.Rect b)

getIntBounds

public android.graphics.Rect getIntBounds()