Add class Ray

docs/api/ray.md

@@ -0,0 +1,19 @@
+# Ray
+
+A ray with origin and direction.
+
+*Since:* 0.4.0
+
+## Properties
+
+### origin
+
+`ray.origin: Vector3`
+
+The origin point of the ray.
+
+### direction
+
+`ray.direction: Vector3`
+
+The direction of the ray, a unit vector.

mkdocs.yml

@@ -103,6 +103,7 @@ nav:
       - 'Vector2': 'api/vector2.md'
       - 'Vector3': 'api/vector3.md'
       - 'Quaternion': 'api/quaternion.md'
+      - 'Ray': 'api/ray.md'
     - 'Visualization':
       - 'Viewport': 'api/viewport.md'
       - 'HUD': 'api/hud.md'

src/geometry/ray.ts

@@ -0,0 +1,65 @@
+/*
+ * encantar.js
+ * GPU-accelerated Augmented Reality for the web
+ * Copyright (C) 2022-2024 Alexandre Martins <alemartf(at)gmail.com>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published
+ * by the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ * ray.ts
+ * Rays
+ */
+
+import { Vector3 } from './vector3';
+
+
+/**
+ * A ray with origin and direction
+ */
+export class Ray
+{
+    /** origin of the ray, a point */
+    private _origin: Vector3;
+
+    /** direction, a unit vector */
+    private _direction: Vector3;
+
+
+
+    /**
+     * Constructor
+     * @param origin a point
+     * @param direction a unit vector
+     */
+    constructor(origin: Vector3, direction: Vector3)
+    {
+        this._origin = origin;
+        this._direction = direction;
+    }
+
+    /**
+     * The origin point of the ray
+     */
+    get origin(): Vector3
+    {
+        return this._origin;
+    }
+
+    /**
+     * The direction of the ray, a unit vector
+     */
+    get direction(): Vector3
+    {
+        return this._direction;
+    }
+}