com.mindgene.d20.common.map

Class MapMarker

java.lang.Object

com.mindgene.d20.common.map.MapMarker

All Implemented Interfaces:

Tethered, java.io.Serializable, java.lang.Comparable<MapMarker>

public final class MapMarker
extends java.lang.Object
implements java.lang.Comparable<MapMarker>, java.io.Serializable, Tethered

Model for a map marker.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MapMarker.Layer
static class	MapMarker.MarkerKey
static class	MapMarker.Size
static class	MapMarker.Style

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
MapMarker()

Method Summary

Modifier and Type	Method and Description
void	assignDescription(java.lang.String description)
void	attach(GenericMapModel map)
MapMarker.MarkerKey	buildKey()
int	compareTo(MapMarker o)
java.lang.String	declareTooltip()
void	detach(GenericMapModel map)
java.awt.Shape	footprint()
com.mindgene.d20.common.creature.CreatureLabel	getBottomLabel()
java.awt.Color	getColor()
boolean	getCustomSize()
java.lang.String	getDescription()
float	getHeight()
java.lang.String	getIcon()
short	getIconId()
MapMarker.Layer	getLayer()
java.util.List<com.d20pro.common.hyperlink.D20Hyperlink>	getLinks()
java.lang.String	getName()
float	getRadius()
int	getRotateBy()
float	getRotation()
int	getStyle()
Tethered	getTether()
java.lang.String	getTextDescription()
com.mindgene.d20.common.creature.CreatureLabel	getTopLabel()
java.lang.String	getType()
float	getWidth()
float	getX()
float	getY()
boolean	isBeneath(java.awt.geom.Point2D.Float mapLocation)
boolean	isDescVisible() Deprecated.
boolean	isLocked()
boolean	isVisible()
boolean	isVisibleTo(java.lang.String playerName)
boolean	ownedBy(java.lang.String playerName)
void	paintIconImmediate(java.awt.Graphics2D g2, java.awt.Point at, int pixelsPerCell, float markerRadius, boolean isVisible, com.mindgene.d20.common.util.ImageProvider provider, java.awt.image.ImageObserver observer)
void	paintImmediate(java.awt.Graphics2D g2, GenericMapView mapView)
void	paintImmediate(java.awt.Graphics2D g2, java.awt.Point at, int pixelsPerCell, float markerRadius, boolean isVisible, com.mindgene.d20.common.util.ImageProvider provider, java.awt.image.ImageObserver observer)
void	recognizeMobMoved(GenericMapObject mob)
void	setBottomLabel(com.mindgene.d20.common.creature.CreatureLabel bottomLabel)
void	setColor(java.awt.Color color)
void	setCustomSize(boolean v)
void	setDescription(java.lang.String description) Deprecated. - XML Only call assignDescription( String )
void	setDescVisible(boolean descVisible) Deprecated.
void	setHeight(float height)
void	setIcon(java.lang.String icon)
void	setIconId(short iconId)
void	setLayer(MapMarker.Layer layer)
void	setLinks(java.util.List<com.d20pro.common.hyperlink.D20Hyperlink> links)
void	setLocked(boolean locked)
void	setName(java.lang.String name)
void	setRadius(float radius)
void	setRotateBy(int r)
void	setRotation(float r)
void	setStyle(int style)
void	setTopLabel(com.mindgene.d20.common.creature.CreatureLabel topLabel)
void	setType(java.lang.String type)
void	setVisible(boolean visible)
void	setWidth(float width)
void	setX(float x)
void	setY(float y)
void	toggleVisibility()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

PLAYER_TYPE_PREFIX

public static final java.lang.String PLAYER_TYPE_PREFIX

See Also:

Constant Field Values

Constructor Detail

MapMarker

public MapMarker()

Method Detail

getIconId

public short getIconId()

setIconId

public void setIconId(short iconId)

buildKey

public MapMarker.MarkerKey buildKey()

ownedBy

public boolean ownedBy(java.lang.String playerName)

isVisibleTo

