Package VASSAL.counters

Class FreeRotator

java.lang.Object

VASSAL.counters.Decorator

VASSAL.counters.FreeRotator

All Implemented Interfaces:

MouseListener, MouseMotionListener, EventListener, Drawable, PropertyNameSource, PropertySource, EditablePiece, GamePiece, PropertyExporter, StateMergeable, TranslatablePiece, PersistentPropertyContainer

public class FreeRotator
extends Decorator
implements EditablePiece, MouseListener, MouseMotionListener, Drawable, TranslatablePiece

A Decorator that rotates a GamePiece to an arbitrary angle

Field Summary

Fields

Modifier and Type	Field	Description
protected int	angleIndex
protected Map<Double,Rectangle>	bounds
protected KeyCommand[]	commands
static String	DEGREES
protected boolean	drawGhost
static String	FACING
protected GamePieceOp	gpOp
static String	ID
protected Map<Double,Image>	images	Deprecated, for removal: This API element is subject to removal in a future version.
protected String	name
static double	PI_180
protected Point	pivot
protected KeyCommand	rotateCCWCommand
protected NamedKeyStroke	rotateCCWKey
protected String	rotateCCWText
protected KeyCommand	rotateCWCommand
protected NamedKeyStroke	rotateCWKey
protected String	rotateCWText
protected KeyCommand	rotateRNDCommand
protected NamedKeyStroke	rotateRNDKey
protected String	rotateRNDText
protected Map<Double,RotateScaleOp>	rotOp
protected KeyCommand	setAngleCommand
protected NamedKeyStroke	setAngleKey
protected String	setAngleText
protected double	startAngle
protected Map	startMap
protected Point	startPosition
protected double	tempAngle
protected PieceImage	unrotated	Deprecated, for removal: This API element is subject to removal in a future version.
protected boolean	useUnrotatedShape
protected double[]	validAngles

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
FreeRotator()
FreeRotator(String type, GamePiece inner)

Method Summary

Modifier and Type	Method	Description
void	beginInteractiveRotate()
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
void	draw(Graphics g, Map map)
boolean	drawAboveCounters()
void	endInteractiveRotate()
double	getAngle()
double	getAngleInRadians()
double	getCumulativeAngle()
double	getCumulativeAngleInRadians()
String	getDescription()	A plain-English description of this type of piece
PieceEditor	getEditor()	Get the configurer for this trait
protected GamePieceOp	getGpOp()
HelpFile	getHelpFile()
PieceI18nData	getI18nData()	Return I18n data for this piece
Object	getLocalizedProperty(Object key)
String	getName()	The plain English name for this piece
Object	getProperty(Object key)
List<String>	getPropertyNames()	Return Property names exposed by this trait
Rectangle	getRotatedBounds()	Deprecated, for removal: This API element is subject to removal in a future version. Use boundingBox() instead.
Image	getRotatedImage(double angle, Component obs)	Deprecated, for removal: This API element is subject to removal in a future version. Use a GamePieceOp if you need this Image.
Shape	getShape()	The shape of the piece from the user's viewpoint.
boolean	hasPieceMoved()	Has the piece been moved by a Global key command since interactive rotate mode was turned on?
void	mouseClicked(MouseEvent e)
void	mouseDragged(MouseEvent e)
void	mouseEntered(MouseEvent e)
void	mouseExited(MouseEvent e)
void	mouseMoved(MouseEvent e)
void	mousePressed(MouseEvent e)
void	mouseReleased(MouseEvent e)
KeyCommand[]	myGetKeyCommands()
String	myGetState()
String	myGetType()
Command	myKeyEvent(KeyStroke stroke)	The response of this trait alone to the given KeyStroke
void	mySetState(String state)	Set just the state of this trait
void	mySetType(String type)	Set the type information for this piece.
void	setAngle(double angle)
void	setInner(GamePiece p)	Set the inner GamePiece
void	setPivot(int x, int y)	The point around which the piece will pivot while rotating interactively
void	setProperty(Object key, Object val)	Other properties, possibly game-specific, can be associated with a piece.

Methods inherited from class VASSAL.counters.Decorator

getCommandDescription, getDecorator, getI18nData, getI18nData, getId, getInner, getInnermost, getKeyCommands, getLocalizedName, getMap, getOuter, getOutermost, getParent, getPersistentProperty, getPosition, getProperties, getState, getTranslation, getType, isSelected, keyEvent, mergeState, putOldProperties, repack, reportDataError, reportDataError, reportDataError, setId, setMap, setOldProperties, setOldProperties, setParent, setPersistentProperty, setPosition, 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, getState, getType, keyEvent, setId, setMap, setParent, setPosition, setState

Methods inherited from interface VASSAL.counters.PropertyExporter

getProperties

Field Details

ID

public static final String ID

See Also:

Constant Field Values

FACING

public static final String FACING

See Also:

Constant Field Values

DEGREES

public static final String DEGREES

See Also:

Constant Field Values

PI_180

public static final double PI_180

See Also:

Constant Field Values

setAngleCommand

protected KeyCommand setAngleCommand

rotateCWCommand

protected KeyCommand rotateCWCommand

rotateCCWCommand

protected KeyCommand rotateCCWCommand

commands

protected KeyCommand[] commands

setAngleKey

protected NamedKeyStroke setAngleKey

setAngleText

protected String setAngleText

rotateCWKey

