mirror of
https://github.com/JulianGro/overte.git
synced 2025-04-17 20:50:14 +02:00
Merge pull request #15959 from ctrlaltdavid/DOC-124
DOC-124: Tidy JSDoc from some recent API changes
This commit is contained in:
jennaingersoll
GitHub
commit
f487d094fe
5 changed files with 39 additions and 32 deletions
|
|
@ -2042,17 +2042,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 - <code>true</code> to show the debug graphics, <code>false</code> 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 - <code>true</code> to show the debug graphics, <code>false</code> to hide.
|
||||
* @param {string} poseName - The name of the animation node to display debug graphics for. Use <code>""</code> to reset to
|
||||
* default.
|
||||
*/
|
||||
void setDebugDrawAnimPoseName(QString poseName);
|
||||
|
||||
|
|
|
|||
|
|
@ -66,15 +66,19 @@ class Audio : public AudioScriptingInterface, protected ReadWriteLockable {
|
|||
* @property {boolean} pushToTalkHMD - <code>true</code> if HMD push-to-talk is enabled, otherwise <code>false</code>.
|
||||
* @property {boolean} pushingToTalk - <code>true</code> if the user is currently pushing-to-talk, otherwise
|
||||
* <code>false</code>.
|
||||
* @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 {boolean} acousticEchoCancellation - <code>true</code> if audio-echo-cancellation is enabled, otherwise
|
||||
* <code>false</code>. When enabled, sound from the audio output will be suppressed when it echos back to the
|
||||
* input audio signal.
|
||||
|
||||
* @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.
|
||||
* @property {boolean} acousticEchoCancellation - <code>true</code> if acoustic echo cancellation is enabled, otherwise
|
||||
* <code>false</code>. When enabled, sound from the audio output is suppressed when it echos back to the input audio
|
||||
* signal.
|
||||
*
|
||||
* @comment The following properties are from AudioScriptingInterface.h.
|
||||
* @property {boolean} isStereoInput - <code>true</code> if the input audio is being used in stereo, otherwise
|
||||
|
|
@ -301,18 +305,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();
|
||||
|
||||
|
|
@ -457,7 +461,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);
|
||||
|
|
@ -465,7 +469,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);
|
||||
|
|
@ -473,7 +477,7 @@ signals:
|
|||
/**jsdoc
|
||||
* Triggered when the server injector gain changes.
|
||||
* @function Audio.serverInjectorGainChanged
|
||||
* @param {number} gain - The new server injector gain value.
|
||||
* @param {number} gain - The new server injector gain value (dB).
|
||||
* @returns {Signal}
|
||||
*/
|
||||
void serverInjectorGainChanged(float gain);
|
||||
|
|
@ -481,7 +485,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);
|
||||
|
|
@ -489,7 +493,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);
|
||||
|
|
|
|||
|
|
@ -1307,11 +1307,11 @@ 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 - <code>true</code> if the entity should be unaffected by lighting. Otherwise, the text
|
||||
* is lit by the keylight and local lights.
|
||||
* @property {string} font="" - The text is rendered with this font. Can be one of the following: <code>Courier</code,
|
||||
* <code>Inconsolata</code>, <code>Roboto</code>, <code>Timeless</code>, or a path to a .sdff file.
|
||||
* @property {TextEffect} textEffect="none" - The effect that is applied to the text.
|
||||
* @property {boolean} unlit=false - <code>true</code> if the entity is unaffected by lighting, <code>false</code> if it is lit
|
||||
* by the key light and local lights.
|
||||
* @property {string} font="" - The font to render the text with. It can be one of the following: <code>"Courier"</code,
|
||||
* <code>"Inconsolata"</code>, <code>"Roboto"</code>, <code>"Timeless"</code>, or a path to a .sdff file.
|
||||
* @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 <code>0.0</code> – <code>0.5</code>.
|
||||
* @property {BillboardMode} billboardMode="none" - Whether the entity is billboarded to face the camera.
|
||||
|
|
|
|||
|
|
@ -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
|
||||
* <code>{@link Entities.EntityProperties|canCastShadow}</code> property set to <code>true</code>.
|
||||
* @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 <code>0.0</code> – <code>1.0</code>.
|
||||
* @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 <code>1.0</code> – <code>250.0</code>.
|
||||
* @property {number} shadowBias=0.5 - The bias of the shadows cast by the light, range <code>0.0</code> –
|
||||
* <code>1.0</code>. 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 <code>1.0</code> – <code>250.0</code>. Higher values cover more of the scene but with less precision.
|
||||
*/
|
||||
class KeyLightPropertyGroup : public PropertyGroup {
|
||||
public:
|
||||
|
|
|
|||
|
|
@ -120,7 +120,8 @@ NetworkMaterialResource::ParsedMaterials NetworkMaterialResource::parseJSONMater
|
|||
* Set to <code>"fallthrough"</code> to fall through to the material below. <code>"hifi_pbr"</code> model only.
|
||||
* @property {number|string} opacity=1.0 - The opacity, range <code>0.0</code> – <code>1.0</code>.
|
||||
* Set to <code>"fallthrough"</code> to fall through to the material below. <code>"hifi_pbr"</code> model only.
|
||||
* @property {boolean|string} unlit=false - <code>true</code> if the material is not lit, <code>false</code> if it is.
|
||||
* @property {boolean|string} unlit=false - <code>true</code> if the material is unaffected by lighting, <code>false</code> if
|
||||
* it is lit by the key light and local lights.
|
||||
* Set to <code>"fallthrough"</code> to fall through to the material below. <code>"hifi_pbr"</code> 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 <code>0.0</code> – <code>1.0</code>. A {@link RGBS} value can be either RGB or sRGB.
|
||||
|
|
|
|||
Loading…
Reference in a new issue