Public Member Functions
	Length (float value, LengthUnit unit)

float	ConvertTo (LengthUnit unit)
	Converts the length to a value in the provided units. More...

double	PreciselyConvertTo (LengthUnit unit)
	Converts the length to a double value in the provided units. More...

Static Public Member Functions
static float	ConvertToMeters (float length, LengthUnit unit)
	Converts the provided length value to a value in meters. More...

static float	ConvertMetersTo (float meters, LengthUnit unit)
	Converts the provided meter value to a value in the provided units. More...

static double	PreciselyConvertMetersTo (double meters, LengthUnit unit)
	Converts the provided meter value to a double value in the provided units. More...

static Length	operator* (Length a, float scalar)
	Multiplies a Length by some scalar value. More...

static Length	operator+ (Length a, Length b)
	Adds two Length values together. More...

static Length	operator- (Length a, Length b)
	Subtracts one Length value from another Length value. More...

Static Public Attributes
const float	METERS_TO_FEET = 3.28084f

const float	METERS_TO_YARDS = 1.0936f

const float	METERS_TO_FURLONGS = 0.004971f

const float	METERS_TO_MILLIMETERS = 1000f

const float	METERS_TO_MEGABEARDSECONDS = 200f

const float	METERS_TO_CENTIMETERS = 100f

const float	METERS_TO_ATTOPARSECS = 32.4078f

const float	METERS_TO_SMOOTS = 0.587613f

const float	METERS_TO_KILOMETERS = 0.001f

const float	MILES_TO_METERS = 1609.34f

Properties
float	ToInches `[get]`
	The Length, converted to inches. More...

float	ToFeet `[get]`
	The Length, converted to feet. More...

float	ToYards `[get]`
	The Length, converted to yards. More...

float	ToFurlongs `[get]`
	The Length, converted to furlongs. More...

float	ToMiles `[get]`
	The Length, converted to miles. More...

float	ToMillimeters `[get]`
	The Length, converted to millimeters. More...

float	ToMegaBeardSeconds `[get]`
	The Length, converted to mega-beard-seconds. More...

float	ToCentimeters `[get]`
	The Length, converted to centimeters. More...

float	ToAttoparsecs `[get]`
	The Length, converted to attoparsecs. More...

float	ToMeters `[get]`
	The Length, converted to meters. More...

float	ToSmoots `[get]`
	The Length, converted to smoots. More...

float	ToKilometers `[get]`
	The Length, converted to kilometers. More...

Private Attributes
float	_meters

Static Private Attributes
const float	METERS_TO_INCHES = 39.3701f

Detailed Description

Definition at line 41 of file Length.cs.

Constructor & Destructor Documentation

◆ Length()

TiltFive.Length.Length	(	float	value,
		LengthUnit	unit
	)

Definition at line 129 of file Length.cs.

         {
             _meters = ConvertToMeters(value, unit);
         }

References TiltFive.Length._meters, and TiltFive.Length.ConvertToMeters().

Member Function Documentation

◆ ConvertMetersTo()

static float TiltFive.Length.ConvertMetersTo	(	float	meters,
		LengthUnit	unit
	)

static

Converts the provided meter value to a value in the provided units.

Parameters

meters	The provided length in meters.
unit	The provided length units.

Returns: The length, in the provided units.

Definition at line 217 of file Length.cs.

         {
             switch (unit)
             {
                 case LengthUnit.Kilometers:
                     return meters * METERS_TO_KILOMETERS;
                 case LengthUnit.Smoots:
                     return meters * METERS_TO_SMOOTS;
                 case LengthUnit.Attoparsecs:
                     return meters * METERS_TO_ATTOPARSECS;
                 case LengthUnit.Centimeters:
                     return meters * METERS_TO_CENTIMETERS;
                 case LengthUnit.MegaBeardSeconds:
                     return meters * METERS_TO_MEGABEARDSECONDS;
                 case LengthUnit.Millimeters:
                     return meters * METERS_TO_MILLIMETERS;
                 case LengthUnit.Miles:
                     return meters / MILES_TO_METERS;
                 case LengthUnit.Furlongs:
                     return meters * METERS_TO_FURLONGS;
                 case LengthUnit.Yards:
                     return meters * METERS_TO_YARDS;
                 case LengthUnit.Feet:
                     return meters * METERS_TO_FEET;
                 case LengthUnit.Inches:
                     return meters * METERS_TO_INCHES;
                 default:    // Meters
                     return meters;
             }
         }

