A 4D vector using integer coordinates.
struct Vector4iA 4-element structure that can be used to represent 4D grid coordinates or any other quadruplet of integers.
It uses integer coordinates and is therefore preferable to Vector4 when exact precision is required. Note that the values are limited to 32 bits, and unlike Vector4 this cannot be configured with an engine build option. Use integer or PackedInt64Array if 64-bit values are needed.
import SwiftGodotFramework to write Godot Game Extensions using the Swift Programming Language.
struct Vector4A 4D vector using floating-point coordinates.
class PackedInt64ArrayA packed array of 64-bit integers.
protocol CopyableA type whose values can be implicitly or explicitly copied.
protocol EquatableA type that can be compared for value equality.
protocol Escapableprotocol Hashable : EquatableA type that can be hashed into a Hasher to produce an integer hash value.
protocol IntScalableprotocol SelfVariantRepresentable : VariantRepresentable where Self == Self.VariantContentStructs and scalar types use their own layout for storage.
protocol Snappableprotocol VariantRepresentable : VariantStorableTypes that conform to VariantRepresentable can be stored directly in Variant with no conversion. These include all of the Variant types from Godot (for example GString, Rect, Plane), Godot objects (those that subclass SwiftGodot.Object) as well as the built-in Swift types UInt8, Int64 and Double.
protocol VariantStorableTypes that conform to VariantStorable can be stored in a Variant and can be extracted back out of a Variant.
init() Constructs a default-initialized Vector4i with all components set to 0.
init(from: Vector4i) Constructs a Vector4i as a copy of the given Vector4i.
init(from: Vector4) Constructs a new Vector4i from the given Vector4 by truncating components’ fractional parts (rounding towards zero). For a different behavior consider passing the result of ceil, floor or round to this constructor instead.
init(x: Int32, y: Int32, z: Int32, w: Int32) Returns a Vector4i with the given components.
static let axisW: IntEnumerated value for the W axis. Returned by maxAxisIndex and minAxisIndex.
static let axisX: IntEnumerated value for the X axis. Returned by maxAxisIndex and minAxisIndex.
static let axisY: IntEnumerated value for the Y axis. Returned by maxAxisIndex and minAxisIndex.
static let axisZ: IntEnumerated value for the Z axis. Returned by maxAxisIndex and minAxisIndex.
static var godotType: Variant.GType { get }static let max: Vector4iMax vector, a vector with all components equal to INT32_MAX. Can be used as an integer equivalent of Vector4.INF.
static let min: Vector4iMin vector, a vector with all components equal to INT32_MIN. Can be used as a negative integer equivalent of Vector4.INF.
static let one: Vector4iOne vector, a vector with all components set to 1.
static let zero: Vector4iZero vector, a vector with all components set to 0.
var w: Int32The vector’s W component. Also accessible by using the index position [3].
var x: Int32The vector’s X component. Also accessible by using the index position [0].
var y: Int32The vector’s Y component. Also accessible by using the index position [1].
var z: Int32The vector’s Z component. Also accessible by using the index position [2].
subscript(index: Int64) -> Int64 { mutating get set } static func != (lhs: Vector4i, rhs: Vector4i) -> Bool Returns true if the vectors are not equal.
static func % (lhs: Vector4i, rhs: Vector4i) -> Vector4i Gets the remainder of each component of the Vector4i with the components of the given Vector4i. This operation uses truncated division, which is often not desired as it does not work well with negative numbers. Consider using @GlobalScope.posmod instead if you want to handle negative numbers.
static func % (lhs: Vector4i, rhs: Int64) -> Vector4i Gets the remainder of each component of the Vector4i with the the given integer. This operation uses truncated division, which is often not desired as it does not work well with negative numbers. Consider using @GlobalScope.posmod instead if you want to handle negative numbers.
static func %= (left: inout `Self`, right: `Self`) static func * (lhs: Vector4i, rhs: Vector4i) -> Vector4i Multiplies each component of the Vector4i by the components of the given Vector4i.
static func * (lhs: Vector4i, rhs: Int64) -> Vector4i Multiplies each component of the Vector4i by the given integer.
static func * (lhs: Vector4i, rhs: Double) -> Vector4 Multiplies each component of the Vector4i by the given float.
static func *= (left: inout `Self`, right: `Self`) static func + (lhs: Vector4i, rhs: Vector4i) -> Vector4i Adds each component of the Vector4i by the components of the given Vector4i.
static func += (left: inout `Self`, right: `Self`) static func - (v: `Self`) -> Vector4i Returns the negative value of the Vector4i. This is the same as writing Vector4i(-v.x, -v.y, -v.z, -v.w). This operation flips the direction of the vector while keeping the same magnitude.
static func - (lhs: Vector4i, rhs: Vector4i) -> Vector4i Subtracts each component of the Vector4i by the components of the given Vector4i.
static func -= (left: inout `Self`, right: `Self`) static func / (lhs: Vector4i, rhs: Vector4i) -> Vector4i Divides each component of the Vector4i by the components of the given Vector4i.
static func / (lhs: Vector4i, rhs: Int64) -> Vector4i Divides each component of the Vector4i by the given integer.
static func / (lhs: Vector4i, rhs: Double) -> Vector4 Divides each component of the Vector4i by the given float.
static func /= (left: inout `Self`, right: `Self`) static func < (lhs: Vector4i, rhs: Vector4i) -> Bool Compares two Vector4i vectors by first checking if the X value of the left vector is less than the X value of the right vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, Z values of the two vectors, and then with the W values. This operator is useful for sorting vectors.
static func <= (lhs: Vector4i, rhs: Vector4i) -> Bool Compares two Vector4i vectors by first checking if the X value of the left vector is less than or equal to the X value of the right vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, Z values of the two vectors, and then with the W values. This operator is useful for sorting vectors.
static func == (lhs: Vector4i, rhs: Vector4i) -> Bool Returns true if the vectors are exactly equal.
static func > (lhs: Vector4i, rhs: Vector4i) -> Bool Compares two Vector4i vectors by first checking if the X value of the left vector is greater than the X value of the right vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, Z values of the two vectors, and then with the W values. This operator is useful for sorting vectors.
static func >= (lhs: Vector4i, rhs: Vector4i) -> Bool Compares two Vector4i vectors by first checking if the X value of the left vector is greater than or equal to the X value of the right vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, Z values of the two vectors, and then with the W values. This operator is useful for sorting vectors.
func abs() -> Vector4i Returns a new vector with all components in absolute values (i.e. positive).
func clamp(min: Vector4i, max: Vector4i) -> Vector4i Returns a new vector with all components clamped between the components of min and max, by running @GlobalScope.clamp on each component.
func clampi(min: Int64, max: Int64) -> Vector4i Returns a new vector with all components clamped between min and max, by running @GlobalScope.clamp on each component.
func distanceSquaredTo(_ to: Vector4i) -> Int64 Returns the squared distance between this vector and to.
func distanceTo(_ to: Vector4i) -> Double Returns the distance between this vector and to.
func length() -> Double Returns the length (magnitude) of this vector.
func lengthSquared() -> Int64 Returns the squared length (squared magnitude) of this vector.
func max(with: Vector4i) -> Vector4i Returns the component-wise maximum of this and with, equivalent to Vector4i(maxi(x, with.x), maxi(y, with.y), maxi(z, with.z), maxi(w, with.w)).
func maxAxisIndex() -> Int64 Returns the axis of the vector’s highest value. See AXIS_* constants. If all components are equal, this method returns .x.
func maxi(with: Int64) -> Vector4i Returns the component-wise maximum of this and with, equivalent to Vector4i(maxi(x, with), maxi(y, with), maxi(z, with), maxi(w, with)).
func min(with: Vector4i) -> Vector4i Returns the component-wise minimum of this and with, equivalent to Vector4i(mini(x, with.x), mini(y, with.y), mini(z, with.z), mini(w, with.w)).
func minAxisIndex() -> Int64 Returns the axis of the vector’s lowest value. See AXIS_* constants. If all components are equal, this method returns .w.
func mini(with: Int64) -> Vector4i Returns the component-wise minimum of this and with, equivalent to Vector4i(mini(x, with), mini(y, with), mini(z, with), mini(w, with)).
func sign() -> Vector4i Returns a new vector with each component set to 1 if it’s positive, -1 if it’s negative, and 0 if it’s zero. The result is identical to calling @GlobalScope.sign on each component.
func snapped(step: `Self`) -> Vector4i func snappedi(step: Int64) -> Vector4i Returns a new vector with each component snapped to the closest multiple of step.
enum Axisinit?(_ variant: Variant) static func makeOrUnwrap(_ variant: Variant) -> Self? where Self : Object Unwraps an object from a variant.
static func makeOrUnwrap(_ variant: Variant) -> Self? Unwraps an object from a variant. This is useful when you want one method to call that will return the unwrapped Variant, regardless of whether it is a SwiftGodot.Object or not.
var content: VariantContent { get }static func != (lhs: Self, rhs: Self) -> Bool Returns a Boolean value indicating whether two values are not equal.
static func * (lhs: Self, rhs: Int) -> Self static func *= (lhs: inout Self, rhs: Int) static func / (lhs: Self, rhs: Int) -> Self static func /= (lhs: inout Self, rhs: Int) func toVariantRepresentable() -> Self