scaffold.libs_as.feathers.utils.math.clamp.as Maven / Gradle / Ivy

Go to download
/*
Feathers
Copyright 2012-2016 Bowler Hat LLC. All Rights Reserved.

This program is free software. You can redistribute and/or modify it in
accordance with the terms of the accompanying license agreement.
*/
package feathers.utils.math
{
	
	/**
	 * Forces a numeric value into a specified range.
	 * 
	 * @param value		The value to force into the range.
	 * @param minimum	The minimum bound of the range.
	 * @param maximum	The maximum bound of the range.
	 * @return			A value within the specified range.
	 * 
	 * @author Josh Tynjala (joshblog.net)
	 */
	public function clamp(value:Number, minimum:Number, maximum:Number):Number
	{
		if(minimum > maximum)
		{
			throw new ArgumentError("minimum should be smaller than maximum.");
		}
		if(value < minimum)
		{
			value = minimum;
		}
		else if(value > maximum)
		{
			value = maximum;
		}
		return value;
	}
}