References TiltFive.Length.METERS_TO_ATTOPARSECS, TiltFive.Length.METERS_TO_CENTIMETERS, TiltFive.Length.METERS_TO_FEET, TiltFive.Length.METERS_TO_FURLONGS, TiltFive.Length.METERS_TO_INCHES, TiltFive.Length.METERS_TO_KILOMETERS, TiltFive.Length.METERS_TO_MEGABEARDSECONDS, TiltFive.Length.METERS_TO_MILLIMETERS, TiltFive.Length.METERS_TO_SMOOTS, TiltFive.Length.METERS_TO_YARDS, and TiltFive.Length.MILES_TO_METERS.

Referenced by TiltFive.Length.ConvertTo().

◆ ConvertTo()

float TiltFive.Length.ConvertTo ( LengthUnit unit )

Converts the length to a value in the provided units.

Parameters

unit	The provided length units.

Returns: The length, in the provided units.

Definition at line 139 of file Length.cs.

         {
             return ConvertMetersTo(_meters, unit);
         }

References TiltFive.Length._meters, and TiltFive.Length.ConvertMetersTo().

◆ ConvertToMeters()

static float TiltFive.Length.ConvertToMeters	(	float	length,
		LengthUnit	unit
	)

static

Converts the provided length value to a value in meters.

Parameters

length	The provided length.
unit	The provided length units.

Returns: The length, in meters.

Definition at line 164 of file Length.cs.

         {
             float meters = 0f;
  
             switch (unit)
             {
                 case LengthUnit.Kilometers:
                     meters = length / METERS_TO_KILOMETERS;
                     break;
                 case LengthUnit.Smoots:
                     meters = length / METERS_TO_SMOOTS;
                     break;
                 case LengthUnit.Attoparsecs:
                     meters = length / METERS_TO_ATTOPARSECS;
                     break;
                 case LengthUnit.Centimeters:
                     meters = length / METERS_TO_CENTIMETERS;
                     break;
                 case LengthUnit.MegaBeardSeconds:
                     meters = length / METERS_TO_MEGABEARDSECONDS;
                     break;
                 case LengthUnit.Millimeters:
                     meters = length / METERS_TO_MILLIMETERS;
                     break;
                 case LengthUnit.Miles:
                     meters = length * MILES_TO_METERS;
                     break;
                 case LengthUnit.Furlongs:
                     meters = length / METERS_TO_FURLONGS;
                     break;
                 case LengthUnit.Yards:
                     meters = length / METERS_TO_YARDS;
                     break;
                 case LengthUnit.Feet:
                     meters = length / METERS_TO_FEET;
                     break;
                 case LengthUnit.Inches:
                     meters = length / METERS_TO_INCHES;
                     break;
                 default:    // Meters
                     meters = length;
                     break;
             }
  
             return meters;
         }

References TiltFive.Length.METERS_TO_ATTOPARSECS, TiltFive.Length.METERS_TO_CENTIMETERS, TiltFive.Length.METERS_TO_FEET, TiltFive.Length.METERS_TO_FURLONGS, TiltFive.Length.METERS_TO_INCHES, TiltFive.Length.METERS_TO_KILOMETERS, TiltFive.Length.METERS_TO_MEGABEARDSECONDS, TiltFive.Length.METERS_TO_MILLIMETERS, TiltFive.Length.METERS_TO_SMOOTS, TiltFive.Length.METERS_TO_YARDS, and TiltFive.Length.MILES_TO_METERS.

Referenced by TiltFive.Length.Length().

◆ operator*()

static Length TiltFive.Length.operator*	(	Length	a,
		float	scalar
	)

static

Multiplies a Length by some scalar value.

Parameters

a
scalar

Returns

◆ operator+()

static Length TiltFive.Length.operator+	(	Length	a,
		Length	b
	)

static

Adds two Length values together.

Parameters

a
b

Returns

◆ operator-()

static Length TiltFive.Length.operator-	(	Length	a,
		Length	b
	)

static

Subtracts one Length value from another Length value.

Parameters

a
b

Returns

◆ PreciselyConvertMetersTo()

static double TiltFive.Length.PreciselyConvertMetersTo	(	double	meters,
		LengthUnit	unit
	)

static

Converts the provided meter value to a double value in the provided units.

Parameters

meters	The provided length in meters.
unit	The provided length units.

Returns: The length, in the provided units.

Performs the conversion calculation using double arithmetic to reduce floating-point rounding errors. This may be less performant, so Drink Responsibly™. /remarks>

