Mirrors/overte
3
0
Fork 0
mirror of https://github.com/overte-org/overte.git synced 2025-08-08 12:57:59 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update Overlays events and signals JSDoc

Browse source
This commit is contained in:
David Rowe 2019-07-11 16:15:24 +12:00
parent 42bee63f52
commit e1f181e8ee
1 changed files with 18 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
interface/src/ui/overlays/Overlays.h
View file

@ -512,13 +512,13 @@ public slots:
bool isAddedOverlay(const QUuid& id); bool isAddedOverlay(const QUuid& id);
/**jsdoc /**jsdoc
* Generate a mouse press event on an overlay. * Generates a mouse press event on an overlay (or local entity).
* @function Overlays.sendMousePressOnOverlay * @function Overlays.sendMousePressOnOverlay
* @param {Uuid} id - The ID of the overlay to generate a mouse press event on. * @param {Uuid} id - The ID of the overlay (or local entity) to generate a mouse press event on.
* @param {PointerEvent} event - The mouse press event details. * @param {PointerEvent} event - The mouse press event details.
* @example <caption>Create a 2D rectangle overlay plus a 3D cube overlay and generate mousePressOnOverlay events for the 2D * @example <caption>Create a 2D rectangle overlay plus a 3D cube overlay and generate mousePressOnOverlay events for the
* overlay.</caption> * 2D overlay.</caption>
* var overlay = Overlays.addOverlay("cube", { * var overlay3D = Overlays.addOverlay("cube", {
* position: Vec3.sum(MyAvatar.position, Vec3.multiplyQbyV(MyAvatar.orientation, { x: 0, y: 0, z: -3 })), * position: Vec3.sum(MyAvatar.position, Vec3.multiplyQbyV(MyAvatar.orientation, { x: 0, y: 0, z: -3 })),
* rotation: MyAvatar.orientation, * rotation: MyAvatar.orientation,
* dimensions: { x: 0.3, y: 0.3, z: 0.3 }, * dimensions: { x: 0.3, y: 0.3, z: 0.3 },
@ -526,7 +526,7 @@ public slots:
* }); * });
* print("3D overlay: " + overlay); * print("3D overlay: " + overlay);
* *
* var overlay = Overlays.addOverlay("rectangle", { * var overlay2D = Overlays.addOverlay("rectangle", {
* bounds: { x: 100, y: 100, width: 200, height: 100 }, * bounds: { x: 100, y: 100, width: 200, height: 100 },
* color: { red: 255, green: 255, blue: 255 } * color: { red: 255, green: 255, blue: 255 }
* }); * });
@ -552,41 +552,41 @@ public slots:
void sendMousePressOnOverlay(const QUuid& id, const PointerEvent& event); void sendMousePressOnOverlay(const QUuid& id, const PointerEvent& event);
/**jsdoc /**jsdoc
* Generate a mouse release event on an overlay. * Generates a mouse release event on an overlay (or local entity).
* @function Overlays.sendMouseReleaseOnOverlay * @function Overlays.sendMouseReleaseOnOverlay
* @param {Uuid} id - The ID of the overlay to generate a mouse release event on. * @param {Uuid} id - The ID of the overlay (or local entity) to generate a mouse release event on.
* @param {PointerEvent} event - The mouse release event details. * @param {PointerEvent} event - The mouse release event details.
*/ */
void sendMouseReleaseOnOverlay(const QUuid& id, const PointerEvent& event); void sendMouseReleaseOnOverlay(const QUuid& id, const PointerEvent& event);
/**jsdoc /**jsdoc
* Generate a mouse move event on an overlay. * Generates a mouse move event on an overlay (or local entity).
* @function Overlays.sendMouseMoveOnOverlay * @function Overlays.sendMouseMoveOnOverlay
* @param {Uuid} id - The ID of the overlay to generate a mouse move event on. * @param {Uuid} id - The ID of the overlay (or local entity) to generate a mouse move event on.
* @param {PointerEvent} event - The mouse move event details. * @param {PointerEvent} event - The mouse move event details.
*/ */
void sendMouseMoveOnOverlay(const QUuid& id, const PointerEvent& event); void sendMouseMoveOnOverlay(const QUuid& id, const PointerEvent& event);
/**jsdoc /**jsdoc
* Generate a hover enter event on an overlay. * Generates a hover enter event on an overlay (or local entity).
* @function Overlays.sendHoverEnterOverlay * @function Overlays.sendHoverEnterOverlay
* @param {Uuid} id - The ID of the overlay to generate a hover enter event on. * @param {Uuid} id - The ID of the overlay (or local entity) to generate a hover enter event on.
* @param {PointerEvent} event - The hover enter event details. * @param {PointerEvent} event - The hover enter event details.
*/ */
void sendHoverEnterOverlay(const QUuid& id, const PointerEvent& event); void sendHoverEnterOverlay(const QUuid& id, const PointerEvent& event);
/**jsdoc /**jsdoc
* Generate a hover over event on an overlay. * Generates a hover over event on an overlay (or entity).
* @function Overlays.sendHoverOverOverlay * @function Overlays.sendHoverOverOverlay
* @param {Uuid} id - The ID of the overlay to generate a hover over event on. * @param {Uuid} id - The ID of the overlay (or local entity) to generate a hover over event on.
* @param {PointerEvent} event - The hover over event details. * @param {PointerEvent} event - The hover over event details.
*/ */
void sendHoverOverOverlay(const QUuid& id, const PointerEvent& event); void sendHoverOverOverlay(const QUuid& id, const PointerEvent& event);
/**jsdoc /**jsdoc
* Generate a hover leave event on an overlay. * Generates a hover leave event on an overlay (or local entity).
* @function Overlays.sendHoverLeaveOverlay * @function Overlays.sendHoverLeaveOverlay
* @param {Uuid} id - The ID of the overlay to generate a hover leave event on. * @param {Uuid} id - The ID of the overlay (or local entity) to generate a hover leave event on.
* @param {PointerEvent} event - The hover leave event details. * @param {PointerEvent} event - The hover leave event details.
*/ */
void sendHoverLeaveOverlay(const QUuid& id, const PointerEvent& event); void sendHoverLeaveOverlay(const QUuid& id, const PointerEvent& event);
@ -612,9 +612,9 @@ public slots:
signals: signals:
/**jsdoc /**jsdoc
* Triggered when an overlay is deleted. * Triggered when an overlay (or entity) is deleted.
* @function Overlays.overlayDeleted * @function Overlays.overlayDeleted
* @param {Uuid} id - The ID of the overlay that was deleted. * @param {Uuid} id - The ID of the overlay (or entity) that was deleted.
* @returns {Signal} * @returns {Signal}
* @example <caption>Create an overlay then delete it after 1s.</caption> * @example <caption>Create an overlay then delete it after 1s.</caption>
* var overlay = Overlays.addOverlay("cube", { * var overlay = Overlays.addOverlay("cube", {