Inheritance diagram for com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation:

Collaboration diagram for com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation:

Public Member Functions
int	getCur ()

int	getH ()

int	getHeight ()

int	getMax ()

int	getMin ()

int	getW ()

int	getWidth ()

int	getX ()

int	getY ()

boolean	isLowImage ()

boolean	isNegativeImage ()

boolean	isValid ()

boolean	setExtends (final int width, final int height)

void	setHasNegativeImage (final boolean hasNegativeImage)

boolean	setValues (final int cur, final int min, final int max)

Protected Member Functions
	AbstractOrientation ()

abstract void	reCalculate ()

void	setExtent (final int x, final int y, final int w, final int h)

Static Protected Member Functions
static int	calculate (final int val, final int max, final int size)

Private Attributes
int	cur

int	h

boolean	hasNegativeImage

int	height

int	max

int	min

int	w

int	width

int	x

int	y

Detailed Description

Abstract base class for implementing Orientation instances.

Author: Andreas Kirschbaum

Definition at line 29 of file AbstractOrientation.java.

Constructor & Destructor Documentation

◆ AbstractOrientation()

com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.AbstractOrientation ( )

protected

Creates a new instance.

Definition at line 85 of file AbstractOrientation.java.

Member Function Documentation

◆ calculate()

static int com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.calculate	(	final int	val,
		final int	max,
		final int	size
	)

staticprotected

Returns the fraction

val/max

rounded to [

0..size

].

Parameters

val	the value
max	the range size
size	the size of the result

Returns: the fraction in pixels

Definition at line 170 of file AbstractOrientation.java.

References com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.max.

Referenced by com.realtime.crossfire.jxclient.gui.gauge.OrientationEW.reCalculate(), com.realtime.crossfire.jxclient.gui.gauge.OrientationWE.reCalculate(), com.realtime.crossfire.jxclient.gui.gauge.OrientationSN.reCalculate(), and com.realtime.crossfire.jxclient.gui.gauge.OrientationNS.reCalculate().

Here is the caller graph for this function:

◆ getCur()

int com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.getCur ( )

Returns the current value.

Returns: the current value

Definition at line 200 of file AbstractOrientation.java.

References com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.cur.

Referenced by com.realtime.crossfire.jxclient.gui.gauge.OrientationEW.reCalculate(), com.realtime.crossfire.jxclient.gui.gauge.OrientationWE.reCalculate(), com.realtime.crossfire.jxclient.gui.gauge.OrientationSN.reCalculate(), and com.realtime.crossfire.jxclient.gui.gauge.OrientationNS.reCalculate().

Here is the caller graph for this function:

◆ getH()

int com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.getH ( )

Returns the height of the highlighted part of the image.

Returns: the height

Implements com.realtime.crossfire.jxclient.gui.gauge.Orientation.

Definition at line 139 of file AbstractOrientation.java.

References com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.h.

◆ getHeight()

int com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.getHeight ( )

Returns the total height of the image.

Returns: the height

Definition at line 192 of file AbstractOrientation.java.

References com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.height.

Referenced by com.realtime.crossfire.jxclient.gui.gauge.OrientationEW.reCalculate(), com.realtime.crossfire.jxclient.gui.gauge.OrientationWE.reCalculate(), com.realtime.crossfire.jxclient.gui.gauge.OrientationSN.reCalculate(), and com.realtime.crossfire.jxclient.gui.gauge.OrientationNS.reCalculate().

Here is the caller graph for this function:

◆ getMax()

int com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.getMax ( )

Returns the maximum value.

Returns: the maximum value

Definition at line 216 of file AbstractOrientation.java.

References com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.max.

Referenced by com.realtime.crossfire.jxclient.gui.gauge.OrientationEW.reCalculate(), com.realtime.crossfire.jxclient.gui.gauge.OrientationWE.reCalculate(), com.realtime.crossfire.jxclient.gui.gauge.OrientationSN.reCalculate(), and com.realtime.crossfire.jxclient.gui.gauge.OrientationNS.reCalculate().

Here is the caller graph for this function:

◆ getMin()

int com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.getMin ( )

Returns the minimum value.

Returns: the minimum value

Definition at line 208 of file AbstractOrientation.java.

References com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.min.

Referenced by com.realtime.crossfire.jxclient.gui.gauge.OrientationEW.reCalculate(), com.realtime.crossfire.jxclient.gui.gauge.OrientationWE.reCalculate(), com.realtime.crossfire.jxclient.gui.gauge.OrientationSN.reCalculate(), and com.realtime.crossfire.jxclient.gui.gauge.OrientationNS.reCalculate().

