com.mindgene.d20.common.map

Class GenericMapObject

java.lang.Object

com.mindgene.d20.common.map.GenericMapObject

All Implemented Interfaces:

com.mindgene.d20.common.util.Matchable, com.sengent.common.control.Named, java.io.Serializable

Direct Known Subclasses:

AbstractCreatureInPlay, PublicItemInPlay

public abstract class GenericMapObject
extends java.lang.Object
implements com.mindgene.d20.common.util.Matchable, com.sengent.common.control.Named, java.io.Serializable

Abstract class for an object that exists on the map.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	CLIP_TAB

Constructor Summary

Constructors

Constructor and Description
GenericMapObject() Constructs a new map object with the next assignable UIN.

Method Summary

Modifier and Type	Method and Description
void	assignMap(GenericMapModel map)
static java.awt.Shape	clip_RoundedRectangle(java.awt.Rectangle mobBounds, int pixelsPerCell)
boolean	equals(java.lang.Object o)
float	getElevation()
abstract java.awt.Rectangle	getFootprint()
java.util.List<com.mindgene.d20.common.geometry.Light>	getLights()
java.awt.Point	getLocation()
java.awt.Point	getLocationClosestTo(java.awt.Point to) Returns the coord within this footprint.
java.lang.String	getMapName()
java.lang.Long	getMapUIN()
java.util.List<MapMarker>	getMarkers()
com.mindgene.d20.common.map.movement.MapObjectMovementModel	getMovement()
java.awt.geom.Point2D.Double	getOffset()
java.awt.Point	getPoint(int x, int y)
java.awt.geom.Point2D.Double	getPoint2D(double x, double y)
java.util.List<MapTemplate>	getTemplates()
java.util.List<Tethered>	getTethers()
long	getUIN()
int	hashCode()
boolean	hasMovement()
boolean	inLimbo() Indicates if this creature is in limbo.
boolean	isOnMap(GenericMapModel map)
boolean	isRotated() Deprecated.
boolean	isTetheredTo(Tethered tether)
boolean	matches(com.mindgene.d20.common.util.Matchable o)
void	mimic(GenericMapObject gmo)
void	notifyMobMoved()
abstract void	paint(com.mindgene.d20.common.AbstractApp<?> app, java.awt.Graphics2D g2, com.mindgene.d20.common.util.ImageProvider imgProvider, java.awt.image.ImageObserver observer, java.awt.Rectangle mobBounds, int pixelsPerCell, boolean visible, boolean showRotatedPic, boolean showRotatedArrow, boolean showDamage, com.mindgene.d20.common.creature.CreatureStatusBinder binder, boolean showBorder, com.mindgene.d20.common.options.D20PreferenceModel_Units units)
abstract java.awt.Image	peekPrimaryImage(com.mindgene.d20.common.util.ImageProvider imgProvider)
java.lang.Long	peekUIN()
void	putInLimbo() Move the mini from a valid map to limbo.
void	removeAllLights()
void	removeLights(java.util.List<com.mindgene.d20.common.geometry.Light> lights)
boolean	removeTetherTo(Tethered tether)
java.awt.Point	resolveCenter() Determines the cell coordinate for the center of the creature.
void	setElevation(float elevation)
void	setLights(java.util.List<com.mindgene.d20.common.geometry.Light> lights)
void	setLocation(java.awt.Point location)
void	setLocation(java.awt.geom.Point2D.Double location)
void	setMapName(java.lang.String mapName)
void	setMapUIN(java.lang.Long UIN)
void	setMarkers(java.util.List<MapMarker> markers)
void	setMovement(com.mindgene.d20.common.map.movement.MapObjectMovementModel movement)
void	setOffset(java.awt.geom.Point2D.Double offset)
void	setRotated(boolean rotated) Deprecated.
void	setTemplates(java.util.List<MapTemplate> templates)
void	setTethers(java.util.List<Tethered> tethers)
void	setUIN(long uin)
java.lang.String	toString()
void	translate(java.awt.Point delta)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.sengent.common.control.Named

getName

Field Detail

CLIP_TAB

protected static final int CLIP_TAB

See Also:

Constant Field Values

Constructor Detail

GenericMapObject

public GenericMapObject()

Constructs a new map object with the next assignable UIN.

Method Detail

setUIN

public void setUIN(long uin)

matches

public boolean matches(com.mindgene.d20.common.util.Matchable o)

