de.griefed.larsonscanner

Class LarsonScanner

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

de.griefed.larsonscanner.LarsonScanner

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class LarsonScanner
extends javax.swing.JPanel

A Larson Scanner which some may or may not know from the Cylons from Battlestar Galactica or Kitt from Knight Rider.

The Larson Scanner is named after Glen A. Larson, who produced the Battlestar Galactica and Knight Rider series, and is responsible for introducing scanning red light effects to the sci-fi TV viewing population of the 1970s and 80s.

Basically, a Larson Scanner is a red light which runs from left to right, to left, to right etc. with, usually, a nice fading effect. It's so simple, but oh so awesome!

A user by the name of Kreezxil made a request for ServerPackCreator to have some sort of progress-/thinking bar to indicate that ServerPackCreator is currently busy doing server pack things. And off I went to create this little over engineered thing. Enjoy!

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LarsonScanner.ScannerConfig Convenience-class with which to change or acquire the configuration of the LarsonScanner.

Nested classes/interfaces inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
LarsonScanner() Create a Larson Scanner with default settings.
LarsonScanner(short updateInterval) Convenience constructor allowing you to specify the interval at which the position changes.
LarsonScanner(short interval, @NotNull java.awt.Color backgroundColor) Convenience constructor allowing you to specify the interval at which the position changes, as well as the background colours for the scanner and the eye.
LarsonScanner(short interval, @NotNull java.awt.Color backgroundColor, @NotNull java.awt.Color eyeColor) Convenience constructor allowing you to specify the interval at which the position changes, the background colours for the scanner and the eye, and the color of the eye.

Method Summary

Modifier and Type	Method and Description
void	drawOval(boolean useOval) Whether to draw each element oval or rectangular.
void	forceAspectRatio(boolean force) Set the enforcement of an aspect ratio.
short[]	getAlphas() Get the currently set alphas for the elements in the eye.
LarsonScanner.ScannerConfig	getCurrentConfig() Get the current Larson Scanner configuration as a ScannerConfig.
short	getDivider() Get the divider with which the position of the eye is currently being in-/decremented.
java.awt.Color	getEyeBackground() Acquire the background colour of the eye.
java.awt.Color[]	getEyeColours() Get the array of colours currently used for all elements in the eye, left-to-right / 0-n.
float[]	getFractions() Get the currently set fractions for use in radial gradient creation.
float	getGapPercent() Get the percentage of the width between rectangular elements.
short	getInterval() Get the currently set interval at wich the eye is being updated.
byte	getNumberOfElements() Get the currently set number of elements in the eye.
double	getPartitionDivider() Get the partition divider which currently determines the width of the eye.
int	getQualitySetting() Get the integer indicating the last set rendering quality.
boolean	isAspectRatioForced() Whether the aspect ratio is currently being enforced.
boolean	isCylonAnimation() Get whether the eye is currently being animated using the Cylon-eye or Kitt-eye animation.
boolean	isDividerActive() Whether the divider is currently being used.
boolean	isGradientActive() Whether the eye is currently being drawn using gradients or solid colours.
boolean	isRunning() Whether the eye is currently being animated.
boolean	isShapeOval() Return whether the shape is currently set to oval.
void	loadConfig(@NotNull LarsonScanner.ScannerConfig config) Set the configuration of the Larson Scanner with values from the given config.
void	loadDefaults() Load the default values into the Larson Scanner and eye, resetting it.
void	pause() Pause the eye, freezing the animation.
void	play() Unpause the eye, continuing the animation.
void	setAlphas(short[] alphas) Set the alpha values for the elements in the eye, one for each element.
void	setDivider(short newStepDivider) Set the divider with which the position of the eye is being in-/decremented.
void	setEyeBackground(@NotNull java.awt.Color backgroundColor) Set the background colour for the eye.
void	setEyeColour(@NotNull java.awt.Color color) Set the colour for all elements in the eye to the same colour.
void	setEyeColours(@NotNull java.awt.Color[] colours) Set the colour for each element in the eye, from left to right.
void	setFractions(float fractionOne, float fractionTwo) Set the fractions for the distribution of the colours along the gradients of each oval-shaped element.
void	setGapPercent(float percentile) Set the width of the gap between rectangular shapes in percent.
void	setInterval(short updateInterval) Set the interval in milliseconds at which to fire the timer of the eye.
void	setNumberOfElements(byte amount) Set the number of elements in the eye.
void	setPartitionDivider(double partitionDivider) The partition divider controls the width of the eye in the Larson Scanner.
void	setQualityHigh() Set the rendering quality of the eye to high.
void	setQualityLow() Set the rendering quality of the eye to low.
void	setQualityMedium() Set the rendering quality of the eye to medium.
void	toggleAspectRatio() Toggle the enforcement of an aspect ratio.
void	toggleCylonAnimation() Toggle whether the eye os to be animated using the Cylon-eye or Kitt-eye animation.
void	toggleDivider() Toggle the use of the divider.
void	toggleGradient() Toggle the drawing of the eye between gradient and solid colours.
void	togglePauseUnpause() Toggle the animation of the eye on/off.
void	toggleShape() Toggle the eye between oval-shape and rectangle-shape.
void	useCylonAnimation(boolean useCylonAnimation) Whether to use the Cylon-eye animation or Kitt-eye animation.
void	useDivider(boolean useDivider) Whether to use a divider to in-/decrement across the width of the Larson Scanner.
void	useGradient(boolean useGradient) Whether to draw the eye using gradients.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

