From 39ae575ef30c6f45a856e2e875ae834c7fedae29 Mon Sep 17 00:00:00 2001 From: David Rowe Date: Tue, 23 Jul 2019 11:02:43 +1200 Subject: [PATCH 1/5] Tidy entities' "unlit" properties --- libraries/entities/src/EntityItemProperties.cpp | 4 ++-- .../src/material-networking/MaterialCache.cpp | 3 ++- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/libraries/entities/src/EntityItemProperties.cpp b/libraries/entities/src/EntityItemProperties.cpp index 980cd31652..5dd29e7c34 100644 --- a/libraries/entities/src/EntityItemProperties.cpp +++ b/libraries/entities/src/EntityItemProperties.cpp @@ -1285,8 +1285,8 @@ EntityPropertyFlags EntityItemProperties::getChangedProperties() const { * @property {number} rightMargin=0.0 - The right margin, in meters. * @property {number} topMargin=0.0 - The top margin, in meters. * @property {number} bottomMargin=0.0 - The bottom margin, in meters. - * @property {boolean} unlit=false - true if the entity should be unaffected by lighting. Otherwise, the text - * is lit by the keylight and local lights. + * @property {boolean} unlit=false - true if the entity is unaffected by lighting, false if it is lit + * by the key light and local lights. * @property {BillboardMode} billboardMode="none" - Whether the entity is billboarded to face the camera. * @property {boolean} faceCamera - true if billboardMode is "yaw", false * if it isn't. Setting this property to false sets the billboardMode to "none". diff --git a/libraries/material-networking/src/material-networking/MaterialCache.cpp b/libraries/material-networking/src/material-networking/MaterialCache.cpp index fd218fe074..087e1ca049 100644 --- a/libraries/material-networking/src/material-networking/MaterialCache.cpp +++ b/libraries/material-networking/src/material-networking/MaterialCache.cpp @@ -120,7 +120,8 @@ NetworkMaterialResource::ParsedMaterials NetworkMaterialResource::parseJSONMater * Set to "fallthrough" to fall through to the material below. "hifi_pbr" model only. * @property {number|string} opacity=1.0 - The opacity, range 0.0 – 1.0. * Set to "fallthrough" to fall through to the material below. "hifi_pbr" model only. - * @property {boolean|string} unlit=false - true if the material is not lit, false if it is. + * @property {boolean|string} unlit=false - true if the material is unaffected by lighting, false if + * it is lit by the key light and local lights. * Set to "fallthrough" to fall through to the material below. "hifi_pbr" model only. * @property {ColorFloat|RGBS|string} albedo - The albedo color. A {@link ColorFloat} value is treated as sRGB and must have * component values in the range 0.0 – 1.0. A {@link RGBS} value can be either RGB or sRGB. From 6b80a272589e70bd4336c761c3c2da47332c9cd3 Mon Sep 17 00:00:00 2001 From: David Rowe Date: Tue, 23 Jul 2019 11:26:48 +1200 Subject: [PATCH 2/5] Tidy Audio API's gain properties etc. JSDoc --- interface/src/scripting/Audio.h | 34 ++++++++++++++++++--------------- 1 file changed, 19 insertions(+), 15 deletions(-) diff --git a/interface/src/scripting/Audio.h b/interface/src/scripting/Audio.h index d62fd70cc4..a313e9eaaf 100644 --- a/interface/src/scripting/Audio.h +++ b/interface/src/scripting/Audio.h @@ -66,12 +66,16 @@ class Audio : public AudioScriptingInterface, protected ReadWriteLockable { * @property {boolean} pushToTalkHMD - true if HMD push-to-talk is enabled, otherwise false. * @property {boolean} pushingToTalk - true if the user is currently pushing-to-talk, otherwise * false. - * @property {number} avatarGain - The gain (relative volume) that avatars' voices are played at. This gain is used at the server. - * @property {number} localInjectorGain - The gain (relative volume) that local injectors (local environment sounds) are played at. - * @property {number} serverInjectorGain - The gain (relative volume) that server injectors (server environment sounds) are played at. This gain is used at the server. - * @property {number} systemInjectorGain - The gain (relative volume) that system sounds are played at. - * @property {number} pushingToTalkOutputGainDesktop - The gain (relative volume) that all sounds are played at when the user is holding - * the push-to-talk key in Desktop mode. + + * @property {number} avatarGain - The gain (relative volume in dB) that avatars' voices are played at. This gain is used + * at the server. + * @property {number} localInjectorGain - The gain (relative volume in dB) that local injectors (local environment sounds) + * are played at. + * @property {number} serverInjectorGain - The gain (relative volume in dB) that server injectors (server environment + * sounds) are played at. This gain is used at the server. + * @property {number} systemInjectorGain - The gain (relative volume in dB) that system sounds are played at. + * @property {number} pushingToTalkOutputGainDesktop - The gain (relative volume in dB) that all sounds are played at when + * the user is holding the push-to-talk key in desktop mode. * * @comment The following properties are from AudioScriptingInterface.h. * @property {boolean} isStereoInput - true if the input audio is being used in stereo, otherwise @@ -295,18 +299,18 @@ public: Q_INVOKABLE bool getRecording(); /**jsdoc - * Sets the output volume gain that will be used when the user is holding the Push to Talk key. + * Sets the output volume gain that will be used when the user is holding the push-to-talk key. * Should be negative. * @function Audio.setPushingToTalkOutputGainDesktop - * @param {number} gain - The output volume gain (dB) while using PTT. + * @param {number} gain - The output volume gain (dB) while using push-to-talk. */ Q_INVOKABLE void setPushingToTalkOutputGainDesktop(float gain); /**jsdoc - * Gets the output volume gain that is used when the user is holding the Push to Talk key. + * Gets the output volume gain that is used when the user is holding the push-to-talk key. * Should be negative. * @function Audio.getPushingToTalkOutputGainDesktop - * @returns {number} gain - The output volume gain (dB) while using PTT. + * @returns {number} gain - The output volume gain (dB) while using push-to-talk. */ Q_INVOKABLE float getPushingToTalkOutputGainDesktop(); @@ -443,7 +447,7 @@ signals: /**jsdoc * Triggered when the avatar gain changes. * @function Audio.avatarGainChanged - * @param {number} gain - The new avatar gain value. + * @param {number} gain - The new avatar gain value (dB). * @returns {Signal} */ void avatarGainChanged(float gain); @@ -451,7 +455,7 @@ signals: /**jsdoc * Triggered when the local injector gain changes. * @function Audio.localInjectorGainChanged - * @param {number} gain - The new local injector gain value. + * @param {number} gain - The new local injector gain value (dB). * @returns {Signal} */ void localInjectorGainChanged(float gain); @@ -459,7 +463,7 @@ signals: /**jsdoc * Triggered when the server injector gain changes. * @function Audio.serverInjectorGainChanged - * @param {float} gain - The new server injector gain value. + * @param {number} gain - The new server injector gain value (dB). * @returns {Signal} */ void serverInjectorGainChanged(float gain); @@ -467,7 +471,7 @@ signals: /**jsdoc * Triggered when the system injector gain changes. * @function Audio.systemInjectorGainChanged - * @param {number} gain - The new system injector gain value. + * @param {number} gain - The new system injector gain value (dB). * @returns {Signal} */ void systemInjectorGainChanged(float gain); @@ -475,7 +479,7 @@ signals: /**jsdoc * Triggered when the push to talk gain changes. * @function Audio.pushingToTalkOutputGainDesktopChanged - * @param {number} gain - The new output gain value. + * @param {number} gain - The new output gain value (dB). * @returns {Signal} */ void pushingToTalkOutputGainDesktopChanged(float gain); From 8a6a4041d97e9b537d1b14ede0f98ef1597d102f Mon Sep 17 00:00:00 2001 From: David Rowe Date: Tue, 23 Jul 2019 11:28:57 +1200 Subject: [PATCH 3/5] Tidy key light property's shadow values JSDoc --- libraries/entities/src/KeyLightPropertyGroup.h | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/libraries/entities/src/KeyLightPropertyGroup.h b/libraries/entities/src/KeyLightPropertyGroup.h index facbf88f3c..6441c30d50 100644 --- a/libraries/entities/src/KeyLightPropertyGroup.h +++ b/libraries/entities/src/KeyLightPropertyGroup.h @@ -37,10 +37,10 @@ class ReadBitstreamToTreeParams; * are cast by avatars, plus {@link Entities.EntityProperties-Model|Model} and * {@link Entities.EntityProperties-Shape|Shape} entities that have their * {@link Entities.EntityProperties|canCastShadow} property set to true. - * @property {number} shadowBias=0.5 - The bias of the shadows cast by the light. Use this to fine-tune your shadows to your scene - * to prevent shadow acne and peter panning. In the range 0.0 – 1.0. - * @property {number} shadowMaxDistance=40.0 - The max distance from your view at which shadows will be computed. Higher values will - * cover more of your scene, but with less precision. In the range 1.0 – 250.0. + * @property {number} shadowBias=0.5 - The bias of the shadows cast by the light, range 0.0 – + * 1.0. This fine-tunes shadows cast by the light, to prevent shadow acne and peter panning. + * @property {number} shadowMaxDistance=40.0 - The maximum distance from the camera position at which shadows will be computed, + * range 1.0 – 250.0. Higher values cover more of the scene but with less precision. */ class KeyLightPropertyGroup : public PropertyGroup { public: From 3b2bb65c77ce446ef47a9b062cf5e9324fb3acca Mon Sep 17 00:00:00 2001 From: David Rowe Date: Tue, 23 Jul 2019 12:42:41 +1200 Subject: [PATCH 4/5] Tidy MyAvatar API's animation debug graphics methods' JSDod --- interface/src/avatar/MyAvatar.h | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/interface/src/avatar/MyAvatar.h b/interface/src/avatar/MyAvatar.h index d092122863..9c071c0415 100644 --- a/interface/src/avatar/MyAvatar.h +++ b/interface/src/avatar/MyAvatar.h @@ -2022,17 +2022,19 @@ public slots: void setEnableDebugDrawDefaultPose(bool isEnabled); /**jsdoc - * Displays animation debug graphics. By default it shows the animation poses used for rendering. - * However, the property MyAvatar.setDebugDrawAnimPoseName can be used to draw a specific animation node. + * Displays animation debug graphics. By default, the animation poses used for rendering are displayed. However, + * {@link MyAvatar.setDebugDrawAnimPoseName} can be used to set a specific animation node to display. * @function MyAvatar.setEnableDebugDrawAnimPose * @param {boolean} enabled - true to show the debug graphics, false to hide. */ void setEnableDebugDrawAnimPose(bool isEnabled); /**jsdoc - * If set it determines which animation debug graphics to draw, when MyAvatar.setEnableDebugDrawAnimPose is set to true. + * Sets the animation node to display when animation debug graphics are enabled with + * {@link MyAvatar.setEnableDebugDrawAnimPose}. * @function MyAvatar.setDebugDrawAnimPoseName - * @param {boolean} enabled - true to show the debug graphics, false to hide. + * @param {string} poseName - The name of the animation node to display debug graphics for. Use "" to reset to + * default. */ void setDebugDrawAnimPoseName(QString poseName); From 2939610eaec750f40b623c13104eee9495a08440 Mon Sep 17 00:00:00 2001 From: David Rowe Date: Tue, 6 Aug 2019 11:00:24 +1200 Subject: [PATCH 5/5] Fix link to TextEffect type --- libraries/entities/src/EntityItemProperties.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/libraries/entities/src/EntityItemProperties.cpp b/libraries/entities/src/EntityItemProperties.cpp index 28af5a3b2b..8dcf50de24 100644 --- a/libraries/entities/src/EntityItemProperties.cpp +++ b/libraries/entities/src/EntityItemProperties.cpp @@ -1311,7 +1311,7 @@ EntityPropertyFlags EntityItemProperties::getChangedProperties() const { * by the key light and local lights. * @property {string} font="" - The font to render the text with. It can be one of the following: "Courier""Inconsolata", "Roboto", "Timeless", or a path to a .sdff file. - * @property {TextEffect} textEffect="none" - The effect that is applied to the text. + * @property {Entities.TextEffect} textEffect="none" - The effect that is applied to the text. * @property {Color} textEffectColor=255,255,255 - The color of the effect. * @property {number} textEffectThickness=0.2 - The magnitude of the text effect, range 0.0 – 0.5. * @property {BillboardMode} billboardMode="none" - Whether the entity is billboarded to face the camera.