Struct Index3

Struktur zur Definierung einer dreidimensionalen Index-Position.

Namespace: OctoAwesome

Assembly: OctoAwesome.dll

Syntax

public struct Index3

Konstructoren

Index3(Index2, Int32)

Initialisierung

Deklaration

public Index3(Index2 index, int z)

Parameter

Typ	Name	Beschreibung
Index2	index	2D-Basis
System.Int32	z	Z-Anteil

Index3(Index3)

Initialisierung

Deklaration

public Index3(Index3 index)

Parameter

Typ	Name	Beschreibung
Index3	index	3D-Basis

Index3(Int32, Int32, Int32)

Initialisierung

Deklaration

public Index3(int x, int y, int z)

Parameter

Typ	Name	Beschreibung
System.Int32	x	X-Anteil
System.Int32	y	Y-Anteil
System.Int32	z	Z-Anteil

Felder

X

X Anteil

Deklaration

public int X

Wert des Feldes

Typ	Beschreibung
System.Int32

Y

Y Anteil

Deklaration

public int Y

Wert des Feldes

Typ	Beschreibung
System.Int32

Z

Z Anteil

Deklaration

public int Z

Wert des Feldes

Typ	Beschreibung
System.Int32

Eigenschaften

One

Gibts Index(1,1,1) zurück

Deklaration

public static Index3 One { get; }

Wert der Eigenschaft

Typ	Beschreibung
Index3

UnitX

Einheitsindex für X

Deklaration

public static Index3 UnitX { get; }

Wert der Eigenschaft

Typ	Beschreibung
Index3

UnitY

Einheitsindex für Y

Deklaration

public static Index3 UnitY { get; }

Wert der Eigenschaft

Typ	Beschreibung
Index3

UnitZ

Einheitsindex für Z

Deklaration

public static Index3 UnitZ { get; }

Wert der Eigenschaft

Typ	Beschreibung
Index3

Zero

Null-Index

Deklaration

public static Index3 Zero { get; }

Wert der Eigenschaft

Typ	Beschreibung
Index3

Methoden

Equals(Object)

Überprüft, ob der gegebene Index3 den gleichen Wert aufweist, wie der aktuelle Index3.

Deklaration

public override bool Equals(object obj)

Parameter

Typ	Name	Beschreibung
System.Object	obj

R�ckgabewert

Typ	Beschreibung
System.Boolean

GetHashCode()

Gibt einen möglichst eindeutigen Hashwert für den aktuellen Index3 zurück.

Deklaration

public override int GetHashCode()

R�ckgabewert

Typ	Beschreibung
System.Int32

Length()

Ermittelt die Entferung zum Nullpunkt.

Deklaration

public double Length()

R�ckgabewert

Typ	Beschreibung
System.Double

LengthSquared()

Ermittelt die Entfernung zum Nullpunkt im Quadrat.

Deklaration

public int LengthSquared()

R�ckgabewert

Typ	Beschreibung
System.Int32

NormalizeX(Index2)

Normalisiert die X-Achse auf die angegebene Größe.

Deklaration

public void NormalizeX(Index2 size)

Parameter

Typ	Name	Beschreibung
Index2	size	2D-Size

NormalizeX(Index3)

Normalisiert die X-Achse auf die angegebene Größe.

Deklaration

public void NormalizeX(Index3 size)

Parameter

Typ	Name	Beschreibung
Index3	size	3D-Size

NormalizeX(Int32)

Normalisiert die X-Achse auf die angegebene Größe.

Deklaration

public void NormalizeX(int size)

Parameter

Typ	Name	Beschreibung
System.Int32	size	Maximalwert für X

NormalizeXY(Index2)

Normalisiert die X- und Y-Achse auf die angegebene Größe.

Deklaration

public void NormalizeXY(Index2 size)

Parameter

Typ	Name	Beschreibung
Index2	size	Maximalwert für X und Y

NormalizeXY(Index3)

Normalisiert die X- und Y-Achse auf die angegebene Größe.

Deklaration

public void NormalizeXY(Index3 size)

Parameter

Typ	Name	Beschreibung
Index3	size	Maximalwert für X und Y

NormalizeXY(Int32, Int32)

Normalisiert die X- und Y-Achse auf die angegebene Größe.

Deklaration

public void NormalizeXY(int x, int y)

Parameter

Typ	Name	Beschreibung
System.Int32	x	X-Anteil
System.Int32	y	Y-Anteil

NormalizeXYZ(Index2, Int32)

