pluginbase.Helpers.Coords.Rotation2d Struct Reference

Rotation XZ; In radians More...

Public Member Functions
	Rotation2d (double x, double z)
Rotation2d	TurnTo (Rotation2d toRot)
	Calculates the shortest turn-distance from this rotation to another one. (Not resulting rotation, but how much we have to rotate and which direction) eg. if this rotation is 0, and the other rotation is 7, it should compute the shortest turn to be 0.72 More...
Rotation2d	TurnToResult (Rotation2d toRot)
	Calculates the resulting rotation of computing the shortest turn two a given rotation More...
void	Normalize ()
	Normalize this back into the 0-2pi range More...
Rotation2d	Normalized ()
	Normalize the current rotation in the 0-2pi range and return the result More...
override string	ToString ()

Static Public Member Functions
static Rotation2d	FromDegrees (double x, double z)
static Rotation2d	FromDirectionZUp (Vector3d dir)
static implicit	operator Vector2d (Rotation2d rot)
static	operator Rotation2d (Vector2d vec)
static implicit	operator Rotation2d (Rotation2 rot)
static	operator Rotation2 (Rotation2d rot)
static Rotation2d	operator+ (Rotation2d a, Rotation2d b)
static Rotation2d	operator- (Rotation2d a, Rotation2d b)
static Rotation2d	operator* (Rotation2d a, Rotation2d b)
static Rotation2d	operator/ (Rotation2d a, Rotation2d b)
static Rotation2d	operator* (Rotation2d a, double v)
static Rotation2d	operator* (double v, Rotation2d b)

Public Attributes
double	X
double	Z

Static Public Attributes
static readonly Rotation2d	Zero = new Rotation2d(0.0, 0.0)
static readonly Rotation2d	UnitX = new Rotation2d(1.0, 0.0)
static readonly Rotation2d	UnitZ = new Rotation2d(0.0, 1.0)

Properties
double	DegreesX [get]
double	DegreesZ [get]
Vector3d	Vector [get]
Vector3d	VectorZAxis [get]

Detailed Description

Rotation XZ; In radians

Constructor & Destructor Documentation

Rotation2d()

pluginbase.Helpers.Coords.Rotation2d.Rotation2d	(	double	x,
		double	z
	)

        {
            X = x;
            Z = z;
        }

Member Function Documentation

FromDegrees()

static Rotation2d pluginbase.Helpers.Coords.Rotation2d.FromDegrees ( double  x, double  z  )

static

        {
            return new Rotation2d( MExt.DegreeToRadian(x), MExt.DegreeToRadian(z) );
        }

FromDirectionZUp()

static Rotation2d pluginbase.Helpers.Coords.Rotation2d.FromDirectionZUp ( Vector3d  dir )

static

        {
            return new Rotation2d(
                Math.Asin(dir.Z),
                Math.Atan2(dir.X, dir.Y)
            );
        }

Normalize()

void pluginbase.Helpers.Coords.Rotation2d.Normalize

(

)

Normalize this back into the 0-2pi range

        {
            this.X = MExt.FloatRemainder(this.X, MathHelper.TwoPi);
            this.Z = MExt.FloatRemainder(this.Z, MathHelper.TwoPi);
        }

Normalized()

Rotation2d pluginbase.Helpers.Coords.Rotation2d.Normalized

(

)

Normalize the current rotation in the 0-2pi range and return the result

Returns

The normalized.

        {
            var rot = new Rotation2d(this.X, this.Z);
            rot.Normalize();
            return rot;
        }

operator Rotation2()

static pluginbase.Helpers.Coords.Rotation2d.operator Rotation2 ( Rotation2d  rot )

explicitstatic

        {
            return new Rotation2((float)rot.X, (float)rot.Z);
        }

operator Rotation2d() [1/2]

static pluginbase.Helpers.Coords.Rotation2d.operator Rotation2d ( Vector2d  vec )

explicitstatic

        {
            return new Rotation2d(vec.X, vec.Y);
        }

operator Rotation2d() [2/2]

static implicit pluginbase.Helpers.Coords.Rotation2d.operator Rotation2d ( Rotation2  rot )