Here is the caller graph for this function:

◆ getW()

int com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.getW ( )

Returns the width of the highlighted part of the image.

Returns: the width

Implements com.realtime.crossfire.jxclient.gui.gauge.Orientation.

Definition at line 134 of file AbstractOrientation.java.

References com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.w.

◆ getWidth()

int com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.getWidth ( )

Returns the total width of the image.

Returns: the width

Definition at line 184 of file AbstractOrientation.java.

References com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.width.

Referenced by com.realtime.crossfire.jxclient.gui.gauge.OrientationEW.reCalculate(), com.realtime.crossfire.jxclient.gui.gauge.OrientationWE.reCalculate(), com.realtime.crossfire.jxclient.gui.gauge.OrientationSN.reCalculate(), and com.realtime.crossfire.jxclient.gui.gauge.OrientationNS.reCalculate().

Here is the caller graph for this function:

◆ getX()

int com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.getX ( )

Returns the x-coordinate of the highlighted part of the image.

Returns: the x-coordinate

Implements com.realtime.crossfire.jxclient.gui.gauge.Orientation.

Definition at line 124 of file AbstractOrientation.java.

References com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.x.

◆ getY()

int com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.getY ( )

Returns the y-coordinate of the highlighted part of the image.

Returns: the y-coordinate

Implements com.realtime.crossfire.jxclient.gui.gauge.Orientation.

Definition at line 129 of file AbstractOrientation.java.

References com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.y.

◆ isLowImage()

boolean com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.isLowImage ( )

Returns whether the low image should be shown.

Returns: whether the low image should be shown

Implements com.realtime.crossfire.jxclient.gui.gauge.Orientation.

Definition at line 149 of file AbstractOrientation.java.

References com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.cur, com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.isNegativeImage(), com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.max, and com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.min.

Here is the call graph for this function:

◆ isNegativeImage()

boolean com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.isNegativeImage ( )

Returns whether the negative image should be shown.

Returns: whether the negative image should be shown

Implements com.realtime.crossfire.jxclient.gui.gauge.Orientation.

Definition at line 144 of file AbstractOrientation.java.

References com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.cur, com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.hasNegativeImage, and com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.min.

Referenced by com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.isLowImage(), com.realtime.crossfire.jxclient.gui.gauge.OrientationWE.reCalculate(), com.realtime.crossfire.jxclient.gui.gauge.OrientationSN.reCalculate(), com.realtime.crossfire.jxclient.gui.gauge.OrientationNS.reCalculate(), and com.realtime.crossfire.jxclient.gui.gauge.OrientationEW.reCalculate().

Here is the caller graph for this function:

◆ isValid()

boolean com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.isValid ( )

Returns whether the gauge's values are valid.

Returns: whether the values are valid

Implements com.realtime.crossfire.jxclient.gui.gauge.Orientation.

Definition at line 154 of file AbstractOrientation.java.

References com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.max, and com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.min.

◆ reCalculate()

abstract void com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.reCalculate ( )

abstractprotected

Recalculate the extents of the highlighted image part.

Reimplemented in com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientationTest.TestOrientation, com.realtime.crossfire.jxclient.gui.gauge.OrientationEW, com.realtime.crossfire.jxclient.gui.gauge.OrientationNS, com.realtime.crossfire.jxclient.gui.gauge.OrientationSN, and com.realtime.crossfire.jxclient.gui.gauge.OrientationWE.

Referenced by com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.setExtends(), com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.setHasNegativeImage(), and com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.setValues().

Here is the caller graph for this function:

◆ setExtends()

boolean com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.setExtends	(	final int	width,
		final int	height
	)

Sets the extends of the image.

Parameters

width	the width
height	the height

Returns: true if the size changed, false else

Implements com.realtime.crossfire.jxclient.gui.gauge.Orientation.

Definition at line 112 of file AbstractOrientation.java.

References com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.height, com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.reCalculate(), and com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.width.

Here is the call graph for this function:

◆ setExtent()

void com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.setExtent	(	final int	x,
		final int	y,
		final int	w,
		final int	h
	)

protected

Sets the extent of the highlighted part of the image.

Parameters

x	the x-coordinate
y	the y-coordinate
w	the width
h	the height

Definition at line 227 of file AbstractOrientation.java.

References com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.h, com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.w, com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.x, and com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.y.

