Package VASSAL.counters

Class AreaOfEffect

java.lang.Object

VASSAL.counters.Decorator

VASSAL.counters.AreaOfEffect

All Implemented Interfaces:

MapShader.ShadedPiece, PropertyNameSource, PropertySource, EditablePiece, GamePiece, PropertyExporter, StateMergeable, TranslatablePiece, PersistentPropertyContainer

public class AreaOfEffect
extends Decorator
implements TranslatablePiece, MapShader.ShadedPiece

Author:

Scott Giese sgiese@sprintmail.com Displays a transparency surrounding the GamePiece which represents the Area of Effect of the GamePiece

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AreaOfEffect.TraitEditor

Field Summary

Fields

Modifier and Type	Field	Description
protected String	activateCommand
protected NamedKeyStroke	activateKey
protected boolean	active
protected boolean	alwaysActive
protected KeyCommand[]	commands
protected static int	defaultRadius
protected static Color	defaultTransparencyColor
protected static float	defaultTransparencyLevel
protected String	description
protected boolean	fixedRadius
static String	ID
protected KeyCommand	keyCommand
protected String	mapShaderName
protected int	radius
protected String	radiusMarker
protected MapShader	shader
protected Color	transparencyColor
protected float	transparencyLevel

Fields inherited from class VASSAL.counters.Decorator

piece

Fields inherited from interface VASSAL.counters.PropertyExporter

LOCALIZED_NAME

Fields inherited from interface VASSAL.i18n.TranslatablePiece

PREFIX

Constructor Summary

Constructors

Constructor	Description
AreaOfEffect()
AreaOfEffect(String type, GamePiece inner)

Method Summary

Modifier and Type	Method	Description
Rectangle	boundingBox()	The area which this GamePiece occupies when drawn at the point (0,0)
void	draw(Graphics g, int x, int y, Component obs, double zoom)	Draw this GamePiece
protected Area	getArea()
Area	getArea(MapShader shader)	Returns the Area to add to (or subtract from) the area drawn by the MapShader's.
String	getDescription()	A plain-English description of this type of piece
PieceEditor	getEditor()	Get the configurer for this trait
HelpFile	getHelpFile()
PieceI18nData	getI18nData()	Return I18n data for this piece
String	getName()	The plain English name for this piece
protected int	getRadius()
Shape	getShape()	The shape of the piece from the user's viewpoint.
protected KeyCommand[]	myGetKeyCommands()
String	myGetState()
String	myGetType()
Command	myKeyEvent(KeyStroke stroke)	The response of this trait alone to the given KeyStroke
void	mySetState(String newState)	Set just the state of this trait
void	mySetType(String type)	Set the type information for this piece.

Methods inherited from class VASSAL.counters.Decorator

getCommandDescription, getDecorator, getI18nData, getI18nData, getId, getInner, getInnermost, getKeyCommands, getLocalizedName, getLocalizedProperty, getMap, getOuter, getOutermost, getParent, getPersistentProperty, getPosition, getProperties, getProperty, getPropertyNames, getState, getTranslation, getType, isSelected, keyEvent, mergeState, putOldProperties, repack, reportDataError, reportDataError, reportDataError, setId, setInner, setMap, setOldProperties, setOldProperties, setParent, setPersistentProperty, setPosition, setProperty, setSelected, setState, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface VASSAL.counters.GamePiece

getId, getLocalizedName, getMap, getParent, getPosition, getProperty, getState, getType, keyEvent, setId, setMap, setParent, setPosition, setProperty, setState

Methods inherited from interface VASSAL.counters.PropertyExporter

getProperties

Methods inherited from interface VASSAL.build.module.properties.PropertySource

getLocalizedProperty

Field Details

ID

public static final String ID

See Also:

Constant Field Values

defaultTransparencyColor

protected static final Color defaultTransparencyColor

defaultTransparencyLevel

protected static final float defaultTransparencyLevel

See Also:

Constant Field Values

defaultRadius

protected static final int defaultRadius

See Also:

Constant Field Values

transparencyColor

