true if the avatar is in a "hero" zone, false if it isn't.
* Read-only.
+ * @property {boolean} hasScriptedBlendshapes=false - true if blend shapes are controlled by scripted actions,
+ * otherwise false. Set this to true before using the {@link MyAvatar.setBlendshape} method,
+ * and set back to false after you no longer want scripted control over the blend shapes.
+ * Note: This property will automatically be set to true if the Controller system has valid facial + * blend shape actions.
+ * @property {boolean} hasProceduralBlinkFaceMovement=true -true if avatars blink automatically by animating
+ * facial blend shapes, false if automatic blinking is disabled. Set to false to fully control
+ * the blink facial blend shapes via the {@link MyAvatar.setBlendshape} method.
+ * @property {boolean} hasProceduralEyeFaceMovement=true - true if the facial blend shapes for an avatar's eyes
+ * adjust automatically as the eyes move, false if this automatic movement is disabled. Set this property
+ * to true to prevent the iris from being obscured by the upper or lower lids. Set to false to
+ * fully control the eye blend shapes via the {@link MyAvatar.setBlendshape} method.
+ * @property {boolean} hasAudioEnabledFaceMovement=true - true if the avatar's mouth blend shapes animate
+ * automatically based on detected microphone input, false if this automatic movement is disabled. Set
+ * this property to false to fully control the mouth facial blend shapes via the
+ * {@link MyAvatar.setBlendshape} method.
*
* @example Warning: Potentially an expensive call. Do not use if possible.
* @function Avatar.getAvatarEntityData - * @returns {AvatarEntityMap} Details of the avatar entities. + * @returns {AvatarEntityMap} Details of all avatar entities. * @exampleWarning: Potentially an expensive call. Do not use if possible.
diff --git a/cmake/externals/glad32es/CMakeLists.txt b/cmake/externals/glad32es/CMakeLists.txt deleted file mode 100644 index 8487e5aaaf..0000000000 --- a/cmake/externals/glad32es/CMakeLists.txt +++ /dev/null @@ -1,33 +0,0 @@ -set(EXTERNAL_NAME glad32es) - -include(ExternalProject) -include(SelectLibraryConfigurations) - -ExternalProject_Add( - ${EXTERNAL_NAME} - URL "${EXTERNAL_BUILD_ASSETS}/dependencies/glad/glad32es.zip" - URL_MD5 6a641d8c49dee4c895fa59315f5682a6 - CONFIGURE_COMMAND CMAKE_ARGS -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE} -DCMAKE_INSTALL_PREFIX:PATH=CameraFirstPersonCameraFirstPersonLookAtCameraThirdPersonCameraFSMCameraLookAtCameraFSMCameraSelfieCameraIndependentCameraEntityInHMDDeprecated: Use avatar entities instead.
*/
@@ -296,7 +296,7 @@ QVariantMap AvatarBookmarks::getAvatarDataToBookmark() {
if (entityTree) {
QScriptEngine scriptEngine;
- auto avatarEntities = myAvatar->getAvatarEntityData();
+ auto avatarEntities = myAvatar->getAvatarEntityDataNonDefault();
for (auto entityID : avatarEntities.keys()) {
auto entity = entityTree->findEntityByID(entityID);
if (!entity || !isWearableEntity(entity)) {
diff --git a/interface/src/InterfaceParentFinder.cpp b/interface/src/InterfaceParentFinder.cpp
index 33328f54cc..0f1c8876a9 100644
--- a/interface/src/InterfaceParentFinder.cpp
+++ b/interface/src/InterfaceParentFinder.cpp
@@ -45,10 +45,6 @@ SpatiallyNestableWeakPointer InterfaceParentFinder::find(QUuid parentID, bool& s
success = true;
return parent;
}
- if (parentID == AVATAR_SELF_ID) {
- success = true;
- return avatarManager->getMyAvatar();
- }
success = false;
return parent;
diff --git a/interface/src/LODManager.h b/interface/src/LODManager.h
index 4708deb61b..16b0529b05 100644
--- a/interface/src/LODManager.h
+++ b/interface/src/LODManager.h
@@ -66,16 +66,62 @@ class AABox;
/**jsdoc
- * The LOD class manages your Level of Detail functions within Interface.
+ * The LODManager API manages the Level of Detail displayed in Interface. If the LOD is being automatically
+ * adjusted, the LOD is decreased if the measured frame rate is lower than the target FPS, and increased if the measured frame
+ * rate is greater than the target FPS.
+ *
* @namespace LODManager
*
* @hifi-interface
* @hifi-client-entity
* @hifi-avatar
*
- * @property {number} presentTime Read-only.
- * @property {number} engineRunTime Read-only.
- * @property {number} gpuTime Read-only.
+ * @property {LODManager.WorldDetailQuality} worldDetailQuality - The quality of the rendered world detail.
+ *
Setting this value updates the current desktop or HMD target LOD FPS.
+ * @property {number} lodQualityLevel - Not used. + *Deprecated: This property is deprecated and will be removed.
+ * @property {boolean} automaticLODAdjust -true to automatically adjust the LOD, false to manually
+ * adjust it.
+ *
+ * @property {number} engineRunTime - The time spent in the "render" thread to produce the most recent frame, in ms.
+ * Read-only.
+ * @property {number} batchTime - The time spent in the "present" thread processing the batches of the most recent frame, in ms.
+ * Read-only.
+ * @property {number} presentTime - The time spent in the "present" thread between the last buffer swap, i.e., the total time
+ * to submit the most recent frame, in ms.
+ * Read-only.
+ * @property {number} gpuTime - The time spent in the GPU executing the most recent frame, in ms.
+ * Read-only.
+ *
+ * @property {number} nowRenderTime - The current, instantaneous time spend to produce frames, in ms. This is the worst of
+ * engineRunTime, batchTime, presentTime, and gpuTime.
+ * Read-only.
+ * @property {number} nowRenderFPS - The current, instantaneous frame rate, in Hz.
+ * Read-only.
+ *
+ * @property {number} smoothScale - The amount of smoothing applied to calculate smoothRenderTime and
+ * smoothRenderFPS.
+ * @property {number} smoothRenderTime - The average time spend to produce frames, in ms.
+ * Read-only.
+ * @property {number} smoothRenderFPS - The average frame rate, in Hz.
+ * Read-only.
+ *
+ * @property {number} lodTargetFPS - The target LOD FPS per the current desktop or HMD display mode, capped by the target
+ * refresh rate set by the {@link Performance} API.
+ * Read-only.
+
+ * @property {number} lodAngleDeg - The minimum angular dimension (relative to the camera position) of an entity in order for
+ * it to be rendered, in degrees. The angular dimension is calculated as a sphere of radius half the diagonal of the
+ * entity's AA box.
+ *
+ * @property {number} pidKp - Not used.
+ * @property {number} pidKi - Not used.
+ * @property {number} pidKd - Not used.
+ * @property {number} pidKv - Not used.
+ * @property {number} pidOp - Not used. Read-only.
+ * @property {number} pidOi - Not used. Read-only.
+ * @property {number} pidOd - Not used. Read-only.
+ * @property {number} pidO - Not used. Read-only.
*/
class LODManager : public QObject, public Dependency {
Q_OBJECT
@@ -117,83 +163,96 @@ class LODManager : public QObject, public Dependency {
public:
/**jsdoc
+ * Sets whether the LOD should be automatically adjusted.
* @function LODManager.setAutomaticLODAdjust
- * @param {boolean} value
+ * @param {boolean} value - true to automatically adjust the LOD, false to manually adjust it.
*/
Q_INVOKABLE void setAutomaticLODAdjust(bool value);
/**jsdoc
+ * Gets whether the LOD is being automatically adjusted.
* @function LODManager.getAutomaticLODAdjust
- * @returns {boolean}
+ * @returns {boolean} true if the LOD is being automatically adjusted, false if it is being
+ * manually adjusted.
*/
Q_INVOKABLE bool getAutomaticLODAdjust() const { return _automaticLODAdjust; }
/**jsdoc
+ * Sets the target desktop LOD FPS.
* @function LODManager.setDesktopLODTargetFPS
- * @param {number} value
+ * @param {number} value - The target desktop LOD FPS, in Hz.
*/
Q_INVOKABLE void setDesktopLODTargetFPS(float value);
/**jsdoc
+ * Gets the target desktop LOD FPS.
* @function LODManager.getDesktopLODTargetFPS
- * @returns {number}
+ * @returns {number} The target desktop LOD FPS, in Hz.
*/
Q_INVOKABLE float getDesktopLODTargetFPS() const;
/**jsdoc
+ * Sets the target HMD LOD FPS.
* @function LODManager.setHMDLODTargetFPS
- * @param {number} value
+ * @param {number} value - The target HMD LOD FPS, in Hz.
*/
Q_INVOKABLE void setHMDLODTargetFPS(float value);
/**jsdoc
+ * Gets the target HMD LOD FPS.
+ * The target FPS in HMD mode. The LOD is adjusted to ...
* @function LODManager.getHMDLODTargetFPS
- * @returns {number}
+ * @returns {number} The target HMD LOD FPS, in Hz.
*/
Q_INVOKABLE float getHMDLODTargetFPS() const;
// User Tweakable LOD Items
+
/**jsdoc
+ * Gets a text description of the current level of detail rendered.
* @function LODManager.getLODFeedbackText
- * @returns {string}
+ * @returns {string} A text description of the current level of detail rendered.
+ * @example lodAngleDeg property instead.
*/
Q_INVOKABLE void setOctreeSizeScale(float sizeScale);
/**jsdoc
* @function LODManager.getOctreeSizeScale
- * @returns {number}
- * @deprecated This function is deprecated and will be removed. Use the {@link LODManager.lodAngleDeg} property instead.
+ * @returns {number} The octree size scale.
+ * @deprecated This function is deprecated and will be removed. Use the lodAngleDeg property instead.
*/
Q_INVOKABLE float getOctreeSizeScale() const;
/**jsdoc
* @function LODManager.setBoundaryLevelAdjust
- * @param {number} boundaryLevelAdjust
+ * @param {number} boundaryLevelAdjust - The boundary level adjust factor.
* @deprecated This function is deprecated and will be removed.
*/
Q_INVOKABLE void setBoundaryLevelAdjust(int boundaryLevelAdjust);
/**jsdoc
* @function LODManager.getBoundaryLevelAdjust
- * @returns {number}
+ * @returns {number} The boundary level adjust factor.
* @deprecated This function is deprecated and will be removed.
*/
Q_INVOKABLE int getBoundaryLevelAdjust() const { return _boundaryLevelAdjust; }
/**jsdoc
- * @function LODManager.getLODTargetFPS
- * @returns {number}
- */
+ * The target LOD FPS per the current desktop or HMD display mode, capped by the target refresh rate.
+ * @function LODManager.getLODTargetFPS
+ * @returns {number} The target LOD FPS, in Hz.
+ */
Q_INVOKABLE float getLODTargetFPS() const;
@@ -249,19 +308,41 @@ public:
signals:
/**jsdoc
+ * Not triggered.
* @function LODManager.LODIncreased
* @returns {Signal}
+ * @deprecated This signal is deprecated and will be removed.
*/
void LODIncreased();
/**jsdoc
+ * Not triggered.
* @function LODManager.LODDecreased
* @returns {Signal}
+ * @deprecated This signal is deprecated and will be removed.
*/
void LODDecreased();
+ /**jsdoc
+ * Triggered when whether or not the LOD is being automatically adjusted changes.
+ * @function LODManager.autoLODChanged
+ * @returns {Signal}
+ */
void autoLODChanged();
+
+ /**jsdoc
+ * Triggered when the lodQualityLevel property value changes.
+ * @function LODManager.lodQualityLevelChanged
+ * @returns {Signal}
+ * @deprecated This signal is deprecated and will be removed.
+ */
void lodQualityLevelChanged();
+
+ /**jsdoc
+ * Triggered when the world detail quality changes.
+ * @function LODManager.worldDetailQualityChanged
+ * @returns {Signal}
+ */
void worldDetailQualityChanged();
private:
diff --git a/interface/src/Menu.cpp b/interface/src/Menu.cpp
index fbb69842bd..b5cacd662b 100644
--- a/interface/src/Menu.cpp
+++ b/interface/src/Menu.cpp
@@ -29,6 +29,8 @@
#include Refresh rate profile.
+ *| Value | Description |
|---|---|
"Eco" | Low refresh rate, which is reduced when Interface doesn't have focus or is + * minimized. |
"Interactive" | Medium refresh rate, which is reduced when Interface doesn't have focus or is + * minimized. |
"Realtime" | High refresh rate, even when Interface doesn't have focus or is minimized. + * |
Interface states that affect the refresh rate.
+ *| Value | Description |
|---|---|
"FocusActive" | Interface has focus and the user is active or is in VR. |
"FocusInactive" | Interface has focus and the user is inactive. |
"Unfocus" | Interface doesn't have focus. |
"Minimized" | Interface is minimized. |
"StartUp" | Interface is starting up. |
"ShutDown" | Interface is shutting down. |
User experience (UX) modes.
+ *| Value | Description |
|---|---|
"Desktop" | Desktop user experience. |
"VR" | VR user experience. |
Interface states that affect the refresh rate.
+ *| Value | Name | Description | + *
|---|---|---|
0 | FOCUS_ACTIVE | Interface has focus and the user is active or is in VR. |
1 | FOCUS_INACTIVE | Interface has focus and the user is inactive. |
2 | UNFOCUS | Interface doesn't have focus. |
3 | MINIMIZED | Interface is minimized. |
4 | STARTUP | Interface is starting up. |
5 | SHUTDOWN | Interface is shutting down. |
User experience (UX) modes.
+ *| Value | Name | Description | + *
|---|---|---|
0 | DESKTOP | Desktop user experience. |
1 | VR | VR use experience. |
true if the avatar is in a "hero" zone, false if it isn't.
* Read-only.
+ * @property {boolean} hasScriptedBlendshapes=false - true if blend shapes are controlled by scripted actions,
+ * otherwise false. Set this to true before using the {@link MyAvatar.setBlendshape} method,
+ * and set back to false after you no longer want scripted control over the blend shapes.
+ * Note: This property will automatically be set to true if the controller system has
+ * valid facial blend shape actions.
true if avatars blink automatically by animating
+ * facial blend shapes, false if automatic blinking is disabled. Set to false to fully control
+ * the blink facial blend shapes via the {@link MyAvatar.setBlendshape} method.
+ * @property {boolean} hasProceduralEyeFaceMovement=true - true if the facial blend shapes for an avatar's eyes
+ * adjust automatically as the eyes move, false if this automatic movement is disabled. Set this property
+ * to true to prevent the iris from being obscured by the upper or lower lids. Set to false to
+ * fully control the eye blend shapes via the {@link MyAvatar.setBlendshape} method.
+ * @property {boolean} hasAudioEnabledFaceMovement=true - true if the avatar's mouth blend shapes animate
+ * automatically based on detected microphone input, false if this automatic movement is disabled. Set
+ * this property to false to fully control the mouth facial blend shapes via the
+ * {@link MyAvatar.setBlendshape} method.
*
* @comment IMPORTANT: This group of properties is copied from Avatar.h; they should NOT be edited here.
* @property {Vec3} skeletonOffset - Can be used to apply a translation offset between the avatar's position and the
@@ -270,9 +286,9 @@ class MyAvatar : public Avatar {
* @property {number} isInSittingState - true if the user wearing the HMD is determined to be sitting
* (avatar leaning is disabled, recentering is enabled), false if the user wearing the HMD is
* determined to be standing (avatar leaning is enabled, and avatar recenters if it leans too far).
- * If userRecenterModel == 2 (i.e., auto) the property value automatically updates as the user sits
+ * If userRecenterModel == 2 (i.e., "auto") the property value automatically updates as the user sits
* or stands, unless isSitStandStateLocked == true. Setting the property value overrides the current
- * siting / standing state, which is updated when the user next sits or stands unless
+ * sitting / standing state, which is updated when the user next sits or stands unless
* isSitStandStateLocked == true.
* @property {boolean} isSitStandStateLocked - true to lock the avatar sitting/standing state, i.e., use this
* to disable automatically changing state.
@@ -305,10 +321,7 @@ class MyAvatar : public Avatar {
* @borrows Avatar.setAttachmentsVariant as setAttachmentsVariant
* @borrows Avatar.updateAvatarEntity as updateAvatarEntity
* @borrows Avatar.clearAvatarEntity as clearAvatarEntity
- * @borrows Avatar.hasScriptedBlendshapes as hasScriptedBlendshapes
- * @borrows Avatar.hasProceduralBlinkFaceMovement as hasProceduralBlinkFaceMovement
- * @borrows Avatar.hasProceduralEyeFaceMovement as hasProceduralEyeFaceMovement
- * @borrows Avatar.hasAudioEnabledFaceMovement as hasAudioEnabledFaceMovement
+ * @borrows Avatar.setForceFaceTrackerConnected as setForceFaceTrackerConnected
* @borrows Avatar.setSkeletonModelURL as setSkeletonModelURL
* @borrows Avatar.getAttachmentData as getAttachmentData
* @borrows Avatar.setAttachmentData as setAttachmentData
@@ -420,38 +433,72 @@ class MyAvatar : public Avatar {
const bool DEFAULT_STRAFE_ENABLED = true;
public:
+ /**jsdoc
+ * The DriveKeys API provides constant numeric values that represent different logical keys that drive your
+ * avatar and camera.
+ *
+ * @namespace DriveKeys
+ *
+ * @hifi-interface
+ * @hifi-client-entity
+ * @hifi-avatar
+ *
+ * @property {number} TRANSLATE_X - Move the user's avatar in the direction of its x-axis, if the camera isn't in
+ * independent or mirror modes.
+ * @property {number} TRANSLATE_Y - Move the user's avatar in the direction of its y-axis, if the camera isn't in
+ * independent or mirror modes.
+ * @property {number} TRANSLATE_Z - Move the user's avatar in the direction of its z-axis, if the camera isn't in
+ * independent or mirror modes.
+ * @property {number} YAW - Rotate the user's avatar about its y-axis at a rate proportional to the control value, if the
+ * camera isn't in independent or mirror modes.
+ * @property {number} STEP_TRANSLATE_X - No action.
+ * @property {number} STEP_TRANSLATE_Y - No action.
+ * @property {number} STEP_TRANSLATE_Z - No action.
+ * @property {number} STEP_YAW - Rotate the user's avatar about its y-axis in a step increment, if the camera isn't in
+ * independent or mirror modes.
+ * @property {number} PITCH - Rotate the user's avatar head and attached camera about its negative x-axis (i.e., positive
+ * values pitch down) at a rate proportional to the control value, if the camera isn't in HMD, independent, or mirror
+ * modes.
+ * @property {number} ZOOM - Zoom the camera in or out.
+ * @property {number} DELTA_YAW - Rotate the user's avatar about its y-axis by an amount proportional to the control value,
+ * if the camera isn't in independent or mirror modes.
+ * @property {number} DELTA_PITCH - Rotate the user's avatar head and attached camera about its negative x-axis (i.e.,
+ * positive values pitch down) by an amount proportional to the control value, if the camera isn't in HMD, independent,
+ * or mirror modes.
+ */
+
/**jsdoc
* Logical keys that drive your avatar and camera.
*| Value | Name | Description |
|---|---|---|
| Value | Description | |
0 | TRANSLATE_X | Move the user's avatar in the direction of its x-axis, if the - * camera isn't in independent or mirror modes. |
1 | TRANSLATE_Y | Move the user's avatar in the direction of its y-axis, if the - * camera isn't in independent or mirror modes. |
2 | TRANSLATE_Z | Move the user's avatar in the direction of its z-axis, if the - * camera isn't in independent or mirror modes |
3 | YAW | Rotate the user's avatar about its y-axis at a rate proportional to the - * control value, if the camera isn't in independent or mirror modes. |
4 | STEP_TRANSLATE_X | No action. |
5 | STEP_TRANSLATE_Y | No action. |
6 | STEP_TRANSLATE_Z | No action. |
7 | STEP_YAW | Rotate the user's avatar about its y-axis in a step increment, if - * the camera isn't in independent or mirror modes. |
8 | PITCH | Rotate the user's avatar head and attached camera about its negative - * x-axis (i.e., positive values pitch down) at a rate proportional to the control value, if the camera isn't in HMD, - * independent, or mirror modes. |
9 | ZOOM | Zoom the camera in or out. |
10 | DELTA_YAW | Rotate the user's avatar about its y-axis by an amount proportional - * to the control value, if the camera isn't in independent or mirror modes. |
11 | DELTA_PITCH | Rotate the user's avatar head and attached camera about its - * negative x-axis (i.e., positive values pitch down) by an amount proportional to the control value, if the camera - * isn't in HMD, independent, or mirror modes. |
{@link DriveKeys|DriveKeys.TRANSLATE_X} | Move the user's avatar in the direction of its + * x-axis, if the camera isn't in independent or mirror modes. | |
{@link DriveKeys|DriveKeys.TRANSLATE_Y} | Move the user's avatar in the direction of its + * -axis, if the camera isn't in independent or mirror modes. | |
{@link DriveKeys|DriveKeys.TRANSLATE_Z} | Move the user's avatar in the direction of its + * z-axis, if the camera isn't in independent or mirror modes. | |
{@link DriveKeys|DriveKeys.YAW} | Rotate the user's avatar about its y-axis at a rate + * proportional to the control value, if the camera isn't in independent or mirror modes. | |
{@link DriveKeys|DriveKeys.STEP_TRANSLATE_X} | No action. | |
{@link DriveKeys|DriveKeys.STEP_TRANSLATE_Y} | No action. | |
{@link DriveKeys|DriveKeys.STEP_TRANSLATE_Z} | No action. | |
{@link DriveKeys|DriveKeys.STEP_YAW} | Rotate the user's avatar about its y-axis in a + * step increment, if the camera isn't in independent or mirror modes. | |
{@link DriveKeys|DriveKeys.PITCH} | Rotate the user's avatar head and attached camera + * about its negative x-axis (i.e., positive values pitch down) at a rate proportional to the control value, if the + * camera isn't in HMD, independent, or mirror modes. | |
{@link DriveKeys|DriveKeys.ZOOM} | Zoom the camera in or out. | |
{@link DriveKeys|DriveKeys.DELTA_YAW} | Rotate the user's avatar about its y-axis by an + * amount proportional to the control value, if the camera isn't in independent or mirror modes. | |
{@link DriveKeys|DriveKeys.DELTA_PITCH} | Rotate the user's avatar head and attached + * camera about its negative x-axis (i.e., positive values pitch down) by an amount proportional to the control + * value, if the camera isn't in HMD, independent, or mirror modes. |
012Note: When using pre-built animation data, it's critical that the joint orientation of the source animation and target * rig are equivalent, since the animation data applies absolute values onto the joints. If the orientations are different, * the avatar will move in unpredictable ways. For more information about avatar joint orientation standards, see - * Avatar Standards.
+ * Avatar Standards. * @function MyAvatar.overrideAnimation * @param {string} url - The URL to the animation file. Animation files may be in glTF or FBX format, but only need to * contain the avatar skeleton and animation data. glTF models may be in JSON or binary format (".gltf" or ".glb" URLs @@ -618,7 +665,7 @@ public: * @param {number} firstFrame - The frame to start the animation at. * @param {number} lastFrame - The frame to end the animation at. * @exampletrue if the drive key is disabled, false if it isn't.
*/
Q_INVOKABLE bool isDriveKeyDisabled(DriveKeys key) const;
@@ -1137,7 +1183,7 @@ public:
/**jsdoc
* Gets information on the avatar your avatar is currently looking at.
* @function MyAvatar.getTargetAvatar
- * @returns {AvatarData} Information on the avatar being looked at.
+ * @returns {ScriptAvatar} Information on the avatar being looked at, null if no avatar is being looked at.
*/
// FIXME: The return type doesn't have a conversion to a script value so the function always returns undefined in
// JavaScript. Note: When fixed, JSDoc is needed for the return type.
@@ -1746,57 +1792,57 @@ public:
void prepareAvatarEntityDataForReload();
/**jsdoc
- * Turn the avatar's head until it faces the target point within the 90/-90 degree range.
- * Once this method is called, API calls will have full control of the head for a limited time.
- * If this method is not called for two seconds, the engine will regain control of the head.
- * @function MyAvatar.setHeadLookAt
- * @param {Vec3} lookAtTarget - The target point in world coordinates.
- */
+ * Turns the avatar's head until it faces the target point within a +90/-90 degree range.
+ * Once this method is called, API calls have full control of the head for a limited time.
+ * If this method is not called for 2 seconds, the engine regains control of the head.
+ * @function MyAvatar.setHeadLookAt
+ * @param {Vec3} lookAtTarget - The target point in world coordinates.
+ */
Q_INVOKABLE void setHeadLookAt(const glm::vec3& lookAtTarget);
/**jsdoc
- * Returns the current head look at target point in world coordinates.
- * @function MyAvatar.getHeadLookAt
- * @returns {Vec3} The head's look at target in world coordinates.
- */
+ * Gets the current target point of the head's look direction in world coordinates.
+ * @function MyAvatar.getHeadLookAt
+ * @returns {Vec3} The head's look-at target in world coordinates.
+ */
Q_INVOKABLE glm::vec3 getHeadLookAt() { return _lookAtCameraTarget; }
/**jsdoc
- * When this function is called the engine regains control of the head immediately.
- * @function MyAvatar.releaseHeadLookAtControl
- */
+ * Returns control of the avatar's head to the engine, and releases control from API calls.
+ * @function MyAvatar.releaseHeadLookAtControl
+ */
Q_INVOKABLE void releaseHeadLookAtControl();
/**jsdoc
- * Force the avatar's eyes to look to the specified location.
- * Once this method is called, API calls will have full control of the eyes for a limited time.
- * If this method is not called for two seconds, the engine will regain control of the eyes.
- * @function MyAvatar.setEyesLookAt
- * @param {Vec3} lookAtTarget - The target point in world coordinates.
- */
+ * Forces the avatar's eyes to look at a specified location. Once this method is called, API calls
+ * full control of the eyes for a limited time. If this method is not called for 2 seconds,
+ * the engine regains control of the eyes.
+ * @function MyAvatar.setEyesLookAt
+ * @param {Vec3} lookAtTarget - The target point in world coordinates.
+ */
Q_INVOKABLE void setEyesLookAt(const glm::vec3& lookAtTarget);
/**jsdoc
- * Returns the current eyes look at target point in world coordinates.
- * @function MyAvatar.getEyesLookAt
- * @returns {Vec3} The eyes's look at target in world coordinates.
- */
+ * Gets the current target point of the eyes look direction in world coordinates.
+ * @function MyAvatar.getEyesLookAt
+ * @returns {Vec3} The eyes' look-at target in world coordinates.
+ */
Q_INVOKABLE glm::vec3 getEyesLookAt() { return _eyesLookAtTarget.get(); }
/**jsdoc
- * When this function is called the engine regains control of the eyes immediately.
- * @function MyAvatar.releaseEyesLookAtControl
- */
+ * Returns control of the avatar's eyes to the engine, and releases control from API calls.
+ * @function MyAvatar.releaseEyesLookAtControl
+ */
Q_INVOKABLE void releaseEyesLookAtControl();
/**jsdoc
- * Aims the pointing directional blending towards the provided target point.
- * The "point" reaction should be triggered before using this method.
- * MyAvatar.beginReaction("point")
- * Returns true if the target point lays in front of the avatar.
- * @function MyAvatar.setPointAt
- * @param {Vec3} pointAtTarget - The target point in world coordinates.
- */
+ * Sets the point-at target for the "point" reaction that may be started with {@link MyAvatar.beginReaction}.
+ * The point-at target is set only if it is in front of the avatar.
+ * Note: The "point" reaction should be started before calling this method.
true if the target point was set, false if it wasn't.
+ */
Q_INVOKABLE bool setPointAt(const glm::vec3& pointAtTarget);
glm::quat getLookAtRotation() { return _lookAtYaw * _lookAtPitch; }
@@ -1840,14 +1886,17 @@ public:
/**jsdoc
* Gets details of all avatar entities.
+ * Warning: Potentially an expensive call. Do not use if possible.
* @function MyAvatar.getAvatarEntityData - * @returns {AvatarEntityMap} Details of the avatar entities. + * @returns {AvatarEntityMap} Details of all avatar entities. * @exampletrue if flow simulation is enabled on the joint, false if it isn't.
* @param {boolean} isCollidable - true to enable collisions in the flow simulation, false to
* disable.
- * @param {Objecttrue if the avatar is in a seated pose.
+ * @returns {boolean} true if the avatar is in a seated pose, false if it isn't.
*/
Q_INVOKABLE bool isSeated() { return _characterController.getSeated(); }
@@ -2003,7 +2051,8 @@ public slots:
float getGravity();
/**jsdoc
- * Moves the avatar to a new position and/or orientation in the domain, while taking into account Avatar leg-length.
+ * Moves the avatar to a new position and/or orientation in the domain, with safe landing, while taking into account avatar
+ * leg length.
* @function MyAvatar.goToFeetLocation
* @param {Vec3} position - The new position for the avatar, in world coordinates.
* @param {boolean} [hasOrientation=false] - Set to true to set the orientation of the avatar.
@@ -2021,21 +2070,21 @@ public slots:
* @param {boolean} [hasOrientation=false] - Set to true to set the orientation of the avatar.
* @param {Quat} [orientation=Quat.IDENTITY] - The new orientation for the avatar.
* @param {boolean} [shouldFaceLocation=false] - Set to true to position the avatar a short distance away from
- * @param {boolean} [withSafeLanding=true] - Set to false MyAvatar::safeLanding will not be called (used when teleporting).
* the new position and orientate the avatar to face the position.
+ * @param {boolean} [withSafeLanding=true] - Set to false to disable safe landing when teleporting.
*/
void goToLocation(const glm::vec3& newPosition,
bool hasOrientation = false, const glm::quat& newOrientation = glm::quat(),
bool shouldFaceLocation = false, bool withSafeLanding = true);
/**jsdoc
- * Moves the avatar to a new position and (optional) orientation in the domain.
+ * Moves the avatar to a new position and (optional) orientation in the domain, with safe landing.
* @function MyAvatar.goToLocation
* @param {MyAvatar.GoToProperties} target - The goto target.
*/
void goToLocation(const QVariant& properties);
/**jsdoc
- * Moves the avatar to a new position and then enables collisions.
+ * Moves the avatar to a new position, with safe landing, and enables collisions.
* @function MyAvatar.goToLocationAndEnableCollisions
* @param {Vec3} position - The new position for the avatar, in world coordinates.
*/
@@ -2297,43 +2346,52 @@ public slots:
virtual void setModelScale(float scale) override;
/**jsdoc
- * MyAvatar.getTriggerReactions
- * Returns a list of reactions names that can be triggered using MyAvatar.triggerReaction().
- * @returns {string[]} Array of reaction names.
+ * Gets the list of reactions names that can be triggered using {@link MyAvatar.triggerReaction}.
+ * See also: {@link MyAvatar.getBeginEndReactions}. + * @function MyAvatar.getTriggerReactions + * @returns {string[]} List of reaction names that can be triggered using {@link MyAvatar.triggerReaction}. + * @example
See also: {@link MyAvatar.getTriggerReactions}. + * @function MyAvatar.getBeginEndReactions + * @returns {string[]} List of reaction names that can be enabled using {@link MyAvatar.beginReaction} and + * {@link MyAvatar.endReaction}. + * @example
Only reaction names returned by {@link MyAvatar.getTriggerReactions} are available.
+ * @function MyAvatar.triggerReaction + * @param {string} reactionName - The reaction to trigger. + * @returns {boolean}true if the reaction was played, false if the reaction is not supported.
*/
bool triggerReaction(QString reactionName);
/**jsdoc
- * MyAvatar.beginReaction
- * Plays the given reaction on the avatar. The avatar will continue to play the reaction until stopped via the MyAvatar.endReaction() call or superseeded by another reaction.
- * Only reaction names returned from MyAvatar.getBeginEndReactions() are available.
- * NOTE: the caller is responsible for calling the corresponding MyAvatar.endReaction(), otherwise the avatar might become stuck in the reaction forever.
- * @param {string} reactionName - reaction name
- * @returns {bool} false if the given reaction is not supported.
+ * Starts playing a reaction on the avatar. The reaction will continue to play until stopped using
+ * {@link MyAvatar.endReaction} or superseded by another reaction.
+ * Only reactions returned by {@link MyAvatar.getBeginEndReactions} are available.
+ * @function MyAvatar.beginReaction + * @param {string} reactionName - The reaction to start playing. + * @returns {boolean}true if the reaction was started, false if the reaction is not supported.
*/
bool beginReaction(QString reactionName);
/**jsdoc
- * MyAvatar.endReaction
- * Used to stop a given reaction that was started via MyAvatar.beginReaction().
- * @param {string} reactionName - reaction name
- * @returns {bool} false if the given reaction is not supported.
+ * Stops playing a reaction that was started using {@link MyAvatar.beginReaction}.
+ * @function MyAvatar.endReaction
+ * @param {string} reactionName - The reaction to stop playing.
+ * @returns {boolean} true if the reaction was stopped, false if the reaction is not supported.
*/
bool endReaction(QString reactionName);
@@ -2970,19 +3028,19 @@ private:
// correctly stored in _cachedAvatarEntityBlobs. These come from loadAvatarEntityDataFromSettings() and
// setAvatarEntityData(). These changes need to be extracted from _cachedAvatarEntityBlobs and applied to
// real EntityItems.
- std::vectordirection.
* @property {Quat} [orientation] - Alternative property for specifying direction. The value is applied to the
* default direction value.
- * @property {PickType} pickType - The type of pick when getting these properties from {@link Picks.getPickProperties} or {@link Picks.getPickScriptParameters}. A ray pick's type is {@link PickType.Ray}.
- * @property {Vec3} baseScale - Returned from {@link Picks.getPickProperties} when the pick has a parent with varying scale (usually an avatar or an entity).
- * Its value is the original scale of the parent at the moment the pick was created, and is used to scale the pointer which owns this pick, if any.
+ * @property {PickType} pickType - The type of pick when getting these properties from {@link Picks.getPickProperties} or
+ * {@link Picks.getPickScriptParameters}. A ray pick's type is {@link PickType.Ray}.
+ * @property {Vec3} baseScale - Returned from {@link Picks.getPickProperties} when the pick has a parent with varying scale
+ * (usually an avatar or an entity). Its value is the original scale of the parent at the moment the pick was created, and
+ * is used to scale the pointer which owns this pick, if any.
*/
std::shared_ptrscalewithParent.
* Deprecated: This property is deprecated and will be removed.
- * @property {PickType} pickType - The type of pick when getting these properties from {@link Picks.getPickProperties} or {@link Picks.getPickScriptParameters}. A parabola pick's type is {@link PickType.Parabola}. - * @property {Vec3} baseScale - Returned from {@link Picks.getPickProperties} when the pick has a parent with varying scale (usually an avatar or an entity). - * Its value is the original scale of the parent at the moment the pick was created, and is used to rescale the pick, and/or the pointer which owns this pick, if any. + * @property {PickType} pickType - The type of pick when getting these properties from {@link Picks.getPickProperties} or + * {@link Picks.getPickScriptParameters}. A parabola pick's type is {@link PickType.Parabola}. + * @property {Vec3} baseScale - Returned from {@link Picks.getPickProperties} when the pick has a parent with varying scale + * (usually an avatar or an entity). Its value is the original scale of the parent at the moment the pick was created, and + * is used to rescale the pick and the pointer which owns this pick, if any. */ std::shared_ptrWarning: Not yet implemented.
* + * @property {FilterFlags} PICK_BYPASS_IGNORE - Allows pick to intersect entities even when their + *ignorePickIntersection property value is true. For debug purposes.
+ * Read-only.
+ *
* @property {IntersectionType} INTERSECTED_NONE - Intersected nothing. Read-only.
* @property {IntersectionType} INTERSECTED_ENTITY - Intersected an entity. Read-only.
* @property {IntersectionType} INTERSECTED_LOCAL_ENTITY - Intersected a local entity. Read-only.
@@ -87,6 +91,8 @@ class PickScriptingInterface : public QObject, public Dependency {
Q_PROPERTY(unsigned int PICK_ALL_INTERSECTIONS READ PICK_ALL_INTERSECTIONS CONSTANT)
+ Q_PROPERTY(unsigned int PICK_BYPASS_IGNORE READ PICK_BYPASS_IGNORE CONSTANT)
+
Q_PROPERTY(unsigned int INTERSECTED_NONE READ INTERSECTED_NONE CONSTANT)
Q_PROPERTY(unsigned int INTERSECTED_ENTITY READ INTERSECTED_ENTITY CONSTANT)
Q_PROPERTY(unsigned int INTERSECTED_LOCAL_ENTITY READ INTERSECTED_LOCAL_ENTITY CONSTANT)
@@ -147,19 +153,20 @@ public:
* Gets the current properties of the pick.
* @function Picks.getPickProperties
* @param {number} id - The ID of the pick.
- * @returns {Picks.RayPickProperties|Picks.ParabolaPickProperties|Picks.StylusPickProperties|Picks.CollisionPickProperties} Properties of the pick, per the pick type.
+ * @returns {Picks.RayPickProperties|Picks.ParabolaPickProperties|Picks.StylusPickProperties|Picks.CollisionPickProperties}
+ * Properties of the pick, per the pick type.
*/
Q_INVOKABLE QVariantMap getPickProperties(unsigned int uid) const;
/**jsdoc
- * Gets the parameters that were passed in to {@link Picks.createPick} to create the pick,
- * if the pick was created through a script.
- * Note that these properties do not reflect the current state of the pick.
- * See {@link Picks.getPickProperties}.
- * @function Picks.getPickScriptParameters
- * @param {number} id - The ID of the pick.
- * @returns {Picks.RayPickProperties|Picks.ParabolaPickProperties|Picks.StylusPickProperties|Picks.CollisionPickProperties} User-provided properties, per the pick type.
- */
+ * Gets the parameters that were passed in to {@link Picks.createPick} to create the pick, if the pick was created through
+ * a script. Note that these properties do not reflect the current state of the pick.
+ * See {@link Picks.getPickProperties}.
+ * @function Picks.getPickScriptParameters
+ * @param {number} id - The ID of the pick.
+ * @returns {Picks.RayPickProperties|Picks.ParabolaPickProperties|Picks.StylusPickProperties|Picks.CollisionPickProperties}
+ * Script-provided properties, per the pick type.
+ */
Q_INVOKABLE QVariantMap getPickScriptParameters(unsigned int uid) const;
/**jsdoc
@@ -282,6 +289,8 @@ public:
unsigned int getPerFrameTimeBudget() const;
void setPerFrameTimeBudget(unsigned int numUsecs);
+ static constexpr unsigned int PICK_BYPASS_IGNORE() { return PickFilter::getBitMask(PickFilter::FlagBit::PICK_BYPASS_IGNORE); }
+
public slots:
/**jsdoc
diff --git a/interface/src/raypick/PointerScriptingInterface.cpp b/interface/src/raypick/PointerScriptingInterface.cpp
index 3520aacbd0..a3aeb314e5 100644
--- a/interface/src/raypick/PointerScriptingInterface.cpp
+++ b/interface/src/raypick/PointerScriptingInterface.cpp
@@ -89,10 +89,13 @@ QVariantMap PointerScriptingInterface::getPointerScriptParameters(unsigned int u
* @property {Pointers.StylusPointerModel} [model] - Override some or all of the default stylus model properties.
* @property {boolean} [hover=false] - true if the pointer generates {@link Entities} hover events,
* false if it doesn't.
- * @property {PickType} pointerType - The type of pointer when getting these properties from {@link Pointers.getPointerProperties} or {@link Pointers.getPointerScriptParameters}. A stylus pointer's type is {@link PickType.Stylus}.
- * @property {number} [pickID] - Returned from {@link Pointers.getPointerProperties}. The ID of the pick created alongside this pointer.
+ * @property {PickType} pointerType - The type of the stylus pointer returned from {@link Pointers.getPointerProperties}
+ * or {@link Pointers.getPointerScriptParameters}. A stylus pointer's type is {@link PickType(0)|PickType.Stylus}.
+ * @property {number} [pickID] - The ID of the pick created alongside this pointer, returned from
+ * {@link Pointers.getPointerProperties}.
* @see {@link Picks.StylusPickProperties} for additional properties from the underlying stylus pick.
*/
+
/**jsdoc
* The properties of a stylus pointer model.
* @typedef {object} Pointers.StylusPointerModel
@@ -208,8 +211,10 @@ std::shared_ptrfalse if it doesn't.
* @property {Pointers.Trigger[]} [triggers=[]] - A list of ways that a {@link Controller} action or function should trigger
* events on the entity or overlay currently intersected.
- * @property {PickType} pointerType - The type of pointer when getting these properties from {@link Pointers.getPointerProperties} or {@link Pointers.getPointerScriptParameters}. A laser pointer's type is {@link PickType.Ray}.
- * @property {number} [pickID] - Returned from {@link Pointers.getPointerProperties}. The ID of the pick created alongside this pointer.
+ * @property {PickType} pointerType - The type of pointer returned from {@link Pointers.getPointerProperties} or
+ * {@link Pointers.getPointerScriptParameters}. A laser pointer's type is {@link PickType(0)|PickType.Ray}.
+ * @property {number} [pickID] - The ID of the pick created alongside this pointer, returned from
+ * {@link Pointers.getPointerProperties}.
* @see {@link Picks.RayPickProperties} for additional properties from the underlying ray pick.
*/
std::shared_ptrfalse if it doesn't.
* @property {Pointers.Trigger[]} [triggers=[]] - A list of ways that a {@link Controller} action or function should trigger
* events on the entity or overlay currently intersected.
- * @property {PickType} pointerType - The type of pointer when getting these properties from {@link Pointers.getPointerProperties} or {@link Pointers.getPointerScriptParameters}. A parabola pointer's type is {@link PickType.Parabola}.
- * @property {number} [pickID] - Returned from {@link Pointers.getPointerProperties}. The ID of the pick created alongside this pointer.
+ * @property {PickType} pointerType - The type of pointer returned from {@link Pointers.getPointerProperties} or
+ * {@link Pointers.getPointerScriptParameters}. A parabola pointer's type is {@link PickType(0)|PickType.Parabola}.
+ * @property {number} [pickID] - The ID of the pick created alongside this pointer, returned from
+ * {@link Pointers.getPointerProperties}.
* @see {@link Picks.ParabolaPickProperties} for additional properties from the underlying parabola pick.
*/
std::shared_ptrNote: These properties do not reflect the current state of the pointer. To get the current state
+ * of the pointer, see {@link Pointers.getPointerProperties}.
* @function Pointers.getPointerScriptParameters
* @param {number} id - The ID of the pointer.
- * @returns {Pointers.RayPointerProperties|Picks.ParabolaPointerProperties|Picks.StylusPointerProperties} User-provided properties, per the pointer type.
+ * @returns {Pointers.RayPointerProperties|Pointers.ParabolaPointerProperties|Pointers.StylusPointerProperties}
+ * Script-provided properties, per the pointer type.
*/
Q_INVOKABLE QVariantMap getPointerScriptParameters(unsigned int uid) const;
diff --git a/interface/src/scripting/AccountServicesScriptingInterface.h b/interface/src/scripting/AccountServicesScriptingInterface.h
index 3ad637d0e6..288137e166 100644
--- a/interface/src/scripting/AccountServicesScriptingInterface.h
+++ b/interface/src/scripting/AccountServicesScriptingInterface.h
@@ -46,6 +46,7 @@ class AccountServicesScriptingInterface : public QObject {
* @hifi-avatar
*
* @namespace AccountServices
+ *
* @property {string} username - The user name of the user logged in. If there is no user logged in, it is
* "Unknown user". Read-only.
* @property {boolean} loggedIn - true if the user is logged in, otherwise false.
@@ -61,6 +62,86 @@ class AccountServicesScriptingInterface : public QObject {
* — typically "https://metaverse.highfidelity.com". Read-only.
*/
+ /**jsdoc
+ * The Account API provides functions that give information on user connectivity, visibility, and asset
+ * download progress.
+ *
+ * @deprecated This API is the same as the {@link AccountServices} API and will be removed.
+ *
+ * @hifi-interface
+ * @hifi-client-entity
+ * @hifi-avatar
+ *
+ * @namespace Account
+ *
+ * @property {string} username - The user name of the user logged in. If there is no user logged in, it is
+ * "Unknown user". Read-only.
+ * @property {boolean} loggedIn - true if the user is logged in, otherwise false.
+ * Read-only.
+ * @property {string} findableBy - The user's visibility to other users:
+ *
"none" — user appears offline."friends" — user is visible only to friends."connections" — user is visible to friends and connections."all" — user is visible to everyone."https://metaverse.highfidelity.com". Read-only.
+ *
+ * @borrows AccountServices.getDownloadInfo as getDownloadInfo
+ * @borrows AccountServices.updateDownloadInfo as updateDownloadInfo
+ * @borrows AccountServices.isLoggedIn as isLoggedIn
+ * @borrows AccountServices.checkAndSignalForAccessToken as checkAndSignalForAccessToken
+ * @borrows AccountServices.logOut as logOut
+ *
+ * @borrows AccountServices.connected as connected
+ * @borrows AccountServices.disconnected as disconnected
+ * @borrows AccountServices.myUsernameChanged as myUsernameChanged
+ * @borrows AccountServices.downloadInfoChanged as downloadInfoChanged
+ * @borrows AccountServices.findableByChanged as findableByChanged
+ * @borrows AccountServices.loggedInChanged as loggedInChanged
+ */
+
+ /**jsdoc
+ * The GlobalServices API provides functions that give information on user connectivity, visibility, and asset
+ * download progress.
+ *
+ * @deprecated This API is the same as the {@link AccountServices} API and will be removed.
+ *
+ * @hifi-interface
+ * @hifi-client-entity
+ * @hifi-avatar
+ *
+ * @namespace GlobalServices
+ *
+ * @property {string} username - The user name of the user logged in. If there is no user logged in, it is
+ * "Unknown user". Read-only.
+ * @property {boolean} loggedIn - true if the user is logged in, otherwise false.
+ * Read-only.
+ * @property {string} findableBy - The user's visibility to other users:
+ * "none" — user appears offline."friends" — user is visible only to friends."connections" — user is visible to friends and connections."all" — user is visible to everyone."https://metaverse.highfidelity.com". Read-only.
+ *
+ * @borrows AccountServices.getDownloadInfo as getDownloadInfo
+ * @borrows AccountServices.updateDownloadInfo as updateDownloadInfo
+ * @borrows AccountServices.isLoggedIn as isLoggedIn
+ * @borrows AccountServices.checkAndSignalForAccessToken as checkAndSignalForAccessToken
+ * @borrows AccountServices.logOut as logOut
+ *
+ * @borrows AccountServices.connected as connected
+ * @borrows AccountServices.disconnected as disconnected
+ * @borrows AccountServices.myUsernameChanged as myUsernameChanged
+ * @borrows AccountServices.downloadInfoChanged as downloadInfoChanged
+ * @borrows AccountServices.findableByChanged as findableByChanged
+ * @borrows AccountServices.loggedInChanged as loggedInChanged
+ */
+
Q_PROPERTY(QString username READ getUsername NOTIFY myUsernameChanged)
Q_PROPERTY(bool loggedIn READ loggedIn NOTIFY loggedInChanged)
Q_PROPERTY(QString findableBy READ getFindableBy WRITE setFindableBy NOTIFY findableByChanged)
diff --git a/interface/src/scripting/DesktopScriptingInterface.cpp b/interface/src/scripting/DesktopScriptingInterface.cpp
index ae4af48cd6..f78f7853ca 100644
--- a/interface/src/scripting/DesktopScriptingInterface.cpp
+++ b/interface/src/scripting/DesktopScriptingInterface.cpp
@@ -30,21 +30,6 @@
* @property {InteractiveWindow.DockArea} LEFT - Dock to the left edge of the Interface window.
* @property {InteractiveWindow.DockArea} RIGHT - Dock to the right edge of the Interface window.
*/
-/**jsdoc
- * A docking location of an InteractiveWindow.
| Value | Name | Description |
|---|---|---|
0 | TOP | Dock to the top edge of the Interface window. |
1 | BOTTOM | Dock to the bottom edge of the Interface window. |
2 | LEFT | Dock to the left edge of the Interface window. |
3 | RIGHT | Dock to the right edge of the Interface window. |
InteractiveWindow. Used when defining the `relativePosition` property of an `InteractiveWindow`.
+ * The possible relative position anchors of an InteractiveWindow relative to the Interface window.
* @typedef {object} InteractiveWindow.RelativePositionAnchors
- * @property {InteractiveWindow.RelativePositionAnchor} NO_ANCHOR - Specifies that the position of the `InteractiveWindow` will not be relative to any part of the Interface window.
- * @property {InteractiveWindow.RelativePositionAnchor} TOP_LEFT - Specifies that the `relativePosition` of the `InteractiveWindow` will be offset from the top left of the Interface window.
- * @property {InteractiveWindow.RelativePositionAnchor} TOP_RIGHT - Specifies that the `relativePosition` of the `InteractiveWindow` will be offset from the top right of the Interface window.
- * @property {InteractiveWindow.RelativePositionAnchor} BOTTOM_RIGHT - Specifies that the `relativePosition` of the `InteractiveWindow` will be offset from the bottom right of the Interface window.
- * @property {InteractiveWindow.RelativePositionAnchor} BOTTOM_LEFT - Specifies that the `relativePosition` of the `InteractiveWindow` will be offset from the bottom left of the Interface window.
+ * @property {InteractiveWindow.RelativePositionAnchor} NO_ANCHOR - Position is not relative to any part of the Interface
+ * window.
+ * @property {InteractiveWindow.RelativePositionAnchor} TOP_LEFT - Position is offset from the top left of the Interface window.
+ * @property {InteractiveWindow.RelativePositionAnchor} TOP_RIGHT - Position is offset from the top right of the Interface
+ * window.
+ * @property {InteractiveWindow.RelativePositionAnchor} BOTTOM_RIGHT - Position offset from the bottom right of the Interface
+ * window.
+ * @property {InteractiveWindow.RelativePositionAnchor} BOTTOM_LEFT - Position is offset from the bottom left of the Interface
+ * window.
*/
static const QVariantMap RELATIVE_POSITION_ANCHOR {
{ "NO_ANCHOR", RelativePositionAnchor::NO_ANCHOR },
@@ -89,21 +78,6 @@ int DesktopScriptingInterface::getHeight() {
* @property {InteractiveWindow.PresentationMode} NATIVE - The window is displayed separately from the Interface window, as its
* own separate window.
*/
-/**jsdoc
- * A display mode for an InteractiveWindow.
| Value | Name | Description |
|---|---|---|
0 | VIRTUAL | The window is displayed inside Interface: in the desktop window in - * desktop mode or on the HUD surface in HMD mode. |
1 | NATIVE | The window is displayed separately from the Interface window, as its - * own separate window. |
Desktop API provides the dimensions of the computer screen, sets the opacity of the HUD surface, and
* enables QML and HTML windows to be shown inside or outside of Interface.
- *
+ *
* @namespace Desktop
*
* @hifi-interface
@@ -42,8 +42,8 @@
* @property {InteractiveWindow.DockAreas} DockArea - The possible docking locations of an {@link InteractiveWindow}: top,
* bottom, left, or right of the Interface window.
* Read-only.
- * @property {InteractiveWindow.RelativePositionAnchors} RelativePositionAnchor - The possible "relative position anchors" for an {@link InteractiveWindow}: top left,
- * top right, bottom right, or bottom left of the Interface window.
+ * @property {InteractiveWindow.RelativePositionAnchors} RelativePositionAnchor - The possible relative position anchors for an
+ * {@link InteractiveWindow}: none, top left, top right, bottom right, or bottom left of the Interface window.
* Read-only.
*/
class DesktopScriptingInterface : public QObject, public Dependency {
@@ -84,7 +84,7 @@ public:
* @param {string} url - The QML file that specifies the window content. The QML file can use a WebView
* control (defined by "WebView.qml" included in the Interface install) to embed an HTML web page (complete with
* EventBridge object).
- * @param {InteractiveWindow.Properties} [properties] - Initial window properties.
+ * @param {InteractiveWindow.WindowProperties} [properties] - Initial window properties.
* @returns {InteractiveWindow} A new window object.
* @example DialogsMamnager API provides facilities to work with some key dialogs.
+ *
+ * @namespace DialogsManager
+ *
+ * @hifi-interface
+ * @hifi-client-entity
+ * @hifi-avatar
+ */
+
class DialogsManagerScriptingInterface : public QObject {
Q_OBJECT
public:
DialogsManagerScriptingInterface();
static DialogsManagerScriptingInterface* getInstance();
+
+ /**jsdoc
+ * Currently performs no action.
+ * @function DialogsManager.showFeed
+ */
Q_INVOKABLE void showFeed();
public slots:
+ /**jsdoc
+ * Shows the "Goto" dialog.
+ * @function DialogsManager.showAddressBar
+ */
void showAddressBar();
+
+ /**jsdoc
+ * Hides the "Goto" dialog.
+ * @function DialogsManager.hideAddressBar
+ */
void hideAddressBar();
+
+ /**jsdoc
+ * Shows the login dialog.
+ * @function DialogsManager.showLoginDialog
+ */
void showLoginDialog();
signals:
+ /**jsdoc
+ * Triggered when the "Goto" dialog is opened or closed.
+ * Warning: Currently isn't always triggered.
+ * @function DialogsManager.addressBarShown + * @param {boolean} visible -true if the Goto dialog has been opened, false if it has been
+ * closed.
+ * @returns {Signal}
+ */
void addressBarShown(bool visible);
};
diff --git a/interface/src/scripting/PerformanceScriptingInterface.h b/interface/src/scripting/PerformanceScriptingInterface.h
index 92d4273dfb..8a7e403e5d 100644
--- a/interface/src/scripting/PerformanceScriptingInterface.h
+++ b/interface/src/scripting/PerformanceScriptingInterface.h
@@ -18,6 +18,18 @@
#include "../RefreshRateManager.h"
+/**jsdoc
+ * The Performance API provides control and information on graphics performance settings.
+ *
+ * @namespace Performance
+ *
+ * @hifi-interface
+ * @hifi-client-entity
+ * @hifi-avatar
+ *
+ * @property {Performance.PerformancePreset} performancePreset - The current graphics performance preset.
+ * @property {Performance.RefreshRateProfile} refreshRateProfile - The current refresh rate profile.
+ */
class PerformanceScriptingInterface : public QObject {
Q_OBJECT
Q_PROPERTY(PerformancePreset performancePreset READ getPerformancePreset WRITE setPerformancePreset NOTIFY settingsChanged)
@@ -25,6 +37,23 @@ class PerformanceScriptingInterface : public QObject {
public:
+ /**jsdoc
+ * Graphics performance presets.
+ *| Value | Name | Description | + *
|---|---|---|
0 | UNKNOWN | Custom settings of world detail, rendering effects, and refresh + * rate. |
1 | LOW | Low world detail, no rendering effects, lo refresh rate. |
2 | MID | Medium world detail, some rendering effects, medium refresh + * rate. |
3 | HIGH | Maximum world detail, all rendering effects, high refresh rate. |
Refresh rate profile.
+ *| Value | Name | Description | + *
|---|---|---|
0 | ECO | Low refresh rate, which is reduced when Interface doesn't have focus or + * is minimized. |
1 | INTERACTIVE | Medium refresh rate, which is reduced when Interface doesn't have + * focus or is minimized. |
2 | REALTIME | High refresh rate, even when Interface doesn't have focus or is + * minimized. |
Rates API provides some information on current rendering performance.
+ *
+ * @namespace Rates
+ *
+ * @hifi-interface
+ * @hifi-client-entity
+ * @hifi-avatar
+ *
+ * @property {number} render - The rate at which new GPU frames are being created, in Hz.
+ * Read-only.
+ * @property {number} present - The rate at which the display plugin is presenting to the display device, in Hz.
+ * Read-only.
+ * @property {number} newFrame - The rate at which the display plugin is presenting new GPU frames, in Hz.
+ * Read-only.
+ * @property {number} dropped - The rate at which the display plugin is dropping GPU frames, in Hz.
+ * Read-only.
+ * @property {number} simulation - The rate at which the game loop is running, in Hz.
+ * Read-only.
+ *
+ * @example 0, the
* full resolution is used (window dimensions in desktop mode; HMD display dimensions in HMD mode), otherwise one of the
* dimensions is adjusted in order to match the aspect ratio.
- * @param {string} [filename=""] - If a filename is not provided, the image is saved as "hifi-snap-by-<user
+ * @param {string} [filename=""] - If a filename is not provided, the image is saved as "vircadia-snap-by-<user
* name>-on-YYYY-MM-DD_HH-MM-SS".
* Still images are saved in JPEG or PNG format according to the extension provided — ".jpg",
* ".jpeg", or ".png" — or if not provided then in JPEG format with an extension of
@@ -364,7 +364,7 @@ public slots:
* @function Window.takeSecondaryCameraSnapshot
* @param {boolean} [notify=true] - This value is passed on through the {@link Window.stillSnapshotTaken|stillSnapshotTaken}
* signal.
- * @param {string} [filename=""] - If a filename is not provided, the image is saved as "hifi-snap-by-<user
+ * @param {string} [filename=""] - If a filename is not provided, the image is saved as "vircadia-snap-by-<user
* name>-on-YYYY-MM-DD_HH-MM-SS".
*
Images are saved in JPEG or PNG format according to the extension provided — ".jpg",
* ".jpeg", or ".png" — or if not provided then in JPEG format with an extension of
@@ -383,7 +383,7 @@ public slots:
* otherwise it is saved as an equirectangular image.
* @param {boolean} [notify=true] - This value is passed on through the {@link Window.stillSnapshotTaken|stillSnapshotTaken}
* signal.
- * @param {string} [filename=""] - If a filename is not provided, the image is saved as "hifi-snap-by-<user
+ * @param {string} [filename=""] - If a filename is not provided, the image is saved as "vircadia-snap-by-<user
* name>-on-YYYY-MM-DD_HH-MM-SS".
*
Images are saved in JPEG or PNG format according to the extension provided — ".jpg",
* ".jpeg", or ".png" — or if not provided then in JPEG format with an extension of
@@ -818,8 +818,12 @@ signals:
/**jsdoc
* Triggered when "minimized" state of the Interface window changes.
* @function Window.minimizedChanged
- * @param {bool} isMinimized - true if the Interface window is now minimized; false otherwise.
+ * @param {boolean} isMinimized - true if the Interface window is minimized, false if it isn't.
* @returns {Signal}
+ * @example
InteractiveWindow.
- * @typedef {object} InteractiveWindow.Properties
+ * Property values used when creating an InteractiveWindow.
+ * @typedef {object} InteractiveWindow.WindowProperties
* @property {string} [title="InteractiveWindow] - The title of the window.
* @property {Vec2} [position] - The initial position of the window, in pixels.
* @property {Vec2} [size] - The initial size of the window, in pixels
@@ -142,13 +142,36 @@ void InteractiveWindow::emitMainWindowResizeEvent() {
* @property {InteractiveWindow.PresentationWindowInfo} [presentationWindowInfo] - Controls how a NATIVE window is
* displayed. If used, the window is docked to the specified edge of the Interface window, otherwise the window is
* displayed as its own separate window.
- * @property {InteractiveWindow.AdditionalFlags} [additionalFlags=0] - Window behavior flags in addition to "native window flags" (minimize/maximize/close),
- * set at window creation. Possible flag values are provided as {@link Desktop|Desktop.ALWAYS_ON_TOP} and {@link Desktop|Desktop.CLOSE_BUTTON_HIDES}.
- * Additional flag values can be found on Qt's website at https://doc.qt.io/qt-5/qt.html#WindowType-enum.
- * @property {InteractiveWindow.OverrideFlags} [overrideFlags=0] - Window behavior flags instead of the default window flags.
- * Set at window creation. Possible flag values are provided as {@link Desktop|Desktop.ALWAYS_ON_TOP} and {@link Desktop|Desktop.CLOSE_BUTTON_HIDES}.
- * Additional flag values can be found on Qt's website at https://doc.qt.io/qt-5/qt.html#WindowType-enum.
+ * @property {InteractiveWindow.Flags} [additionalFlags=0] - Customizes window behavior.
+ * @property {InteractiveWindow.OverrideFlags} [overrideFlags=0] - Customizes window controls.
+
+ * @property {InteractiveWindow.RelativePositionAnchor} [relativePositionAnchor] - The anchor for the
+ * relativePosition, if used.
+ * @property {Vec2} [relativePosition] - The position of the window, relative to the relativePositionAnchor, in
+ * pixels. Excludes the window frame.
+ * @property {boolean} [isFullScreenWindow] - true to make the window full screen.
*/
+/**jsdoc
+ * A set of flags customizing InteractiveWindow controls. The value is constructed by using the |
+ * (bitwise OR) operator on the individual flag values..
| Value | Name | Description | |
|---|---|---|---|
0x00000001 | Window | Displays the window as a window rather than a dialog. | |
0x00001000 | WindowTitleHint | Adds a title bar. | + * |
0x00002000 | WindowSystemMenuHint | Adds a window system menu. | + * |
0x00004000 | WindowMinimizeButtonHint | Adds a minimize button. | + * |
0x00008000 | WindowMaximizeButtonHint | Adds a maximize button. | + * |
0x00040000 | WindowStaysOnTopHint | The window stays on top of other windows. + * Not used on Windows. + * | |
0x08000000 | WindowCloseButtonHint | Adds a close button. | + * |
A display mode for an InteractiveWindow.
| Value | Name | Description |
|---|---|---|
0 | VIRTUAL | The window is displayed inside Interface: in the desktop window in + * desktop mode or on the HUD surface in HMD mode. |
1 | NATIVE | The window is displayed separately from the Interface window, as its + * own separate window. |
A docking location of an InteractiveWindow.
| Value | Name | Description |
|---|---|---|
0 | TOP | Dock to the top edge of the Interface window. |
1 | BOTTOM | Dock to the bottom edge of the Interface window. |
2 | LEFT | Dock to the left edge of the Interface window. |
3 | RIGHT | Dock to the right edge of the Interface window. |
The anchor for a relative position of an InteractiveWindow.
| Value | Name | Description |
|---|---|---|
0 | NO_ANCHOR | Position is not relative to any part of the Interface window. |
1 | TOP_LEFT | Position is offset from the top left of the Interface window. |
2 | TOP_RIGHT | Position is offset from the top right of the Interface window. |
3 | BOTTOM_RIGHT | Position offset from the bottom right of the Interface + * window. |
4 | BOTTOM_LEFFT | Position is offset from the bottom left of the Interface + * window. |
Create using {@link Desktop.createWindow}.
* * @class InteractiveWindow + * @hideconstructor * * @hifi-interface * @hifi-client-entity * @hifi-avatar * * @property {string} title - The title of the window. - * @property {Vec2} position - The position of the window, in pixels. + * @property {Vec2} position - The absolute position of the window, in pixels. + * @property {InteractiveWindow.RelativePositionAnchor} relativePositionAnchor - The anchor for the + *relativePosition, if used.
+ * @property {Vec2} relativePosition - The position of the window, relative to the relativePositionAnchor, in
+ * pixels. Excludes the window frame.
* @property {Vec2} size - The size of the window, in pixels.
* @property {boolean} visible - true if the window is visible, false if it isn't.
* @property {InteractiveWindow.PresentationMode} presentationMode - The presentation mode of the window:
@@ -186,24 +239,24 @@ public slots:
* @example EventBridge that is automatically provided to the script:
+ * EventBridge that is automatically provided for the script:
* EventBridge.scriptEventReceived.connect(function(message) {
* ...
* });Stats API provides statistics on Interface and domain operation, per the statistics overlay.
+ *
+ * Note: This API is primarily an internal diagnostics tool and is provided "as is".
+ * * @namespace Stats * * @hifi-interface @@ -32,159 +36,422 @@ private: \ * @hifi-server-entity * @hifi-assignment-client * - * @property {boolean} expanded - * @property {boolean} timingExpanded - Read-only. - * @property {string} monospaceFont - Read-only. + * @property {boolean} expanded -true if the statistics overlay should be in expanded form when the overlay is
+ * displayed, false if it shouldn't be expanded.
+ * @property {boolean} timingExpanded - true if timing details should be displayed when the statistics overlay is
+ * displayed in expanded form, false if timing details should not be displayed. Set by the menu item,
+ * Developer > Timing > Performance Timer > Display Timing Details.
+ * Read-only.
+ * @property {string} monospaceFont - The name of the monospace font used in the statistics overlay.
+ * Read-only.
*
- * @property {number} serverCount - Read-only.
- * @property {number} renderrate - How often the app is creating new gpu::Frames. Read-only.
- * @property {number} presentrate - How often the display plugin is presenting to the device. Read-only.
- * @property {number} stutterrate - How often the display device is reprojecting old frames. Read-only.
+ * @property {number} serverCount - The number of servers that Interface is connected to.
+ * Read-only.
+ * @property {number} renderrate - The rate at which new GPU frames are being created, in Hz.
+ * Read-only.
+ * @property {number} presentrate - The rate at which the display plugin is presenting to the display device, in Hz.
+ * Read-only.
+ * @property {number} stutterrate - The rate at which the display plugin is reprojecting old GPU frames, in Hz.
+ * Read-only.
*
- * @property {number} appdropped - Read-only.
- * @property {number} longsubmits - Read-only.
- * @property {number} longrenders - Read-only.
- * @property {number} longframes - Read-only.
+ * @property {number} appdropped - The number of times a frame has not been provided to the display device in time.
+ * Read-only.
+ * @property {number} longsubmits - The number of times the display device has taken longer than 11ms to return after being
+ * given a frame.
+ * Read-only.
+ * @property {number} longrenders - The number of times it has taken longer than 11ms to submit a new frame to the display
+ * device.
+ * Read-only.
+ * @property {number} longframes - The number of times longsubmits + longrenders has taken longer than 15ms.
+ * Read-only.
*
- * @property {number} presentnewrate - Read-only.
- * @property {number} presentdroprate - Read-only.
- * @property {number} gameLoopRate - Read-only.
- * @property {number} avatarCount - Read-only.
- * @property {number} heroAvatarCount - Read-only.
- * @property {number} physicsObjectCount - Read-only.
- * @property {number} updatedAvatarCount - Read-only.
- * @property {number} updatedHeroAvatarCount - Read-only.
- * @property {number} notUpdatedAvatarCount - Read-only.
- * @property {number} packetInCount - Read-only.
- * @property {number} packetOutCount - Read-only.
- * @property {number} mbpsIn - Read-only.
- * @property {number} mbpsOut - Read-only.
- * @property {number} assetMbpsIn - Read-only.
- * @property {number} assetMbpsOut - Read-only.
- * @property {number} audioPing - Read-only.
- * @property {number} avatarPing - Read-only.
- * @property {number} entitiesPing - Read-only.
- * @property {number} assetPing - Read-only.
- * @property {number} messagePing - Read-only.
- * @property {Vec3} position - Read-only.
- * @property {number} speed - Read-only.
- * @property {number} yaw - Read-only.
- * @property {number} avatarMixerInKbps - Read-only.
- * @property {number} avatarMixerInPps - Read-only.
- * @property {number} avatarMixerOutKbps - Read-only.
- * @property {number} avatarMixerOutPps - Read-only.
- * @property {number} myAvatarSendRate - Read-only.
- *
- * @property {number} audioMixerInKbps - Read-only.
- * @property {number} audioMixerInPps - Read-only.
- * @property {number} audioMixerOutKbps - Read-only.
- * @property {number} audioMixerOutPps - Read-only.
- * @property {number} audioMixerKbps - Read-only.
- * @property {number} audioMixerPps - Read-only.
- * @property {number} audioOutboundPPS - Read-only.
- * @property {number} audioSilentOutboundPPS - Read-only.
- * @property {number} audioAudioInboundPPS - Read-only.
- * @property {number} audioSilentInboundPPS - Read-only.
- * @property {number} audioPacketLoss - Read-only.
- * @property {string} audioCodec - Read-only.
- * @property {string} audioNoiseGate - Read-only.
- * @property {Vec2} audioInjectors - Read-only.
- * @property {number} entityPacketsInKbps - Read-only.
- *
- * @property {number} downloads - Read-only.
- * @property {number} downloadLimit - Read-only.
- * @property {number} downloadsPending - Read-only.
- * @property {string[]} downloadUrls - Read-only.
- * @property {number} processing - Read-only.
- * @property {number} processingPending - Read-only.
- * @property {number} triangles - Read-only.
- * @property {number} materialSwitches - Read-only.
- * @property {number} itemConsidered - Read-only.
- * @property {number} itemOutOfView - Read-only.
- * @property {number} itemTooSmall - Read-only.
- * @property {number} itemRendered - Read-only.
- * @property {number} shadowConsidered - Read-only.
- * @property {number} shadowOutOfView - Read-only.
- * @property {number} shadowTooSmall - Read-only.
- * @property {number} shadowRendered - Read-only.
- * @property {string} sendingMode - Read-only.
- * @property {string} packetStats - Read-only.
- * @property {number} lodAngle - Read-only.
- * @property {number} lodTargetFramerate - Read-only.
- * @property {string} lodStatus - Read-only.
- * @property {string} numEntityUpdates - Read-only.
- * @property {string} numNeededEntityUpdates - Read-only.
- * @property {string} timingStats - Read-only.
- * @property {string} gameUpdateStats - Read-only.
- * @property {number} serverElements - Read-only.
- * @property {number} serverInternal - Read-only.
- * @property {number} serverLeaves - Read-only.
- * @property {number} localElements - Read-only.
- * @property {number} localInternal - Read-only.
- * @property {number} localLeaves - Read-only.
- * @property {number} rectifiedTextureCount - Read-only.
- * @property {number} decimatedTextureCount - Read-only.
- * @property {number} gpuBuffers - Read-only.
- * @property {number} gpuBufferMemory - Read-only.
- * @property {number} gpuTextures - Read-only.
- * @property {number} glContextSwapchainMemory - Read-only.
- * @property {number} qmlTextureMemory - Read-only.
- * @property {number} texturePendingTransfers - Read-only.
- * @property {number} gpuTextureMemory - Read-only.
- * @property {number} gpuTextureResidentMemory - Read-only.
- * @property {number} gpuTextureFramebufferMemory - Read-only.
- * @property {number} gpuTextureResourceMemory - Read-only.
- * @property {number} gpuTextureResourceIdealMemory - Read-only.
- * @property {number} gpuTextureResourcePopulatedMemory - Read-only.
- * @property {number} gpuTextureExternalMemory - Read-only.
- * @property {string} gpuTextureMemoryPressureState - Read-only.
- * @property {number} gpuFreeMemory - Read-only.
- * @property {number} gpuFrameTime - Read-only.
- * @property {number} batchFrameTime - Read-only.
- * @property {number} engineFrameTime - Read-only.
- * @property {number} avatarSimulationTime - Read-only.
- *
- *
- * @property {number} x
- * @property {number} y
- * @property {number} z
- * @property {number} width
- * @property {number} height
- *
- * @property {number} opacity
- * @property {boolean} enabled
- * @property {boolean} visible
- *
- * @property {string} state
- * @property {object} anchors - Read-only.
- * @property {number} baselineOffset
- *
- * @property {boolean} clip
- *
- * @property {boolean} focus
- * @property {boolean} activeFocus - Read-only.
- * @property {boolean} activeFocusOnTab
- *
- * @property {number} rotation
- * @property {number} scale
- * @property {number} transformOrigin
- *
- * @property {boolean} smooth
- * @property {boolean} antialiasing
- * @property {number} implicitWidth
- * @property {number} implicitHeight
- *
- * @property {object} layer - Read-only.
+ * @property {number} presentnewrate - The rate at which the display plugin is presenting new GPU frames, in Hz.
+ * Read-only.
+ * @property {number} presentdroprate - The rate at which the display plugin is dropping GPU frames, in Hz.
+ * Read-only.
- * @property {number} stylusPicksCount - Read-only.
- * @property {number} rayPicksCount - Read-only.
- * @property {number} parabolaPicksCount - Read-only.
- * @property {number} collisionPicksCount - Read-only.
- * @property {Vec3} stylusPicksUpdated - Read-only.
- * @property {Vec3} rayPicksUpdated - Read-only.
- * @property {Vec3} parabolaPicksUpdated - Read-only.
- * @property {Vec3} collisionPicksUpdated - Read-only.
- * @property {bool} eventQueueDebuggingOn - Read-only.
+ * @property {number} gameLoopRate - The rate at which the game loop is running, in Hz.
+ * Read-only.
+ * @property {number} refreshRateTarget - The current target refresh rate, in Hz, per the current refreshRateMode
+ * and refreshRateRegime if in desktop mode; a higher rate if in VR mode.
+ * Read-only.
+ * @property {RefreshRateProfileName} refreshRateMode - The current refresh rate profile.
+ * Read-only.
+ * @property {RefreshRateRegimeName} refreshRateRegime - The current refresh rate regime.
+ * Read-only.
+ * @property {UXModeName} uxMode - The user experience (UX) mode that Interface is running in.
+ * Read-only.
+ * @property {number} avatarCount - The number of avatars in the domain other than the client's.
+ * Read-only.
+ * @property {number} heroAvatarCount - The number avatars in a "hero" zone in the domain, other than the client's.
+ * Read-only.
+ * @property {number} physicsObjectCount - The number of objects that have collisions enabled.
+ * Read-only.
+ * @property {number} updatedAvatarCount - The number of avatars in the domain, other than the client's, that were updated in
+ * the most recent game loop.
+ * Read-only.
+ * @property {number} updatedHeroAvatarCount - The number of avatars in a "hero" zone in the domain, other than the client's,
+ * that were updated in the most recent game loop.
+ * Read-only.
+ * @property {number} notUpdatedAvatarCount - The number of avatars in the domain, other than the client's, that weren't able
+ * to be updated in the most recent game loop because there wasn't enough time to.
+ * Read-only.
+ * @property {number} packetInCount - The number of packets being received from the domain server, in packets per second.
+ * Read-only.
+ * @property {number} packetOutCount - The number of packets being sent to the domain server, in packets per second.
+ * Read-only.
+ * @property {number} mbpsIn - The amount of data being received from the domain server, in megabits per second.
+ * Read-only.
+ * @property {number} mbpsOut - The amount of data being sent to the domain server, in megabits per second.
+ * Read-only.
+ @property {number} assetMbpsIn - The amount of data being received from the asset server, in megabits per second.
+ * 0.0 if not connected to an avatar mixer.
+ * Read-only.
+ * @property {number} assetMbpsOut - The amount of data being sent to the asset server, in megabits per second.
+ * 0.0 if not connected to an avatar mixer.
+ * Read-only.
+ * @property {number} audioPing - The ping time to the audio mixer, in ms.
+ * -1 if not connected to an audio mixer.
+ * Read-only.
+ * @property {number} avatarPing - The ping time to the avatar mixer, in ms.
+ * -1 if not connected to an avatar mixer.
+ * Read-only.
+ * @property {number} entitiesPing - The average ping time to the entity servers, in ms.
+ * -1 if not connected to an entity server.
+ * Read-only.
+ * @property {number} assetPing - The ping time to the asset server, in ms.
+ * -1 if not connected to an asset server.
+ * Read-only.
+ * @property {number} messagePing - The ping time to the message mixer, in ms.
+ * -1 if not connected to a message mixer.
+ * Read-only.
+ * @property {Vec3} position - The position of the user's avatar.
+ * Read-only.
+ * Note: Property not available in the API.
+ * @property {number} speed - The speed of the user's avatar, in m/s. + * Read-only. + * @property {number} yaw - The yaw of the user's avatar body, in degrees. + * Read-only. + * @property {number} avatarMixerInKbps - The amount of data being received from the avatar mixer, in kilobits per second. + *-1 if not connected to an avatar mixer.
+ * Read-only.
+ * @property {number} avatarMixerInPps - The number of packets being received from the avatar mixer, in packets per second.
+ * -1 if not connected to an avatar mixer.
+ * Read-only.
+ * @property {number} avatarMixerOutKbps - The amount of data being sent to the avatar mixer, in kilobits per second.
+ * -1 if not connected to an avatar mixer.
+ * Read-only.
+ * @property {number} avatarMixerOutPps - The number of packets being sent to the avatar mixer, in packets per second.
+ * -1 if not connected to an avatar mixer.
+ * Read-only.
+ * @property {number} myAvatarSendRate - The number of avatar packets being sent by the user's avatar, in packets per second.
+ * Read-only.
+ *
+ * @property {number} audioMixerInKbps - The amount of data being received from the audio mixer, in kilobits per second.
+ * -1 if not connected to an audio mixer.
+ * Read-only.
+ * @property {number} audioMixerInPps - The number of packets being received from the audio mixer, in packets per second.
+ * -1 if not connected to an audio mixer.
+ * Read-only.
+ * @property {number} audioMixerOutKbps - The amount of data being sent to the audio mixer, in kilobits per second.
+ * -1 if not connected to an audio mixer.
+ * Read-only.
+ * @property {number} audioMixerOutPps - The number of packets being sent to the audio mixer, in packets per second.
+ * -1 if not connected to an audio mixer.
+ * Read-only.
+ * @property {number} audioMixerKbps - The total amount of data being sent to and received from the audio mixer, in kilobits
+ * per second.
+ * -1 if not connected to an audio mixer.
+ * Read-only.
+ * @property {number} audioMixerPps - The total number of packets being sent to and received from the audio mixer, in packets
+ * per second.
+ * -1 if not connected to an audio mixer.
+ * Read-only.
+ * @property {number} audioOutboundPPS - The number of non-silent audio packets being sent by the user, in packets per second.
+ * -1 if not connected to an audio mixer.
+ * Read-only.
+ * @property {number} audioSilentOutboundPPS - The number of silent audio packets being sent by the user, in packets per
+ * second.
+ * -1 if not connected to an audio mixer.
+ * Read-only.
+ * @property {number} audioInboundPPS - The number of non-silent audio packets being received by the user, in packets per
+ * second.
+ * -1 if not connected to an audio mixer.
+ * Read-only.
+ * @property {number} audioAudioInboundPPS - The number of non-silent audio packets being received by the user, in packets per
+ * second.
+ * -1 if not connected to an audio mixer.
+ * Read-only.
+ * Deprecated: This property is deprecated and will be removed. Use audioInboundPPS
+ * instead.
-1 if not connected to an audio mixer.
+ * Read-only.
+ * @property {number} audioPacketLoss - The number of audio packets being lost, sent to or received from the audio mixer, in %.
+ * -1 if not connected to an audio mixer.
+ * Read-only.
+ * @property {string} audioCodec - The name of the audio codec.
+ * Read-only.
+ * @property {string} audioNoiseGate - The status of the audio noise gate: "Open" or "Closed".
+ * Read-only.
+ * @property {Vec2} audioInjectors - The number of audio injectors, local and non-local.
+ * Read-only.
+ * Note: Property not available in the API.
+ * @property {number} entityPacketsInKbps - The average amount of data being received from entity servers, in kilobits per + * second. (Multiply by the number of entity servers to get the total amount of data being received.) + *-1 if not connected to an entity server.
+ * Read-only.
+ *
+ * @property {number} downloads - The number of downloads in progress.
+ * Read-only.
+ * @property {number} downloadLimit - The maximum number of concurrent downloads.
+ * Read-only.
+ * @property {number} downloadsPending - The number of downloads pending.
+ * Read-only.
+ * @property {string[]} downloadUrls - The download URLs.
+ * Read-only.
+ * Note: Property not available in the API.
+ * @property {number} processing - The number of completed downloads being processed. + * Read-only. + * @property {number} processingPending - The number of completed downloads waiting to be processed. + * Read-only. + * @property {number} triangles - The number of triangles in the rendered scene. + * Read-only. + * @property {number} drawcalls - The number of draw calls made for the rendered scene. + * Read-only. + * @property {number} materialSwitches - The number of material switches performed for the rendered scene. + * Read-only. + * @property {number} itemConsidered - The number of item considerations made for rendering. + * Read-only. + * @property {number} itemOutOfView - The number of items out of view. + * Read-only. + * @property {number} itemTooSmall - The number of items too small to render. + * Read-only. + * @property {number} itemRendered - The number of items rendered. + * Read-only. + * @property {number} shadowConsidered - The number of shadow considerations made for rendering. + * Read-only. + * @property {number} shadowOutOfView - The number of shadows out of view. + * Read-only. + * @property {number} shadowTooSmall - The number of shadows too small to render. + * Read-only. + * @property {number} shadowRendered - The number of shadows rendered. + * Read-only. + * @property {string} sendingMode - Description of the octree sending mode. + * Read-only. + * @property {string} packetStats - Description of the octree packet processing state. + * Read-only. + * @property {number} lodAngle - The target LOD angle, in degrees. + * Read-only. + * @property {number} lodTargetFramerate - The target LOD frame rate, in Hz. + * Read-only. + * @property {string} lodStatus - Description of the current LOD. + * Read-only. + * @property {string} numEntityUpdates - The number of entity updates that happened last frame. + * Read-only. + * @property {string} numNeededEntityUpdates - The total number of entity updates scheduled for last frame. + * Read-only. + * @property {string} timingStats - Details of the average time (ms) spent in and number of calls made to different parts of + * the code. Provided only iftimingExpanded is true. Only the top 10 items are provided if
+ * Developer > Timing > Performance Timer > Only Display Top 10 is enabled.
+ * Read-only.
+ * @property {string} gameUpdateStats - Details of the average time (ms) spent in different parts of the game loop.
+ * Read-only.
+ * @property {number} serverElements - The total number of elements in the server octree.
+ * Read-only.
+ * @property {number} serverInternal - The number of internal elements in the server octree.
+ * Read-only.
+ * @property {number} serverLeaves - The number of leaf elements in the server octree.
+ * Read-only.
+ * @property {number} localElements - The total number of elements in the client octree.
+ * Read-only.
+ * @property {number} localInternal - The number of internal elements in the client octree.
+ * Read-only.
+ * @property {number} localLeaves - The number of leaf elements in the client octree.
+ * Read-only.
+ * @property {number} rectifiedTextureCount - The number of textures that have been resized so that their dimensions is a power
+ * of 2 if smaller than 128 pixels, or a multiple of 128 if greater than 128 pixels.
+ * Read-only.
+ * @property {number} decimatedTextureCount - The number of textures that have been reduced in size because they were over the
+ * maximum allowed dimensions of 4096 pixels on desktop or 2048 pixels on mobile.
+ * Read-only.
+ * @property {number} gpuBuffers - The number of OpenGL buffer objects managed by the GPU back-end.
+ * Read-only.
+ * @property {number} gpuBufferMemory - The total memory size of the gpuBuffers, in MB.
+ * Read-only.
+ * @property {number} gpuTextures - The number of OpenGL textures managed by the GPU back-end. This is the sum of the number of
+ * textures managed for gpuTextureResidentMemory, gpuTextureResourceMemory, and
+ * gpuTextureFramebufferMemory.
+ * Read-only.
+ * @property {number} gpuTextureMemory - The total memory size of the gpuTextures, in MB. This is the sum of
+ * gpuTextureResidentMemory, gpuTextureResourceMemory, and
+ * gpuTextureFramebufferMemory.
+ * Read-only.
+ * @property {number} glContextSwapchainMemory - The estimated memory used by the default OpenGL frame buffer, in MB.
+ * Read-only.
+ * @property {number} qmlTextureMemory - The memory size of textures managed by the offscreen QML surface, in MB.
+ * Read-only.
+ * @property {number} texturePendingTransfers - The memory size of textures pending transfer to the GPU, in MB.
+ * Read-only.
+ * @property {number} gpuTextureResidentMemory - The memory size of the "strict" textures that always have their full
+ * resolution in GPU memory, in MB.
+ * Read-only.
+ * @property {number} gpuTextureFramebufferMemory - The memory size of the frame buffer on the GPU, in MB.
+ * Read-only.
+ * @property {number} gpuTextureResourceMemory - The amount of GPU memory that has been allocated for "variable" textures that
+ * don't necessarily always have their full resolution in GPU memory, in MB.
+ * Read-only.
+ * @property {number} gpuTextureResourceIdealMemory - The amount of memory that "variable" textures would take up if they were
+ * all completely loaded, in MB.
+ * Read-only.
+ * @property {number} gpuTextureResourcePopulatedMemory - How much of the GPU memory allocated has actually been populated, in
+* MB.
+ * Read-only.
+ * @property {string} gpuTextureMemoryPressureState - The stats of the texture transfer engine.
+ * "Undersubscribed": There is texture data that can fit in memory but that isn't on the GPU, so more
+ * GPU texture memory should be allocated if possible."Transfer": More GPU texture memory has been allocated and texture data is being transferred."Idle": Either all texture data has been transferred to the GPU or there is nor more space
+ * available.Note: This is not a reliable number because OpenGL doesn't have an official method of getting this + * information.
+ * @property {number} gpuTextureExternalMemory - The estimated amount of memory consumed by textures being used but that are + * not managed by the GPU library, in MB. + * Read-only. + * @property {Vec2} gpuFrameSize - The dimensions of the frames being rendered, in pixels. + * Read-only. + *Note: Property not available in the API.
+ * @property {number} gpuFrameTime - The time the GPU is spending on a frame, in ms. + * Read-only. + * @property {number} gpuFrameTimePerPixel - The time the GPU is spending on a pixel, in ns. + * Read-only. + * @property {number} batchFrameTime - The time being spent batch processing each frame, in ms. + * Read-only. + * @property {number} engineFrameTime - The time being spent in the render engine each frame, in ms. + * Read-only. + * @property {number} avatarSimulationTime - The time being spent simulating avatars each frame, in ms. + * Read-only. + * + * @property {number} stylusPicksCount - The number of stylus picks currently in effect. + * Read-only. + * @property {number} rayPicksCount - The number of ray picks currently in effect. + * Read-only. + * @property {number} parabolaPicksCount - The number of parabola picks currently in effect. + * Read-only. + * @property {number} collisionPicksCount - The number of collision picks currently in effect. + * Read-only. + * @property {Vec3} stylusPicksUpdated - The number of stylus pick intersection that were found in the most recent game loop: + *x = entity intersections.y = avatar intersections.z = HUD intersections.Note: Property not available in the API.
+ * @property {Vec3} rayPicksUpdated - The number of ray pick intersections that were found in the most recent game loop: + *x = entity intersections.y = avatar intersections.z = HUD intersections.Note: Property not available in the API.
+ * @property {Vec3} parabolaPicksUpdated - The number of parabola pick intersections that were found in the most recent game + * loop: + *x = entity intersections.y = avatar intersections.z = HUD intersections.Note: Property not available in the API.
+ * @property {Vec3} collisionPicksUpdated - The number of collision pick intersections that were found in the most recent game + * loop: + *x = entity intersections.y = avatar intersections.z = HUD intersections.Note: Property not available in the API.
+ * + * @property {boolean} eventQueueDebuggingOn -true if event queue statistics are provided, false if
+ * they're not.
+ * Read-only.
+ * @property {number} mainThreadQueueDepth - The number of events in the main thread's event queue.
+ * Only provided if eventQueueDebuggingOn is true.
+ * Read-only.
+ * @property {number} nodeListThreadQueueDepth - The number of events in the node list thread's event queue.
+ * Only provided if eventQueueDebuggingOn is true.
+ * Read-only.
+ *
+ * @comment The following property is from Stats.qml. It shouldn't be in the API.
+ * @property {string} bgColor
+ * Read-only.
+ * Deprecated: This property is deprecated and will be removed.
+ * + * @comment The following properties are from QQuickItem. They shouldn't be in the API. + * @property {boolean} activeFocus + * Read-only. + *Deprecated: This property is deprecated and will be removed.
+ * @property {boolean} activeFocusOnTab + *Deprecated: This property is deprecated and will be removed.
+ * @property {object} anchors + * Read-only. + *Deprecated: This property is deprecated and will be removed.
+ * @property {boolean} antialiasing + *Deprecated: This property is deprecated and will be removed.
+ * @property {number} baselineOffset + *Deprecated: This property is deprecated and will be removed.
+ * @property {object[]} children + * Read-only. + *Note: Property not available in the API.
+ *Deprecated: This property is deprecated and will be removed.
+ * @property {boolean} clip + *Deprecated: This property is deprecated and will be removed.
+ * @property {object} containmentMask + *Deprecated: This property is deprecated and will be removed.
+ * @property {boolean} enabled + *Deprecated: This property is deprecated and will be removed.
+ * @property {boolean} focus + *Deprecated: This property is deprecated and will be removed.
+ * @property {number} height + *Deprecated: This property is deprecated and will be removed.
+ * @property {number} implicitHeight + *Deprecated: This property is deprecated and will be removed.
+ * @property {number} implicitWidth + *Deprecated: This property is deprecated and will be removed.
+ * @property {object} layer + * Read-only. + *Deprecated: This property is deprecated and will be removed.
+ * @property {number} opacity + *Deprecated: This property is deprecated and will be removed.
+ * @property {number} rotation + *Deprecated: This property is deprecated and will be removed.
+ * @property {number} scale + *Deprecated: This property is deprecated and will be removed.
+ * @property {boolean} smooth + *Deprecated: This property is deprecated and will be removed.
+ * @property {string} state + *Deprecated: This property is deprecated and will be removed.
+ * @property {number} transformOrigin + *Deprecated: This property is deprecated and will be removed.
+ * @property {boolean} visible + *Deprecated: This property is deprecated and will be removed.
+ * @property {number} width + *Deprecated: This property is deprecated and will be removed.
+ * @property {number} x + *Deprecated: This property is deprecated and will be removed.
+ * @property {number} y + *Deprecated: This property is deprecated and will be removed.
+ * @property {number} z + *Deprecated: This property is deprecated and will be removed.
*/ // Properties from x onwards are QQuickItem properties. @@ -249,6 +516,7 @@ class Stats : public QQuickItem { STATS_PROPERTY(int, audioMixerPps, 0) STATS_PROPERTY(int, audioOutboundPPS, 0) STATS_PROPERTY(int, audioSilentOutboundPPS, 0) + STATS_PROPERTY(int, audioInboundPPS, 0) STATS_PROPERTY(int, audioAudioInboundPPS, 0) STATS_PROPERTY(int, audioSilentInboundPPS, 0) STATS_PROPERTY(int, audioPacketLoss, 0) @@ -291,6 +559,7 @@ class Stats : public QQuickItem { STATS_PROPERTY(int, localLeaves, 0) STATS_PROPERTY(int, rectifiedTextureCount, 0) STATS_PROPERTY(int, decimatedTextureCount, 0) + STATS_PROPERTY(int, gpuBuffers, 0) STATS_PROPERTY(int, gpuBufferMemory, 0) STATS_PROPERTY(int, gpuTextures, 0) @@ -356,37 +625,35 @@ public: QStringList downloadUrls () { return _downloadUrls; } public slots: + + /**jsdoc + * Updates statistics to make current values available to scripts even though the statistics overlay may not be displayed. + * (Many statistics values are normally updated only if the statistics overlay is displayed.) + *Note: Not all statistics values are updated when the statistics overlay isn't displayed or + * expanded.
+ * @function Stats.forceUpdateStats + * @examplelongsubmits property changes.
- * @function Stats.longsubmitsChanged
- * @returns {Signal}
- */
- void longsubmitsChanged();
-
- /**jsdoc
- * Triggered when the value of the longrenders property changes.
- * @function Stats.longrendersChanged
- * @returns {Signal}
- */
- void longrendersChanged();
-
- /**jsdoc
- * Triggered when the value of the longframes property changes.
- * @function Stats.longframesChanged
- * @returns {Signal}
- */
- void longframesChanged();
-
- /**jsdoc
- * Triggered when the value of the appdropped property changes.
- * @function Stats.appdroppedChanged
- * @returns {Signal}
- */
- void appdroppedChanged();
+ // Signals for properties...
/**jsdoc
* Triggered when the value of the expanded property changes.
@@ -423,6 +690,41 @@ signals:
*/
void presentrateChanged();
+ /**jsdoc
+ * Triggered when the value of the stutterrate property changes.
+ * @function Stats.stutterrateChanged
+ * @returns {Signal}
+ */
+ void stutterrateChanged();
+
+ /**jsdoc
+ * Triggered when the value of the appdropped property changes.
+ * @function Stats.appdroppedChanged
+ * @returns {Signal}
+ */
+ void appdroppedChanged();
+
+ /**jsdoc
+ * Triggered when the value of the longsubmits property changes.
+ * @function Stats.longsubmitsChanged
+ * @returns {Signal}
+ */
+ void longsubmitsChanged();
+
+ /**jsdoc
+ * Triggered when the value of the longrenders property changes.
+ * @function Stats.longrendersChanged
+ * @returns {Signal}
+ */
+ void longrendersChanged();
+
+ /**jsdoc
+ * Triggered when the value of the longframes property changes.
+ * @function Stats.longframesChanged
+ * @returns {Signal}
+ */
+ void longframesChanged();
+
/**jsdoc
* Triggered when the value of the presentnewrate property changes.
* @function Stats.presentnewrateChanged
@@ -437,13 +739,6 @@ signals:
*/
void presentdroprateChanged();
- /**jsdoc
- * Triggered when the value of the stutterrate property changes.
- * @function Stats.stutterrateChanged
- * @returns {Signal}
- */
- void stutterrateChanged();
-
/**jsdoc
* Triggered when the value of the gameLoopRate property changes.
* @function Stats.gameLoopRateChanged
@@ -451,13 +746,6 @@ signals:
*/
void gameLoopRateChanged();
- /**jsdoc
- * Trigered when
- * @function Stats.numPhysicsBodiesChanged
- * @returns {Signal}
- */
- void physicsObjectCountChanged();
-
/**jsdoc
* Triggered when the value of the avatarCount property changes.
* @function Stats.avatarCountChanged
@@ -465,6 +753,34 @@ signals:
*/
void avatarCountChanged();
+ /**jsdoc
+ * Triggered when the value of the refreshRateTarget property changes.
+ * @function Stats.refreshRateTargetChanged
+ * @returns {Signal}
+ */
+ void refreshRateTargetChanged();
+
+ /**jsdoc
+ * Triggered when the value of the refreshRateMode property changes.
+ * @function Stats.refreshRateModeChanged
+ * @returns {Signal}
+ */
+ void refreshRateModeChanged();
+
+ /**jsdoc
+ * Triggered when the value of the refreshRateRegime property changes.
+ * @function Stats.refreshRateRegimeChanged
+ * @returns {Signal}
+ */
+ void refreshRateRegimeChanged();
+
+ /**jsdoc
+ * Triggered when the value of the uxMode property changes.
+ * @function Stats.uxModeChanged
+ * @returns {Signal}
+ */
+ void uxModeChanged();
+
/**jsdoc
* Triggered when the value of the heroAvatarCount property changes.
* @function Stats.heroAvatarCountChanged
@@ -472,6 +788,13 @@ signals:
*/
void heroAvatarCountChanged();
+ /**jsdoc
+ * Triggered when the value of the physicsObjectCount property changes.
+ * @function Stats.physicsObjectCountChanged
+ * @returns {Signal}
+ */
+ void physicsObjectCountChanged();
+
/**jsdoc
* Triggered when the value of the updatedAvatarCount property changes.
* @function Stats.updatedAvatarCountChanged
@@ -682,10 +1005,19 @@ signals:
*/
void audioSilentOutboundPPSChanged();
+ /**jsdoc
+ * Triggered when the value of the audioInboundPPS property changes.
+ * @function Stats.audioInboundPPSChanged
+ * @returns {Signal}
+ */
+ void audioInboundPPSChanged();
+
/**jsdoc
* Triggered when the value of the audioAudioInboundPPS property changes.
* @function Stats.audioAudioInboundPPSChanged
* @returns {Signal}
+ * @deprecated This signal is deprecated and will be removed. Use
+ * {@link Stats.audioInboundPPSChanged|audioInboundPPSChanged} instead.
*/
void audioAudioInboundPPSChanged();
@@ -731,7 +1063,6 @@ signals:
*/
void entityPacketsInKbpsChanged();
-
/**jsdoc
* Triggered when the value of the downloads property changes.
* @function Stats.downloadsChanged
@@ -782,11 +1113,10 @@ signals:
void trianglesChanged();
/**jsdoc
- * Triggered when the value of the drawcalls property changes.
- * This
- * @function Stats.drawcallsChanged
- * @returns {Signal}
- */
+ * Triggered when the value of the drawcalls property changes.
+ * @function Stats.drawcallsChanged
+ * @returns {Signal}
+ */
void drawcallsChanged();
/**jsdoc
@@ -901,6 +1231,20 @@ signals:
*/
void numNeededEntityUpdatesChanged();
+ /**jsdoc
+ * Triggered when the value of the timingStats property changes.
+ * @function Stats.timingStatsChanged
+ * @returns {Signal}
+ */
+ void timingStatsChanged();
+
+ /**jsdoc
+ * Triggered when the value of the gameUpdateStats property changes.
+ * @function Stats.gameUpdateStatsChanged
+ * @returns {Signal}
+ */
+ void gameUpdateStatsChanged();
+
/**jsdoc
* Triggered when the value of the serverElements property changes.
* @function Stats.serverElementsChanged
@@ -944,39 +1288,18 @@ signals:
void localLeavesChanged();
/**jsdoc
- * Triggered when the value of the timingStats property changes.
- * @function Stats.timingStatsChanged
+ * Triggered when the value of the rectifiedTextureCount property changes.
+ * @function Stats.rectifiedTextureCountChanged
* @returns {Signal}
*/
- void timingStatsChanged();
+ void rectifiedTextureCountChanged();
/**jsdoc
- * Triggered when the value of the gameUpdateStats property changes.
- * @function Stats.gameUpdateStatsChanged
+ * Triggered when the value of the decimatedTextureCount property changes.
+ * @function Stats.decimatedTextureCountChanged
* @returns {Signal}
*/
- void gameUpdateStatsChanged();
-
- /**jsdoc
- * Triggered when the value of the glContextSwapchainMemory property changes.
- * @function Stats.glContextSwapchainMemoryChanged
- * @returns {Signal}
- */
- void glContextSwapchainMemoryChanged();
-
- /**jsdoc
- * Triggered when the value of the qmlTextureMemory property changes.
- * @function Stats.qmlTextureMemoryChanged
- * @returns {Signal}
- */
- void qmlTextureMemoryChanged();
-
- /**jsdoc
- * Triggered when the value of the texturePendingTransfers property changes.
- * @function Stats.texturePendingTransfersChanged
- * @returns {Signal}
- */
- void texturePendingTransfersChanged();
+ void decimatedTextureCountChanged();
/**jsdoc
* Triggered when the value of the gpuBuffers property changes.
@@ -999,6 +1322,27 @@ signals:
*/
void gpuTexturesChanged();
+ /**jsdoc
+ * Triggered when the value of the glContextSwapchainMemory property changes.
+ * @function Stats.glContextSwapchainMemoryChanged
+ * @returns {Signal}
+ */
+ void glContextSwapchainMemoryChanged();
+
+ /**jsdoc
+ * Triggered when the value of the qmlTextureMemory property changes.
+ * @function Stats.qmlTextureMemoryChanged
+ * @returns {Signal}
+ */
+ void qmlTextureMemoryChanged();
+
+ /**jsdoc
+ * Triggered when the value of the texturePendingTransfers property changes.
+ * @function Stats.texturePendingTransfersChanged
+ * @returns {Signal}
+ */
+ void texturePendingTransfersChanged();
+
/**jsdoc
* Triggered when the value of the gpuTextureMemory property changes.
* @function Stats.gpuTextureMemoryChanged
@@ -1063,15 +1407,8 @@ signals:
void gpuFreeMemoryChanged();
/**jsdoc
- * Triggered when the value of the gpuFrameTime property changes.
- * @function Stats.gpuFrameTimeChanged
- * @returns {Signal}
- */
- void gpuFrameTimeChanged();
-
- /**jsdoc
- * Triggered when the value of the gpuFrameTime property changes.
- * @function Stats.gpuFrameTimeChanged
+ * Triggered when the value of the gpuFrameSize property changes.
+ * @function Stats.gpuFrameSizeChanged
* @returns {Signal}
*/
void gpuFrameSizeChanged();
@@ -1081,6 +1418,13 @@ signals:
* @function Stats.gpuFrameTimeChanged
* @returns {Signal}
*/
+ void gpuFrameTimeChanged();
+
+ /**jsdoc
+ * Triggered when the value of the gpuFrameTimePerPixel property changes.
+ * @function Stats.gpuFrameTimePerPixelChanged
+ * @returns {Signal}
+ */
void gpuFrameTimePerPixelChanged();
/**jsdoc
@@ -1104,250 +1448,6 @@ signals:
*/
void avatarSimulationTimeChanged();
- /**jsdoc
- * Triggered when the value of the rectifiedTextureCount property changes.
- * @function Stats.rectifiedTextureCountChanged
- * @returns {Signal}
- */
- void rectifiedTextureCountChanged();
-
- /**jsdoc
- * Triggered when the value of the decimatedTextureCount property changes.
- * @function Stats.decimatedTextureCountChanged
- * @returns {Signal}
- */
- void decimatedTextureCountChanged();
-
-
- void refreshRateTargetChanged();
-
- void refreshRateModeChanged();
-
- void refreshRateRegimeChanged();
-
- void uxModeChanged();
-
- // QQuickItem signals.
-
- /**jsdoc
- * Triggered when the parent item changes.
- * @function Stats.parentChanged
- * @param {object} parent
- * @returns {Signal}
- */
-
- /**jsdoc
- * Triggered when the value of the x property changes.
- * @function Stats.xChanged
- * @returns {Signal}
- */
-
- /**jsdoc
- * Triggered when the value of the y property changes.
- * @function Stats.yChanged
- * @returns {Signal}
- */
-
- /**jsdoc
- * Triggered when the value of the z property changes.
- * @function Stats.zChanged
- * @returns {Signal}
- */
-
- /**jsdoc
- * Triggered when the value of the width property changes.
- * @function Stats.widthChanged
- * @returns {Signal}
- */
-
- /**jsdoc
- * Triggered when the value of the height property changes.
- * @function Stats.heightChanged
- * @returns {Signal}
- */
-
- /**jsdoc
- * Triggered when the value of the opacity property changes.
- * @function Stats.opacityChanged
- * @returns {Signal}
- */
-
- /**jsdoc
- * Triggered when the value of the enabled property changes.
- * @function Stats.enabledChanged
- * @returns {Signal}
- */
-
- /**jsdoc
- * Triggered when the value of the visibleChanged property changes.
- * @function Stats.visibleChanged
- * @returns {Signal}
- */
-
- /**jsdoc
- * Triggered when the list of visible children changes.
- * @function Stats.visibleChildrenChanged
- * @returns {Signal}
- */
-
- /**jsdoc
- * Triggered when the value of the state property changes.
- * @function Stats.stateChanged
- * @paramm {string} state
- * @returns {Signal}
- */
-
- /**jsdoc
- * Triggered when the position and size of the rectangle containing the children changes.
- * @function Stats.childrenRectChanged
- * @param {Rect} childrenRect
- * @returns {Signal}
- */
-
- /**jsdoc
- * Triggered when the value of the baselineOffset property changes.
- * @function Stats.baselineOffsetChanged
- * @param {number} baselineOffset
- * @returns {Signal}
- */
-
- /**jsdoc
- * Triggered when the value of the clip property changes.
- * @function Stats.clipChanged
- * @param {boolean} clip
- * @returns {Signal}
- */
-
- /**jsdoc
- * Triggered when the value of the focus property changes.
- * @function Stats.focusChanged
- * @param {boolean} focus
- * @returns {Signal}
- */
-
- /**jsdoc
- * Triggered when the value of the activeFocus property changes.
- * @function Stats.activeFocusChanged
- * @param {boolean} activeFocus
- * @returns {Signal}
- */
-
- /**jsdoc
- * Triggered when the value of the activeFocusOnTab property changes.
- * @function Stats.activeFocusOnTabChanged
- * @param {boolean} activeFocusOnTab
- * @returns {Signal}
- */
-
- /**jsdoc
- * Triggered when the value of the rotation property changes.
- * @function Stats.rotationChanged
- * @returns {Signal}
- */
-
- /**jsdoc
- * Triggered when the value of the scaleChanged property changes.
- * @function Stats.scaleChanged
- * @returns {Signal}
- */
-
- /**jsdoc
- * Triggered when the value of the transformOrigin property changes.
- * @function Stats.transformOriginChanged
- * @param {number} transformOrigin
- * @returns {Signal}
- */
-
- /**jsdoc
- * Triggered when the value of the smooth property changes.
- * @function Stats.smoothChanged
- * @param {boolean} smooth
- * @returns {Signal}
- */
-
- /**jsdoc
- * Triggered when the value of the antialiasing property changes.
- * @function Stats.antialiasingChanged
- * @param {boolean} antialiasing
- * @returns {Signal}
- */
-
- /**jsdoc
- * Triggered when the value of the implicitWidth property changes.
- * @function Stats.implicitWidthChanged
- * @returns {Signal}
- */
-
- /**jsdoc
- * Triggered when the value of the implicitHeight property changes.
- * @function Stats.implicitHeightChanged
- * @returns {Signal}
- */
-
- /**jsdoc
- * @function Stats.windowChanged
- * @param {object} window
- * @returns {Signal}
- */
-
-
- // QQuickItem functions.
-
- /**jsdoc
- * @function Stats.grabToImage
- * @param {object} callback
- * @param {Size} [targetSize=0,0]
- * @returns {boolean}
- */
-
- /**jsdoc
- * @function Stats.contains
- * @param {Vec2} point
- * @returns {boolean}
- */
-
- /**jsdoc
- * @function Stats.mapFromItem
- * @param {object} item
- */
-
- /**jsdoc
- * @function Stats.mapToItem
- * @param {object} item
- */
-
- /**jsdoc
- * @function Stats.mapFromGlobal
- * @param {object} global
- */
-
- /**jsdoc
- * @function Stats.mapToGlobal
- * @param {object} global
- */
-
- /**jsdoc
- * @function Stats.forceActiveFocus
- * @param {number} [reason=7]
- */
-
- /**jsdoc
- * @function Stats.nextItemInFocusChain
- * @param {boolean} [forward=true]
- * @returns {object}
- */
-
- /**jsdoc
- * @function Stats.childAt
- * @param {number} x
- * @param {number} y
- * @returns {object}
- */
-
- /**jsdoc
- * @function Stats.update
- */
-
/**jsdoc
* Triggered when the value of the stylusPicksCount property changes.
* @function Stats.stylusPicksCountChanged
@@ -1405,11 +1505,11 @@ signals:
void collisionPicksUpdatedChanged();
/**jsdoc
- * Triggered when the value of the eventQueueDebuggingOn property changes.
- * @function Stats.eventQueueDebuggingOn
+ * Triggered when the value of the mainThreadQueueDepth property changes.
+ * @function Stats.mainThreadQueueDepthChanged
* @returns {Signal}
*/
- void eventQueueDebuggingOnChanged();
+ void mainThreadQueueDepthChanged();
/**jsdoc
* Triggered when the value of the nodeListThreadQueueDepth property changes.
@@ -1419,11 +1519,294 @@ signals:
void nodeListThreadQueueDepthChanged();
/**jsdoc
- * Triggered when the value of the nodeListThreadQueueDepth property changes.
- * @function Stats.nodeListThreadQueueDepth
+ * Triggered when the value of the eventQueueDebuggingOn property changes.
+ * @function Stats.eventQueueDebuggingOnChanged
* @returns {Signal}
*/
- void mainThreadQueueDepthChanged();
+ void eventQueueDebuggingOnChanged();
+
+
+ // Stats.qml signals: shouldn't be in the API.
+
+ /**jsdoc
+ * Triggered when the value of the bgColor property changes.
+ * @function Stats.bgColorChanged
+ * @returns {Signal}
+ * @deprecated This signal is deprecated and will be removed.
+ */
+
+
+ // QQuickItem signals: shouldn't be in the API.
+
+ /**jsdoc
+ * Triggered when the value of the activeFocus property changes.
+ * @function Stats.activeFocusChanged
+ * @param {boolean} activeFocus - Active focus.
+ * @returns {Signal}
+ * @deprecated This signal is deprecated and will be removed.
+ */
+
+ /**jsdoc
+ * Triggered when the value of the activeFocusOnTab property changes.
+ * @function Stats.activeFocusOnTabChanged
+ * @param {boolean} activeFocusOnTab - Active focus on tab.
+ * @returns {Signal}
+ * @deprecated This signal is deprecated and will be removed.
+ */
+
+ /**jsdoc
+ * Triggered when the value of the antialiasing property changes.
+ * @function Stats.antialiasingChanged
+ * @param {boolean} antialiasing - Antialiasing.
+ * @returns {Signal}
+ * @deprecated This signal is deprecated and will be removed.
+ */
+
+ /**jsdoc
+ * Triggered when the value of the baselineOffset property changes.
+ * @function Stats.baselineOffsetChanged
+ * @param {number} baselineOffset - Baseline offset.
+ * @returns {Signal}
+ * @deprecated This signal is deprecated and will be removed.
+ */
+
+ /**jsdoc
+ * Triggered when the value of the children property changes.
+ * @function Stats.childrenChanged
+ * @returns {Signal}
+ * @deprecated This signal is deprecated and will be removed.
+ */
+
+ /**jsdoc
+ * Triggered when the position and size of the rectangle containing the children changes.
+ * @function Stats.childrenRectChanged
+ * @param {Rect} childrenRect - Children rect.
+ * @returns {Signal}
+ * @deprecated This signal is deprecated and will be removed.
+ */
+
+
+ /**jsdoc
+ * Triggered when the value of the clip property changes.
+ * @function Stats.clipChanged
+ * @param {boolean} clip - Clip.
+ * @returns {Signal}
+ * @deprecated This signal is deprecated and will be removed.
+ */
+
+ /**jsdoc
+ * Triggered when the value of the containmentMask property changes.
+ * @function Stats.containmentMaskChanged
+ * @returns {Signal}
+ * @deprecated This signal is deprecated and will be removed.
+ */
+
+ /**jsdoc
+ * Triggered when the value of the enabled property changes.
+ * @function Stats.enabledChanged
+ * @returns {Signal}
+ * @deprecated This signal is deprecated and will be removed.
+ */
+
+ /**jsdoc
+ * Triggered when the value of the focus property changes.
+ * @function Stats.focusChanged
+ * @param {boolean} focus - Focus.
+ * @returns {Signal}
+ * @deprecated This signal is deprecated and will be removed.
+ */
+
+ /**jsdoc
+ * Triggered when the value of the height property changes.
+ * @function Stats.heightChanged
+ * @returns {Signal}
+ * @deprecated This signal is deprecated and will be removed.
+ */
+
+ /**jsdoc
+ * Triggered when the value of the implicitHeight property changes.
+ * @function Stats.implicitHeightChanged
+ * @returns {Signal}
+ * @deprecated This signal is deprecated and will be removed.
+ */
+
+ /**jsdoc
+ * Triggered when the value of the implicitWidth property changes.
+ * @function Stats.implicitWidthChanged
+ * @returns {Signal}
+ * @deprecated This signal is deprecated and will be removed.
+ */
+
+ /**jsdoc
+ * Triggered when the value of the opacity property changes.
+ * @function Stats.opacityChanged
+ * @returns {Signal}
+ * @deprecated This signal is deprecated and will be removed.
+ */
+
+ /**jsdoc
+ * Triggered when the parent item changes.
+ * @function Stats.parentChanged
+ * @param {object} parent - Parent.
+ * @returns {Signal}
+ * @deprecated This signal is deprecated and will be removed.
+ */
+
+ /**jsdoc
+ * Triggered when the value of the rotation property changes.
+ * @function Stats.rotationChanged
+ * @returns {Signal}
+ * @deprecated This signal is deprecated and will be removed.
+ */
+
+ /**jsdoc
+ * Triggered when the value of the scale property changes.
+ * @function Stats.scaleChanged
+ * @returns {Signal}
+ * @deprecated This signal is deprecated and will be removed.
+ */
+
+ /**jsdoc
+ * Triggered when the value of the smooth property changes.
+ * @function Stats.smoothChanged
+ * @param {boolean} smooth - Smooth.
+ * @returns {Signal}
+ * @deprecated This signal is deprecated and will be removed.
+ */
+
+ /**jsdoc
+ * Triggered when the value of the state property changes.
+ * @function Stats.stateChanged
+ * @paramm {string} state - State.
+ * @returns {Signal}
+ * @deprecated This signal is deprecated and will be removed.
+ */
+
+ /**jsdoc
+ * Triggered when the value of the transformOrigin property changes.
+ * @function Stats.transformOriginChanged
+ * @param {number} transformOrigin - Transformm origin.
+ * @returns {Signal}
+ * @deprecated This signal is deprecated and will be removed.
+ */
+
+ /**jsdoc
+ * Triggered when the value of the visibleChanged property changes.
+ * @function Stats.visibleChanged
+ * @returns {Signal}
+ * @deprecated This signal is deprecated and will be removed.
+ */
+
+ /**jsdoc
+ * Triggered when the list of visible children changes.
+ * @function Stats.visibleChildrenChanged
+ * @returns {Signal}
+ * @deprecated This signal is deprecated and will be removed.
+ */
+
+ /**jsdoc
+ * Triggered when the value of the width property changes.
+ * @function Stats.widthChanged
+ * @returns {Signal}
+ * @deprecated This signal is deprecated and will be removed.
+ */
+
+ /**jsdoc
+ * Triggered when the stats window changes.
+ * @function Stats.windowChanged
+ * @param {object} window - Window.
+ * @returns {Signal}
+ * @deprecated This signal is deprecated and will be removed.
+ */
+
+ /**jsdoc
+ * Triggered when the value of the x property changes.
+ * @function Stats.xChanged
+ * @returns {Signal}
+ * @deprecated This signal is deprecated and will be removed.
+ */
+
+ /**jsdoc
+ * Triggered when the value of the y property changes.
+ * @function Stats.yChanged
+ * @returns {Signal}
+ * @deprecated This signal is deprecated and will be removed.
+ */
+
+ /**jsdoc
+ * Triggered when the value of the z property changes.
+ * @function Stats.zChanged
+ * @returns {Signal}
+ * @deprecated This signal is deprecated and will be removed.
+ */
+
+
+ // QQuickItem methods: shouldn't be in the API.
+
+ /**jsdoc
+ * @function Stats.childAt
+ * @param {number} x - X.
+ * @param {number} y - Y.
+ * @returns {object}
+ * @deprecated This method is deprecated and will be removed.
+ */
+
+ /**jsdoc
+ * @function Stats.contains
+ * @param {Vec2} point - Point
+ * @returns {boolean}
+ * @deprecated This method is deprecated and will be removed.
+ */
+
+ /**jsdoc
+ * @function Stats.forceActiveFocus
+ * @param {number} [reason=7] - Reason
+ * @deprecated This method is deprecated and will be removed.
+ */
+
+ /**jsdoc
+ * @function Stats.grabToImage
+ * @param {object} callback - Callback.
+ * @param {Size} [targetSize=0,0] - Target size.
+ * @returns {boolean}
+ * @deprecated This method is deprecated and will be removed.
+ */
+
+ /**jsdoc
+ * @function Stats.mapFromGlobal
+ * @param {object} global - Global.
+ * @deprecated This method is deprecated and will be removed.
+ */
+
+ /**jsdoc
+ * @function Stats.mapFromItem
+ * @param {object} item - Item.
+ * @deprecated This method is deprecated and will be removed.
+ */
+
+ /**jsdoc
+ * @function Stats.mapToGlobal
+ * @param {object} global - Global.
+ * @deprecated This method is deprecated and will be removed.
+ */
+
+ /**jsdoc
+ * @function Stats.mapToItem
+ * @param {object} item - Item
+ * @deprecated This method is deprecated and will be removed.
+ */
+
+ /**jsdoc
+ * @function Stats.nextItemInFocusChain
+ * @param {boolean} [forward=true] - Forward.
+ * @returns {object}
+ * @deprecated This method is deprecated and will be removed.
+ */
+
+ /**jsdoc
+ * @function Stats.update
+ * @deprecated This method is deprecated and will be removed.
+ */
private:
int _recentMaxPackets{ 0 } ; // recent max incoming voxel packets to process
diff --git a/interface/src/ui/overlays/ContextOverlayInterface.h b/interface/src/ui/overlays/ContextOverlayInterface.h
index e688d1c115..5d11b254fc 100644
--- a/interface/src/ui/overlays/ContextOverlayInterface.h
+++ b/interface/src/ui/overlays/ContextOverlayInterface.h
@@ -29,6 +29,22 @@
#include "EntityTree.h"
#include "ContextOverlayLogging.h"
+/**jsdoc
+ * The ContextOverlay API manages the "i" proof-of-provenance context overlay that appears on Marketplace items
+ * when a user right-clicks them.
+ *
+ * @namespace ContextOverlay
+ *
+ * @hifi-interface
+ * @hifi-client-entity
+ * @hifi-avatar
+ *
+ * @property {boolean} enabled - true if the context overlay is enabled to be displayed, false if it
+ * is disabled and will never be displayed.
+ * @property {Uuid} entityWithContextOverlay - The ID of the entity that the context overlay is currently displayed for,
+ * null if the context overlay is not currently displayed.
+ * @property {boolean} isInMarketplaceInspectionMode - Currently not used.
+ */
class ContextOverlayInterface : public QObject, public Dependency {
Q_OBJECT
@@ -44,30 +60,140 @@ class ContextOverlayInterface : public QObject, public Dependency {
QUuid _contextOverlayID { UNKNOWN_ENTITY_ID };
public:
ContextOverlayInterface();
+
+ /**jsdoc
+ * Gets the ID of the entity that the context overlay is currently displayed for.
+ * @function ContextOverlay.getCurrentEntityWithContextOverlay
+ * @returns {Uuid} - The ID of the entity that the context overlay is currently displayed for, null if the
+ * context overlay is not currently displayed.
+ */
Q_INVOKABLE QUuid getCurrentEntityWithContextOverlay() { return _currentEntityWithContextOverlay; }
+
void setCurrentEntityWithContextOverlay(const QUuid& entityID) { _currentEntityWithContextOverlay = entityID; }
void setLastInspectedEntity(const QUuid& entityID) { _challengeOwnershipTimeoutTimer.stop(); }
void setEnabled(bool enabled);
bool getEnabled() { return _enabled; }
bool getIsInMarketplaceInspectionMode() { return _isInMarketplaceInspectionMode; }
void setIsInMarketplaceInspectionMode(bool mode) { _isInMarketplaceInspectionMode = mode; }
+
+ /**jsdoc
+ * Initiates a check on an avatar entity belongs to the user wearing it. The result is returned via
+ * {@link WalletScriptingInterface.ownershipVerificationSuccess} or
+ * {@link WalletScriptingInterface.ownershipVerificationFailed}.
+ * Warning: Neither of these signals are triggered if the entity is not an avatar entity or is not + * certified.
+ * @function ContextOverlay.requestOwnershipVerification + * @param {Uuid} entityID - The ID of the entity to check. + */ Q_INVOKABLE void requestOwnershipVerification(const QUuid& entityID); + EntityPropertyFlags getEntityPropertyFlags() { return _entityPropertyFlags; } signals: + /**jsdoc + * Triggered when the user clicks on the context overlay. + * @function ContextOverlay.contextOverlayClicked + * @param {Uuid} id - The ID of the entity that the context overlay is for. + * @returns {Signal} + * @exampletrue if the context overlay was deleted or displayed on the specified entity,
+ * false if no action was taken.
+ */
bool createOrDestroyContextOverlay(const EntityItemID& entityItemID, const PointerEvent& event);
+
+ /**jsdoc
+ * Deletes the context overlay and removes the entity highlight, if shown.
+ * @function ContextOverlay.destroyContextOverlay
+ * @param {Uuid} entityID - The ID of the entity.
+ * @param {PointerEvent} [event] - Not used.
+ * @returns {boolean} - true if the context overlay was deleted, false if it wasn't (e.g., it
+ * wasn't displayed).
+ */
bool destroyContextOverlay(const EntityItemID& entityItemID, const PointerEvent& event);
bool destroyContextOverlay(const EntityItemID& entityItemID);
+
+ /**jsdoc
+ * @function ContextOverlay.contextOverlays_hoverEnterOverlay
+ * @param {Uuid} id - Overlay ID.
+ * @param {PointerEvent} event - Pointer event.
+ * @deprecated This method is deprecated and will be removed.
+ */
+ // FIXME: Method shouldn't be in the API.
void contextOverlays_hoverEnterOverlay(const QUuid& id, const PointerEvent& event);
+
+ /**jsdoc
+ * @function ContextOverlay.contextOverlays_hoverLeaveOverlay
+ * @param {Uuid} id - Overlay ID.
+ * @param {PointerEvent} event - Pointer event.
+ * @deprecated This method is deprecated and will be removed.
+ */
+ // FIXME: Method shouldn't be in the API.
void contextOverlays_hoverLeaveOverlay(const QUuid& id, const PointerEvent& event);
+
+ /**jsdoc
+ * @function ContextOverlay.contextOverlays_hoverEnterEntity
+ * @param {Uuid} id - Entity ID.
+ * @param {PointerEvent} event - Pointer event.
+ * @deprecated This method is deprecated and will be removed.
+ */
+ // FIXME: Method shouldn't be in the API.
void contextOverlays_hoverEnterEntity(const EntityItemID& entityID, const PointerEvent& event);
+
+ /**jsdoc
+ * @function ContextOverlay.contextOverlays_hoverLeaveEntity
+ * @param {Uuid} id - Entity ID.
+ * @param {PointerEvent} event - Pointer event.
+ * @deprecated This method is deprecated and will be removed.
+ */
+ // FIXME: Method shouldn't be in the API.
void contextOverlays_hoverLeaveEntity(const EntityItemID& entityID, const PointerEvent& event);
+
+ /**jsdoc
+ * Checks with a context overlay should be displayed for an entity — in particular, whether the item has a non-empty
+ * certificate ID.
+ * @function ContextOverlay.contextOverlayFilterPassed
+ * @param {Uuid} entityID - The ID of the entity to check.
+ * @returns {boolean} - true if the context overlay should be shown for the entity, false if it
+ * shouldn't.
+ * @example