Normalisiert die X-, Y- und Z-Achse auf die angegebene Größe.

Deklaration

public void NormalizeXYZ(Index2 size, int z)

Parameter

Typ	Name	Beschreibung
Index2	size	2D-Size
System.Int32	z	Z-Anteil

NormalizeXYZ(Index3)

Normalisiert die X-, Y- und Z-Achse auf die angegebene Größe.

Deklaration

public void NormalizeXYZ(Index3 size)

Parameter

Typ	Name	Beschreibung
Index3	size	Maximalwert für X, Y und Z

NormalizeXYZ(Int32, Int32, Int32)

Normalisiert die X-, Y- und Z-Achse auf die angegebene Größe.

Deklaration

public void NormalizeXYZ(int x, int y, int z)

Parameter

Typ	Name	Beschreibung
System.Int32	x	X-Anteil
System.Int32	y	Y-Anteil
System.Int32	z	Z-Anteil

NormalizeY(Index2)

Normalisiert die Y-Achse auf die angegebene Größe.

Deklaration

public void NormalizeY(Index2 size)

Parameter

Typ	Name	Beschreibung
Index2	size	2D-Size

NormalizeY(Index3)

Normalisiert die Y-Achse auf die angegebene Größe.

Deklaration

public void NormalizeY(Index3 size)

Parameter

Typ	Name	Beschreibung
Index3	size	3D-Size

NormalizeY(Int32)

Normalisiert die Y-Achse auf die angegebene Größe.

Deklaration

public void NormalizeY(int size)

Parameter

Typ	Name	Beschreibung
System.Int32	size	Maximalwert für Y

NormalizeZ(Index3)

Normalisiert die Z-Achse auf die angegebene Größe.

Deklaration

public void NormalizeZ(Index3 size)

Parameter

Typ	Name	Beschreibung
Index3	size	3D-Size

NormalizeZ(Int32)

Normalisiert die Z-Achse auf die angegebene Größe.

Deklaration

public void NormalizeZ(int size)

Parameter

Typ	Name	Beschreibung
System.Int32	size	Maximalwert für Z

ShortestDistanceX(Int32, Int32)

Ermittelt die kürzeste Entfernung zum Ziel auf einer normalisierten X-Achse.

Deklaration

public int ShortestDistanceX(int x, int size)

Parameter

Typ	Name	Beschreibung
System.Int32	x	Ziel
System.Int32	size	Normalisierungsgröße

R�ckgabewert

Typ	Beschreibung
System.Int32	Entfernung

ShortestDistanceXY(Index2, Index2)

Ermittelt die kürzeste Entfernung zum Ziel auf den normalisierten Achsen.

Deklaration

public Index2 ShortestDistanceXY(Index2 destination, Index2 size)

Parameter

Typ	Name	Beschreibung
Index2	destination	Ziel
Index2	size	Normalisierungsgröße

R�ckgabewert

Typ	Beschreibung
Index2	Entfernung

ShortestDistanceXY(Index3, Index2)

Ermittelt die kürzeste Entfernung zum Ziel auf den normalisierten Achsen.

Deklaration

public Index3 ShortestDistanceXY(Index3 destination, Index2 size)

Parameter

Typ	Name	Beschreibung
Index3	destination	Ziel
Index2	size	Normalisierungsgröße

R�ckgabewert

Typ	Beschreibung
Index3	Entfernung

ShortestDistanceXY(Index3, Index3)

Ermittelt die kürzeste Entfernung zum Ziel auf den normalisierten Achsen.

Deklaration

public Index3 ShortestDistanceXY(Index3 destination, Index3 size)

Parameter

Typ	Name	Beschreibung
Index3	destination	Ziel
Index3	size	Normalisierungsgröße

R�ckgabewert

Typ	Beschreibung
Index3	Entfernung

ShortestDistanceXYZ(Index3, Index3)

Ermittelt die kürzeste Entfernung zum Ziel auf den normalisierten Achsen.

Deklaration

public Index3 ShortestDistanceXYZ(Index3 destination, Index3 size)

Parameter

Typ	Name	Beschreibung
Index3	destination	Ziel
Index3	size	Normalisierungsgröße

R�ckgabewert

Typ	Beschreibung
Index3	Entfernung

ShortestDistanceY(Int32, Int32)

Ermittelt die kürzeste Entfernung zum Ziel auf einer normalisierten Y-Achse.

Deklaration

public int ShortestDistanceY(int y, int size)

Parameter