protected Color transparencyColor

transparencyLevel

protected float transparencyLevel

radius

protected int radius

alwaysActive

protected boolean alwaysActive

active

protected boolean active

activateCommand

protected String activateCommand

activateKey

protected NamedKeyStroke activateKey

commands

protected KeyCommand[] commands

mapShaderName

protected String mapShaderName

shader

protected MapShader shader

keyCommand

protected KeyCommand keyCommand

fixedRadius

protected boolean fixedRadius

radiusMarker

protected String radiusMarker

description

protected String description

Constructor Details

AreaOfEffect

public AreaOfEffect()

AreaOfEffect

public AreaOfEffect(String type,
GamePiece inner)

Method Details

getDescription

public String getDescription()

Description copied from interface: EditablePiece

A plain-English description of this type of piece

Specified by:

getDescription in interface EditablePiece

myGetType

public String myGetType()

Specified by:

myGetType in class Decorator

Returns:

the type of this trait alone

See Also:

Decorator.getType()

mySetType

public void mySetType(String type)

Description copied from interface: EditablePiece

Set the type information for this piece. See Decorator.myGetType()

Specified by:

mySetType in interface EditablePiece

myGetState

public String myGetState()

Specified by:

myGetState in class Decorator

Returns:

the state of this trait alone

See Also:

Decorator.getState()

mySetState

public void mySetState(String newState)

Description copied from class: Decorator

Set just the state of this trait

Specified by:

mySetState in class Decorator

See Also:

Decorator.myGetState()

boundingBox

public Rectangle boundingBox()

Description copied from interface: GamePiece

The area which this GamePiece occupies when drawn at the point (0,0)

Specified by:

boundingBox in interface GamePiece

getShape

public Shape getShape()

Description copied from interface: GamePiece

The shape of the piece from the user's viewpoint. This defines the area in which the user must click to select or move the piece, for example. Like GamePiece.boundingBox(), it assumes the position is (0,0) and must be translated to the actual location where the piece is being drawn.

Specified by:

getShape in interface GamePiece

getName

public String getName()

Description copied from interface: GamePiece

The plain English name for this piece

Specified by:

getName in interface GamePiece

draw

public void draw(Graphics g,
int x,
int y,
Component obs,
double zoom)

Description copied from interface: GamePiece

Draw this GamePiece

Specified by:

draw in interface GamePiece

x - x-location of the center of the piece

y - y-location of the center of the piece

obs - the Component on which this piece is being drawn

zoom - the scaling factor.

getArea

protected Area getArea()

getRadius

protected int getRadius()

myGetKeyCommands

protected KeyCommand[] myGetKeyCommands()

Specified by:

myGetKeyCommands in class Decorator

Returns:

the commands for this trait alone

See Also:

Decorator.getKeyCommands()

myKeyEvent

public Command myKeyEvent(KeyStroke stroke)

Description copied from class: Decorator

The response of this trait alone to the given KeyStroke

Specified by:

myKeyEvent in class Decorator

Parameters:

stroke - Stroke to apply

Returns:

Generated Command or null if no effect

See Also:

Decorator.keyEvent(javax.swing.KeyStroke)

getHelpFile

public HelpFile getHelpFile()

Specified by:

getHelpFile in interface EditablePiece

getEditor

public PieceEditor getEditor()

Description copied from interface: EditablePiece

Get the configurer for this trait

Specified by:

getEditor in interface EditablePiece

Overrides:

getEditor in class Decorator

getArea

public Area getArea(MapShader shader)

Description copied from interface: MapShader.ShadedPiece

Returns the Area to add to (or subtract from) the area drawn by the MapShader's. Area is assumed to be at zoom factor 1.0

Specified by:

getArea in interface MapShader.ShadedPiece

Parameters:

shader - Map Shader

Returns:

the Area contributed by the piece

getI18nData

public PieceI18nData getI18nData()

Description copied from class: Decorator

Return I18n data for this piece

Specified by:

getI18nData in interface TranslatablePiece

Overrides:

getI18nData in class Decorator

Returns:

I18n data