public boolean isVisibleTo(java.lang.String playerName)

Parameters:

playerName - username or player or null for judge

Returns:

boolean

getTextDescription

public java.lang.String getTextDescription()

getDescription

public java.lang.String getDescription()

isDescVisible

@Deprecated
public boolean isDescVisible()

Deprecated.

getName

public java.lang.String getName()

getType

public java.lang.String getType()

isVisible

public boolean isVisible()

getRadius

public float getRadius()

getWidth

public float getWidth()

getHeight

public float getHeight()

getRotation

public float getRotation()

getRotateBy

public int getRotateBy()

getCustomSize

public boolean getCustomSize()

setCustomSize

public void setCustomSize(boolean v)

setRotateBy

public void setRotateBy(int r)

setRotation

public void setRotation(float r)

setWidth

public void setWidth(float width)

setHeight

public void setHeight(float height)

setRadius

public void setRadius(float radius)

getX

public float getX()

getY

public float getY()

assignDescription

public void assignDescription(java.lang.String description)

setDescription

@Deprecated
public void setDescription(java.lang.String description)

Deprecated. - XML Only call assignDescription( String )

setDescVisible

@Deprecated
public void setDescVisible(boolean descVisible)

Deprecated.

setName

public void setName(java.lang.String name)

setType

public void setType(java.lang.String type)

setVisible

public void setVisible(boolean visible)

toggleVisibility

public void toggleVisibility()

setX

public void setX(float x)

setY

public void setY(float y)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

paintImmediate

public void paintImmediate(java.awt.Graphics2D g2,
                           GenericMapView mapView)

paintImmediate

public void paintImmediate(java.awt.Graphics2D g2,
                           java.awt.Point at,
                           int pixelsPerCell,
                           float markerRadius,
                           boolean isVisible,
                           com.mindgene.d20.common.util.ImageProvider provider,
                           java.awt.image.ImageObserver observer)

paintIconImmediate

public void paintIconImmediate(java.awt.Graphics2D g2,
                               java.awt.Point at,
                               int pixelsPerCell,
                               float markerRadius,
                               boolean isVisible,
                               com.mindgene.d20.common.util.ImageProvider provider,
                               java.awt.image.ImageObserver observer)

isBeneath

public boolean isBeneath(java.awt.geom.Point2D.Float mapLocation)

footprint

public java.awt.Shape footprint()

getColor

public java.awt.Color getColor()

setColor

public void setColor(java.awt.Color color)

declareTooltip

public java.lang.String declareTooltip()

compareTo

public int compareTo(MapMarker o)

Specified by:

compareTo in interface java.lang.Comparable<MapMarker>

setStyle

public void setStyle(int style)

getStyle

public int getStyle()

isLocked

public boolean isLocked()

setLocked

public void setLocked(boolean locked)

getLayer

public MapMarker.Layer getLayer()

setLayer

public void setLayer(MapMarker.Layer layer)

getTopLabel

public com.mindgene.d20.common.creature.CreatureLabel getTopLabel()

setTopLabel

public void setTopLabel(com.mindgene.d20.common.creature.CreatureLabel topLabel)

getBottomLabel

public com.mindgene.d20.common.creature.CreatureLabel getBottomLabel()

setBottomLabel

public void setBottomLabel(com.mindgene.d20.common.creature.CreatureLabel bottomLabel)

getLinks

public java.util.List<com.d20pro.common.hyperlink.D20Hyperlink> getLinks()

getTether

public Tethered getTether()

setLinks

public void setLinks(java.util.List<com.d20pro.common.hyperlink.D20Hyperlink> links)

recognizeMobMoved

public void recognizeMobMoved(GenericMapObject mob)

Specified by:

recognizeMobMoved in interface Tethered

attach

public void attach(GenericMapModel map)

Specified by:

attach in interface Tethered

detach

public void detach(GenericMapModel map)

Specified by:

detach in interface Tethered

getIcon

public java.lang.String getIcon()

setIcon

public void setIcon(java.lang.String icon)