1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260
// SPDX-FileCopyrightText: 2023 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
// SPDX-FileContributor: Andrew Hayzen <andrew.hayzen@kdab.com>
//
// SPDX-License-Identifier: MIT OR Apache-2.0
use cxx::{type_id, ExternType};
#[cxx::bridge]
mod ffi {
unsafe extern "C++" {
include!("cxx-qt-lib/qpoint.h");
type QPoint = crate::QPoint;
include!("cxx-qt-lib/qpointf.h");
type QPointF = crate::QPointF;
include!("cxx-qt-lib/qstring.h");
type QString = crate::QString;
include!("cxx-qt-lib/qvector2d.h");
type QVector2D = crate::QVector2D;
include!("cxx-qt-lib/qvector3d.h");
type QVector3D = super::QVector3D;
include!("cxx-qt-lib/qvector4d.h");
type QVector4D = crate::QVector4D;
/// Returns true if the x, y, and z coordinates are set to 0.0, otherwise returns false.
#[rust_name = "is_null"]
fn isNull(self: &QVector3D) -> bool;
/// Returns the length of the vector from the origin.
fn length(self: &QVector3D) -> f32;
/// Returns the squared length of the vector from the origin.
/// This is equivalent to the dot product of the vector with itself.
#[rust_name = "length_squared"]
fn lengthSquared(self: &QVector3D) -> f32;
/// Normalizes the currect vector in place. Nothing happens if this vector is a null vector
/// or the length of the vector is very close to 1.
fn normalize(self: &mut QVector3D);
/// Returns the normalized unit vector form of this vector.
///
/// If this vector is null, then a null vector is returned.
/// If the length of the vector is very close to 1, then the vector will be returned as-is.
/// Otherwise the normalized form of the vector of length 1 will be returned.
fn normalized(self: &QVector3D) -> QVector3D;
/// Sets the x coordinate of this point to the given finite x coordinate.
#[rust_name = "set_x"]
fn setX(self: &mut QVector3D, x: f32);
/// Sets the y coordinate of this point to the given finite y coordinate.
#[rust_name = "set_y"]
fn setY(self: &mut QVector3D, y: f32);
/// Sets the z coordinate of this point to the given finite z coordinate.
#[rust_name = "set_z"]
fn setZ(self: &mut QVector3D, z: f32);
// From trait is more idiomatic to Rust and implemented in QPoint and QPointF
#[doc(hidden)]
#[rust_name = "to_point"]
fn toPoint(self: &QVector3D) -> QPoint;
#[doc(hidden)]
#[rust_name = "to_pointf"]
fn toPointF(self: &QVector3D) -> QPointF;
/// Returns the x coordinate of this point.
fn x(self: &QVector3D) -> f32;
/// Returns the y coordinate of this point.
fn y(self: &QVector3D) -> f32;
/// Returns the z coordinate of this point.
fn z(self: &QVector3D) -> f32;
}
#[namespace = "rust::cxxqtlib1"]
unsafe extern "C++" {
include!("cxx-qt-lib/common.h");
#[doc(hidden)]
#[rust_name = "qvector3d_init_qvector4d"]
fn construct(vector: QVector4D) -> QVector3D;
#[doc(hidden)]
#[rust_name = "qvector3d_init_qvector2d"]
fn construct(vector: QVector2D) -> QVector3D;
#[doc(hidden)]
#[rust_name = "qvector3d_init_qpointf"]
fn construct(point: QPointF) -> QVector3D;
#[doc(hidden)]
#[rust_name = "qvector3d_init_qpoint"]
fn construct(point: QPoint) -> QVector3D;
#[doc(hidden)]
#[rust_name = "qvector3d_init"]
fn construct(x: f32, y: f32, z: f32) -> QVector3D;
#[doc(hidden)]
#[rust_name = "qvector3d_init_default"]
fn construct() -> QVector3D;
// Note that Qt 5 takes const-ref and Qt 6 takes by-value
//
// We want by-value, as that is Rust-idiomatic, so for Qt 5 we create a proxy
#[doc(hidden)]
#[rust_name = "qvector3d_distance_to_line"]
fn qvector3DDistanceToLine(
vector: &QVector3D,
point: QVector3D,
direction: QVector3D,
) -> f32;
#[doc(hidden)]
#[rust_name = "qvector3d_distance_to_plane"]
fn qvector3DDistanceToPlane(vector: &QVector3D, point: QVector3D, normal: QVector3D)
-> f32;
#[doc(hidden)]
#[rust_name = "qvector3d_distance_to_point"]
fn qvector3DDistanceToPoint(vector: &QVector3D, point: QVector3D) -> f32;
#[doc(hidden)]
#[rust_name = "qvector3d_to_qstring"]
fn toQString(value: &QVector3D) -> QString;
#[doc(hidden)]
#[rust_name = "qvector3d_plus"]
fn operatorPlus(a: &QVector3D, b: &QVector3D) -> QVector3D;
#[doc(hidden)]
#[rust_name = "qvector3d_minus"]
fn operatorMinus(a: &QVector3D, b: &QVector3D) -> QVector3D;
#[doc(hidden)]
#[rust_name = "qvector3d_mul"]
fn operatorMul(a: f32, b: &QVector3D) -> QVector3D;
#[doc(hidden)]
#[rust_name = "qvector3d_div"]
fn operatorDiv(a: f32, b: &QVector3D) -> QVector3D;
}
}
/// The QVector3D class represents a vector or vertex in 3D space.
#[derive(Debug, Clone, PartialEq)]
#[repr(C)]
pub struct QVector3D {
v: [f32; 3],
}
impl QVector3D {
/// Constructs a vector with coordinates (xpos, ypos, zpos). All parameters must be finite.
pub fn new(xpos: f32, ypos: f32, zpos: f32) -> Self {
ffi::qvector3d_init(xpos, ypos, zpos)
}
/// Returns the distance that this vertex is from a line defined by point and the unit vector direction.
///
/// If direction is a null vector, then it does not define a line.
/// In that case, the distance from point to this vertex is returned.
pub fn distance_to_line(&self, point: QVector3D, direction: QVector3D) -> f32 {
ffi::qvector3d_distance_to_line(self, point, direction)
}
/// Returns the distance from this vertex to a plane defined by the vertex plane and a normal unit vector. The normal parameter is assumed to have been normalized to a unit vector.
///
/// The return value will be negative if the vertex is below the plane, or zero if it is on the plane.
pub fn distance_to_plane(&self, point: QVector3D, normal: QVector3D) -> f32 {
ffi::qvector3d_distance_to_plane(self, point, normal)
}
/// Returns the distance from this vertex to a point defined by the vertex point.
pub fn distance_to_point(&self, point: QVector3D) -> f32 {
ffi::qvector3d_distance_to_point(self, point)
}
}
impl Default for QVector3D {
/// Constructs a null vector, i.e. with coordinates (0, 0, 0).
fn default() -> Self {
ffi::qvector3d_init_default()
}
}
impl std::fmt::Display for QVector3D {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
write!(f, "{}", ffi::qvector3d_to_qstring(self))
}
}
impl std::ops::Add for QVector3D {
type Output = Self;
fn add(self, other: Self) -> Self {
ffi::qvector3d_plus(&self, &other)
}
}
impl std::ops::Sub for QVector3D {
type Output = Self;
fn sub(self, other: Self) -> Self {
ffi::qvector3d_minus(&self, &other)
}
}
impl std::ops::Mul<f32> for QVector3D {
type Output = Self;
fn mul(self, rhs: f32) -> Self {
ffi::qvector3d_mul(rhs, &self)
}
}
impl std::ops::Div<f32> for QVector3D {
type Output = Self;
fn div(self, rhs: f32) -> Self {
ffi::qvector3d_div(rhs, &self)
}
}
impl From<crate::QVector4D> for QVector3D {
/// Constructs a 3D vector from the specified 4D vector.
/// The w coordinate is dropped.
fn from(value: crate::QVector4D) -> Self {
ffi::qvector3d_init_qvector4d(value)
}
}
impl From<crate::QVector2D> for QVector3D {
/// Constructs a 3D vector from the specified 2D vector.
/// The z coordinate is set to zero.
fn from(value: crate::QVector2D) -> Self {
ffi::qvector3d_init_qvector2d(value)
}
}
impl From<crate::QPointF> for QVector3D {
/// Constructs a vector with x and y coordinates from a 2D point, and a z coordinate of 0.
fn from(value: crate::QPointF) -> Self {
ffi::qvector3d_init_qpointf(value)
}
}
impl From<QVector3D> for crate::QPointF {
/// Returns the QPointF form of this 3D vector. The z coordinate is dropped.
fn from(value: QVector3D) -> Self {
value.to_pointf()
}
}
impl From<crate::QPoint> for QVector3D {
/// Constructs a vector with x and y coordinates from a 2D point, and a z coordinate of 0.
fn from(value: crate::QPoint) -> Self {
ffi::qvector3d_init_qpoint(value)
}
}
impl From<QVector3D> for crate::QPoint {
/// Returns the QPoint form of this 3D vector. The z coordinate is dropped.
fn from(value: QVector3D) -> Self {
value.to_point()
}
}
// Safety:
//
// Static checks on the C++ side ensure that QVector3D is trivial.
unsafe impl ExternType for QVector3D {
type Id = type_id!("QVector3D");
type Kind = cxx::kind::Trivial;
}