Definition at line 258 of file Length.cs.

         {
             switch (unit)
             {
                 case LengthUnit.Kilometers:
                     return meters * METERS_TO_KILOMETERS;
                 case LengthUnit.Smoots:
                     return meters * METERS_TO_SMOOTS;
                 case LengthUnit.Attoparsecs:
                     return meters * METERS_TO_ATTOPARSECS;
                 case LengthUnit.Centimeters:
                     return meters * METERS_TO_CENTIMETERS;
                 case LengthUnit.MegaBeardSeconds:
                     return meters * METERS_TO_MEGABEARDSECONDS;
                 case LengthUnit.Millimeters:
                     return meters * METERS_TO_MILLIMETERS;
                 case LengthUnit.Miles:
                     return meters / MILES_TO_METERS;
                 case LengthUnit.Furlongs:
                     return meters * METERS_TO_FURLONGS;
                 case LengthUnit.Yards:
                     return meters * METERS_TO_YARDS;
                 case LengthUnit.Feet:
                     return meters * METERS_TO_FEET;
                 case LengthUnit.Inches:
                     return meters * METERS_TO_INCHES;
                 default:    // Meters
                     return meters;
             }
         }

References TiltFive.Length.METERS_TO_ATTOPARSECS, TiltFive.Length.METERS_TO_CENTIMETERS, TiltFive.Length.METERS_TO_FEET, TiltFive.Length.METERS_TO_FURLONGS, TiltFive.Length.METERS_TO_INCHES, TiltFive.Length.METERS_TO_KILOMETERS, TiltFive.Length.METERS_TO_MEGABEARDSECONDS, TiltFive.Length.METERS_TO_MILLIMETERS, TiltFive.Length.METERS_TO_SMOOTS, TiltFive.Length.METERS_TO_YARDS, and TiltFive.Length.MILES_TO_METERS.

Referenced by TiltFive.Length.PreciselyConvertTo().

◆ PreciselyConvertTo()

double TiltFive.Length.PreciselyConvertTo ( LengthUnit unit )

Converts the length to a double value in the provided units.

Parameters

unit	The provided length units.

Returns: The length, in the provided units.

Performs the conversion calculation using double arithmetic to reduce floating-point rounding errors. This may be less performant, so Drink Responsibly™. /remarks>

Definition at line 153 of file Length.cs.

         {
             return PreciselyConvertMetersTo(_meters, unit);
         }

References TiltFive.Length._meters, and TiltFive.Length.PreciselyConvertMetersTo().

Member Data Documentation

◆ _meters

float TiltFive.Length._meters

private

Definition at line 111 of file Length.cs.

Referenced by TiltFive.Length.ConvertTo(), TiltFive.Length.Length(), and TiltFive.Length.PreciselyConvertTo().

◆ METERS_TO_ATTOPARSECS

const float TiltFive.Length.METERS_TO_ATTOPARSECS = 32.4078f

static

Definition at line 119 of file Length.cs.

Referenced by TiltFive.Length.ConvertMetersTo(), TiltFive.Length.ConvertToMeters(), and TiltFive.Length.PreciselyConvertMetersTo().

◆ METERS_TO_CENTIMETERS

const float TiltFive.Length.METERS_TO_CENTIMETERS = 100f

static

Definition at line 118 of file Length.cs.

Referenced by TiltFive.Length.ConvertMetersTo(), TiltFive.Length.ConvertToMeters(), and TiltFive.Length.PreciselyConvertMetersTo().

◆ METERS_TO_FEET

const float TiltFive.Length.METERS_TO_FEET = 3.28084f

static

Definition at line 113 of file Length.cs.

Referenced by TiltFive.Length.ConvertMetersTo(), TiltFive.Length.ConvertToMeters(), and TiltFive.Length.PreciselyConvertMetersTo().

◆ METERS_TO_FURLONGS

const float TiltFive.Length.METERS_TO_FURLONGS = 0.004971f

static

Definition at line 115 of file Length.cs.

Referenced by TiltFive.Length.ConvertMetersTo(), TiltFive.Length.ConvertToMeters(), and TiltFive.Length.PreciselyConvertMetersTo().

◆ METERS_TO_INCHES

const float TiltFive.Length.METERS_TO_INCHES = 39.3701f

staticprivate

Definition at line 112 of file Length.cs.

Referenced by TiltFive.Length.ConvertMetersTo(), TiltFive.Length.ConvertToMeters(), and TiltFive.Length.PreciselyConvertMetersTo().

◆ METERS_TO_KILOMETERS

const float TiltFive.Length.METERS_TO_KILOMETERS = 0.001f

static

Definition at line 121 of file Length.cs.

Referenced by TiltFive.Length.ConvertMetersTo(), TiltFive.Length.ConvertToMeters(), and TiltFive.Length.PreciselyConvertMetersTo().

◆ METERS_TO_MEGABEARDSECONDS

const float TiltFive.Length.METERS_TO_MEGABEARDSECONDS = 200f

static

Definition at line 117 of file Length.cs.

Referenced by TiltFive.Length.ConvertMetersTo(), TiltFive.Length.ConvertToMeters(), and TiltFive.Length.PreciselyConvertMetersTo().