Typ	Name	Beschreibung
System.Int32	y	Ziel
System.Int32	size	Normalisierungsgröße

R�ckgabewert

Typ	Beschreibung
System.Int32	Entfernung

ShortestDistanceZ(Int32, Int32)

Ermittelt die kürzeste Entfernung zum Ziel auf einer normalisierten Z-Achse.

Deklaration

public int ShortestDistanceZ(int z, int size)

Parameter

Typ	Name	Beschreibung
System.Int32	z	Ziel
System.Int32	size	Normalisierungsgröße

R�ckgabewert

Typ	Beschreibung
System.Int32	Entfernung

ToString()

Gibt einen string zurück, der den akteullen Index3 darstellt.

Deklaration

public override string ToString()

R�ckgabewert

Typ	Beschreibung
System.String

Operatoren

Addition(Index3, Index2)

Addiert einen Index3 und einen Index2

Deklaration

public static Index3 operator +(Index3 i1, Index2 i2)

Parameter

Typ	Name	Beschreibung
Index3	i1	Summand
Index2	i2	Summand (ohne Z-Anteil)

R�ckgabewert

Typ	Beschreibung
Index3

Anmerkungen

Der Z-Anteil des Index3 wird unverändert übernommen.

Addition(Index3, Index3)

Addiert zwei Indices3

Deklaration

public static Index3 operator +(Index3 i1, Index3 i2)

Parameter

Typ	Name	Beschreibung
Index3	i1	Summand
Index3	i2	Summand

R�ckgabewert

Typ	Beschreibung
Index3

Division(Index3, Int32)

Dividiert einen Index3 durch einen Skalierungsfaktor.

Deklaration

public static Index3 operator /(Index3 i1, int scale)

Parameter

Typ	Name	Beschreibung
Index3	i1	Der Index3
System.Int32	scale	Der Skalierungsfaktor

R�ckgabewert

Typ	Beschreibung
Index3

Equality(Index3, Index3)

Überprüft, ob beide gegebenen Indices3 den gleichen Wert aufweisen.

Deklaration

public static bool operator ==(Index3 i1, Index3 i2)

Parameter

Typ	Name	Beschreibung
Index3	i1
Index3	i2

R�ckgabewert

Typ	Beschreibung
System.Boolean

Implicit(Index3 to Vector3)

Implizite Umwandlung des aktuellen Index3 in einen Vector3.

Deklaration

public static implicit operator Vector3(Index3 index)

Parameter

Typ	Name	Beschreibung
Index3	index

R�ckgabewert

Typ	Beschreibung
Vector3

Anmerkungen

Bei der Konvertierung von int zu float können Rundungsfehler auftreten!

Inequality(Index3, Index3)

Überprüft, ob beide gegebenen Indices3 nicht den gleichen Wert aufweisen.

Deklaration

public static bool operator !=(Index3 i1, Index3 i2)

Parameter

Typ	Name	Beschreibung
Index3	i1
Index3	i2

R�ckgabewert

Typ	Beschreibung
System.Boolean

Multiply(Index3, Index3)

Multiplieziert wei Indices3 miteinander.

Deklaration

public static Index3 operator *(Index3 i1, Index3 i2)

Parameter

Typ	Name	Beschreibung
Index3	i1	Faktor
Index3	i2	Faktor

R�ckgabewert

Typ	Beschreibung
Index3

Multiply(Index3, Int32)

Skaliert einen Index3 mit einem Integer.

Deklaration

public static Index3 operator *(Index3 i1, int scale)

Parameter

Typ	Name	Beschreibung
Index3	i1	Der zu skalierende Index3
System.Int32	scale	Der Skalierungsfaktor

R�ckgabewert

Typ	Beschreibung
Index3

Subtraction(Index3, Index2)

Subtrahiert einen Index2 von einem Index3

Deklaration

public static Index3 operator -(Index3 i1, Index2 i2)

Parameter

Typ	Name	Beschreibung
Index3	i1	Minuend
Index2	i2	Subtrahend

R�ckgabewert

Typ	Beschreibung
Index3

Anmerkungen

Der Z-Anteil des Index3 wird unverändert übernommen.

Subtraction(Index3, Index3)

Subtrahiert zwei Indices3

Deklaration

public static Index3 operator -(Index3 i1, Index3 i2)

Parameter

Typ	Name	Beschreibung
Index3	i1	Minuend
Index3	i2	Subtrahend

R�ckgabewert

Typ	Beschreibung
Index3