Extensions for float More...

Collaboration diagram for UnityEngine.FloatExtensions:

Static Public Member Functions
static float	Loop (this float floatToBeLooped, float exclusiveMaximum, float inclusiveMinimum=0f, float variancePerStep=1f)
	Loops the float between a minimum and maximum. More...

static float	Map (this float value, float originalRangeMin, float originalRangeMax, float newRangeMin=0f, float newRangeMax=1f)
	Maps the value from one range to another range. More...

Detailed Description

Extensions for float

Definition at line 6 of file FloatExtensions.cs.

Member Function Documentation

static float UnityEngine.FloatExtensions.Loop	(	this float	floatToBeLooped,
		float	exclusiveMaximum,
		float	inclusiveMinimum = `0f`,
		float	variancePerStep = `1f`
	)

static

Loops the float between a minimum and maximum.

Parameters

exclusiveMaximum	The exclusive maximum value than can be obtained.
inclusiveMinimum	The minimum value that can be obtained.
variancePerStep	The value added to the int every time that the method is called.

Returns: Returns a the result of adding the 'variancePerStep' (default to 1f) to the original integer. The value is always between the minimum (inclusive, default to 0f) and the maximum (exclusive).

Definition at line 15 of file FloatExtensions.cs.

static float UnityEngine.FloatExtensions.Map	(	this float	value,
		float	originalRangeMin,
		float	originalRangeMax,
		float	newRangeMin = `0f`,
		float	newRangeMax = `1f`
	)

static

Maps the value from one range to another range.

Parameters

originalRangeMin	The minimum value in the original range.
originalRangeMax	The maximum value in the original range.
newRangeMin	The minimum value in the new range.
newRangeMax	The maximum value in the new range.

Definition at line 31 of file FloatExtensions.cs.

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