protected NamedKeyStroke rotateCWKey

rotateCWText

protected String rotateCWText

rotateCCWKey

protected NamedKeyStroke rotateCCWKey

rotateCCWText

protected String rotateCCWText

name

protected String name

rotateRNDCommand

protected KeyCommand rotateRNDCommand

rotateRNDText

protected String rotateRNDText

rotateRNDKey

protected NamedKeyStroke rotateRNDKey

useUnrotatedShape

protected boolean useUnrotatedShape

validAngles

protected double[] validAngles

angleIndex

protected int angleIndex

images

@Deprecated(since="2020-08-06",
            forRemoval=true)
protected Map<Double,Image> images

Deprecated, for removal: This API element is subject to removal in a future version.

bounds

protected Map<Double,Rectangle> bounds

unrotated

@Deprecated(since="2020-08-06",
            forRemoval=true)
protected PieceImage unrotated

Deprecated, for removal: This API element is subject to removal in a future version.

gpOp

protected GamePieceOp gpOp

rotOp

protected Map<Double,RotateScaleOp> rotOp

tempAngle

protected double tempAngle

startAngle

protected double startAngle

pivot

protected Point pivot

drawGhost

protected boolean drawGhost

startMap

protected Map startMap

startPosition

protected Point startPosition

Constructor Details

FreeRotator

public FreeRotator()

FreeRotator

public FreeRotator(String type,
GamePiece inner)

Method Details

getName

public String getName()

Description copied from interface: GamePiece

The plain English name for this piece

Specified by:

getName in interface GamePiece

setInner

public void setInner(GamePiece p)

Description copied from class: Decorator

Set the inner GamePiece

Overrides:

setInner in class Decorator

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

getGpOp

protected GamePieceOp getGpOp()

getAngle

public double getAngle()

getCumulativeAngle

public double getCumulativeAngle()

getCumulativeAngleInRadians

public double getCumulativeAngleInRadians()

setAngle

public void setAngle(double angle)

getRotatedBounds

@Deprecated(since="2020-08-06",
            forRemoval=true)
public Rectangle getRotatedBounds()

Deprecated, for removal: This API element is subject to removal in a future version.

Use boundingBox() instead.

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

getAngleInRadians

public double getAngleInRadians()

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

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.

draw

public void draw(Graphics g,
Map map)

Specified by:

draw in interface Drawable

drawAboveCounters

public boolean drawAboveCounters()

Specified by:

drawAboveCounters in interface Drawable

myGetType

public String myGetType()

Specified by:

myGetType in class Decorator

Returns:

the type of this trait alone

See Also:

Decorator.getType()

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 state)

Description copied from class: Decorator

Set just the state of this trait

Specified by:

mySetState in class Decorator

See Also:

Decorator.myGetState()

myGetKeyCommands

public 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)

beginInteractiveRotate

public void beginInteractiveRotate()

endInteractiveRotate

public void endInteractiveRotate()

hasPieceMoved

public boolean hasPieceMoved()

Has the piece been moved by a Global key command since interactive rotate mode was turned on?

setPivot

public void setPivot(int x,
int y)

The point around which the piece will pivot while rotating interactively

mouseClicked

public void mouseClicked(MouseEvent e)

Specified by:

mouseClicked in interface MouseListener

mouseEntered

public void mouseEntered(MouseEvent e)

Specified by:

mouseEntered in interface MouseListener

mouseExited

public void mouseExited(MouseEvent e)

Specified by:

mouseExited in interface MouseListener

mousePressed

public void mousePressed(MouseEvent e)

Specified by:

mousePressed in interface MouseListener

mouseReleased

public void mouseReleased(MouseEvent e)

Specified by:

mouseReleased in interface MouseListener

setProperty

public void setProperty(Object key,
Object val)

Description copied from interface: GamePiece

Other properties, possibly game-specific, can be associated with a piece. The properties may or may not need to be encoded in the piece's GamePiece.getState() method.

Specified by:

setProperty in interface GamePiece

Overrides:

setProperty in class Decorator

getLocalizedProperty

public Object getLocalizedProperty(Object key)

Specified by:

getLocalizedProperty in interface PropertySource

Overrides:

getLocalizedProperty in class Decorator

getProperty

public Object getProperty(Object key)

Specified by:

getProperty in interface GamePiece

Specified by:

getProperty in interface PropertySource

Overrides:

getProperty in class Decorator

mouseDragged

public void mouseDragged(MouseEvent e)

Specified by:

mouseDragged in interface MouseMotionListener

mouseMoved

public void mouseMoved(MouseEvent e)

Specified by:

mouseMoved in interface MouseMotionListener

getRotatedImage

@Deprecated(since="2020-08-06",
            forRemoval=true)
public Image getRotatedImage(double angle,
Component obs)

Deprecated, for removal: This API element is subject to removal in a future version.

Use a GamePieceOp if you need this Image.

Return a full-scale cached image of this piece, rotated to the appropriate angle.

Parameters:

angle - Rotation angle

obs - Component observer

Returns:

Rotated Image

getDescription

public String getDescription()

Description copied from interface: EditablePiece

A plain-English description of this type of piece

Specified by:

getDescription in interface EditablePiece

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

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

getPropertyNames

public List<String> getPropertyNames()

Return Property names exposed by this trait

Specified by:

getPropertyNames in interface PropertyNameSource

Overrides:

getPropertyNames in class Decorator