PickRay JSDoc

libraries/shared/src/RegisteredMetaTypes.h

@@ -125,6 +125,14 @@ QVector<QUuid> qVectorQUuidFromScriptValue(const QScriptValue& array);
 QScriptValue aaCubeToScriptValue(QScriptEngine* engine, const AACube& aaCube);
 void aaCubeFromScriptValue(const QScriptValue &object, AACube& aaCube);
 
+/**jsdoc
+ * A PickRay defines a vector with a starting point. It is used, for example, when finding entities or overlays that lie under a
+ * mouse click or intersect a laser beam.
+ *
+ * @typedef PickRay
+ * @property {Vec3} origin - The starting position of the PickRay.
+ * @property {Quat} direction - The direction that the PickRay travels.
+ */
 class PickRay {
 public:
     PickRay() : origin(0.0f), direction(0.0f)  { }

libraries/shared/src/shared/Camera.h

@@ -172,12 +172,13 @@ public slots:
     void setOrientation(const glm::quat& orientation);
 
     /**jsdoc
-     * Compute a {PickRay} based on the current camera configuration and the specified <code>x, y</code> position on the screen.
+     * Compute a {@link PickRay} based on the current camera configuration and the specified <code>x, y</code> position on the 
-     *     The {PickRay} can be used in functions such as {Entities.findRayIntersection} and {Overlays.findRayIntersection}.
+     *     screen. The {@link PickRay} can be used in functions such as {@link Entities.findRayIntersection} and 
+     *     {@link Overlays.findRayIntersection}.
      * @function Camera.computePickRay
      * @param {number} x - X-coordinate on screen.
      * @param {number} y - Y-coordinate on screen.
-     * @return {PickRay} The computed {PickRay}.
+     * @return {PickRay} The computed {@link PickRay}.
      * @example
      * function onMousePressEvent(event) {
      *     var pickRay = Camera.computePickRay(event.x, event.y);