namespace TBF.Boxes
{
public class FloatBox : IBox
{
/// Box value
private float val;
public float Val
{
get { return (valid ? val : 0); }
set { val = value; valid = true; }
}
/// Box name
string name;
public string Name
{
get { return name; }
set { name = value; }
}
/// Validity flag: true = the box value is valid
private bool valid = false;
public bool Valid
{
get { return valid; }
}
/// Parameterless constructor
public FloatBox()
{
}
/// Constructor that initializes the value
public FloatBox(float val)
{
this.Val = val;
}
///
/// Clear the box value and the valid flag
///
public void Clear()
{
val = 0;
valid = false;
}
///
/// Specifies a conversion to a string.
/// In the most complex case the conversion is:
/// string.Format(FormatEx, val.ToString(Format))
/// If the value is invalid, the conversion result is 'FormatInvalid'.
///
public string Format = null;
public string FormatEx = "{0}";
public string FormatInvalid = "---";
public float Factor = 1.0f;
public float LimitLo = float.MinValue;
public float LimitHi = float.MaxValue;
///
/// Converts the box value to a string representation
///
public override string ToString()
{
if (!valid)
{
return FormatInvalid;
}
else if (Format == null)
{
return string.Format(FormatEx, Val * Factor);
}
else
{
return string.Format(FormatEx, (Val * Factor).ToString(Format));
}
}
///
/// Validate the string representation of the box value
///
/// String representation of the parameter
/// true = string is OK, false = string is wrong (see 'message')
public bool ValidateParam(string strVal)
{
float dummy;
return Utils.TryParseSFloat(strVal, out dummy) &&
((dummy / Factor) >= LimitLo) &&
((dummy / Factor) <= LimitHi);
}
///
/// Update the parameter from a string
///
/// String representation of the box value
public void UpdateParam(string strVal)
{
try
{
Val = Utils.ParseSFloat(strVal) / Factor;
}
catch { };
}
public FloatBox Clone()
{
FloatBox newFloatBox = new FloatBox();
newFloatBox.name = name;
newFloatBox.val = val;
newFloatBox.valid = valid;
newFloatBox.Format = Format;
newFloatBox.FormatInvalid = FormatInvalid;
newFloatBox.FormatEx = FormatEx;
newFloatBox.Factor = Factor;
return newFloatBox;
}
}
}