Package megamek.common.enums

Enum Class FacingArc

java.lang.Object

java.lang.Enum<FacingArc>

megamek.common.enums.FacingArc

All Implemented Interfaces:

Serializable, Comparable<FacingArc>, Constable

public enum FacingArc
extends Enum<FacingArc>

All the different possible facing arcs

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ARC_360
ARC_AFT
ARC_AFT_WPL
ARC_EAST
ARC_FORWARD
ARC_LEFT_BROADSIDE
ARC_LEFT_BROADSIDE_WPL
ARC_LEFT_SPHERE_GROUND
ARC_LEFTARM
ARC_LEFTSIDE
ARC_LEFTSIDE_SPHERE
ARC_LEFTSIDE_SPHERE_WPL
ARC_LEFTSIDEA_SPHERE
ARC_LEFTSIDEA_SPHERE_WPL
ARC_LWING
ARC_LWING_WPL
ARC_LWINGA
ARC_LWINGA_WPL
ARC_MAINGUN
ARC_NORTH
ARC_NOSE
ARC_NOSE_WPL
ARC_PINTLE_TURRET_FRONT
ARC_PINTLE_TURRET_LEFT
ARC_PINTLE_TURRET_REAR
ARC_PINTLE_TURRET_RIGHT
ARC_REAR
ARC_RIGHT_BROADSIDE
ARC_RIGHT_BROADSIDE_WPL
ARC_RIGHT_SPHERE_GROUND
ARC_RIGHTARM
ARC_RIGHTSIDE
ARC_RIGHTSIDE_SPHERE
ARC_RIGHTSIDE_SPHERE_WPL
ARC_RIGHTSIDEA_SPHERE
ARC_RIGHTSIDEA_SPHERE_WPL
ARC_RWING
ARC_RWING_WPL
ARC_RWINGA
ARC_RWINGA_WPL
ARC_SPONSON_TURRET_LEFT
ARC_SPONSON_TURRET_RIGHT
ARC_TURRET
ARC_VGL_FRONT
ARC_VGL_LF
ARC_VGL_LR
ARC_VGL_REAR
ARC_VGL_RF
ARC_VGL_RR
ARC_WEST

Method Summary