Referenced by com.realtime.crossfire.jxclient.gui.gauge.OrientationEW.reCalculate(), com.realtime.crossfire.jxclient.gui.gauge.OrientationWE.reCalculate(), com.realtime.crossfire.jxclient.gui.gauge.OrientationSN.reCalculate(), and com.realtime.crossfire.jxclient.gui.gauge.OrientationNS.reCalculate().

Here is the caller graph for this function:

◆ setHasNegativeImage()

void com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.setHasNegativeImage ( final boolean hasNegativeImage )

Sets whether the gauge can display negative images. By default, negative images are not supported.

Parameters

hasNegativeImage whether the gauge can display negative images

Implements com.realtime.crossfire.jxclient.gui.gauge.Orientation.

Definition at line 89 of file AbstractOrientation.java.

References com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.hasNegativeImage, and com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.reCalculate().

Here is the call graph for this function:

◆ setValues()

boolean com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.setValues	(	final int	cur,
		final int	min,
		final int	max
	)

Sets the gauge's values.

Parameters

cur	the current value
min	the minimum value
max	the maximum value

Returns: whether the values have been updated

Implements com.realtime.crossfire.jxclient.gui.gauge.Orientation.

Definition at line 99 of file AbstractOrientation.java.

References com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.cur, com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.max, com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.min, and com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.reCalculate().

Here is the call graph for this function:

Member Data Documentation

◆ cur

int com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.cur

private

The current value.

Definition at line 44 of file AbstractOrientation.java.

◆ h

int com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.h

private

The height of the highlighted part of the image.

Definition at line 75 of file AbstractOrientation.java.

Referenced by com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.getH(), com.realtime.crossfire.jxclient.gui.gauge.OrientationSN.reCalculate(), com.realtime.crossfire.jxclient.gui.gauge.OrientationNS.reCalculate(), and com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.setExtent().

◆ hasNegativeImage

boolean com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.hasNegativeImage

private

Whether the gauge can display negative images.

Definition at line 80 of file AbstractOrientation.java.

Referenced by com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.isNegativeImage(), and com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.setHasNegativeImage().

◆ height

int com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.height

private

The total height of the image.

Definition at line 39 of file AbstractOrientation.java.

Referenced by com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.getHeight(), com.realtime.crossfire.jxclient.gui.gauge.OrientationSN.reCalculate(), and com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.setExtends().

◆ max

int com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.max

private

The maximum value; the gauge is displayed as full if

cur >= max

.

Definition at line 55 of file AbstractOrientation.java.

Referenced by com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.calculate(), com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.getMax(), com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.isLowImage(), com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.isValid(), and com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.setValues().

◆ min

int com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.min

private

The minimum value; the gauge is displayed as empty if

cur >= min

.

Definition at line 50 of file AbstractOrientation.java.

◆ w

int com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.w

private

The width of the highlighted part of the image.

Definition at line 70 of file AbstractOrientation.java.

Referenced by com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.getW(), com.realtime.crossfire.jxclient.gui.gauge.OrientationWE.reCalculate(), com.realtime.crossfire.jxclient.gui.gauge.OrientationEW.reCalculate(), and com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.setExtent().

◆ width

int com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.width

private

The total width of the image.

Definition at line 34 of file AbstractOrientation.java.

Referenced by com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.getWidth(), com.realtime.crossfire.jxclient.gui.gauge.OrientationEW.reCalculate(), and com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.setExtends().

◆ x

int com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.x

private

The x-coordinate of the highlighted part of the image.

Definition at line 60 of file AbstractOrientation.java.

Referenced by com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.getX(), and com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.setExtent().

◆ y

int com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.y

private

The y-coordinate of the highlighted part of the image.

Definition at line 65 of file AbstractOrientation.java.

Referenced by com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.getY(), and com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.setExtent().

The documentation for this class was generated from the following file:

src/gui/src/main/java/com/realtime/crossfire/jxclient/gui/gauge/AbstractOrientation.java

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AbstractOrientation()

Member Function Documentation

◆ calculate()

◆ getCur()

◆ getH()

◆ getHeight()

◆ getMax()

◆ getMin()

◆ getW()

◆ getWidth()

◆ getX()

◆ getY()

◆ isLowImage()

◆ isNegativeImage()

◆ isValid()

◆ reCalculate()

◆ setExtends()

◆ setExtent()

◆ setHasNegativeImage()

◆ setValues()

Member Data Documentation

◆ cur

◆ h

◆ hasNegativeImage

◆ height

◆ max

◆ min

◆ w

◆ width

◆ x

◆ y