Package net.eternalclient.api.internal.mouse.naturalmouse.support

Class SinusoidalDeviationProvider

java.lang.Object

net.eternalclient.api.internal.mouse.naturalmouse.support.SinusoidalDeviationProvider

All Implemented Interfaces:

DeviationProvider

public class SinusoidalDeviationProvider
extends java.lang.Object
implements DeviationProvider

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_SLOPE_DIVIDER

Constructor Summary

Constructors

Constructor	Description
SinusoidalDeviationProvider(double slopeDivider)

Method Summary

Modifier and Type	Method	Description
DoublePoint	getDeviation(double totalDistanceInPixels, double completionFraction)	Gets the deviation for current trajectory.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SLOPE_DIVIDER

public static final int DEFAULT_SLOPE_DIVIDER

See Also:

Constant Field Values

Constructor Detail

SinusoidalDeviationProvider

public SinusoidalDeviationProvider(double slopeDivider)

Method Detail

getDeviation

public DoublePoint getDeviation(double totalDistanceInPixels,
                                double completionFraction)

Description copied from interface: DeviationProvider

Gets the deviation for current trajectory. Deviation is an offset from the original straight trajectory.

Deviation is different from the Noise because it works like a mathematical function, the resulting Point is added to single trajectory point and it will not have any effect in the next mouse movement step, making it easy to implement this as a formula based on the input parameters. e.g the something like 'deviation = totalDistanceInPixels / completionFraction', resulting in smooth movement. (Don't actually use this formula), 'Noise' is generating an offset from the original trajectory and is accumulating.

As deviation should be deterministic and return same result for same parameters, it should not include Random behaviour, thus Random is not included as a parameter.

It is recommended that deviation is decreasing when completionFraction nears 1, but MouseMotion itself also makes sure that the effect of deviation is reduced when the mouse is nearing its destination.

Specified by:

getDeviation in interface DeviationProvider

Parameters:

totalDistanceInPixels - the total pixels between target and mouse initial position

completionFraction - the completed fraction of mouse movement total distance, value from 0...1 (0;1]

Returns:

a point which describes how much the mouse is going to deviate from the straight trajectory between target and initial position. This is not the final deviation of the mouse as MouseMotion will randomly decide to either amplify or decrease it over the whole mouse movement, making the resulting arc stand out more or less, or is flipped negatively.