Class Vector3I
Inheritance
System.Object
Vector3I
Assembly: VRage.Math.dll
Syntax
public sealed class Vector3I : ValueType, IEquatable<Vector3I>, IComparable<Vector3I>
Constructors
Vector3I(Byte[], Int32)
Declaration
public Vector3I(byte[] bytes, int index)
Parameters
Type |
Name |
Description |
System.Byte[] |
bytes |
|
System.Int32 |
index |
|
Vector3I(Int32)
Declaration
Parameters
Type |
Name |
Description |
System.Int32 |
xyz |
|
Vector3I(Int32, Int32, Int32)
Declaration
public Vector3I(int x, int y, int z)
Parameters
Type |
Name |
Description |
System.Int32 |
x |
|
System.Int32 |
y |
|
System.Int32 |
z |
|
Vector3I(Single, Single, Single)
Declaration
public Vector3I(float x, float y, float z)
Parameters
Type |
Name |
Description |
System.Single |
x |
|
System.Single |
y |
|
System.Single |
z |
|
Vector3I(Vector2I, Int32)
Declaration
public Vector3I(Vector2I xy, int z)
Parameters
Type |
Name |
Description |
Vector2I |
xy |
|
System.Int32 |
z |
|
Vector3I(Vector3)
Declaration
public Vector3I(Vector3 xyz)
Parameters
Vector3I(Vector3D)
Declaration
public Vector3I(Vector3D xyz)
Parameters
Vector3I(Vector3S)
Declaration
public Vector3I(Vector3S xyz)
Parameters
Fields
Backward
Declaration
public static Vector3I Backward
Field Value
Comparer
Declaration
public static readonly Vector3I.EqualityComparer Comparer
Field Value
Down
Declaration
public static Vector3I Down
Field Value
Forward
Declaration
public static Vector3I Forward
Field Value
Left
Declaration
public static Vector3I Left
Field Value
MaxValue
Declaration
public static Vector3I MaxValue
Field Value
MinValue
Declaration
public static Vector3I MinValue
Field Value
One
Declaration
public static Vector3I One
Field Value
Right
Declaration
public static Vector3I Right
Field Value
UnitX
Declaration
public static Vector3I UnitX
Field Value
UnitY
Declaration
public static Vector3I UnitY
Field Value
UnitZ
Declaration
public static Vector3I UnitZ
Field Value
Up
Declaration
public static Vector3I Up
Field Value
X
Declaration
Field Value
Type |
Description |
System.Int32 |
|
Y
Declaration
Field Value
Type |
Description |
System.Int32 |
|
Z
Declaration
Field Value
Type |
Description |
System.Int32 |
|
Zero
Declaration
public static Vector3I Zero
Field Value
Properties
IsPowerOfTwo
Declaration
public bool IsPowerOfTwo { get; }
Property Value
Type |
Description |
System.Boolean |
|
Item[Int32]
Declaration
public int this[int index] { get; set; }
Parameters
Type |
Name |
Description |
System.Int32 |
index |
|
Property Value
Type |
Description |
System.Int32 |
|
Size
How many cubes are in block with this size
Declaration
Property Value
Type |
Description |
System.Int32 |
|
SizeLong
Declaration
public long SizeLong { get; }
Property Value
Type |
Description |
System.Int64 |
|
Methods
Abs(Vector3I)
Declaration
public static Vector3I Abs(Vector3I value)
Parameters
Returns
Abs(ref Vector3I, out Vector3I)
Declaration
public static void Abs(ref Vector3I value, out Vector3I result)
Parameters
AbsMax()
Returns the component of the vector, whose absolute value is largest of all the three components.
Declaration
Returns
Type |
Description |
System.Int32 |
|
AbsMin()
Returns the component of the vector, whose absolute value is smallest of all the three components.
Declaration
Returns
Type |
Description |
System.Int32 |
|
AxisValue(Base6Directions.Axis)
Declaration
public int AxisValue(Base6Directions.Axis axis)
Parameters
Returns
Type |
Description |
System.Int32 |
|
BoxContains(Vector3I, Vector3I, Vector3I)
Declaration
public static bool BoxContains(Vector3I boxMin, Vector3I boxMax, Vector3I pt)
Parameters
Returns
Type |
Description |
System.Boolean |
|
BoxContains(ref Vector3I, ref Vector3I, ref Vector3I)
Declaration
public static bool BoxContains(ref Vector3I boxMin, ref Vector3I boxMax, ref Vector3I pt)
Parameters
Returns
Type |
Description |
System.Boolean |
|
BoxIntersects(Vector3I, Vector3I, Vector3I, Vector3I)
Declaration
public static bool BoxIntersects(Vector3I minA, Vector3I maxA, Vector3I minB, Vector3I maxB)
Parameters
Returns
Type |
Description |
System.Boolean |
|
BoxIntersects(ref Vector3I, ref Vector3I, ref Vector3I, ref Vector3I)
Declaration
public static bool BoxIntersects(ref Vector3I minA, ref Vector3I maxA, ref Vector3I minB, ref Vector3I maxB)
Parameters
Returns
Type |
Description |
System.Boolean |
|
Ceiling(Vector3)
Declaration
public static Vector3I Ceiling(Vector3 value)
Parameters
Type |
Name |
Description |
Vector3 |
value |
|
Returns
Ceiling(Vector3D)
Declaration
public static Vector3I Ceiling(Vector3D value)
Parameters
Returns
Clamp(Vector3I, Vector3I, Vector3I)
Declaration
public static Vector3I Clamp(Vector3I value1, Vector3I min, Vector3I max)
Parameters
Returns
Clamp(ref Vector3I, ref Vector3I, ref Vector3I, out Vector3I)
Declaration
public static void Clamp(ref Vector3I value1, ref Vector3I min, ref Vector3I max, out Vector3I result)
Parameters
CompareTo(Vector3I)
Declaration
public int CompareTo(Vector3I other)
Parameters
Returns
Type |
Description |
System.Int32 |
|
Cross(ref Vector3I, ref Vector3I, out Vector3I)
Calculates the cross product of two vectors.
Declaration
public static void Cross(ref Vector3I vector1, ref Vector3I vector2, out Vector3I result)
Parameters
Type |
Name |
Description |
Vector3I |
vector1 |
Source vector.
|
Vector3I |
vector2 |
Source vector.
|
Vector3I |
result |
[OutAttribute] The cross product of the vectors.
|
DistanceManhattan(Vector3I, Vector3I)
Manhattan distance (cube distance)
X + Y + Z of Abs(first - second)
Declaration
public static int DistanceManhattan(Vector3I first, Vector3I second)
Parameters
Returns
Type |
Description |
System.Int32 |
|
DominantAxisProjection(Vector3I)
Returns a vector that is equal to the projection of the input vector to the coordinate axis that corresponds
to the original vector's largest value.
Declaration
public static Vector3I DominantAxisProjection(Vector3I value1)
Parameters
Type |
Name |
Description |
Vector3I |
value1 |
Source vector.
|
Returns
DominantAxisProjection(ref Vector3I, out Vector3I)
Calculates a vector that is equal to the projection of the input vector to the coordinate axis that corresponds
to the original vector's largest value. The result is saved into a user-specified variable.
Declaration
public static void DominantAxisProjection(ref Vector3I value1, out Vector3I result)
Parameters
Type |
Name |
Description |
Vector3I |
value1 |
Source vector.
|
Vector3I |
result |
[OutAttribute] The projected vector.
|
Dot(Vector3I, Vector3I)
Declaration
public static int Dot(Vector3I vector1, Vector3I vector2)
Parameters
Returns
Type |
Description |
System.Int32 |
|
Dot(ref Vector3I)
Declaration
public int Dot(ref Vector3I v)
Parameters
Returns
Type |
Description |
System.Int32 |
|
Dot(ref Vector3I, ref Vector3I)
Declaration
public static int Dot(ref Vector3I vector1, ref Vector3I vector2)
Parameters
Returns
Type |
Description |
System.Int32 |
|
Dot(ref Vector3I, ref Vector3I, out Int32)
Declaration
public static void Dot(ref Vector3I vector1, ref Vector3I vector2, out int dot)
Parameters
EnumerateRange(Vector3I, Vector3I)
Enumerate all values in a integer interval (a cuboid).
This method is an allocating version of the Vector3I_RangeIterator.
This once can be used in the foreach syntax though so it's more convenient for debug routines.
Declaration
public static IEnumerable<Vector3I> EnumerateRange(Vector3I minInclusive, Vector3I maxExclusive)
Parameters
Type |
Name |
Description |
Vector3I |
minInclusive |
Minimum range (inclusive)
|
Vector3I |
maxExclusive |
Maximum range (exclusive)
|
Returns
Type |
Description |
System.Collections.Generic.IEnumerable<Vector3I> |
An iterator for that range.
|
Equals(Object)
Declaration
public override bool Equals(object obj)
Parameters
Type |
Name |
Description |
System.Object |
obj |
|
Returns
Type |
Description |
System.Boolean |
|
Equals(Vector3I)
Declaration
public bool Equals(Vector3I other)
Parameters
Returns
Type |
Description |
System.Boolean |
|
Floor(Vector3)
Declaration
public static Vector3I Floor(Vector3 value)
Parameters
Type |
Name |
Description |
Vector3 |
value |
|
Returns
Floor(ref Vector3, out Vector3I)
Declaration
public static void Floor(ref Vector3 v, out Vector3I r)
Parameters
Floor(Vector3D)
Declaration
public static Vector3I Floor(Vector3D value)
Parameters
Returns
Floor(ref Vector3D, out Vector3I)
Declaration
public static void Floor(ref Vector3D v, out Vector3I r)
Parameters
GetDominantDirection(Vector3I)
Declaration
public static CubeFace GetDominantDirection(Vector3I val)
Parameters
Returns
GetDominantDirectionVector(Vector3I)
Declaration
public static Vector3I GetDominantDirectionVector(Vector3I val)
Parameters
Returns
GetHashCode()
Declaration
public override int GetHashCode()
Returns
Type |
Description |
System.Int32 |
|
IsAxisAligned()
Declaration
public bool IsAxisAligned()
Returns
Type |
Description |
System.Boolean |
|
IsInside(Vector3I, Vector3I)
Declaration
public bool IsInside(Vector3I inclusiveMin, Vector3I exclusiveMax)
Parameters
Returns
Type |
Description |
System.Boolean |
|
IsInside(ref Vector3I, ref Vector3I)
Declaration
public bool IsInside(ref Vector3I inclusiveMin, ref Vector3I exclusiveMax)
Parameters
Returns
Type |
Description |
System.Boolean |
|
IsInsideInclusiveEnd(Vector3I, Vector3I)
Declaration
public bool IsInsideInclusiveEnd(Vector3I min, Vector3I max)
Parameters
Returns
Type |
Description |
System.Boolean |
|
IsInsideInclusiveEnd(ref Vector3I, ref Vector3I)
Declaration
public bool IsInsideInclusiveEnd(ref Vector3I min, ref Vector3I max)
Parameters
Returns
Type |
Description |
System.Boolean |
|
Length()
Declaration
Returns
Type |
Description |
System.Int32 |
|
Max(Vector3I, Vector3I)
Declaration
public static Vector3I Max(Vector3I value1, Vector3I value2)
Parameters
Returns
Max(ref Vector3I, ref Vector3I, out Vector3I)
Declaration
public static void Max(ref Vector3I value1, ref Vector3I value2, out Vector3I result)
Parameters
Min(Vector3I, Vector3I)
Declaration
public static Vector3I Min(Vector3I value1, Vector3I value2)
Parameters
Returns
Min(ref Vector3I, ref Vector3I, out Vector3I)
Declaration
public static void Min(ref Vector3I value1, ref Vector3I value2, out Vector3I result)
Parameters
MinMax(ref Vector3I, ref Vector3I)
Separates minimal and maximal values of any two input vectors
Declaration
public static void MinMax(ref Vector3I min, ref Vector3I max)
Parameters
Type |
Name |
Description |
Vector3I |
min |
minimal values of the two vectors
|
Vector3I |
max |
maximal values of the two vectors
|
RectangularDistance(Vector3I)
Calculates rectangular distance.
It's how many sectors you have to travel to get to other sector from current sector.
Declaration
public int RectangularDistance(Vector3I otherVector)
Parameters
Type |
Name |
Description |
Vector3I |
otherVector |
|
Returns
Type |
Description |
System.Int32 |
|
RectangularLength()
Calculates rectangular distance of this vector, interpreted as a point, from the origin.
Declaration
public int RectangularLength()
Returns
Type |
Description |
System.Int32 |
|
Round(Vector3)
Declaration
public static Vector3I Round(Vector3 value)
Parameters
Type |
Name |
Description |
Vector3 |
value |
|
Returns
Round(ref Vector3, out Vector3I)
Declaration
public static void Round(ref Vector3 v, out Vector3I r)
Parameters
Round(Vector3D)
Declaration
public static Vector3I Round(Vector3D value)
Parameters
Returns
Round(ref Vector3D, out Vector3I)
Declaration
public static void Round(ref Vector3D v, out Vector3I r)
Parameters
Shift(Vector3I)
Declaration
public static Vector3I Shift(Vector3I value)
Parameters
Returns
Sign(Vector3)
Declaration
public static Vector3I Sign(Vector3 value)
Parameters
Type |
Name |
Description |
Vector3 |
value |
|
Returns
Sign(Vector3I)
Declaration
public static Vector3I Sign(Vector3I value)
Parameters
Returns
ToBytes(List<Byte>)
Declaration
public void ToBytes(List<byte> result)
Parameters
Type |
Name |
Description |
System.Collections.Generic.List<System.Byte> |
result |
|
ToString()
Declaration
public override string ToString()
Returns
Type |
Description |
System.String |
|
Declaration
public static Vector3I Transform(Vector3I value, MatrixI transformation)
Parameters
Returns
Declaration
public static Vector3I Transform(Vector3I value, ref MatrixI transformation)
Parameters
Returns
Declaration
public static Vector3I Transform(Vector3I value, Quaternion rotation)
Parameters
Returns
Transforms a Vector3I by the given Matrix.
Declaration
public static void Transform(ref Vector3I position, ref Matrix matrix, out Vector3I result)
Parameters
Type |
Name |
Description |
Vector3I |
position |
The source Vector3I.
|
Matrix |
matrix |
The transformation Matrix.
|
Vector3I |
result |
[OutAttribute] The transformed vector.
|
Declaration
public static void Transform(ref Vector3I value, ref MatrixI matrix, out Vector3I result)
Parameters
Declaration
public static void Transform(ref Vector3I value, ref Quaternion rotation, out Vector3I result)
Parameters
Declaration
public static Vector3I TransformNormal(Vector3I value, ref MatrixI transformation)
Parameters
Returns
Transforms a vector normal by a matrix.
Declaration
public static void TransformNormal(ref Vector3I normal, ref Matrix matrix, out Vector3I result)
Parameters
Type |
Name |
Description |
Vector3I |
normal |
The source vector.
|
Matrix |
matrix |
The transformation Matrix.
|
Vector3I |
result |
[OutAttribute] The Vector3 resulting from the transformation.
|
Declaration
public static void TransformNormal(ref Vector3I normal, ref MatrixI matrix, out Vector3I result)
Parameters
Trunc(Vector3)
Declaration
public static Vector3I Trunc(Vector3 value)
Parameters
Type |
Name |
Description |
Vector3 |
value |
|
Returns
TryParseFromString(String, out Vector3I)
Declaration
public static bool TryParseFromString(string p, out Vector3I vec)
Parameters
Type |
Name |
Description |
System.String |
p |
|
Vector3I |
vec |
|
Returns
Type |
Description |
System.Boolean |
|
Volume()
Declaration
Returns
Type |
Description |
System.Int32 |
|
Operators
Addition(Vector3I, Int32)
Declaration
public static Vector3I operator +(Vector3I a, int b)
Parameters
Type |
Name |
Description |
Vector3I |
a |
|
System.Int32 |
b |
|
Returns
Addition(Vector3I, Single)
Declaration
public static Vector3 operator +(Vector3I a, float b)
Parameters
Type |
Name |
Description |
Vector3I |
a |
|
System.Single |
b |
|
Returns
Addition(Vector3I, Vector3I)
Declaration
public static Vector3I operator +(Vector3I a, Vector3I b)
Parameters
Returns
BitwiseAnd(Vector3I, Int32)
Declaration
public static Vector3I operator &(Vector3I v, int mask)
Parameters
Type |
Name |
Description |
Vector3I |
v |
|
System.Int32 |
mask |
|
Returns
BitwiseOr(Vector3I, Int32)
Declaration
public static Vector3I operator |(Vector3I v, int mask)
Parameters
Type |
Name |
Description |
Vector3I |
v |
|
System.Int32 |
mask |
|
Returns
Division(Single, Vector3I)
Declaration
public static Vector3 operator /(float num, Vector3I a)
Parameters
Type |
Name |
Description |
System.Single |
num |
|
Vector3I |
a |
|
Returns
Division(Vector3I, Int32)
Declaration
public static Vector3I operator /(Vector3I a, int num)
Parameters
Type |
Name |
Description |
Vector3I |
a |
|
System.Int32 |
num |
|
Returns
Division(Vector3I, Single)
Declaration
public static Vector3 operator /(Vector3I a, float num)
Parameters
Type |
Name |
Description |
Vector3I |
a |
|
System.Single |
num |
|
Returns
Division(Vector3I, Vector3I)
Declaration
public static Vector3I operator /(Vector3I a, Vector3I b)
Parameters
Returns
Equality(Vector3I, Vector3I)
Declaration
public static bool operator ==(Vector3I a, Vector3I b)
Parameters
Returns
Type |
Description |
System.Boolean |
|
ExclusiveOr(Vector3I, Int32)
Declaration
public static Vector3I operator ^(Vector3I v, int mask)
Parameters
Type |
Name |
Description |
Vector3I |
v |
|
System.Int32 |
mask |
|
Returns
Explicit(Vector3 to Vector3I)
Declaration
public static explicit operator Vector3I(Vector3 value)
Parameters
Type |
Name |
Description |
Vector3 |
value |
|
Returns
Implicit(Vector3I to Vector3)
Declaration
public static implicit operator Vector3(Vector3I value)
Parameters
Returns
Implicit(Vector3I to Vector3D)
Declaration
public static implicit operator Vector3D(Vector3I value)
Parameters
Returns
Implicit(Vector3I to Vector3L)
Declaration
public static implicit operator Vector3L(Vector3I value)
Parameters
Returns
Inequality(Vector3I, Vector3I)
Declaration
public static bool operator !=(Vector3I a, Vector3I b)
Parameters
Returns
Type |
Description |
System.Boolean |
|
LeftShift(Vector3I, Int32)
Declaration
public static Vector3I operator <<(Vector3I v, int shift)
Parameters
Type |
Name |
Description |
Vector3I |
v |
|
System.Int32 |
shift |
|
Returns
Modulus(Vector3I, Int32)
Declaration
public static Vector3I operator %(Vector3I a, int num)
Parameters
Type |
Name |
Description |
Vector3I |
a |
|
System.Int32 |
num |
|
Returns
Multiply(Double, Vector3I)
Declaration
public static Vector3D operator *(double num, Vector3I b)
Parameters
Type |
Name |
Description |
System.Double |
num |
|
Vector3I |
b |
|
Returns
Multiply(Int32, Vector3I)
Declaration
public static Vector3I operator *(int num, Vector3I b)
Parameters
Type |
Name |
Description |
System.Int32 |
num |
|
Vector3I |
b |
|
Returns
Multiply(Single, Vector3I)
Declaration
public static Vector3 operator *(float num, Vector3I b)
Parameters
Type |
Name |
Description |
System.Single |
num |
|
Vector3I |
b |
|
Returns
Multiply(Vector3, Vector3I)
Declaration
public static Vector3 operator *(Vector3 a, Vector3I b)
Parameters
Returns
Multiply(Vector3D, Vector3I)
Declaration
public static Vector3D operator *(Vector3D a, Vector3I b)
Parameters
Returns
Multiply(Vector3I, Double)
Declaration
public static Vector3D operator *(Vector3I a, double num)
Parameters
Type |
Name |
Description |
Vector3I |
a |
|
System.Double |
num |
|
Returns
Multiply(Vector3I, Int32)
Declaration
public static Vector3I operator *(Vector3I a, int num)
Parameters
Type |
Name |
Description |
Vector3I |
a |
|
System.Int32 |
num |
|
Returns
Multiply(Vector3I, Single)
Declaration
public static Vector3 operator *(Vector3I a, float num)
Parameters
Type |
Name |
Description |
Vector3I |
a |
|
System.Single |
num |
|
Returns
Multiply(Vector3I, Vector3)
Declaration
public static Vector3 operator *(Vector3I a, Vector3 b)
Parameters
Returns
Multiply(Vector3I, Vector3D)
Declaration
public static Vector3D operator *(Vector3I a, Vector3D b)
Parameters
Returns
Multiply(Vector3I, Vector3I)
Declaration
public static Vector3I operator *(Vector3I a, Vector3I b)
Parameters
Returns
OnesComplement(Vector3I)
Declaration
public static Vector3I operator ~(Vector3I v)
Parameters
Returns
RightShift(Vector3I, Int32)
Declaration
public static Vector3I operator >>(Vector3I v, int shift)
Parameters
Type |
Name |
Description |
Vector3I |
v |
|
System.Int32 |
shift |
|
Returns
Subtraction(Vector3I, Int32)
Declaration
public static Vector3I operator -(Vector3I a, int b)
Parameters
Type |
Name |
Description |
Vector3I |
a |
|
System.Int32 |
b |
|
Returns
Subtraction(Vector3I, Vector3I)
Declaration
public static Vector3I operator -(Vector3I a, Vector3I b)
Parameters
Returns
UnaryNegation(Vector3I)
Declaration
public static Vector3I operator -(Vector3I a)
Parameters
Returns