LarsonScanner

public LarsonScanner()

Create a Larson Scanner with default settings.

Default settings are:

• Scanner background: Black
• Timer interval: 100ms
• Eye colour: Red
• Fractions: 0.4f, 1.0f
• Alphas: 100,200,255,200,100
• Divider: 25
• Number of elements: 5
• Aspect ratio forced: false
• Shape: Oval
• Gradient colours: true
• Divider used: true
• Rendering quality: Low

LarsonScanner

public LarsonScanner(short updateInterval)

Convenience constructor allowing you to specify the interval at which the position changes. For more information regarding possible settings, see LarsonScanner().

Parameters:

updateInterval - Short Interval in milliseconds at which to scroll.

LarsonScanner

public LarsonScanner(short interval,
                     @NotNull
                     @NotNull java.awt.Color backgroundColor)

Convenience constructor allowing you to specify the interval at which the position changes, as well as the background colours for the scanner and the eye. For more information regarding possible settings, see LarsonScanner().

Parameters:

interval - Short Interval in milliseconds at which to scroll.

backgroundColor - Color The background colour for the scanner and the eye.

LarsonScanner

public LarsonScanner(short interval,
                     @NotNull
                     @NotNull java.awt.Color backgroundColor,
                     @NotNull
                     @NotNull java.awt.Color eyeColor)

Convenience constructor allowing you to specify the interval at which the position changes, the background colours for the scanner and the eye, and the color of the eye. For more information regarding possible settings, see LarsonScanner().

Parameters:

interval - Short Interval in milliseconds at which to scroll.

backgroundColor - Color The background colour for the scanner and the eye.

eyeColor - Color The color of the eye.

Method Detail

getNumberOfElements

public byte getNumberOfElements()

Get the currently set number of elements in the eye.

Returns:

Byte The current number of elements in the eye.

setNumberOfElements

public void setNumberOfElements(byte amount)
                         throws java.lang.IllegalArgumentException

Set the number of elements in the eye. This number must be odd, meaning that it must not be divisible by two. Examples: 1, 3, 5, 7, 9, 11, 13, 15, 17 and so on.

Default setting: 5

Parameters:

amount - Byte Number of elements in the eye.

Throws:

java.lang.IllegalArgumentException - if the number specified is smaller than 1 or an even number.

setEyeColour

public void setEyeColour(@NotNull
                         @NotNull java.awt.Color color)

Set the colour for all elements in the eye to the same colour.

Default setting: 255,0,0

Parameters:

color - Color The color to set all elements in the eye to.

getEyeColours

public java.awt.Color[] getEyeColours()

Get the array of colours currently used for all elements in the eye, left-to-right / 0-n.

Returns:

Color-array containing the colours of each element in the eye, left-to-right / 0-n.

setEyeColours

public void setEyeColours(@NotNull
                          @NotNull java.awt.Color[] colours)
                   throws java.lang.IllegalArgumentException

Set the colour for each element in the eye, from left to right. This Color-array must be the same size as the current number of elements in the eye.

Default setting: {255,0,0 , 255,0,0 , 255,0,0 , 255,0,0 , 255,0,0}

Parameters:

colours - Color-array of colours, one for each element in the eye, from left to right.

Throws:

java.lang.IllegalArgumentException - if the size of the array is unequal to the current number of elements in the eye.

getEyeBackground

public java.awt.Color getEyeBackground()

Acquire the background colour of the eye.

Returns:

Color The background colour of the eye.

setEyeBackground

public void setEyeBackground(@NotNull
                             @NotNull java.awt.Color backgroundColor)

Set the background colour for the eye.

Default setting: 0,0,0

Parameters:

backgroundColor - Color The color to set the background of the eye to.

drawOval

public void drawOval(boolean useOval)

Whether to draw each element oval or rectangular. Set to true to use oval-shapes, false to use rectangular shapes.

Default setting: true

Parameters:

useOval - Boolean Whether to use oval or rectangular shapes.

toggleShape

public void toggleShape()

Toggle the eye between oval-shape and rectangle-shape.

isShapeOval

public boolean isShapeOval()

Return whether the shape is currently set to oval.

Returns:

Boolean true if oval, false otherwise.

useGradient

public void useGradient(boolean useGradient)

Whether to draw the eye using gradients. Set to true to use gradients, false to use solid colours. Depending on the shape, gradients are drawn in two ways:

• Oval shapes: Gradients are created from the center of element n to the height of element n. This is most beautiful when forcing the aspect ratio, as radial gradients are best for circles, not ovals.
• Rectangle shapes: Gradients are created from left to right, at half the height of element n, over the width of element n, for each element.

Default setting: true

Parameters:

useGradient - Boolean Whether to use gradients or solid colours.

toggleGradient

public void toggleGradient()

Toggle the drawing of the eye between gradient and solid colours. For more information, see useGradient(boolean).

isGradientActive

public boolean isGradientActive()

Whether the eye is currently being drawn using gradients or solid colours. For more information, see useGradient(boolean).

Returns:

Boolean true when the eye is drawn using gradients.

useDivider

public void useDivider(boolean useDivider)

Whether to use a divider to in-/decrement across the width of the Larson Scanner. If the divider is being used, then the position of the eye will be updated with the result of the width of the Scanner divided by the divider. Meaning: Smaller values increase the speed of the eye whilst bigger values decrease it.

Increment: next position = current position + width of the Scanner / divider

Decrement: next position = current position - width of the Scanner / divider

Default setting: true

Parameters:

useDivider - Boolean Whether to in-/decrement using the divider. true to use it.

toggleDivider

public void toggleDivider()

Toggle the use of the divider. See useDivider(boolean) for more information about the divider and how it works.

isDividerActive

public boolean isDividerActive()

Whether the divider is currently being used. See useDivider(boolean) for more information about the divider and how it works.

Returns:

Boolean true if the divider is being used.

useCylonAnimation

public void useCylonAnimation(boolean useCylonAnimation)

Whether to use the Cylon-eye animation or Kitt-eye animation. If the Cylon-animation is chosen, elements in the eye expand from the center outward. If the Kitt-animation is chosen, the eye behaves as follows:

• Left-to-right:
  • From the current position towards the right, each element is drawn. Each element is drawn with less alpha, leading to the last element, visually the first of the eye, being or almost being solid in colour.
  • When the eye leaves the left side, the illusion of the eye emerging is created by drawing the left most element of the elements already drawn from 0 to the width of the eye. As the eye leaves the play, the starting element increases in alpha, thus creating the illusion of the eye emerging from one spot.
  • When the eye enters the right side, the illusion of the elements gathering is created by drawing the brightest, most solid in colour, element at the absolute right, thus creating the illusion of the elements coalescing.
• Right-to-left:
  • From the current position towards the left, each element is drawn.Each element is drawn with less alpha, leading to the last element, visually the first or the eye, being or almost being solid in colour.
  • When the eye leaves the right side, the illusion of the eye emerging is created by drawing the right most element of the elements already drawn from the width of the Larson Scanner to the width of the eye. As the eye leaves the end, the last element increases in alpha, thus creating the illusion of the eye emerging from one spot.
  • When the eye enters the left side, the illusion of the elements gathering is created by drawing the brightest, most solid in colour, element at the absolute left, thus creating the illusion of the elements coalescing.

Parameters:

useCylonAnimation - Boolean true to use the Cylon animation.

toggleCylonAnimation

public void toggleCylonAnimation()

Toggle whether the eye os to be animated using the Cylon-eye or Kitt-eye animation. For more information, see useCylonAnimation(boolean).

isCylonAnimation

public boolean isCylonAnimation()

Get whether the eye is currently being animated using the Cylon-eye or Kitt-eye animation. For more information, see useCylonAnimation(boolean).

Returns:

Boolean true if the eye is being animated as a Cylon-eye.

forceAspectRatio

public void forceAspectRatio(boolean force)

Set the enforcement of an aspect ratio. If the aspect ratio is being forced, each element will be drawn with a 1:1 aspect ratio, turning ovals into circles and rectangles into squares. The aspect ratio is being enforced by de-/increasing the height of the eye in the scanner to the width of one element, resulting in a nice and sexy 1:1 ratio.

If you plan on using different scanner and eye background colours, you should make use of this setting, otherwise the eye background colour will also prevail.

Default setting: false

Parameters:

force - Boolean

toggleAspectRatio

public void toggleAspectRatio()

Toggle the enforcement of an aspect ratio. See forceAspectRatio(boolean) for more information about an aspect ratio enforcement.

isAspectRatioForced

public boolean isAspectRatioForced()

Whether the aspect ratio is currently being enforced. See forceAspectRatio(boolean) for more information about an aspect ratio enforcement.

Returns:

Boolean true if the aspect ratio is being enforced.

setFractions

public void setFractions(float fractionOne,
                         float fractionTwo)
                  throws java.lang.IllegalArgumentException

Set the fractions for the distribution of the colours along the gradients of each oval-shaped element. Keep in mind, that the

1. fractions must range from 0.0f to 1.0f.
2. first fraction must be smaller than the second one.
3. first fraction must not be the same size as the second one
4. first fraction can be 0.0f, but not smaller
5. second fraction must be bigger than the first one
6. second fraction must not be 0.0f

Default setting: 0.4f, 1.0f

Parameters:

fractionOne - Float Fraction to distribute colour across a radial gradient. Ranging from 0.0f to 1.0f, smaller than fractionTwo.

fractionTwo - Float Fraction to distribute colour across a radial gradient. Ranging from 0.0f to 1.0f, bigger than fractionOne.

Throws:

java.lang.IllegalArgumentException - if fractionOne is smaller than 0.0f, if fractionOne is bigger or equal to 1.0f, if fractionOne is bigger than fractionTwo, or if fractionTwo is bigger than 1.0f.

getFractions

public float[] getFractions()

