2019-11-05 12:01:00 +01:00
|
|
|
/**************************************************************************/
|
|
|
|
/* vector3i.h */
|
|
|
|
/**************************************************************************/
|
|
|
|
/* This file is part of: */
|
|
|
|
/* GODOT ENGINE */
|
|
|
|
/* https://godotengine.org */
|
|
|
|
/**************************************************************************/
|
2020-02-11 14:01:43 +01:00
|
|
|
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
|
|
|
|
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
|
2019-11-05 12:01:00 +01:00
|
|
|
/* */
|
|
|
|
/* Permission is hereby granted, free of charge, to any person obtaining */
|
|
|
|
/* a copy of this software and associated documentation files (the */
|
|
|
|
/* "Software"), to deal in the Software without restriction, including */
|
|
|
|
/* without limitation the rights to use, copy, modify, merge, publish, */
|
|
|
|
/* distribute, sublicense, and/or sell copies of the Software, and to */
|
|
|
|
/* permit persons to whom the Software is furnished to do so, subject to */
|
|
|
|
/* the following conditions: */
|
|
|
|
/* */
|
|
|
|
/* The above copyright notice and this permission notice shall be */
|
|
|
|
/* included in all copies or substantial portions of the Software. */
|
|
|
|
/* */
|
|
|
|
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
|
|
|
|
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
|
|
|
|
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
|
|
|
|
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
|
|
|
|
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
|
|
|
|
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
|
|
|
|
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
|
|
|
|
/**************************************************************************/
|
|
|
|
|
2019-10-03 22:39:08 +02:00
|
|
|
#ifndef VECTOR3I_H
|
|
|
|
#define VECTOR3I_H
|
|
|
|
|
2022-03-07 12:15:45 +01:00
|
|
|
#include "core/error/error_macros.h"
|
2021-11-29 18:13:31 +01:00
|
|
|
#include "core/math/math_funcs.h"
|
2022-02-19 16:47:24 +01:00
|
|
|
|
|
|
|
class String;
|
|
|
|
struct Vector3;
|
2019-10-03 22:39:08 +02:00
|
|
|
|
2024-04-12 17:02:26 +02:00
|
|
|
struct [[nodiscard]] Vector3i {
|
2022-09-20 00:50:35 +02:00
|
|
|
static const int AXIS_COUNT = 3;
|
|
|
|
|
2019-10-03 22:39:08 +02:00
|
|
|
enum Axis {
|
|
|
|
AXIS_X,
|
|
|
|
AXIS_Y,
|
|
|
|
AXIS_Z,
|
|
|
|
};
|
|
|
|
|
|
|
|
union {
|
|
|
|
struct {
|
|
|
|
int32_t x;
|
|
|
|
int32_t y;
|
|
|
|
int32_t z;
|
|
|
|
};
|
|
|
|
|
2020-05-12 17:01:17 +02:00
|
|
|
int32_t coord[3] = { 0 };
|
2019-10-03 22:39:08 +02:00
|
|
|
};
|
|
|
|
|
2024-02-17 23:24:59 +01:00
|
|
|
_FORCE_INLINE_ const int32_t &operator[](int p_axis) const {
|
2022-03-07 12:15:45 +01:00
|
|
|
DEV_ASSERT((unsigned int)p_axis < 3);
|
2019-10-03 22:39:08 +02:00
|
|
|
return coord[p_axis];
|
|
|
|
}
|
|
|
|
|
2024-02-17 23:24:59 +01:00
|
|
|
_FORCE_INLINE_ int32_t &operator[](int p_axis) {
|
2022-03-07 12:15:45 +01:00
|
|
|
DEV_ASSERT((unsigned int)p_axis < 3);
|
2019-10-03 22:39:08 +02:00
|
|
|
return coord[p_axis];
|
|
|
|
}
|
|
|
|
|
2019-11-28 09:48:51 +01:00
|
|
|
Vector3i::Axis min_axis_index() const;
|
|
|
|
Vector3i::Axis max_axis_index() const;
|
2019-10-03 22:39:08 +02:00
|
|
|
|
2023-01-29 17:45:22 +01:00
|
|
|
Vector3i min(const Vector3i &p_vector3i) const {
|
|
|
|
return Vector3i(MIN(x, p_vector3i.x), MIN(y, p_vector3i.y), MIN(z, p_vector3i.z));
|
|
|
|
}
|
|
|
|
|
2024-03-03 14:37:52 +01:00
|
|
|
Vector3i mini(int32_t p_scalar) const {
|
|
|
|
return Vector3i(MIN(x, p_scalar), MIN(y, p_scalar), MIN(z, p_scalar));
|
|
|
|
}
|
|
|
|
|
2023-01-29 17:45:22 +01:00
|
|
|
Vector3i max(const Vector3i &p_vector3i) const {
|
|
|
|
return Vector3i(MAX(x, p_vector3i.x), MAX(y, p_vector3i.y), MAX(z, p_vector3i.z));
|
|
|
|
}
|
|
|
|
|
2024-03-03 14:37:52 +01:00
|
|
|
Vector3i maxi(int32_t p_scalar) const {
|
|
|
|
return Vector3i(MAX(x, p_scalar), MAX(y, p_scalar), MAX(z, p_scalar));
|
|
|
|
}
|
|
|
|
|
2021-11-29 18:13:31 +01:00
|
|
|
_FORCE_INLINE_ int64_t length_squared() const;
|
|
|
|
_FORCE_INLINE_ double length() const;
|
|
|
|
|
2019-10-03 22:39:08 +02:00
|
|
|
_FORCE_INLINE_ void zero();
|
|
|
|
|
|
|
|
_FORCE_INLINE_ Vector3i abs() const;
|
|
|
|
_FORCE_INLINE_ Vector3i sign() const;
|
2021-02-01 06:10:52 +01:00
|
|
|
Vector3i clamp(const Vector3i &p_min, const Vector3i &p_max) const;
|
2024-03-03 14:37:52 +01:00
|
|
|
Vector3i clampi(int32_t p_min, int32_t p_max) const;
|
2022-09-24 14:20:06 +02:00
|
|
|
Vector3i snapped(const Vector3i &p_step) const;
|
2024-03-03 14:37:52 +01:00
|
|
|
Vector3i snappedi(int32_t p_step) const;
|
2019-10-03 22:39:08 +02:00
|
|
|
|
2023-10-11 12:04:57 +02:00
|
|
|
_FORCE_INLINE_ double distance_to(const Vector3i &p_to) const;
|
|
|
|
_FORCE_INLINE_ int64_t distance_squared_to(const Vector3i &p_to) const;
|
|
|
|
|
2019-10-03 22:39:08 +02:00
|
|
|
/* Operators */
|
|
|
|
|
|
|
|
_FORCE_INLINE_ Vector3i &operator+=(const Vector3i &p_v);
|
|
|
|
_FORCE_INLINE_ Vector3i operator+(const Vector3i &p_v) const;
|
|
|
|
_FORCE_INLINE_ Vector3i &operator-=(const Vector3i &p_v);
|
|
|
|
_FORCE_INLINE_ Vector3i operator-(const Vector3i &p_v) const;
|
|
|
|
_FORCE_INLINE_ Vector3i &operator*=(const Vector3i &p_v);
|
|
|
|
_FORCE_INLINE_ Vector3i operator*(const Vector3i &p_v) const;
|
|
|
|
_FORCE_INLINE_ Vector3i &operator/=(const Vector3i &p_v);
|
|
|
|
_FORCE_INLINE_ Vector3i operator/(const Vector3i &p_v) const;
|
2020-11-05 03:01:55 +01:00
|
|
|
_FORCE_INLINE_ Vector3i &operator%=(const Vector3i &p_v);
|
|
|
|
_FORCE_INLINE_ Vector3i operator%(const Vector3i &p_v) const;
|
2019-10-03 22:39:08 +02:00
|
|
|
|
2024-02-17 23:24:59 +01:00
|
|
|
_FORCE_INLINE_ Vector3i &operator*=(int32_t p_scalar);
|
|
|
|
_FORCE_INLINE_ Vector3i operator*(int32_t p_scalar) const;
|
|
|
|
_FORCE_INLINE_ Vector3i &operator/=(int32_t p_scalar);
|
|
|
|
_FORCE_INLINE_ Vector3i operator/(int32_t p_scalar) const;
|
|
|
|
_FORCE_INLINE_ Vector3i &operator%=(int32_t p_scalar);
|
|
|
|
_FORCE_INLINE_ Vector3i operator%(int32_t p_scalar) const;
|
2019-10-03 22:39:08 +02:00
|
|
|
|
|
|
|
_FORCE_INLINE_ Vector3i operator-() const;
|
|
|
|
|
|
|
|
_FORCE_INLINE_ bool operator==(const Vector3i &p_v) const;
|
|
|
|
_FORCE_INLINE_ bool operator!=(const Vector3i &p_v) const;
|
|
|
|
_FORCE_INLINE_ bool operator<(const Vector3i &p_v) const;
|
|
|
|
_FORCE_INLINE_ bool operator<=(const Vector3i &p_v) const;
|
|
|
|
_FORCE_INLINE_ bool operator>(const Vector3i &p_v) const;
|
|
|
|
_FORCE_INLINE_ bool operator>=(const Vector3i &p_v) const;
|
|
|
|
|
|
|
|
operator String() const;
|
2022-02-19 16:47:24 +01:00
|
|
|
operator Vector3() const;
|
2019-10-03 22:39:08 +02:00
|
|
|
|
2020-05-12 17:01:17 +02:00
|
|
|
_FORCE_INLINE_ Vector3i() {}
|
2024-02-17 23:24:59 +01:00
|
|
|
_FORCE_INLINE_ Vector3i(int32_t p_x, int32_t p_y, int32_t p_z) {
|
2019-10-03 22:39:08 +02:00
|
|
|
x = p_x;
|
|
|
|
y = p_y;
|
|
|
|
z = p_z;
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
2021-11-29 18:13:31 +01:00
|
|
|
int64_t Vector3i::length_squared() const {
|
|
|
|
return x * (int64_t)x + y * (int64_t)y + z * (int64_t)z;
|
|
|
|
}
|
|
|
|
|
|
|
|
double Vector3i::length() const {
|
|
|
|
return Math::sqrt((double)length_squared());
|
|
|
|
}
|
|
|
|
|
2019-10-03 22:39:08 +02:00
|
|
|
Vector3i Vector3i::abs() const {
|
2022-09-05 03:16:59 +02:00
|
|
|
return Vector3i(Math::abs(x), Math::abs(y), Math::abs(z));
|
2019-10-03 22:39:08 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
Vector3i Vector3i::sign() const {
|
2021-10-16 01:22:57 +02:00
|
|
|
return Vector3i(SIGN(x), SIGN(y), SIGN(z));
|
2019-10-03 22:39:08 +02:00
|
|
|
}
|
|
|
|
|
2023-10-11 12:04:57 +02:00
|
|
|
double Vector3i::distance_to(const Vector3i &p_to) const {
|
|
|
|
return (p_to - *this).length();
|
|
|
|
}
|
|
|
|
|
|
|
|
int64_t Vector3i::distance_squared_to(const Vector3i &p_to) const {
|
|
|
|
return (p_to - *this).length_squared();
|
|
|
|
}
|
|
|
|
|
2019-10-03 22:39:08 +02:00
|
|
|
/* Operators */
|
|
|
|
|
|
|
|
Vector3i &Vector3i::operator+=(const Vector3i &p_v) {
|
|
|
|
x += p_v.x;
|
|
|
|
y += p_v.y;
|
|
|
|
z += p_v.z;
|
|
|
|
return *this;
|
|
|
|
}
|
|
|
|
|
|
|
|
Vector3i Vector3i::operator+(const Vector3i &p_v) const {
|
|
|
|
return Vector3i(x + p_v.x, y + p_v.y, z + p_v.z);
|
|
|
|
}
|
|
|
|
|
|
|
|
Vector3i &Vector3i::operator-=(const Vector3i &p_v) {
|
|
|
|
x -= p_v.x;
|
|
|
|
y -= p_v.y;
|
|
|
|
z -= p_v.z;
|
|
|
|
return *this;
|
|
|
|
}
|
2020-05-14 14:29:06 +02:00
|
|
|
|
2019-10-03 22:39:08 +02:00
|
|
|
Vector3i Vector3i::operator-(const Vector3i &p_v) const {
|
|
|
|
return Vector3i(x - p_v.x, y - p_v.y, z - p_v.z);
|
|
|
|
}
|
|
|
|
|
|
|
|
Vector3i &Vector3i::operator*=(const Vector3i &p_v) {
|
|
|
|
x *= p_v.x;
|
|
|
|
y *= p_v.y;
|
|
|
|
z *= p_v.z;
|
|
|
|
return *this;
|
|
|
|
}
|
2020-05-14 14:29:06 +02:00
|
|
|
|
2019-10-03 22:39:08 +02:00
|
|
|
Vector3i Vector3i::operator*(const Vector3i &p_v) const {
|
|
|
|
return Vector3i(x * p_v.x, y * p_v.y, z * p_v.z);
|
|
|
|
}
|
|
|
|
|
|
|
|
Vector3i &Vector3i::operator/=(const Vector3i &p_v) {
|
|
|
|
x /= p_v.x;
|
|
|
|
y /= p_v.y;
|
|
|
|
z /= p_v.z;
|
|
|
|
return *this;
|
|
|
|
}
|
|
|
|
|
|
|
|
Vector3i Vector3i::operator/(const Vector3i &p_v) const {
|
|
|
|
return Vector3i(x / p_v.x, y / p_v.y, z / p_v.z);
|
|
|
|
}
|
|
|
|
|
2020-11-05 03:01:55 +01:00
|
|
|
Vector3i &Vector3i::operator%=(const Vector3i &p_v) {
|
|
|
|
x %= p_v.x;
|
|
|
|
y %= p_v.y;
|
|
|
|
z %= p_v.z;
|
|
|
|
return *this;
|
|
|
|
}
|
|
|
|
|
|
|
|
Vector3i Vector3i::operator%(const Vector3i &p_v) const {
|
|
|
|
return Vector3i(x % p_v.x, y % p_v.y, z % p_v.z);
|
|
|
|
}
|
|
|
|
|
2024-02-17 23:24:59 +01:00
|
|
|
Vector3i &Vector3i::operator*=(int32_t p_scalar) {
|
2019-10-03 22:39:08 +02:00
|
|
|
x *= p_scalar;
|
|
|
|
y *= p_scalar;
|
|
|
|
z *= p_scalar;
|
|
|
|
return *this;
|
|
|
|
}
|
|
|
|
|
2024-02-17 23:24:59 +01:00
|
|
|
Vector3i Vector3i::operator*(int32_t p_scalar) const {
|
2022-02-03 22:16:58 +01:00
|
|
|
return Vector3i(x * p_scalar, y * p_scalar, z * p_scalar);
|
|
|
|
}
|
|
|
|
|
|
|
|
// Multiplication operators required to workaround issues with LLVM using implicit conversion.
|
|
|
|
|
2024-02-17 23:24:59 +01:00
|
|
|
_FORCE_INLINE_ Vector3i operator*(int32_t p_scalar, const Vector3i &p_vector) {
|
2021-08-15 16:45:37 +02:00
|
|
|
return p_vector * p_scalar;
|
2019-10-03 22:39:08 +02:00
|
|
|
}
|
|
|
|
|
2024-02-17 23:24:59 +01:00
|
|
|
_FORCE_INLINE_ Vector3i operator*(int64_t p_scalar, const Vector3i &p_vector) {
|
2021-08-15 16:45:37 +02:00
|
|
|
return p_vector * p_scalar;
|
|
|
|
}
|
|
|
|
|
2024-02-17 23:24:59 +01:00
|
|
|
_FORCE_INLINE_ Vector3i operator*(float p_scalar, const Vector3i &p_vector) {
|
2021-08-15 16:45:37 +02:00
|
|
|
return p_vector * p_scalar;
|
|
|
|
}
|
|
|
|
|
2024-02-17 23:24:59 +01:00
|
|
|
_FORCE_INLINE_ Vector3i operator*(double p_scalar, const Vector3i &p_vector) {
|
2021-08-15 16:45:37 +02:00
|
|
|
return p_vector * p_scalar;
|
|
|
|
}
|
|
|
|
|
2024-02-17 23:24:59 +01:00
|
|
|
Vector3i &Vector3i::operator/=(int32_t p_scalar) {
|
2019-10-03 22:39:08 +02:00
|
|
|
x /= p_scalar;
|
|
|
|
y /= p_scalar;
|
|
|
|
z /= p_scalar;
|
|
|
|
return *this;
|
|
|
|
}
|
|
|
|
|
2024-02-17 23:24:59 +01:00
|
|
|
Vector3i Vector3i::operator/(int32_t p_scalar) const {
|
2019-10-03 22:39:08 +02:00
|
|
|
return Vector3i(x / p_scalar, y / p_scalar, z / p_scalar);
|
|
|
|
}
|
|
|
|
|
2024-02-17 23:24:59 +01:00
|
|
|
Vector3i &Vector3i::operator%=(int32_t p_scalar) {
|
2020-11-05 03:01:55 +01:00
|
|
|
x %= p_scalar;
|
|
|
|
y %= p_scalar;
|
|
|
|
z %= p_scalar;
|
|
|
|
return *this;
|
|
|
|
}
|
|
|
|
|
2024-02-17 23:24:59 +01:00
|
|
|
Vector3i Vector3i::operator%(int32_t p_scalar) const {
|
2020-11-05 03:01:55 +01:00
|
|
|
return Vector3i(x % p_scalar, y % p_scalar, z % p_scalar);
|
|
|
|
}
|
|
|
|
|
2019-10-03 22:39:08 +02:00
|
|
|
Vector3i Vector3i::operator-() const {
|
|
|
|
return Vector3i(-x, -y, -z);
|
|
|
|
}
|
|
|
|
|
|
|
|
bool Vector3i::operator==(const Vector3i &p_v) const {
|
|
|
|
return (x == p_v.x && y == p_v.y && z == p_v.z);
|
|
|
|
}
|
|
|
|
|
|
|
|
bool Vector3i::operator!=(const Vector3i &p_v) const {
|
2019-10-31 23:54:21 +01:00
|
|
|
return (x != p_v.x || y != p_v.y || z != p_v.z);
|
2019-10-03 22:39:08 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
bool Vector3i::operator<(const Vector3i &p_v) const {
|
|
|
|
if (x == p_v.x) {
|
2020-05-14 16:41:43 +02:00
|
|
|
if (y == p_v.y) {
|
2019-10-03 22:39:08 +02:00
|
|
|
return z < p_v.z;
|
2020-05-14 16:41:43 +02:00
|
|
|
} else {
|
2019-10-03 22:39:08 +02:00
|
|
|
return y < p_v.y;
|
2020-05-14 16:41:43 +02:00
|
|
|
}
|
2019-10-03 22:39:08 +02:00
|
|
|
} else {
|
|
|
|
return x < p_v.x;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
bool Vector3i::operator>(const Vector3i &p_v) const {
|
|
|
|
if (x == p_v.x) {
|
2020-05-14 16:41:43 +02:00
|
|
|
if (y == p_v.y) {
|
2019-10-03 22:39:08 +02:00
|
|
|
return z > p_v.z;
|
2020-05-14 16:41:43 +02:00
|
|
|
} else {
|
2019-10-03 22:39:08 +02:00
|
|
|
return y > p_v.y;
|
2020-05-14 16:41:43 +02:00
|
|
|
}
|
2019-10-03 22:39:08 +02:00
|
|
|
} else {
|
|
|
|
return x > p_v.x;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
bool Vector3i::operator<=(const Vector3i &p_v) const {
|
|
|
|
if (x == p_v.x) {
|
2020-05-14 16:41:43 +02:00
|
|
|
if (y == p_v.y) {
|
2019-10-03 22:39:08 +02:00
|
|
|
return z <= p_v.z;
|
2020-05-14 16:41:43 +02:00
|
|
|
} else {
|
2019-10-03 22:39:08 +02:00
|
|
|
return y < p_v.y;
|
2020-05-14 16:41:43 +02:00
|
|
|
}
|
2019-10-03 22:39:08 +02:00
|
|
|
} else {
|
|
|
|
return x < p_v.x;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
bool Vector3i::operator>=(const Vector3i &p_v) const {
|
|
|
|
if (x == p_v.x) {
|
2020-05-14 16:41:43 +02:00
|
|
|
if (y == p_v.y) {
|
2019-10-03 22:39:08 +02:00
|
|
|
return z >= p_v.z;
|
2020-05-14 16:41:43 +02:00
|
|
|
} else {
|
2019-10-03 22:39:08 +02:00
|
|
|
return y > p_v.y;
|
2020-05-14 16:41:43 +02:00
|
|
|
}
|
2019-10-03 22:39:08 +02:00
|
|
|
} else {
|
|
|
|
return x > p_v.x;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
void Vector3i::zero() {
|
|
|
|
x = y = z = 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
#endif // VECTOR3I_H
|