Modifier and Type	Method	Description
int	getArcCode()
int	getEndAngle()
int	getStartAngle()
boolean	isInsideArc(int angle)
boolean	isInsideArc(Coords source, int facing, Targetable target)
boolean	isInsideArc(UnitPosition source, UnitPosition target)
static FacingArc	valueOf(int arcCode)	Returns the enum constant of this type with the legacy specified arcCode.
static FacingArc	valueOf(String name)	Returns the enum constant of this class with the specified name.
static FacingArc[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ARC_360

public static final FacingArc ARC_360

ARC_FORWARD

public static final FacingArc ARC_FORWARD

ARC_LEFTARM

public static final FacingArc ARC_LEFTARM

ARC_RIGHTARM

public static final FacingArc ARC_RIGHTARM

ARC_REAR

public static final FacingArc ARC_REAR

ARC_LEFTSIDE

public static final FacingArc ARC_LEFTSIDE

ARC_RIGHTSIDE

public static final FacingArc ARC_RIGHTSIDE

ARC_MAINGUN

public static final FacingArc ARC_MAINGUN

ARC_NORTH

public static final FacingArc ARC_NORTH

ARC_EAST

public static final FacingArc ARC_EAST

ARC_WEST

public static final FacingArc ARC_WEST

ARC_NOSE

public static final FacingArc ARC_NOSE

ARC_LWING

public static final FacingArc ARC_LWING

ARC_RWING

public static final FacingArc ARC_RWING

ARC_LWINGA

public static final FacingArc ARC_LWINGA

ARC_RWINGA

public static final FacingArc ARC_RWINGA

ARC_LEFTSIDE_SPHERE

public static final FacingArc ARC_LEFTSIDE_SPHERE

ARC_RIGHTSIDE_SPHERE

public static final FacingArc ARC_RIGHTSIDE_SPHERE

ARC_LEFTSIDEA_SPHERE

public static final FacingArc ARC_LEFTSIDEA_SPHERE

ARC_RIGHTSIDEA_SPHERE

public static final FacingArc ARC_RIGHTSIDEA_SPHERE

ARC_LEFT_BROADSIDE

public static final FacingArc ARC_LEFT_BROADSIDE

ARC_RIGHT_BROADSIDE

public static final FacingArc ARC_RIGHT_BROADSIDE

ARC_AFT

public static final FacingArc ARC_AFT

ARC_LEFT_SPHERE_GROUND

public static final FacingArc ARC_LEFT_SPHERE_GROUND

ARC_RIGHT_SPHERE_GROUND

public static final FacingArc ARC_RIGHT_SPHERE_GROUND

ARC_TURRET

public static final FacingArc ARC_TURRET

ARC_SPONSON_TURRET_LEFT

public static final FacingArc ARC_SPONSON_TURRET_LEFT

ARC_SPONSON_TURRET_RIGHT

public static final FacingArc ARC_SPONSON_TURRET_RIGHT

ARC_PINTLE_TURRET_LEFT

public static final FacingArc ARC_PINTLE_TURRET_LEFT

ARC_PINTLE_TURRET_RIGHT

public static final FacingArc ARC_PINTLE_TURRET_RIGHT

ARC_PINTLE_TURRET_FRONT

public static final FacingArc ARC_PINTLE_TURRET_FRONT

ARC_PINTLE_TURRET_REAR

public static final FacingArc ARC_PINTLE_TURRET_REAR

ARC_VGL_FRONT

public static final FacingArc ARC_VGL_FRONT

ARC_VGL_RF

public static final FacingArc ARC_VGL_RF

ARC_VGL_RR

public static final FacingArc ARC_VGL_RR

ARC_VGL_REAR

public static final FacingArc ARC_VGL_REAR

ARC_VGL_LR

public static final FacingArc ARC_VGL_LR

ARC_VGL_LF

public static final FacingArc ARC_VGL_LF

ARC_NOSE_WPL

public static final FacingArc ARC_NOSE_WPL

ARC_LWING_WPL

public static final FacingArc ARC_LWING_WPL

ARC_RWING_WPL

public static final FacingArc ARC_RWING_WPL

ARC_LWINGA_WPL

public static final FacingArc ARC_LWINGA_WPL

ARC_RWINGA_WPL

public static final FacingArc ARC_RWINGA_WPL

ARC_LEFTSIDE_SPHERE_WPL

public static final FacingArc ARC_LEFTSIDE_SPHERE_WPL

ARC_RIGHTSIDE_SPHERE_WPL

public static final FacingArc ARC_RIGHTSIDE_SPHERE_WPL

ARC_LEFTSIDEA_SPHERE_WPL

public static final FacingArc ARC_LEFTSIDEA_SPHERE_WPL

ARC_RIGHTSIDEA_SPHERE_WPL

public static final FacingArc ARC_RIGHTSIDEA_SPHERE_WPL

ARC_AFT_WPL

public static final FacingArc ARC_AFT_WPL

ARC_LEFT_BROADSIDE_WPL

public static final FacingArc ARC_LEFT_BROADSIDE_WPL

ARC_RIGHT_BROADSIDE_WPL

public static final FacingArc ARC_RIGHT_BROADSIDE_WPL

Method Details

values

public static FacingArc[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static FacingArc valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getArcCode

public int getArcCode()

getStartAngle

public int getStartAngle()

getEndAngle

public int getEndAngle()

isInsideArc

public boolean isInsideArc(int angle)

isInsideArc

public boolean isInsideArc(Coords source,
 int facing,
 Targetable target)

isInsideArc

public boolean isInsideArc(UnitPosition source,
 UnitPosition target)

valueOf

public static FacingArc valueOf(int arcCode)

Returns the enum constant of this type with the legacy specified arcCode. The arcCode must match exactly an arcCode used to declare an enum constant in this type.

Returns:

the enum constant with the specified legacy arcCode

Throws:

IllegalArgumentException - – if this enum type has no constant with the specified arcCode