◆ METERS_TO_MILLIMETERS

const float TiltFive.Length.METERS_TO_MILLIMETERS = 1000f

static

Definition at line 116 of file Length.cs.

Referenced by TiltFive.Length.ConvertMetersTo(), TiltFive.Length.ConvertToMeters(), and TiltFive.Length.PreciselyConvertMetersTo().

◆ METERS_TO_SMOOTS

const float TiltFive.Length.METERS_TO_SMOOTS = 0.587613f

static

Definition at line 120 of file Length.cs.

Referenced by TiltFive.Length.ConvertMetersTo(), TiltFive.Length.ConvertToMeters(), and TiltFive.Length.PreciselyConvertMetersTo().

◆ METERS_TO_YARDS

const float TiltFive.Length.METERS_TO_YARDS = 1.0936f

static

Definition at line 114 of file Length.cs.

Referenced by TiltFive.Length.ConvertMetersTo(), TiltFive.Length.ConvertToMeters(), and TiltFive.Length.PreciselyConvertMetersTo().

◆ MILES_TO_METERS

const float TiltFive.Length.MILES_TO_METERS = 1609.34f

static

Definition at line 122 of file Length.cs.

Referenced by TiltFive.Length.ConvertMetersTo(), TiltFive.Length.ConvertToMeters(), and TiltFive.Length.PreciselyConvertMetersTo().

Property Documentation

◆ ToAttoparsecs

float TiltFive.Length.ToAttoparsecs

get

The Length, converted to attoparsecs.

Definition at line 89 of file Length.cs.

◆ ToCentimeters

float TiltFive.Length.ToCentimeters

get

The Length, converted to centimeters.

Definition at line 84 of file Length.cs.

◆ ToFeet

float TiltFive.Length.ToFeet

get

The Length, converted to feet.

Definition at line 54 of file Length.cs.

◆ ToFurlongs

float TiltFive.Length.ToFurlongs

get

The Length, converted to furlongs.

Definition at line 64 of file Length.cs.

◆ ToInches

float TiltFive.Length.ToInches

get

The Length, converted to inches.

Definition at line 49 of file Length.cs.

◆ ToKilometers

float TiltFive.Length.ToKilometers

get

The Length, converted to kilometers.

Definition at line 104 of file Length.cs.

◆ ToMegaBeardSeconds

float TiltFive.Length.ToMegaBeardSeconds

get

The Length, converted to mega-beard-seconds.

Definition at line 79 of file Length.cs.

◆ ToMeters

float TiltFive.Length.ToMeters

get

The Length, converted to meters.

Definition at line 94 of file Length.cs.

Referenced by TiltFive.GameBoard.GameboardExtents.GetCornerPositionInGameboardSpace(), TiltFive.GameBoard.GameboardExtents.GetEdgeCenterPositionInGameboardSpace(), and TiltFive.GameBoard.GameboardExtents.GetPhysicalCenterPositionInGameboardSpace().

◆ ToMiles

float TiltFive.Length.ToMiles

get

The Length, converted to miles.

Definition at line 69 of file Length.cs.

◆ ToMillimeters

float TiltFive.Length.ToMillimeters

get

The Length, converted to millimeters.

Definition at line 74 of file Length.cs.

◆ ToSmoots

float TiltFive.Length.ToSmoots

get

The Length, converted to smoots.

Definition at line 99 of file Length.cs.

◆ ToYards

float TiltFive.Length.ToYards

get

The Length, converted to yards.

Definition at line 59 of file Length.cs.

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

Length.cs

Public Member Functions

Static Public Member Functions

Static Public Attributes

Properties

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Length()

Member Function Documentation

◆ ConvertMetersTo()

◆ ConvertTo()

◆ ConvertToMeters()

◆ operator*()

◆ operator+()

◆ operator-()

◆ PreciselyConvertMetersTo()

◆ PreciselyConvertTo()

Member Data Documentation

◆ _meters

◆ METERS_TO_ATTOPARSECS

◆ METERS_TO_CENTIMETERS

◆ METERS_TO_FEET

◆ METERS_TO_FURLONGS

◆ METERS_TO_INCHES

◆ METERS_TO_KILOMETERS

◆ METERS_TO_MEGABEARDSECONDS

◆ METERS_TO_MILLIMETERS

◆ METERS_TO_SMOOTS

◆ METERS_TO_YARDS

◆ MILES_TO_METERS

Property Documentation

◆ ToAttoparsecs

◆ ToCentimeters

◆ ToFeet

◆ ToFurlongs

◆ ToInches

◆ ToKilometers

◆ ToMegaBeardSeconds

◆ ToMeters

◆ ToMiles

◆ ToMillimeters

◆ ToSmoots

◆ ToYards