Get the currently set fractions for use in radial gradient creation. See setFractions(float, float) for more information.

Returns:

Float-array containing the two fractions currently set.

getAlphas

public short[] getAlphas()

Get the currently set alphas for the elements in the eye. See setAlphas(short[]) for more information.

Returns:

Short-array containing the alpha-values with which the elements in the eye are being drawn.

setAlphas

public void setAlphas(short[] alphas)
               throws java.lang.IllegalArgumentException

Set the alpha values for the elements in the eye, one for each element. The array must contain exactly as many entries as there are number of elements currently being drawn in the eye.

Note:

Alpha values are reset / automatically set / calculated when you change the number of elements in your configuration. So, if you plan on using custom alpha values and a custom amount of elements, make sure to update your alphas after changing the number of elements!

Depending on the currently set shape, these alpha values are used in different ways:

• Oval: Radial gradients are generated, one for each element in the eye. The alpha is applied to the colour in said gradients, from the center of the element to the edge, with the alpha continually increasing. Outer elements frequently end up fading into transparency, especially if larger number of elements are being drawn.
• Rectangular: Linear gradients are generated, one for each element in the eye. The alpha is applied from left-to-right at half the height of each element, for each element. For each element left-to-center the alpha decreases gradually. For each element center-to-right the alpha continually increases.

Default setting: 100, 200, 255, 200, 100

Parameters:

alphas - Short-array containing the alpha to draw an element with, one for each element.

Throws:

java.lang.IllegalArgumentException - if the amount of alphas is unequal to the current number of elements present in the eye.

getInterval

public short getInterval()

Get the currently set interval at wich the eye is being updated. For more information, see setInterval(short).

Returns:

Short The interval at which the eye is updated.

setInterval

public void setInterval(short updateInterval)
                 throws java.lang.IllegalArgumentException

Set the interval in milliseconds at which to fire the timer of the eye. Every n milliseconds the position of the eye gets updated and the eye redrawn. Smaller values therefor increase the speed at wich the eye scrolls across the screen, whilst bigger values decrease it.

Default setting: 100

Parameters:

updateInterval - Short the interval in milliseconds at which to update the eye.

Throws:

java.lang.IllegalArgumentException

getDivider

public short getDivider()

Get the divider with which the position of the eye is currently being in-/decremented. For more information on how the divider affects the eye, see useDivider(boolean).

Returns:

Short The divider with which the position of the eye is currently being in-/decremented.

setDivider

public void setDivider(short newStepDivider)
                throws java.lang.IllegalArgumentException

Set the divider with which the position of the eye is being in-/decremented. For more information on how the divider affects the eye, see useDivider(boolean).

Default setting: 25

Parameters:

newStepDivider - Short The new divider with which to in-/decrement the position of th eye.

Throws:

java.lang.IllegalArgumentException

getGapPercent

public float getGapPercent()

Get the percentage of the width between rectangular elements.

Returns:

Float The percentage of the width between rectangular elements.

setGapPercent

public void setGapPercent(float percentile)
                   throws java.lang.IllegalArgumentException

Set the width of the gap between rectangular shapes in percent. The gap between rectangular shapes is n% of the width of one element.

Default setting: 25.0f

Parameters:

percentile - Float Width of the gap between rectangular elements, in %.

Throws:

java.lang.IllegalArgumentException - if the specified percentage is smaller than 0.0f.

getPartitionDivider

public double getPartitionDivider()

Get the partition divider which currently determines the width of the eye.

Returns:

Double The partition divider of the eye.

setPartitionDivider

public void setPartitionDivider(double partitionDivider)
                         throws java.lang.IllegalArgumentException

The partition divider controls the width of the eye in the Larson Scanner. The total width of the available area is divided by this value, and the resulting value is the total width of the eye in which all elements will be drawn. The smaller the value, the bigger the eye and the other way around.

Parameters:

partitionDivider - Double The new partition divider to set for the eye.

Throws:

java.lang.IllegalArgumentException - if the specified divider is smaller than or equal to 0.0D.

pause

public void pause()

Pause the eye, freezing the animation.

play

public void play()

Unpause the eye, continuing the animation.

isRunning

public boolean isRunning()

Whether the eye is currently being animated. false if the eye is stopped.

Returns:

Boolean Whether the eye animation is active. false if it is stopped.

togglePauseUnpause

public void togglePauseUnpause()

Toggle the animation of the eye on/off.

getQualitySetting

public int getQualitySetting()

Get the integer indicating the last set rendering quality. See setQualityLow(), setQualityMedium() and setQualityHigh() for more information.

Returns:

Integer Number representation of the last set rendering quality.

setQualityHigh

public void setQualityHigh()

Set the rendering quality of the eye to high. Settings are:

1. RenderingHints.KEY_ANTIALIASING
   RenderingHints.VALUE_ANTIALIAS_ON
2. RenderingHints.KEY_ALPHA_INTERPOLATION
   RenderingHints.VALUE_ALPHA_INTERPOLATION_QUALITY
3. RenderingHints.KEY_COLOR_RENDERING
   RenderingHints.VALUE_COLOR_RENDER_QUALITY
4. RenderingHints.KEY_INTERPOLATION
   RenderingHints.VALUE_INTERPOLATION_BICUBIC
5. RenderingHints.KEY_RENDERING
   RenderingHints.VALUE_RENDER_QUALITY

Default setting: low

setQualityMedium

public void setQualityMedium()

Set the rendering quality of the eye to medium. Settings are:

1. RenderingHints.KEY_ANTIALIASING
   RenderingHints.VALUE_ANTIALIAS_DEFAULT
2. RenderingHints.KEY_ALPHA_INTERPOLATION
   RenderingHints.VALUE_ALPHA_INTERPOLATION_DEFAULT
3. RenderingHints.KEY_COLOR_RENDERING
   RenderingHints.VALUE_COLOR_RENDER_DEFAULT
4. RenderingHints.KEY_INTERPOLATION
   RenderingHints.VALUE_INTERPOLATION_BILINEAR
5. RenderingHints.KEY_RENDERING
   RenderingHints.VALUE_RENDER_DEFAULT

Default setting: low

setQualityLow

public void setQualityLow()

Set the rendering quality of the eye to low. Settings are:

1. RenderingHints.KEY_ANTIALIASING
   RenderingHints.VALUE_ANTIALIAS_OFF
2. RenderingHints.KEY_ALPHA_INTERPOLATION
   RenderingHints.VALUE_ALPHA_INTERPOLATION_SPEED
3. RenderingHints.KEY_COLOR_RENDERING
   RenderingHints.VALUE_COLOR_RENDER_SPEED
4. RenderingHints.KEY_INTERPOLATION
   RenderingHints.VALUE_INTERPOLATION_NEAREST_NEIGHBOR
5. RenderingHints.KEY_RENDERING
   RenderingHints.VALUE_RENDER_SPEED

Default setting: low

loadConfig

public void loadConfig(@NotNull
                       @NotNull LarsonScanner.ScannerConfig config)
                throws java.lang.IllegalArgumentException

Set the configuration of the Larson Scanner with values from the given config.

Parameters:

config - LarsonScanner.ScannerConfig The configuration from which to set the Larson Scanner values.

Throws:

java.lang.IllegalArgumentException - if any of the configured values is invalid.

loadDefaults

public void loadDefaults()

Load the default values into the Larson Scanner and eye, resetting it. See LarsonScanner() for more information on what the defaults are.

getCurrentConfig

public LarsonScanner.ScannerConfig getCurrentConfig()

Get the current Larson Scanner configuration as a ScannerConfig.

Returns:

LarsonScanner.ScannerConfig The current configuration of the Larson Scanner.