static

        {
            return new Rotation2d(rot.X, rot.Z);
        }

operator Vector2d()

static implicit pluginbase.Helpers.Coords.Rotation2d.operator Vector2d ( Rotation2d  rot )

static

        {
            return new Vector2d(rot.X, rot.Z);
        }

operator*() [1/3]

static Rotation2d pluginbase.Helpers.Coords.Rotation2d.operator* ( Rotation2d  a, Rotation2d  b  )

static

        {
            return new Rotation2d(a.X * b.X, a.Z * b.Z);
        }

operator*() [2/3]

static Rotation2d pluginbase.Helpers.Coords.Rotation2d.operator* ( Rotation2d  a, double  v  )

static

        {
            return new Rotation2d(a.X*v, a.Z*v);
        }

operator*() [3/3]

static Rotation2d pluginbase.Helpers.Coords.Rotation2d.operator* ( double  v, Rotation2d  b  )

static

        {
            return new Rotation2d(v*b.X, v*b.Z);
        }

operator+()

static Rotation2d pluginbase.Helpers.Coords.Rotation2d.operator+ ( Rotation2d  a, Rotation2d  b  )

static

        {
            return new Rotation2d(a.X + b.X, a.Z + b.Z);
        }

operator-()

static Rotation2d pluginbase.Helpers.Coords.Rotation2d.operator- ( Rotation2d  a, Rotation2d  b  )

static

        {
            return new Rotation2d(a.X - b.X, a.Z - b.Z);
        }

operator/()

static Rotation2d pluginbase.Helpers.Coords.Rotation2d.operator/ ( Rotation2d  a, Rotation2d  b  )

static

        {
            return new Rotation2d(a.X/b.X, a.Z/b.Z);
        }

ToString()

override string pluginbase.Helpers.Coords.Rotation2d.ToString

(

)

        {
            return string.Format("({0}, {1})", X, Z);
        }

TurnTo()

Rotation2d pluginbase.Helpers.Coords.Rotation2d.TurnTo

(

Rotation2d

toRot

)

Calculates the shortest turn-distance from this rotation to another one. (Not resulting rotation, but how much we have to rotate and which direction) eg. if this rotation is 0, and the other rotation is 7, it should compute the shortest turn to be 0.72

Returns

The turn.

Parameters

toRot

To rot.

        {
            const float ThreePi = 3f * MathHelper.Pi;
            var diff = toRot.Normalized() - this.Normalized();
            return new Rotation2d(
                MExt.FloatRemainder(diff.X + ThreePi, MathHelper.TwoPi) - MathHelper.Pi,
                MExt.FloatRemainder(diff.Z + ThreePi, MathHelper.TwoPi) - MathHelper.Pi);
        }

TurnToResult()

Rotation2d pluginbase.Helpers.Coords.Rotation2d.TurnToResult

(

Rotation2d

toRot

)

Calculates the resulting rotation of computing the shortest turn two a given rotation

Returns

The rotation.

Parameters

toRot

To rot.

        {
            return this + this.TurnTo(toRot);
        }

Member Data Documentation

UnitX

readonly Rotation2d pluginbase.Helpers.Coords.Rotation2d.UnitX = new Rotation2d(1.0, 0.0)

static

UnitZ

readonly Rotation2d pluginbase.Helpers.Coords.Rotation2d.UnitZ = new Rotation2d(0.0, 1.0)

static

X

double pluginbase.Helpers.Coords.Rotation2d.X

Z

double pluginbase.Helpers.Coords.Rotation2d.Z

Zero

readonly Rotation2d pluginbase.Helpers.Coords.Rotation2d.Zero = new Rotation2d(0.0, 0.0)

static

Property Documentation

DegreesX

double pluginbase.Helpers.Coords.Rotation2d.DegreesX

get

DegreesZ

double pluginbase.Helpers.Coords.Rotation2d.DegreesZ

get

Vector

Vector3d pluginbase.Helpers.Coords.Rotation2d.Vector

get

VectorZAxis

Vector3d pluginbase.Helpers.Coords.Rotation2d.VectorZAxis

get

---

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

• pluginbase/Helpers/Coords/Rotation2d.cs