NewGamePhysics.Utilities.Autorange Class Reference

Class to assist in autoranging chart axes or value displays. More...

List of all members.

Static Public Member Functions
static double	GetSnapValue (double valueToSnap, bool snapIsGreater)
	Calculates the closest member in the sequence (... 0.5, 1, 2, 5, 10, 20 ...) to any given value.

---

Detailed Description

Class to assist in autoranging chart axes or value displays.

Definition at line 13 of file Autorange.cs.

---

Member Function Documentation

static double NewGamePhysics.Utilities.Autorange.GetSnapValue	(	double	valueToSnap,
		bool	snapIsGreater
	)			[static]

Calculates the closest member in the sequence (... 0.5, 1, 2, 5, 10, 20 ...) to any given value.

Parameters:

	valueToSnap	The value to check.
	snapIsGreater	If true, the snap value is numerically greater than value; or less if false.

Returns:

The snap value.

Definition at line 23 of file Autorange.cs.

        {
            // Value range factors for positive numbers in sequence.
            double[] factorsP = { 1.0, 2.0, 5.0, 10.0 };

            // Value range factors for negative numbers in sequence.
            double[] factorsN = { 10.0, 5.0, 2.0, 1.0 };

            // Determine factor for input
            double[] factors;
            if (valueToSnap != 0.0)
            {
                bool isPositive = (valueToSnap > 0.0);
                double exponent = Math.Floor(Math.Log10(Math.Abs(valueToSnap)));
                double valueBase = Math.Pow(10, exponent);

                if (isPositive)
                {
                    factors = factorsP;
                }
                else
                {
                    factors = factorsN;
                    valueBase = -valueBase;
                }

                factors[0] *= valueBase;
                for (int i = 1; i < 4; i++)
                {
                    factors[i] *= valueBase;
                    if (factors[i] >= valueToSnap)
                    {
                        if (snapIsGreater)
                        {
                            return factors[i];
                        }
                        else
                        {
                            return factors[i - 1];
                        }
                    }
                }
            }

            // Default
            return 0.0;
        }

---

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

• C:/Users/Andreas Schiffler/Desktop/SVN/NewGamePhysics/NewGamePhysics/Utilities/Autorange.cs