Specified by:

matches in interface com.mindgene.d20.common.util.Matchable

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getUIN

public long getUIN()

Specified by:

getUIN in interface com.mindgene.d20.common.util.Matchable

peekUIN

public java.lang.Long peekUIN()

mimic

public void mimic(GenericMapObject gmo)

getMapName

public final java.lang.String getMapName()

setMapName

public final void setMapName(java.lang.String mapName)

inLimbo

public boolean inLimbo()

Indicates if this creature is in limbo. A creature is in limbo if its map name is null.

Returns:

putInLimbo

public void putInLimbo()

Move the mini from a valid map to limbo.

See Also:

inLimbo()

assignMap

public final void assignMap(GenericMapModel map)

getMapUIN

public final java.lang.Long getMapUIN()

setMapUIN

public final void setMapUIN(java.lang.Long UIN)

isOnMap

public final boolean isOnMap(GenericMapModel map)

getPoint

public final java.awt.Point getPoint(int x,
                                     int y)

getPoint2D

public final java.awt.geom.Point2D.Double getPoint2D(double x,
                                                     double y)

getLocation

public final java.awt.Point getLocation()

getOffset

public final java.awt.geom.Point2D.Double getOffset()

setOffset

public final void setOffset(java.awt.geom.Point2D.Double offset)

setLocation

public final void setLocation(java.awt.Point location)

setLocation

public final void setLocation(java.awt.geom.Point2D.Double location)

translate

public final void translate(java.awt.Point delta)

notifyMobMoved

public void notifyMobMoved()

getLocationClosestTo

public final java.awt.Point getLocationClosestTo(java.awt.Point to)

Returns the coord within this footprint.

Parameters:

to -

Returns:

isRotated

@Deprecated
public final boolean isRotated()

Deprecated.

setRotated

@Deprecated
public final void setRotated(boolean rotated)

Deprecated.

setMovement

public final void setMovement(com.mindgene.d20.common.map.movement.MapObjectMovementModel movement)

getMovement

public final com.mindgene.d20.common.map.movement.MapObjectMovementModel getMovement()

hasMovement

public final boolean hasMovement()

getFootprint

public abstract java.awt.Rectangle getFootprint()

setElevation

public void setElevation(float elevation)

getElevation

public float getElevation()

resolveCenter

public final java.awt.Point resolveCenter()

Determines the cell coordinate for the center of the creature. For a creature of even size, the center will be the upper left of the 2 or 4 centermost squares.

Returns:

clip_RoundedRectangle

public static java.awt.Shape clip_RoundedRectangle(java.awt.Rectangle mobBounds,
                                                   int pixelsPerCell)

paint

public abstract void paint(com.mindgene.d20.common.AbstractApp<?> app,
                           java.awt.Graphics2D g2,
                           com.mindgene.d20.common.util.ImageProvider imgProvider,
                           java.awt.image.ImageObserver observer,
                           java.awt.Rectangle mobBounds,
                           int pixelsPerCell,
                           boolean visible,
                           boolean showRotatedPic,
                           boolean showRotatedArrow,
                           boolean showDamage,
                           com.mindgene.d20.common.creature.CreatureStatusBinder binder,
                           boolean showBorder,
                           com.mindgene.d20.common.options.D20PreferenceModel_Units units)

getTethers

public final java.util.List<Tethered> getTethers()

setTethers

public final void setTethers(java.util.List<Tethered> tethers)

isTetheredTo

public final boolean isTetheredTo(Tethered tether)

removeTetherTo

public final boolean removeTetherTo(Tethered tether)

getLights

public final java.util.List<com.mindgene.d20.common.geometry.Light> getLights()

setLights

public final void setLights(java.util.List<com.mindgene.d20.common.geometry.Light> lights)

getMarkers

public final java.util.List<MapMarker> getMarkers()

setMarkers

public final void setMarkers(java.util.List<MapMarker> markers)

getTemplates

public final java.util.List<MapTemplate> getTemplates()

setTemplates

public final void setTemplates(java.util.List<MapTemplate> templates)

removeAllLights

public final void removeAllLights()

removeLights

public final void removeLights(java.util.List<com.mindgene.d20.common.geometry.Light> lights)

peekPrimaryImage

public abstract java.awt.Image peekPrimaryImage(com.mindgene.d20.common.util.ImageProvider imgProvider)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object