Mirrors/overte-Armored-Dragon
3
0
Fork 0
mirror of https://github.com/Armored-Dragon/overte.git synced 2025-03-11 16:13:16 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

fixed spacing issue

Browse source
This commit is contained in:
milad nazeri 2018-04-24 13:14:55 -07:00
parent 1121fe8da0
commit 23d07fa292
18 changed files with 926 additions and 928 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
interface/src/AvatarBookmarks.h
View file

@ -16,8 +16,8 @@
#include "Bookmarks.h" #include "Bookmarks.h"
/**jsdoc /**jsdoc
* This API helps manage adding and deleting Avatar bookmarks * This API helps manage adding and deleting Avatar bookmarks
*/ */
class AvatarBookmarks: public Bookmarks, public Dependency { class AvatarBookmarks: public Bookmarks, public Dependency {
Q_OBJECT Q_OBJECT
@ -28,13 +28,13 @@ public:
void setupMenus(Menu* menubar, MenuWrapper* menu) override; void setupMenus(Menu* menubar, MenuWrapper* menu) override;
/**jsdoc /**jsdoc
* Add the current Avatar to your Avatar Bookmarks * Add the current Avatar to your Avatar Bookmarks
* @function AvatarBookmarks.addBookMark * @function AvatarBookmarks.addBookMark
*/ */
/**jsdoc /**jsdoc
* @function AvatarBookmarks.deleteBookMark * @function AvatarBookmarks.deleteBookMark
*/ */
public slots: public slots:
void addBookmark(); void addBookmark();

8
interface/src/Bookmarks.h
View file

@ -1,4 +1,4 @@
// //
// Bookmarks.h // Bookmarks.h
// interface/src // interface/src
// //
@ -49,9 +49,9 @@ protected:
protected slots: protected slots:
/**jsdoc /**jsdoc
* Delete * Delete
* @function AvatarBookmarks.deleteBookmark * @function AvatarBookmarks.deleteBookmark
*/ */
void deleteBookmark(); void deleteBookmark();
private: private:

132
interface/src/LODManager.h
View file

@ -10,9 +10,9 @@
// //
/**jsdoc /**jsdoc
* The LOD class manages your Level of Detail functions within interface * The LOD class manages your Level of Detail functions within interface
* @namespace LODManager * @namespace LODManager
*/ */
#ifndef hifi_LODManager_h #ifndef hifi_LODManager_h
#define hifi_LODManager_h #define hifi_LODManager_h
@ -46,122 +46,122 @@ class LODManager : public QObject, public Dependency {
public: public:
/**jsdoc /**jsdoc
* @function LODManager.setAutomaticLODAdjust * @function LODManager.setAutomaticLODAdjust
* @param {boolean} value * @param {boolean} value
*/ */
Q_INVOKABLE void setAutomaticLODAdjust(bool value) { _automaticLODAdjust = value; } Q_INVOKABLE void setAutomaticLODAdjust(bool value) { _automaticLODAdjust = value; }
/**jsdoc /**jsdoc
* @function LODManager.getAutomaticLODAdjust * @function LODManager.getAutomaticLODAdjust
* @returns {boolean} * @returns {boolean}
*/ */
Q_INVOKABLE bool getAutomaticLODAdjust() const { return _automaticLODAdjust; } Q_INVOKABLE bool getAutomaticLODAdjust() const { return _automaticLODAdjust; }
/**jsdoc /**jsdoc
* @function LODManager.setDesktopLODDecreaseFPS * @function LODManager.setDesktopLODDecreaseFPS
* @param {float} value * @param {float} value
*/ */
Q_INVOKABLE void setDesktopLODDecreaseFPS(float value); Q_INVOKABLE void setDesktopLODDecreaseFPS(float value);
/**jsdoc /**jsdoc
* @function LODManager.getDesktopLODDecreaseFPS * @function LODManager.getDesktopLODDecreaseFPS
* @returns {number} * @returns {number}
*/ */
Q_INVOKABLE float getDesktopLODDecreaseFPS() const; Q_INVOKABLE float getDesktopLODDecreaseFPS() const;
/**jsdoc /**jsdoc
* @function LODManager.getDesktopLODIncreaseFPS * @function LODManager.getDesktopLODIncreaseFPS
* @returns {number} * @returns {number}
*/ */
Q_INVOKABLE float getDesktopLODIncreaseFPS() const; Q_INVOKABLE float getDesktopLODIncreaseFPS() const;
/**jsdoc /**jsdoc
* @function LODManager.setHMDLODDecreaseFPS * @function LODManager.setHMDLODDecreaseFPS
* @param {number} value * @param {number} value
*/ */
Q_INVOKABLE void setHMDLODDecreaseFPS(float value); Q_INVOKABLE void setHMDLODDecreaseFPS(float value);
/**jsdoc /**jsdoc
* @function LODManager.getHMDLODDecreaseFPS * @function LODManager.getHMDLODDecreaseFPS
* @returns {number} * @returns {number}
*/ */
Q_INVOKABLE float getHMDLODDecreaseFPS() const; Q_INVOKABLE float getHMDLODDecreaseFPS() const;
/**jsdoc /**jsdoc
* @function LODManager.getHMDLODIncreaseFPS * @function LODManager.getHMDLODIncreaseFPS
* @returns {number} * @returns {number}
*/ */
Q_INVOKABLE float getHMDLODIncreaseFPS() const; Q_INVOKABLE float getHMDLODIncreaseFPS() const;
// User Tweakable LOD Items // User Tweakable LOD Items
/**jsdoc /**jsdoc
* @function LODManager.getLODFeedbackText * @function LODManager.getLODFeedbackText
* @returns {string} * @returns {string}
*/ */
Q_INVOKABLE QString getLODFeedbackText(); Q_INVOKABLE QString getLODFeedbackText();
/**jsdoc /**jsdoc
* @function LODManager.setOctreeSizeScale * @function LODManager.setOctreeSizeScale
* @param {number} sizeScale * @param {number} sizeScale
*/ */
Q_INVOKABLE void setOctreeSizeScale(float sizeScale); Q_INVOKABLE void setOctreeSizeScale(float sizeScale);
/**jsdoc /**jsdoc
* @function LODManager.getOctreeSizeScale * @function LODManager.getOctreeSizeScale
* @returns {number} * @returns {number}
*/ */
Q_INVOKABLE float getOctreeSizeScale() const { return _octreeSizeScale; } Q_INVOKABLE float getOctreeSizeScale() const { return _octreeSizeScale; }
/**jsdoc /**jsdoc
* @function LODManager.setBoundaryLevelAdjust * @function LODManager.setBoundaryLevelAdjust
* @param {number} boundaryLevelAdjust * @param {number} boundaryLevelAdjust
*/ */
Q_INVOKABLE void setBoundaryLevelAdjust(int boundaryLevelAdjust); Q_INVOKABLE void setBoundaryLevelAdjust(int boundaryLevelAdjust);
/**jsdoc /**jsdoc
* @function LODManager.getBoundaryLevelAdjust * @function LODManager.getBoundaryLevelAdjust
* @returns {number} * @returns {number}
*/ */
Q_INVOKABLE int getBoundaryLevelAdjust() const { return _boundaryLevelAdjust; } Q_INVOKABLE int getBoundaryLevelAdjust() const { return _boundaryLevelAdjust; }
/**jsdoc /**jsdoc
* @function LODManager.getLODDecreaseFPS * @function LODManager.getLODDecreaseFPS
* @returns {number} * @returns {number}
*/ */
Q_INVOKABLE float getLODDecreaseFPS() const; Q_INVOKABLE float getLODDecreaseFPS() const;
/**jsdoc /**jsdoc
* @function LODManager.getLODIncreaseFPS * @function LODManager.getLODIncreaseFPS
* @returns {number} * @returns {number}
*/ */
Q_INVOKABLE float getLODIncreaseFPS() const; Q_INVOKABLE float getLODIncreaseFPS() const;
/**jsdoc /**jsdoc
* @namespace LODManager * @namespace LODManager
* @property presentTime {number} * @property presentTime {number}
* @property engineRunTime {number} * @property engineRunTime {number}
* @property gpuTime {number} * @property gpuTime {number}
* @property avgRenderTime {number} * @property avgRenderTime {number}
* @property fps {number} * @property fps {number}
* @property lodLevel {number} * @property lodLevel {number}
* @property lodDecreaseFPS {number} * @property lodDecreaseFPS {number}
* @property lodIncreaseFPS {number} * @property lodIncreaseFPS {number}
*/ */
Q_PROPERTY(float presentTime READ getPresentTime) Q_PROPERTY(float presentTime READ getPresentTime)
Q_PROPERTY(float engineRunTime READ getEngineRunTime) Q_PROPERTY(float engineRunTime READ getEngineRunTime)
@ -192,16 +192,16 @@ public:
signals: signals:
/**jsdoc /**jsdoc
* @function LODManager.LODIncreased * @function LODManager.LODIncreased
* @returns {Signal} * @returns {Signal}
*/ */
void LODIncreased(); void LODIncreased();
/**jsdoc /**jsdoc
* @function LODManager.LODDecreased * @function LODManager.LODDecreased
* @returns {Signal} * @returns {Signal}
*/ */
void LODDecreased(); void LODDecreased();

172
interface/src/audio/AudioScope.h
View file

@ -26,15 +26,15 @@ class AudioScope : public QObject, public Dependency {
SINGLETON_DEPENDENCY SINGLETON_DEPENDENCY
/**jsdoc /**jsdoc
* The AudioScope API helps control the Audio Scope features in Interface * The AudioScope API helps control the Audio Scope features in Interface
* @namespace AudioScope * @namespace AudioScope
* @property {int} scopeInput * @property {int} scopeInput
* @property {int} scopeOutputLeft * @property {int} scopeOutputLeft
* @property {int} scopeOutputRight * @property {int} scopeOutputRight
* @property {int} triggerInput * @property {int} triggerInput
* @property {int} triggerOutputLeft * @property {int} triggerOutputLeft
* @property {int} triggerOutputRight * @property {int} triggerOutputRight
*/ */
Q_PROPERTY(QVector<int> scopeInput READ getScopeInput) Q_PROPERTY(QVector<int> scopeInput READ getScopeInput)
Q_PROPERTY(QVector<int> scopeOutputLeft READ getScopeOutputLeft) Q_PROPERTY(QVector<int> scopeOutputLeft READ getScopeOutputLeft)
@ -53,189 +53,189 @@ public:
public slots: public slots:
/**jsdoc /**jsdoc
* @function AudioScope.toggle * @function AudioScope.toggle
*/ */
void toggle() { setVisible(!_isEnabled); } void toggle() { setVisible(!_isEnabled); }
/**jsdoc /**jsdoc
* @function AudioScope.setVisible * @function AudioScope.setVisible
* @param {boolean} visible * @param {boolean} visible
*/ */
void setVisible(bool visible); void setVisible(bool visible);
/**jsdoc /**jsdoc
* @function AudioScope.getVisible * @function AudioScope.getVisible
* @param {boolean} visible * @param {boolean} visible
* @returns {boolean} * @returns {boolean}
*/ */
bool getVisible() const { return _isEnabled; } bool getVisible() const { return _isEnabled; }
/**jsdoc /**jsdoc
* @function AudioScope.togglePause * @function AudioScope.togglePause
*/ */
void togglePause() { setPause(!_isPaused); } void togglePause() { setPause(!_isPaused); }
/**jsdoc /**jsdoc
* @function AudioScope.setPause * @function AudioScope.setPause
* @param {boolean} * @param {boolean}
*/ */
void setPause(bool paused) { _isPaused = paused; emit pauseChanged(); } void setPause(bool paused) { _isPaused = paused; emit pauseChanged(); }
/**jsdoc /**jsdoc
* @function AudioScope.getPause * @function AudioScope.getPause
* @returns {boolean} * @returns {boolean}
*/ */
bool getPause() { return _isPaused; } bool getPause() { return _isPaused; }
/**jsdoc /**jsdoc
* @function AudioScope.toggleTrigger * @function AudioScope.toggleTrigger
*/ */
void toggleTrigger() { _autoTrigger = !_autoTrigger; } void toggleTrigger() { _autoTrigger = !_autoTrigger; }
/**jsdoc /**jsdoc
* @function AudioScope.getAutoTrigger * @function AudioScope.getAutoTrigger
* @returns {boolean} * @returns {boolean}
*/ */
bool getAutoTrigger() { return _autoTrigger; } bool getAutoTrigger() { return _autoTrigger; }
/**jsdoc /**jsdoc
* @function AudioScope.setAutoTrigger * @function AudioScope.setAutoTrigger
* @param {boolean} autoTrigger * @param {boolean} autoTrigger
*/ */
void setAutoTrigger(bool autoTrigger) { _isTriggered = false; _autoTrigger = autoTrigger; } void setAutoTrigger(bool autoTrigger) { _isTriggered = false; _autoTrigger = autoTrigger; }
/**jsdoc /**jsdoc
* @function AudioScope.setTriggerValues * @function AudioScope.setTriggerValues
* @param {number} x * @param {number} x
* @param {number} y * @param {number} y
*/ */
void setTriggerValues(int x, int y) { _triggerValues.x = x; _triggerValues.y = y; } void setTriggerValues(int x, int y) { _triggerValues.x = x; _triggerValues.y = y; }
/**jsdoc /**jsdoc
* @function AudioScope.setTriggered * @function AudioScope.setTriggered
* @param {boolean} triggered * @param {boolean} triggered
*/ */
void setTriggered(bool triggered) { _isTriggered = triggered; } void setTriggered(bool triggered) { _isTriggered = triggered; }
/**jsdoc /**jsdoc
* @function AudioScope.getTriggered * @function AudioScope.getTriggered
* @returns {boolean} * @returns {boolean}
*/ */
bool getTriggered() { return _isTriggered; } bool getTriggered() { return _isTriggered; }
/**jsdoc /**jsdoc
* @function AudioScope.getFramesPerSecond * @function AudioScope.getFramesPerSecond
* @returns {number} * @returns {number}
*/ */
float getFramesPerSecond(); float getFramesPerSecond();
/**jsdoc /**jsdoc
* @function AudioScope.getFramesPerScope * @function AudioScope.getFramesPerScope
* @returns {number} * @returns {number}
*/ */
int getFramesPerScope() { return _framesPerScope; } int getFramesPerScope() { return _framesPerScope; }
/**jsdoc /**jsdoc
* @function AudioScope.selectAudioScopeFiveFrames * @function AudioScope.selectAudioScopeFiveFrames
*/ */
void selectAudioScopeFiveFrames(); void selectAudioScopeFiveFrames();
/**jsdoc /**jsdoc
* @function AudioScope.selectAudioScopeTwentyFrames * @function AudioScope.selectAudioScopeTwentyFrames
*/ */
void selectAudioScopeTwentyFrames(); void selectAudioScopeTwentyFrames();
/**jsdoc /**jsdoc
* @function AudioScope.selectAudioScopeFiftyFrames * @function AudioScope.selectAudioScopeFiftyFrames
*/ */
void selectAudioScopeFiftyFrames(); void selectAudioScopeFiftyFrames();
/**jsdoc /**jsdoc
* @function AudioScope.getScopeInput * @function AudioScope.getScopeInput
* @returns {number} * @returns {number}
*/ */
QVector<int> getScopeInput() { return _scopeInputData; }; QVector<int> getScopeInput() { return _scopeInputData; };
/**jsdoc /**jsdoc
* @function AudioScope.getScopeOutputLeft * @function AudioScope.getScopeOutputLeft
* @returns {number} * @returns {number}
*/ */
QVector<int> getScopeOutputLeft() { return _scopeOutputLeftData; }; QVector<int> getScopeOutputLeft() { return _scopeOutputLeftData; };
/**jsdoc /**jsdoc
* @function AudioScope.getScopeOutputRight * @function AudioScope.getScopeOutputRight
* @returns {number} * @returns {number}
*/ */
QVector<int> getScopeOutputRight() { return _scopeOutputRightData; }; QVector<int> getScopeOutputRight() { return _scopeOutputRightData; };
/**jsdoc /**jsdoc
* @function AudioScope.getTriggerInput * @function AudioScope.getTriggerInput
* @returns {number} * @returns {number}
*/ */
QVector<int> getTriggerInput() { return _triggerInputData; }; QVector<int> getTriggerInput() { return _triggerInputData; };
/**jsdoc /**jsdoc
* @function AudioScope.getTriggerOutputLeft * @function AudioScope.getTriggerOutputLeft
* @returns {number} * @returns {number}
*/ */
QVector<int> getTriggerOutputLeft() { return _triggerOutputLeftData; }; QVector<int> getTriggerOutputLeft() { return _triggerOutputLeftData; };
/**jsdoc /**jsdoc
* @function AudioScope.getTriggerOutputRight * @function AudioScope.getTriggerOutputRight
* @returns {number} * @returns {number}
*/ */
QVector<int> getTriggerOutputRight() { return _triggerOutputRightData; }; QVector<int> getTriggerOutputRight() { return _triggerOutputRightData; };
/**jsdoc /**jsdoc
* @function AudioScope.setLocalEcho * @function AudioScope.setLocalEcho
* @parm {boolean} serverEcho * @parm {boolean} serverEcho
*/ */
void setLocalEcho(bool serverEcho); void setLocalEcho(bool serverEcho);
/**jsdoc /**jsdoc
* @function AudioScope.setServerEcho * @function AudioScope.setServerEcho
* @parm {boolean} serverEcho * @parm {boolean} serverEcho
*/ */
void setServerEcho(bool serverEcho); void setServerEcho(bool serverEcho);
signals: signals:
/**jsdoc /**jsdoc
* @function AudioScope.pauseChanged * @function AudioScope.pauseChanged
* @returns {Signal} * @returns {Signal}
*/ */
void pauseChanged(); void pauseChanged();
/**jsdoc /**jsdoc
* @function AudioScope.triggered * @function AudioScope.triggered
* @returns {Signal} * @returns {Signal}
*/ */
void triggered(); void triggered();

181
interface/src/avatar/AvatarManager.h
View file

@ -28,9 +28,9 @@
#include "MyAvatar.h" #include "MyAvatar.h"
/**jsdoc /**jsdoc
* The AvatarManager API has properties and methods which manage Avatars within the same domain. * The AvatarManager API has properties and methods which manage Avatars within the same domain.
* @namespace AvatarManager * @namespace AvatarManager
*/ */
class AvatarManager : public AvatarHashMap { class AvatarManager : public AvatarHashMap {
Q_OBJECT Q_OBJECT
@ -41,71 +41,71 @@ public:
// JSDOCS Copied over from AvatarHashMap (see AvatarHashMap.h for reason) // JSDOCS Copied over from AvatarHashMap (see AvatarHashMap.h for reason)
/**jsdoc /**jsdoc
* @function AvatarManager.getAvatarIdentifiers * @function AvatarManager.getAvatarIdentifiers
*/ */
/**jsdoc /**jsdoc
* @function AvatarManager.getAvatarsInRange * @function AvatarManager.getAvatarsInRange
* @param {Vec3} position * @param {Vec3} position
* @param {float} rangeMeters * @param {float} rangeMeters
* @returns {string[]} * @returns {string[]}
*/ */
/**jsdoc /**jsdoc
* @function AvatarManager.getAvatar * @function AvatarManager.getAvatar
* @param {string} avatarID * @param {string} avatarID
* @returns {ScriptAvatarData} * @returns {ScriptAvatarData}
*/ */
/**jsdoc /**jsdoc
* @function AvatarManager.avatarAddedEvent * @function AvatarManager.avatarAddedEvent
* @param {string} sessionUUID * @param {string} sessionUUID
* @returns {Signal} * @returns {Signal}
*/ */
/**jsdoc /**jsdoc
* @function AvatarManager.avatarRemovedEvent * @function AvatarManager.avatarRemovedEvent
* @param {string} sessionUUID * @param {string} sessionUUID
* @returns {Signal} * @returns {Signal}
*/ */
/**jsdoc /**jsdoc
* @function AvatarManager.avatarSessionChangedEvent * @function AvatarManager.avatarSessionChangedEvent
* @param {string} sessionUUID * @param {string} sessionUUID
* @param {string} oldUUID * @param {string} oldUUID
* @returns {Signal} * @returns {Signal}
*/ */
/**jsdoc /**jsdoc
* @function AvatarManager.isAvatarInRange * @function AvatarManager.isAvatarInRange
* @param {string} position * @param {string} position
* @param {string} range * @param {string} range
* @returns {boolean} * @returns {boolean}
*/ */
/**jsdoc /**jsdoc
* @function AvatarManager.sessionUUIDChanged * @function AvatarManager.sessionUUIDChanged
* @param {string} sessionUUID * @param {string} sessionUUID
* @param {string} oldUUID * @param {string} oldUUID
*/ */
/**jsdoc /**jsdoc
* @function AvatarManager.processAvatarDataPacket * @function AvatarManager.processAvatarDataPacket
* @param {} message * @param {} message
* @param {} sendingNode * @param {} sendingNode
*/ */
/**jsdoc /**jsdoc
* @function AvatarManager.processAvatarIdentityPacket * @function AvatarManager.processAvatarIdentityPacket
* @param {} message * @param {} message
* @param {} sendingNode * @param {} sendingNode
*/ */
/**jsdoc /**jsdoc
* @function AvatarManager.processKillAvatar * @function AvatarManager.processKillAvatar
* @param {} message * @param {} message
* @param {} sendingNode * @param {} sendingNode
*/ */
/// Registers the script types associated with the avatar manager. /// Registers the script types associated with the avatar manager.
static void registerMetaTypes(QScriptEngine* engine); static void registerMetaTypes(QScriptEngine* engine);
@ -118,10 +118,10 @@ public:
glm::vec3 getMyAvatarPosition() const { return _myAvatar->getWorldPosition(); } glm::vec3 getMyAvatarPosition() const { return _myAvatar->getWorldPosition(); }
/**jsdoc /**jsdoc
* @function AvatarManager.getAvatar * @function AvatarManager.getAvatar
* @param {string} avatarID * @param {string} avatarID
* @returns {} * @returns {}
*/ */
// Null/Default-constructed QUuids will return MyAvatar // Null/Default-constructed QUuids will return MyAvatar
Q_INVOKABLE virtual ScriptAvatarData* getAvatar(QUuid avatarID) override { return new ScriptAvatar(getAvatarBySessionID(avatarID)); } Q_INVOKABLE virtual ScriptAvatarData* getAvatar(QUuid avatarID) override { return new ScriptAvatar(getAvatarBySessionID(avatarID)); }
@ -147,51 +147,50 @@ public:
void handleCollisionEvents(const CollisionEvents& collisionEvents); void handleCollisionEvents(const CollisionEvents& collisionEvents);
/**jsdoc /**jsdoc
* @function AvatarManager.getAvatarDataRate * @function AvatarManager.getAvatarDataRate
* @param {string} sessionID * @param {string} sessionID
* @param {string} rateName * @param {string} rateName
* @returns {number} * @returns {number}
*/ */
Q_INVOKABLE float getAvatarDataRate(const QUuid& sessionID, const QString& rateName = QString("")) const; Q_INVOKABLE float getAvatarDataRate(const QUuid& sessionID, const QString& rateName = QString("")) const;
/**jsdoc /**jsdoc
* @function AvatarManager.getAvatarUpdateRate * @function AvatarManager.getAvatarUpdateRate
* @param {string} sessionID * @param {string} sessionID
* @param {string} rateName * @param {string} rateName
* @returns {number} * @returns {number}
*/ */
Q_INVOKABLE float getAvatarUpdateRate(const QUuid& sessionID, const QString& rateName = QString("")) const; Q_INVOKABLE float getAvatarUpdateRate(const QUuid& sessionID, const QString& rateName = QString("")) const;
/**jsdoc /**jsdoc
* @function AvatarManager.getAvatarSimulationRate * @function AvatarManager.getAvatarSimulationRate
* @param {string} sessionID * @param {string} sessionID
* @param {string} rateName * @param {string} rateName
* @returns {number} * @returns {number}
*/ */
Q_INVOKABLE float getAvatarSimulationRate(const QUuid& sessionID, const QString& rateName = QString("")) const; Q_INVOKABLE float getAvatarSimulationRate(const QUuid& sessionID, const QString& rateName = QString("")) const;
/**jsdoc /**jsdoc
* @function AvatarManager.findRayIntersection * @function AvatarManager.findRayIntersection
* @param {PickRay} ray * @param {PickRay} ray
* @param {} avatarIdsToInclude * @param {} avatarIdsToInclude
* @param {} avatarIdsToDiscard * @param {} avatarIdsToDiscard
* @returns {RayToAvatarIntersectionResult} * @returns {RayToAvatarIntersectionResult}
*/ */
Q_INVOKABLE RayToAvatarIntersectionResult findRayIntersection(const PickRay& ray, Q_INVOKABLE RayToAvatarIntersectionResult findRayIntersection(const PickRay& ray,
const QScriptValue& avatarIdsToInclude = QScriptValue(), const QScriptValue& avatarIdsToInclude = QScriptValue(),
const QScriptValue& avatarIdsToDiscard = QScriptValue()); const QScriptValue& avatarIdsToDiscard = QScriptValue());
/**jsdoc /**jsdoc
* To Be Completed * @function AvatarManager.findRayIntersectionVector
* @function AvatarManager.findRayIntersectionVector * @param {PickRay} ray
* @param {PickRay} ray * @param {} avatarsToInclude
* @param {} avatarsToInclude * @param {} avatarIdsToDiscard
* @param {} avatarIdsToDiscard * @returns {RayToAvatarIntersectionResult}
* @returns {RayToAvatarIntersectionResult} */
*/
Q_INVOKABLE RayToAvatarIntersectionResult findRayIntersectionVector(const PickRay& ray, Q_INVOKABLE RayToAvatarIntersectionResult findRayIntersectionVector(const PickRay& ray,
const QVector<EntityItemID>& avatarsToInclude, const QVector<EntityItemID>& avatarsToInclude,
@ -199,18 +198,18 @@ public:
// TODO: remove this HACK once we settle on optimal default sort coefficients // TODO: remove this HACK once we settle on optimal default sort coefficients
/**jsdoc /**jsdoc
* @function AvatarManager.getAvatarSortCoefficient * @function AvatarManager.getAvatarSortCoefficient
* @param {string} name * @param {string} name
* @returns {number} * @returns {number}
*/ */
Q_INVOKABLE float getAvatarSortCoefficient(const QString& name); Q_INVOKABLE float getAvatarSortCoefficient(const QString& name);
/**jsdoc /**jsdoc
* @function AvatarManager.setAvatarSortCoefficient * @function AvatarManager.setAvatarSortCoefficient
* @param {string} name * @param {string} name
* @param {string} value * @param {string} value
*/ */
Q_INVOKABLE void setAvatarSortCoefficient(const QString& name, const QScriptValue& value); Q_INVOKABLE void setAvatarSortCoefficient(const QString& name, const QScriptValue& value);
@ -219,9 +218,9 @@ public:
public slots: public slots:
/**jsdoc /**jsdoc
* @function AvatarManager.updateAvatarRenderStatus * @function AvatarManager.updateAvatarRenderStatus
* @param {boolean} shouldRenderAvatars * @param {boolean} shouldRenderAvatars
*/ */
void updateAvatarRenderStatus(bool shouldRenderAvatars); void updateAvatarRenderStatus(bool shouldRenderAvatars);

16
interface/src/devices/DdeFaceTracker.h
View file

@ -27,9 +27,9 @@
#include <trackers/FaceTracker.h> #include <trackers/FaceTracker.h>
/**jsdoc /**jsdoc
* The FaceTracker API helps manage facial tracking hardware. * The FaceTracker API helps manage facial tracking hardware.
* @namespace FaceTracker * @namespace FaceTracker
*/ */
class DdeFaceTracker : public FaceTracker, public Dependency { class DdeFaceTracker : public FaceTracker, public Dependency {
Q_OBJECT Q_OBJECT
@ -64,15 +64,15 @@ public:
public slots: public slots:
/**jsdoc /**jsdoc
* @function FaceTracker.setEnabled * @function FaceTracker.setEnabled
* @param {boolean} enabled * @param {boolean} enabled
*/ */
void setEnabled(bool enabled) override; void setEnabled(bool enabled) override;
/**jsdoc /**jsdoc
* @function FaceTracker.calibrate * @function FaceTracker.calibrate
*/ */
void calibrate(); void calibrate();

88
interface/src/scripting/AccountServicesScriptingInterface.h
View file

@ -36,14 +36,14 @@ class AccountServicesScriptingInterface : public QObject {
Q_OBJECT Q_OBJECT
/**jsdoc /**jsdoc
* The AccountServices API contains helper functions related to user connectivity * The AccountServices API contains helper functions related to user connectivity
* *
* @namespace AccountServices * @namespace AccountServices
* @property {string} username * @property {string} username
* @property {boolean} loggedIn * @property {boolean} loggedIn
* @property {string} findableBy * @property {string} findableBy
* @property {string} metaverseServerURL * @property {string} metaverseServerURL
*/ */
Q_PROPERTY(QString username READ getUsername NOTIFY myUsernameChanged) Q_PROPERTY(QString username READ getUsername NOTIFY myUsernameChanged)
Q_PROPERTY(bool loggedIn READ loggedIn NOTIFY loggedInChanged) Q_PROPERTY(bool loggedIn READ loggedIn NOTIFY loggedInChanged)
@ -60,35 +60,35 @@ public:
public slots: public slots:
/**jsdoc /**jsdoc
* @function AccountServices.getDownloadInfo * @function AccountServices.getDownloadInfo
* @returns {DownloadInfoResult} * @returns {DownloadInfoResult}
*/ */
DownloadInfoResult getDownloadInfo(); DownloadInfoResult getDownloadInfo();
/**jsdoc /**jsdoc
* @function AccountServices.updateDownloadInfo * @function AccountServices.updateDownloadInfo
*/ */
void updateDownloadInfo(); void updateDownloadInfo();
/**jsdoc /**jsdoc
* @function AccountServices.isLoggedIn * @function AccountServices.isLoggedIn
* @returns {boolean} * @returns {boolean}
*/ */
bool isLoggedIn(); bool isLoggedIn();
/**jsdoc /**jsdoc
* @function AccountServices.checkAndSignalForAccessToken * @function AccountServices.checkAndSignalForAccessToken
* @returns {boolean} * @returns {boolean}
*/ */
bool checkAndSignalForAccessToken(); bool checkAndSignalForAccessToken();
/**jsdoc /**jsdoc
* @function AccountServices.logOut * @function AccountServices.logOut
*/ */
void logOut(); void logOut();
@ -105,49 +105,49 @@ private slots:
signals: signals:
/**jsdoc /**jsdoc
* @function AccountServices.connected * @function AccountServices.connected
* @returns {Signal} * @returns {Signal}
*/ */
void connected(); void connected();
/**jsdoc /**jsdoc
* @function AccountServices.disconnected * @function AccountServices.disconnected
* @params {string} reason * @params {string} reason
* @returns {Signal} * @returns {Signal}
*/ */
void disconnected(const QString& reason); void disconnected(const QString& reason);
/**jsdoc /**jsdoc
* @function AccountServices.myUsernameChanged * @function AccountServices.myUsernameChanged
* @params {string} username * @params {string} username
* @returns {Signal} * @returns {Signal}
*/ */
void myUsernameChanged(const QString& username); void myUsernameChanged(const QString& username);
/**jsdoc /**jsdoc
* @function AccountServices.downloadInfoChanged * @function AccountServices.downloadInfoChanged
* @params {} info * @params {} info
* @returns {Signal} * @returns {Signal}
*/ */
void downloadInfoChanged(DownloadInfoResult info); void downloadInfoChanged(DownloadInfoResult info);
/**jsdoc /**jsdoc
* @function AccountServices.findableByChanged * @function AccountServices.findableByChanged
* @params {string} discoverabilityMode * @params {string} discoverabilityMode
* @returns {Signal} * @returns {Signal}
*/ */
void findableByChanged(const QString& discoverabilityMode); void findableByChanged(const QString& discoverabilityMode);
/**jsdoc /**jsdoc
* @function AccountServices.loggedInChanged * @function AccountServices.loggedInChanged
* @params {boolean} loggedIn * @params {boolean} loggedIn
* @returns {Signal} * @returns {Signal}
*/ */
void loggedInChanged(bool loggedIn); void loggedInChanged(bool loggedIn);

114
interface/src/scripting/Audio.h
View file

@ -25,16 +25,16 @@ class Audio : public AudioScriptingInterface {
SINGLETON_DEPENDENCY SINGLETON_DEPENDENCY
/**jsdoc /**jsdoc
* The Audio API features tools to help control audio contexts and settings. * The Audio API features tools to help control audio contexts and settings.
* *
* @namespace Audio * @namespace Audio
* @property {boolean} muted * @property {boolean} muted
* @property {boolean} noiseReduction * @property {boolean} noiseReduction
* @property {boolean} inputVolume * @property {boolean} inputVolume
* @property {boolean} inputLevel * @property {boolean} inputLevel
* @property {string} context * @property {string} context
* @property {} devices * @property {} devices
*/ */
Q_PROPERTY(bool muted READ isMuted WRITE setMuted NOTIFY mutedChanged) Q_PROPERTY(bool muted READ isMuted WRITE setMuted NOTIFY mutedChanged)
Q_PROPERTY(bool noiseReduction READ noiseReductionEnabled WRITE enableNoiseReduction NOTIFY noiseReductionChanged) Q_PROPERTY(bool noiseReduction READ noiseReductionEnabled WRITE enableNoiseReduction NOTIFY noiseReductionChanged)
@ -64,109 +64,109 @@ public:
void setInputVolume(float volume); void setInputVolume(float volume);
/**jsdoc /**jsdoc
* @function Audio.setInputDevice * @function Audio.setInputDevice
* @param {} device * @param {} device
* @param {boolean} isHMD * @param {boolean} isHMD
*/ */
Q_INVOKABLE void setInputDevice(const QAudioDeviceInfo& device, bool isHMD); Q_INVOKABLE void setInputDevice(const QAudioDeviceInfo& device, bool isHMD);
/**jsdoc /**jsdoc
* @function Audio.setOutputDevice * @function Audio.setOutputDevice
* @param {} device * @param {} device
* @param {boolean} isHMD * @param {boolean} isHMD
*/ */
Q_INVOKABLE void setOutputDevice(const QAudioDeviceInfo& device, bool isHMD); Q_INVOKABLE void setOutputDevice(const QAudioDeviceInfo& device, bool isHMD);
/**jsdoc /**jsdoc
* @function Audio.setReverb * @function Audio.setReverb
* @param {boolean} enable * @param {boolean} enable
*/ */
Q_INVOKABLE void setReverb(bool enable); Q_INVOKABLE void setReverb(bool enable);
/**jsdoc /**jsdoc
* @function Audio.setReverbOptions * @function Audio.setReverbOptions
* @param {} options * @param {} options
*/ */
Q_INVOKABLE void setReverbOptions(const AudioEffectOptions* options); Q_INVOKABLE void setReverbOptions(const AudioEffectOptions* options);
/**jsdoc /**jsdoc
* @function Audio.setReverbOptions * @function Audio.setReverbOptions
* @param {string} filename * @param {string} filename
*/ */
Q_INVOKABLE bool startRecording(const QString& filename); Q_INVOKABLE bool startRecording(const QString& filename);
/**jsdoc /**jsdoc
* @function Audio.stopRecording * @function Audio.stopRecording
*/ */
Q_INVOKABLE void stopRecording(); Q_INVOKABLE void stopRecording();
/**jsdoc /**jsdoc
* @function Audio.getRecording * @function Audio.getRecording
*/ */
Q_INVOKABLE bool getRecording(); Q_INVOKABLE bool getRecording();
signals: signals:
/**jsdoc /**jsdoc
* @function Audio.nop * @function Audio.nop
* @returns {Signal} * @returns {Signal}
*/ */
void nop(); void nop();
/**jsdoc /**jsdoc
* @function Audio.nop * @function Audio.nop
* @param {bool} isMuted * @param {bool} isMuted
* @returns {Signal} * @returns {Signal}
*/ */
void mutedChanged(bool isMuted); void mutedChanged(bool isMuted);
/**jsdoc /**jsdoc
* @function Audio.noiseReductionChanged * @function Audio.noiseReductionChanged
* @param {bool} isEnabled * @param {bool} isEnabled
* @returns {Signal} * @returns {Signal}
*/ */
void noiseReductionChanged(bool isEnabled); void noiseReductionChanged(bool isEnabled);
/**jsdoc /**jsdoc
* @function Audio.inputVolumeChanged * @function Audio.inputVolumeChanged
* @param {float} volume * @param {float} volume
* @returns {Signal} * @returns {Signal}
*/ */
void inputVolumeChanged(float volume); void inputVolumeChanged(float volume);
/**jsdoc /**jsdoc
* @function Audio.inputLevelChanged * @function Audio.inputLevelChanged
* @param {float} level * @param {float} level
* @returns {Signal} * @returns {Signal}
*/ */
void inputLevelChanged(float level); void inputLevelChanged(float level);
/**jsdoc /**jsdoc
* @function Audio.contextChanged * @function Audio.contextChanged
* @param {string} context * @param {string} context
* @returns {Signal} * @returns {Signal}
*/ */
void contextChanged(const QString& context); void contextChanged(const QString& context);
public slots: public slots:
/**jsdoc /**jsdoc
* @function Audio.onContextChanged * @function Audio.onContextChanged
* @returns {Signal} * @returns {Signal}
*/ */
void onContextChanged(); void onContextChanged();

92
interface/src/scripting/GooglePolyScriptingInterface.h
View file

@ -16,9 +16,9 @@
#include <DependencyManager.h> #include <DependencyManager.h>
/**jsdoc /**jsdoc
* The GooglePoly API allows you to interact with Google Poly models direct from inside High Fidelity. * The GooglePoly API allows you to interact with Google Poly models direct from inside High Fidelity.
* @namespace GooglePoly * @namespace GooglePoly
*/ */
class GooglePolyScriptingInterface : public QObject, public Dependency { class GooglePolyScriptingInterface : public QObject, public Dependency {
Q_OBJECT Q_OBJECT
@ -29,81 +29,81 @@ public:
public slots: public slots:
/**jsdoc /**jsdoc
* @function GooglePoly.setAPIKey * @function GooglePoly.setAPIKey
* @param {string} key * @param {string} key
*/ */
void setAPIKey(const QString& key); void setAPIKey(const QString& key);
/**jsdoc /**jsdoc
* @function GooglePoly.getAssetList * @function GooglePoly.getAssetList
* @param {string} keyword * @param {string} keyword
* @param {string} category * @param {string} category
* @param {string} format * @param {string} format
* @returns {string} * @returns {string}
*/ */
QString getAssetList(const QString& keyword, const QString& category, const QString& format); QString getAssetList(const QString& keyword, const QString& category, const QString& format);
/**jsdoc /**jsdoc
* @function GooglePoly.getFBX * @function GooglePoly.getFBX
* @param {string} keyword * @param {string} keyword
* @param {string} category * @param {string} category
* @returns {string} * @returns {string}
*/ */
QString getFBX(const QString& keyword, const QString& category); QString getFBX(const QString& keyword, const QString& category);
/**jsdoc /**jsdoc
* @function GooglePoly.getOBJ * @function GooglePoly.getOBJ
* @param {string} keyword * @param {string} keyword
* @param {string} category * @param {string} category
* @returns {string} * @returns {string}
*/ */
QString getOBJ(const QString& keyword, const QString& category); QString getOBJ(const QString& keyword, const QString& category);
/**jsdoc /**jsdoc
* @function GooglePoly.getBlocks * @function GooglePoly.getBlocks
* @param {string} keyword * @param {string} keyword
* @param {string} category * @param {string} category
* @returns {string} * @returns {string}
*/ */
QString getBlocks(const QString& keyword, const QString& category); QString getBlocks(const QString& keyword, const QString& category);
/**jsdoc /**jsdoc
* @function GooglePoly.getGLTF * @function GooglePoly.getGLTF
* @param {string} keyword * @param {string} keyword
* @param {string} category * @param {string} category
* @returns {string} * @returns {string}
*/ */
QString getGLTF(const QString& keyword, const QString& category); QString getGLTF(const QString& keyword, const QString& category);
/**jsdoc /**jsdoc
* @function GooglePoly.getGLTF2 * @function GooglePoly.getGLTF2
* @param {string} keyword * @param {string} keyword
* @param {string} category * @param {string} category
* @returns {string} * @returns {string}
*/ */
QString getGLTF2(const QString& keyword, const QString& category); QString getGLTF2(const QString& keyword, const QString& category);
/**jsdoc /**jsdoc
* @function GooglePoly.getTilt * @function GooglePoly.getTilt
* @param {string} keyword * @param {string} keyword
* @param {string} category * @param {string} category
* @returns {string} * @returns {string}
*/ */
QString getTilt(const QString& keyword, const QString& category); QString getTilt(const QString& keyword, const QString& category);
/**jsdoc /**jsdoc
* @function GooglePoly.getModelInfo * @function GooglePoly.getModelInfo
* @param {string} input * @param {string} input
* @returns {string} * @returns {string}
*/ */
QString getModelInfo(const QString& input); QString getModelInfo(const QString& input);

62
interface/src/ui/AvatarInputs.h
View file

@ -24,13 +24,13 @@ class AvatarInputs : public QObject {
HIFI_QML_DECL HIFI_QML_DECL
/**jsdoc /**jsdoc
* API to help manage your Avatar's input * API to help manage your Avatar's input
* @namespace AvatarInputs * @namespace AvatarInputs
* @param {boolean} cameraEnabled * @param {boolean} cameraEnabled
* @param {boolean} cameraMuted * @param {boolean} cameraMuted
* @param {boolean} isHMD * @param {boolean} isHMD
* @param {boolean} showAudioTools * @param {boolean} showAudioTools
*/ */
AI_PROPERTY(bool, cameraEnabled, false) AI_PROPERTY(bool, cameraEnabled, false)
AI_PROPERTY(bool, cameraMuted, false) AI_PROPERTY(bool, cameraMuted, false)
@ -42,10 +42,10 @@ public:
static AvatarInputs* getInstance(); static AvatarInputs* getInstance();
/**jsdoc /**jsdoc
* @function AvatarInputs.loudnessToAudioLevel * @function AvatarInputs.loudnessToAudioLevel
* @param {number} loudness * @param {number} loudness
* @returns {number} * @returns {number}
*/ */
Q_INVOKABLE float loudnessToAudioLevel(float loudness); Q_INVOKABLE float loudnessToAudioLevel(float loudness);
AvatarInputs(QObject* parent = nullptr); AvatarInputs(QObject* parent = nullptr);
@ -55,54 +55,54 @@ public:
public slots: public slots:
/**jsdoc /**jsdoc
* @function AvatarInputs.setShowAudioTools * @function AvatarInputs.setShowAudioTools
* @param {boolean} showAudioTools * @param {boolean} showAudioTools
*/ */
void setShowAudioTools(bool showAudioTools); void setShowAudioTools(bool showAudioTools);
signals: signals:
/**jsdoc /**jsdoc
* @function AvatarInputs.cameraEnabledChanged * @function AvatarInputs.cameraEnabledChanged
* @returns {Signal} * @returns {Signal}
*/ */
void cameraEnabledChanged(); void cameraEnabledChanged();
/**jsdoc /**jsdoc
* @function AvatarInputs.cameraMutedChanged * @function AvatarInputs.cameraMutedChanged
* @returns {Signal} * @returns {Signal}
*/ */
void cameraMutedChanged(); void cameraMutedChanged();
/**jsdoc /**jsdoc
* @function AvatarInputs.isHMDChanged * @function AvatarInputs.isHMDChanged
* @returns {Signal} * @returns {Signal}
*/ */
void isHMDChanged(); void isHMDChanged();
/**jsdoc /**jsdoc
* @function AvatarInputs.showAudioToolsChanged * @function AvatarInputs.showAudioToolsChanged
* @param {boolean} show * @param {boolean} show
* @returns {Signal} * @returns {Signal}
*/ */
void showAudioToolsChanged(bool show); void showAudioToolsChanged(bool show);
protected: protected:
/**jsdoc /**jsdoc
* @function AvatarInputs.resetSensors * @function AvatarInputs.resetSensors
*/ */
Q_INVOKABLE void resetSensors(); Q_INVOKABLE void resetSensors();
/**jsdoc /**jsdoc
* @function AvatarInputs.toggleCameraMute * @function AvatarInputs.toggleCameraMute
*/ */
Q_INVOKABLE void toggleCameraMute(); Q_INVOKABLE void toggleCameraMute();

104
libraries/animation/src/AnimationCache.h
View file

@ -21,9 +21,9 @@
#include <ResourceCache.h> #include <ResourceCache.h>
/**jsdoc /**jsdoc
* API to manage Animation Cache resources * API to manage Animation Cache resources
* @namespace AnimationCache * @namespace AnimationCache
*/ */
class Animation; class Animation;
@ -38,75 +38,75 @@ public:
// Copied over from ResourceCache (see ResourceCache.h for reason) // Copied over from ResourceCache (see ResourceCache.h for reason)
/**jsdoc /**jsdoc
* @namespace AnimationCache * @namespace AnimationCache
* @property numTotal {number} total number of total resources * @property numTotal {number} total number of total resources
* @property numCached {number} total number of cached resource * @property numCached {number} total number of cached resource
* @property sizeTotal {number} size in bytes of all resources * @property sizeTotal {number} size in bytes of all resources
* @property sizeCached {number} size in bytes of all cached resources * @property sizeCached {number} size in bytes of all cached resources
*/ */
/**jsdoc /**jsdoc
* Returns the total number of resources * Returns the total number of resources
* @function AnimationCache.getNumTotalResources * @function AnimationCache.getNumTotalResources
* @returns {number} * @returns {number}
*/ */
/**jsdoc /**jsdoc
* Returns the total size in bytes of all resources * Returns the total size in bytes of all resources
* @function AnimationCache.getSizeTotalResources * @function AnimationCache.getSizeTotalResources
* @returns {number} * @returns {number}
*/ */
/**jsdoc /**jsdoc
* Returns the total number of cached resources * Returns the total number of cached resources
* @function AnimationCache.getNumCachedResources * @function AnimationCache.getNumCachedResources
* @returns {number} * @returns {number}
*/ */
/**jsdoc /**jsdoc
* Returns the total size in bytes of cached resources * Returns the total size in bytes of cached resources
* @function AnimationCache.getSizeCachedResources * @function AnimationCache.getSizeCachedResources
* @returns {number} * @returns {number}
*/ */
/**jsdoc /**jsdoc
* Returns list of all resource urls * Returns list of all resource urls
* @function AnimationCache.getResourceList * @function AnimationCache.getResourceList
* @returns {string[]} * @returns {string[]}
*/ */
/**jsdoc /**jsdoc
* Asynchronously loads a resource from the spedified URL and returns it. * Asynchronously loads a resource from the spedified URL and returns it.
* @param url {string} url of resource to load * @param url {string} url of resource to load
* @param fallback {string} fallback URL if load of the desired url fails * @param fallback {string} fallback URL if load of the desired url fails
* @function AnimationCache.getResource * @function AnimationCache.getResource
* @returns {Resource} * @returns {Resource}
*/ */
/**jsdoc /**jsdoc
* Prefetches a resource. * Prefetches a resource.
* @param url {string} url of resource to load * @param url {string} url of resource to load
* @function AnimationCache.prefetch * @function AnimationCache.prefetch
* @returns {Resource} * @returns {Resource}
*/ */
/**jsdoc /**jsdoc
* @param {number} deltaSize * @param {number} deltaSize
* @function AnimationCache.updateTotalSize * @function AnimationCache.updateTotalSize
* @returns {Resource} * @returns {Resource}
*/ */
/**jsdoc /**jsdoc
* @function AnimationCache.dirty * @function AnimationCache.dirty
* @returns {Signal} * @returns {Signal}
*/ */
/**jsdoc /**jsdoc
* Returns animation resource for particular animation * Returns animation resource for particular animation
* @function AnimationCache.getAnimation * @function AnimationCache.getAnimation
* @param url {string} url to load * @param url {string} url to load
* @returns {Resource} animation * @returns {Resource} animation
*/ */
Q_INVOKABLE AnimationPointer getAnimation(const QString& url) { return getAnimation(QUrl(url)); } Q_INVOKABLE AnimationPointer getAnimation(const QString& url) { return getAnimation(QUrl(url)); }
Q_INVOKABLE AnimationPointer getAnimation(const QUrl& url); Q_INVOKABLE AnimationPointer getAnimation(const QUrl& url);

116
libraries/audio-client/src/AudioIOStats.h
View file

@ -40,46 +40,46 @@ class AudioStreamStatsInterface : public QObject {
Q_OBJECT Q_OBJECT
/**jsdoc /**jsdoc
* Audio stats from the Audio Mixer * Audio stats from the Audio Mixer
* @namespace AudioStats.mixerStream * @namespace AudioStats.mixerStream
* @param {number} lossRate * @param {number} lossRate
* @param {number} lossCount * @param {number} lossCount
* @param {number} lossRateWindow * @param {number} lossRateWindow
* @param {number} lossCountWindow * @param {number} lossCountWindow
* @param {number} framesDesired * @param {number} framesDesired
* @param {number} framesAvailable * @param {number} framesAvailable
* @param {number} framesAvailableAvg * @param {number} framesAvailableAvg
* @param {number} unplayedMsMax * @param {number} unplayedMsMax
* @param {number} starveCount * @param {number} starveCount
* @param {number} lastStarveDurationCount * @param {number} lastStarveDurationCount
* @param {number} dropCount * @param {number} dropCount
* @param {number} overflowCount * @param {number} overflowCount
* @param {number} timegapMsMax * @param {number} timegapMsMax
* @param {number} timegapMsAvg * @param {number} timegapMsAvg
* @param {number} timegapMsMaxWindow * @param {number} timegapMsMaxWindow
* @param {number} timegapMsAvgWindow * @param {number} timegapMsAvgWindow
*/ */
/**jsdoc /**jsdoc
* Audio stats from the Client Mixer * Audio stats from the Client Mixer
* @namespace AudioStats.clientMixer * @namespace AudioStats.clientMixer
* @param {number} lossRate * @param {number} lossRate
* @param {number} lossCount * @param {number} lossCount
* @param {number} lossRateWindow * @param {number} lossRateWindow
* @param {number} lossCountWindow * @param {number} lossCountWindow
* @param {number} framesDesired * @param {number} framesDesired
* @param {number} framesAvailable * @param {number} framesAvailable
* @param {number} framesAvailableAvg * @param {number} framesAvailableAvg
* @param {number} unplayedMsMax * @param {number} unplayedMsMax
* @param {number} starveCount * @param {number} starveCount
* @param {number} lastStarveDurationCount * @param {number} lastStarveDurationCount
* @param {number} dropCount * @param {number} dropCount
* @param {number} overflowCount * @param {number} overflowCount
* @param {number} timegapMsMax * @param {number} timegapMsMax
* @param {number} timegapMsAvg * @param {number} timegapMsAvg
* @param {number} timegapMsMaxWindow * @param {number} timegapMsMaxWindow
* @param {number} timegapMsAvgWindow * @param {number} timegapMsAvgWindow
*/ */
AUDIO_PROPERTY(float, lossRate) AUDIO_PROPERTY(float, lossRate)
AUDIO_PROPERTY(float, lossCount) AUDIO_PROPERTY(float, lossCount)
@ -113,17 +113,17 @@ class AudioStatsInterface : public QObject {
Q_OBJECT Q_OBJECT
/**jsdoc /**jsdoc
* Audio stats from the client * Audio stats from the client
* @namespace AudioStats * @namespace AudioStats
* @param {number} pingMs * @param {number} pingMs
* @param {number} inputReadMsMax * @param {number} inputReadMsMax
* @param {number} inputUnplayedMsMax * @param {number} inputUnplayedMsMax
* @param {number} outputUnplayedMsMax * @param {number} outputUnplayedMsMax
* @param {number} sentTimegapMsMax * @param {number} sentTimegapMsMax
* @param {number} sentTimegapMsAvg * @param {number} sentTimegapMsAvg
* @param {number} sentTimegapMsMaxWindow * @param {number} sentTimegapMsMaxWindow
* @param {number} sentTimegapMsAvgWindow * @param {number} sentTimegapMsAvgWindow
*/ */
AUDIO_PROPERTY(float, pingMs); AUDIO_PROPERTY(float, pingMs);
@ -156,23 +156,23 @@ public:
signals: signals:
/**jsdoc /**jsdoc
* @function AudioStats.mixerStreamChanged * @function AudioStats.mixerStreamChanged
* @returns {Signal} * @returns {Signal}
*/ */
void mixerStreamChanged(); void mixerStreamChanged();
/**jsdoc /**jsdoc
* @function AudioStats.clientStreamChanged * @function AudioStats.clientStreamChanged
* @returns {Signal} * @returns {Signal}
*/ */
void clientStreamChanged(); void clientStreamChanged();
/**jsdoc /**jsdoc
* @function AudioStats.injectorStreamsChanged * @function AudioStats.injectorStreamsChanged
* @returns {Signal} * @returns {Signal}
*/ */
void injectorStreamsChanged(); void injectorStreamsChanged();

113
libraries/audio/src/SoundCache.h
View file

@ -17,9 +17,9 @@
#include "Sound.h" #include "Sound.h"
/**jsdoc /**jsdoc
* API to manage Sound Cache resources * API to manage Sound Cache resources
* @namespace SoundCache * @namespace SoundCache
*/ */
/// Scriptable interface for sound loading. /// Scriptable interface for sound loading.
@ -31,82 +31,81 @@ public:
// Copied over from ResourceCache (see ResourceCache.h for reason) // Copied over from ResourceCache (see ResourceCache.h for reason)
/**jsdoc /**jsdoc
* @namespace SoundCache * @namespace SoundCache
* @property numTotal {number} total number of total resources * @property numTotal {number} total number of total resources
* @property numCached {number} total number of cached resource * @property numCached {number} total number of cached resource
* @property sizeTotal {number} size in bytes of all resources * @property sizeTotal {number} size in bytes of all resources
* @property sizeCached {number} size in bytes of all cached resources * @property sizeCached {number} size in bytes of all cached resources
*/ */
/**jsdoc /**jsdoc
* Returns the total number of resources * Returns the total number of resources
* @function SoundCache.getNumTotalResources * @function SoundCache.getNumTotalResources
* @returns {number} * @returns {number}
*/ */
/**jsdoc /**jsdoc
* Returns the total size in bytes of all resources * Returns the total size in bytes of all resources
* @function SoundCache.getSizeTotalResources * @function SoundCache.getSizeTotalResources
* @returns {number} * @returns {number}
*/ */
/**jsdoc /**jsdoc
* Returns the total number of cached resources * Returns the total number of cached resources
* @function SoundCache.getNumCachedResources * @function SoundCache.getNumCachedResources
* @returns {number} * @returns {number}
*/ */
/**jsdoc /**jsdoc
* Returns the total size in bytes of cached resources * Returns the total size in bytes of cached resources
* @function SoundCache.getSizeCachedResources * @function SoundCache.getSizeCachedResources
* @returns {number} * @returns {number}
*/ */
/**jsdoc /**jsdoc
* Returns list of all resource urls * Returns list of all resource urls
* @function SoundCache.getResourceList * @function SoundCache.getResourceList
* @returns {string[]} * @returns {string[]}
*/ */
/**jsdoc /**jsdoc
* Returns animation resource for particular animation * Returns animation resource for particular animation
* @function SoundCache.getAnimation * @function SoundCache.getAnimation
* @param url {string} url to load * @param url {string} url to load
* @returns {Resource} animation * @returns {Resource} animation
*/ */
/**jsdoc /**jsdoc
* Asynchronously loads a resource from the spedified URL and returns it. * Asynchronously loads a resource from the spedified URL and returns it.
* @param url {string} url of resource to load * @param url {string} url of resource to load
* @param fallback {string} fallback URL if load of the desired url fails * @param fallback {string} fallback URL if load of the desired url fails
* @function SoundCache.getResource * @function SoundCache.getResource
* @returns {Resource} * @returns {Resource}
*/ */
/**jsdoc /**jsdoc
* Prefetches a resource. * Prefetches a resource.
* @param url {string} url of resource to load * @param url {string} url of resource to load
* @function SoundCache.prefetch * @function SoundCache.prefetch
* @returns {Resource} * @returns {Resource}
*/ */
/**jsdoc /**jsdoc
* To Be Completed * @param {number} deltaSize
* @param {number} deltaSize * @function SoundCache.updateTotalSize
* @function SoundCache.updateTotalSize * @returns {Resource}
* @returns {Resource} */
*/
/**jsdoc /**jsdoc
* @function SoundCache.dirty * @function SoundCache.dirty
* @returns {Signal} * @returns {Signal}
*/ */
/**jsdoc /**jsdoc
* @function SoundCache.getSound * @function SoundCache.getSound
* @param {string} url * @param {string} url
* @returns {} * @returns {}
*/ */
Q_INVOKABLE SharedSoundPointer getSound(const QUrl& url); Q_INVOKABLE SharedSoundPointer getSound(const QUrl& url);
protected: protected:

96
libraries/avatars/src/AvatarHashMap.h
View file

@ -31,9 +31,9 @@
#include "AvatarData.h" #include "AvatarData.h"
/**jsdoc /**jsdoc
* The AvatarHashMap API deals with functionality related to Avatar information and connectivity * The AvatarHashMap API deals with functionality related to Avatar information and connectivity
* @namespace AvatarHashMap * @namespace AvatarHashMap
*/ */
// JSDoc 3.5.5 doesn't augment @property definitions. // JSDoc 3.5.5 doesn't augment @property definitions.
// These functions are being copied into Avatar classes which inherit the AvatarHashMap // These functions are being copied into Avatar classes which inherit the AvatarHashMap
@ -51,25 +51,25 @@ public:
// Currently, your own avatar will be included as the null avatar id. // Currently, your own avatar will be included as the null avatar id.
/**jsdoc /**jsdoc
* @function AvatarHashMap.getAvatarIdentifiers * @function AvatarHashMap.getAvatarIdentifiers
*/ */
Q_INVOKABLE QVector<QUuid> getAvatarIdentifiers(); Q_INVOKABLE QVector<QUuid> getAvatarIdentifiers();
/**jsdoc /**jsdoc
* @function AvatarHashMap.getAvatarsInRange * @function AvatarHashMap.getAvatarsInRange
* @param {Vec3} position * @param {Vec3} position
* @param {float} rangeMeters * @param {float} rangeMeters
* @returns {string[]} * @returns {string[]}
*/ */
Q_INVOKABLE QVector<QUuid> getAvatarsInRange(const glm::vec3& position, float rangeMeters) const; Q_INVOKABLE QVector<QUuid> getAvatarsInRange(const glm::vec3& position, float rangeMeters) const;
/**jsdoc /**jsdoc
* @function AvatarHashMap.getAvatar * @function AvatarHashMap.getAvatar
* @param {string} avatarID * @param {string} avatarID
* @returns {ScriptAvatarData} * @returns {ScriptAvatarData}
*/ */
// Null/Default-constructed QUuids will return MyAvatar // Null/Default-constructed QUuids will return MyAvatar
Q_INVOKABLE virtual ScriptAvatarData* getAvatar(QUuid avatarID) { return new ScriptAvatarData(getAvatarBySessionID(avatarID)); } Q_INVOKABLE virtual ScriptAvatarData* getAvatar(QUuid avatarID) { return new ScriptAvatarData(getAvatarBySessionID(avatarID)); }
@ -80,72 +80,72 @@ public:
signals: signals:
/**jsdoc /**jsdoc
* @function AvatarHashMap.avatarAddedEvent * @function AvatarHashMap.avatarAddedEvent
* @param {string} sessionUUID * @param {string} sessionUUID
* @returns {Signal} * @returns {Signal}
*/ */
void avatarAddedEvent(const QUuid& sessionUUID); void avatarAddedEvent(const QUuid& sessionUUID);
/**jsdoc /**jsdoc
* @function AvatarHashMap.avatarRemovedEvent * @function AvatarHashMap.avatarRemovedEvent
* @param {string} sessionUUID * @param {string} sessionUUID
* @returns {Signal} * @returns {Signal}
*/ */
void avatarRemovedEvent(const QUuid& sessionUUID); void avatarRemovedEvent(const QUuid& sessionUUID);
/**jsdoc /**jsdoc
* @function AvatarHashMap.avatarSessionChangedEvent * @function AvatarHashMap.avatarSessionChangedEvent
* @param {string} sessionUUID * @param {string} sessionUUID
* @param {string} oldUUID * @param {string} oldUUID
* @returns {Signal} * @returns {Signal}
*/ */
void avatarSessionChangedEvent(const QUuid& sessionUUID,const QUuid& oldUUID); void avatarSessionChangedEvent(const QUuid& sessionUUID,const QUuid& oldUUID);
public slots: public slots:
/**jsdoc /**jsdoc
* @function AvatarHashMap.isAvatarInRange * @function AvatarHashMap.isAvatarInRange
* @param {string} position * @param {string} position
* @param {string} range * @param {string} range
* @returns {boolean} * @returns {boolean}
*/ */
bool isAvatarInRange(const glm::vec3 & position, const float range); bool isAvatarInRange(const glm::vec3 & position, const float range);
protected slots: protected slots:
/**jsdoc /**jsdoc
* @function AvatarHashMap.sessionUUIDChanged * @function AvatarHashMap.sessionUUIDChanged
* @param {string} sessionUUID * @param {string} sessionUUID
* @param {string} oldUUID * @param {string} oldUUID
*/ */
void sessionUUIDChanged(const QUuid& sessionUUID, const QUuid& oldUUID); void sessionUUIDChanged(const QUuid& sessionUUID, const QUuid& oldUUID);
/**jsdoc /**jsdoc
* @function AvatarHashMap.processAvatarDataPacket * @function AvatarHashMap.processAvatarDataPacket
* @param {} message * @param {} message
* @param {} sendingNode * @param {} sendingNode
*/ */
void processAvatarDataPacket(QSharedPointer<ReceivedMessage> message, SharedNodePointer sendingNode); void processAvatarDataPacket(QSharedPointer<ReceivedMessage> message, SharedNodePointer sendingNode);
/**jsdoc /**jsdoc
* @function AvatarHashMap.processAvatarIdentityPacket * @function AvatarHashMap.processAvatarIdentityPacket
* @param {} message * @param {} message
* @param {} sendingNode * @param {} sendingNode
*/ */
void processAvatarIdentityPacket(QSharedPointer<ReceivedMessage> message, SharedNodePointer sendingNode); void processAvatarIdentityPacket(QSharedPointer<ReceivedMessage> message, SharedNodePointer sendingNode);
/**jsdoc /**jsdoc
* @function AvatarHashMap.processKillAvatar * @function AvatarHashMap.processKillAvatar
* @param {} message * @param {} message
* @param {} sendingNode * @param {} sendingNode
*/ */
void processKillAvatar(QSharedPointer<ReceivedMessage> message, SharedNodePointer sendingNode); void processKillAvatar(QSharedPointer<ReceivedMessage> message, SharedNodePointer sendingNode);

110
libraries/model-networking/src/model-networking/TextureCache.h
View file

@ -138,9 +138,9 @@ using NetworkTexturePointer = QSharedPointer<NetworkTexture>;
Q_DECLARE_METATYPE(QWeakPointer<NetworkTexture>) Q_DECLARE_METATYPE(QWeakPointer<NetworkTexture>)
/**jsdoc /**jsdoc
* API to manage Texture Cache resources * API to manage Texture Cache resources
* @namespace TextureCache * @namespace TextureCache
*/ */
/// Stores cached textures, including render-to-texture targets. /// Stores cached textures, including render-to-texture targets.
class TextureCache : public ResourceCache, public Dependency { class TextureCache : public ResourceCache, public Dependency {
@ -151,75 +151,75 @@ public:
// Copied over from ResourceCache (see ResourceCache.h for reason) // Copied over from ResourceCache (see ResourceCache.h for reason)
/**jsdoc /**jsdoc
* @namespace TextureCache * @namespace TextureCache
* @property numTotal {number} total number of total resources * @property numTotal {number} total number of total resources
* @property numCached {number} total number of cached resource * @property numCached {number} total number of cached resource
* @property sizeTotal {number} size in bytes of all resources * @property sizeTotal {number} size in bytes of all resources
* @property sizeCached {number} size in bytes of all cached resources * @property sizeCached {number} size in bytes of all cached resources
*/ */
/**jsdoc /**jsdoc
* Returns the total number of resources * Returns the total number of resources
* @function TextureCache.getNumTotalResources * @function TextureCache.getNumTotalResources
* @returns {number} * @returns {number}
*/ */
/**jsdoc /**jsdoc
* Returns the total size in bytes of all resources * Returns the total size in bytes of all resources
* @function TextureCache.getSizeTotalResources * @function TextureCache.getSizeTotalResources
* @returns {number} * @returns {number}
*/ */
/**jsdoc /**jsdoc
* Returns the total number of cached resources * Returns the total number of cached resources
* @function TextureCache.getNumCachedResources * @function TextureCache.getNumCachedResources
* @returns {number} * @returns {number}
*/ */
/**jsdoc /**jsdoc
* Returns the total size in bytes of cached resources * Returns the total size in bytes of cached resources
* @function TextureCache.getSizeCachedResources * @function TextureCache.getSizeCachedResources
* @returns {number} * @returns {number}
*/ */
/**jsdoc /**jsdoc
* Returns list of all resource urls * Returns list of all resource urls
* @function TextureCache.getResourceList * @function TextureCache.getResourceList
* @returns {string[]} * @returns {string[]}
*/ */
/**jsdoc /**jsdoc
* Returns animation resource for particular animation * Returns animation resource for particular animation
* @function TextureCache.getAnimation * @function TextureCache.getAnimation
* @param url {string} url to load * @param url {string} url to load
* @returns {Resource} animation * @returns {Resource} animation
*/ */
/**jsdoc /**jsdoc
* Asynchronously loads a resource from the spedified URL and returns it. * Asynchronously loads a resource from the spedified URL and returns it.
* @param url {string} url of resource to load * @param url {string} url of resource to load
* @param fallback {string} fallback URL if load of the desired url fails * @param fallback {string} fallback URL if load of the desired url fails
* @function TextureCache.getResource * @function TextureCache.getResource
* @returns {Resource} * @returns {Resource}
*/ */
/**jsdoc /**jsdoc
* Prefetches a resource. * Prefetches a resource.
* @param url {string} url of resource to load * @param url {string} url of resource to load
* @function TextureCache.prefetch * @function TextureCache.prefetch
* @returns {Resource} * @returns {Resource}
*/ */
/**jsdoc /**jsdoc
* @param {number} deltaSize * @param {number} deltaSize
* @function TextureCache.updateTotalSize * @function TextureCache.updateTotalSize
* @returns {Resource} * @returns {Resource}
*/ */
/**jsdoc /**jsdoc
* @function TextureCache.dirty * @function TextureCache.dirty
* @returns {Signal} * @returns {Signal}
*/ */
/// Returns the ID of the permutation/normal texture used for Perlin noise shader programs. This texture /// Returns the ID of the permutation/normal texture used for Perlin noise shader programs. This texture
/// has two lines: the first, a set of random numbers in [0, 255] to be used as permutation offsets, and /// has two lines: the first, a set of random numbers in [0, 255] to be used as permutation offsets, and
@ -259,9 +259,9 @@ public:
signals: signals:
/**jsdoc /**jsdoc
* @function TextureCache.spectatorCameraFramebufferReset * @function TextureCache.spectatorCameraFramebufferReset
* @returns {Signal} * @returns {Signal}
*/ */
void spectatorCameraFramebufferReset(); void spectatorCameraFramebufferReset();
protected: protected:

104
libraries/networking/src/ResourceCache.h
View file

@ -88,10 +88,10 @@ class ScriptableResource : public QObject {
/**jsdoc /**jsdoc
* @constructor Resource * @constructor Resource
* @property url {string} url of this resource * @property url {string} url of this resource
* @property state {Resource.State} current loading state * @property state {Resource.State} current loading state
*/ */
Q_OBJECT Q_OBJECT
Q_PROPERTY(QUrl url READ getURL) Q_PROPERTY(QUrl url READ getURL)
@ -139,20 +139,20 @@ public:
signals: signals:
/**jsdoc /**jsdoc
* Signaled when download progress for this resource has changed * Signaled when download progress for this resource has changed
* @function Resource#progressChanged * @function Resource#progressChanged
* @param bytesReceived {int} bytes downloaded so far * @param bytesReceived {int} bytes downloaded so far
* @param bytesTotal {int} total number of bytes in the resource * @param bytesTotal {int} total number of bytes in the resource
* @returns {Signal} * @returns {Signal}
*/ */
void progressChanged(uint64_t bytesReceived, uint64_t bytesTotal); void progressChanged(uint64_t bytesReceived, uint64_t bytesTotal);
/**jsdoc /**jsdoc
* Signaled when resource loading state has changed * Signaled when resource loading state has changed
* @function Resource#stateChanged * @function Resource#stateChanged
* @param bytesReceived {Resource.State} new state * @param bytesReceived {Resource.State} new state
* @returns {Signal} * @returns {Signal}
*/ */
void stateChanged(int state); void stateChanged(int state);
protected: protected:
@ -188,12 +188,12 @@ class ResourceCache : public QObject {
// JSDoc 3.5.5 doesn't augment @property definitions. // JSDoc 3.5.5 doesn't augment @property definitions.
// These functions are being copied into the different exposed cache classes // These functions are being copied into the different exposed cache classes
/**jsdoc /**jsdoc
* @namespace ResourceCache * @namespace ResourceCache
* @property numTotal {number} total number of total resources * @property numTotal {number} total number of total resources
* @property numCached {number} total number of cached resource * @property numCached {number} total number of cached resource
* @property sizeTotal {number} size in bytes of all resources * @property sizeTotal {number} size in bytes of all resources
* @property sizeCached {number} size in bytes of all cached resources * @property sizeCached {number} size in bytes of all cached resources
*/ */
Q_PROPERTY(size_t numTotal READ getNumTotalResources NOTIFY dirty) Q_PROPERTY(size_t numTotal READ getNumTotalResources NOTIFY dirty)
Q_PROPERTY(size_t numCached READ getNumCachedResources NOTIFY dirty) Q_PROPERTY(size_t numCached READ getNumCachedResources NOTIFY dirty)
Q_PROPERTY(size_t sizeTotal READ getSizeTotalResources NOTIFY dirty) Q_PROPERTY(size_t sizeTotal READ getSizeTotalResources NOTIFY dirty)
@ -201,38 +201,38 @@ class ResourceCache : public QObject {
public: public:
/**jsdoc /**jsdoc
* Returns the total number of resources * Returns the total number of resources
* @function ResourceCache.getNumTotalResources * @function ResourceCache.getNumTotalResources
* @return {number} * @return {number}
*/ */
size_t getNumTotalResources() const { return _numTotalResources; } size_t getNumTotalResources() const { return _numTotalResources; }
/**jsdoc /**jsdoc
* Returns the total size in bytes of all resources * Returns the total size in bytes of all resources
* @function ResourceCache.getSizeTotalResources * @function ResourceCache.getSizeTotalResources
* @return {number} * @return {number}
*/ */
size_t getSizeTotalResources() const { return _totalResourcesSize; } size_t getSizeTotalResources() const { return _totalResourcesSize; }
/**jsdoc /**jsdoc
* Returns the total number of cached resources * Returns the total number of cached resources
* @function ResourceCache.getNumCachedResources * @function ResourceCache.getNumCachedResources
* @return {number} * @return {number}
*/ */
size_t getNumCachedResources() const { return _numUnusedResources; } size_t getNumCachedResources() const { return _numUnusedResources; }
/**jsdoc /**jsdoc
* Returns the total size in bytes of cached resources * Returns the total size in bytes of cached resources
* @function ResourceCache.getSizeCachedResources * @function ResourceCache.getSizeCachedResources
* @return {number} * @return {number}
*/ */
size_t getSizeCachedResources() const { return _unusedResourcesSize; } size_t getSizeCachedResources() const { return _unusedResourcesSize; }
/**jsdoc /**jsdoc
* Returns list of all resource urls * Returns list of all resource urls
* @function ResourceCache.getResourceList * @function ResourceCache.getResourceList
* @return {string[]} * @return {string[]}
*/ */
Q_INVOKABLE QVariantList getResourceList(); Q_INVOKABLE QVariantList getResourceList();
static void setRequestLimit(int limit); static void setRequestLimit(int limit);
@ -273,12 +273,12 @@ protected slots:
/// \param fallback a fallback URL to load if the desired one is unavailable /// \param fallback a fallback URL to load if the desired one is unavailable
/// \param extra extra data to pass to the creator, if appropriate /// \param extra extra data to pass to the creator, if appropriate
/**jsdoc /**jsdoc
* Asynchronously loads a resource from the spedified URL and returns it. * Asynchronously loads a resource from the spedified URL and returns it.
* @param url {string} url of resource to load * @param url {string} url of resource to load
* @param fallback {string} fallback URL if load of the desired url fails * @param fallback {string} fallback URL if load of the desired url fails
* @function ResourceCache.getResource * @function ResourceCache.getResource
* @return {Resource} * @return {Resource}
*/ */
QSharedPointer<Resource> getResource(const QUrl& url, const QUrl& fallback = QUrl(), QSharedPointer<Resource> getResource(const QUrl& url, const QUrl& fallback = QUrl(),
void* extra = NULL); void* extra = NULL);
@ -291,11 +291,11 @@ protected:
// which should be a QScriptEngine with ScriptableResource registered, so that // which should be a QScriptEngine with ScriptableResource registered, so that
// the QScriptEngine will delete the pointer when it is garbage collected. // the QScriptEngine will delete the pointer when it is garbage collected.
/**jsdoc /**jsdoc
* Prefetches a resource. * Prefetches a resource.
* @param url {string} url of resource to load * @param url {string} url of resource to load
* @function ResourceCache.prefetch * @function ResourceCache.prefetch
* @return {Resource} * @return {Resource}
*/ */
Q_INVOKABLE ScriptableResource* prefetch(const QUrl& url) { return prefetch(url, nullptr); } Q_INVOKABLE ScriptableResource* prefetch(const QUrl& url) { return prefetch(url, nullptr); }
/// Creates a new resource. /// Creates a new resource.

310
libraries/script-engine/src/AssetScriptingInterface.h
View file

@ -35,82 +35,82 @@ public:
AssetScriptingInterface(QObject* parent = nullptr); AssetScriptingInterface(QObject* parent = nullptr);
/**jsdoc /**jsdoc
* Upload content to the connected domain's asset server. * Upload content to the connected domain's asset server.
* @function Assets.uploadData * @function Assets.uploadData
* @static * @static
* @param data {string} content to upload * @param data {string} content to upload
* @param callback {Assets~uploadDataCallback} called when upload is complete * @param callback {Assets~uploadDataCallback} called when upload is complete
*/ */
/**jsdoc /**jsdoc
* Called when uploadData is complete * Called when uploadData is complete
* @callback Assets~uploadDataCallback * @callback Assets~uploadDataCallback
* @param {string} url * @param {string} url
* @param {string} hash * @param {string} hash
*/ */
Q_INVOKABLE void uploadData(QString data, QScriptValue callback); Q_INVOKABLE void uploadData(QString data, QScriptValue callback);
/**jsdoc /**jsdoc
* Download data from the connected domain's asset server. * Download data from the connected domain's asset server.
* @function Assets.downloadData * @function Assets.downloadData
* @param url {string} URL of asset to download, must be ATP scheme URL. * @param url {string} URL of asset to download, must be ATP scheme URL.
* @param callback {Assets~downloadDataCallback} * @param callback {Assets~downloadDataCallback}
*/ */
/**jsdoc /**jsdoc
* Called when downloadData is complete * Called when downloadData is complete
* @callback Assets~downloadDataCallback * @callback Assets~downloadDataCallback
* @param data {string} content that was downloaded * @param data {string} content that was downloaded
*/ */
Q_INVOKABLE void downloadData(QString url, QScriptValue downloadComplete); Q_INVOKABLE void downloadData(QString url, QScriptValue downloadComplete);
/**jsdoc /**jsdoc
* Sets up a path to hash mapping within the connected domain's asset server * Sets up a path to hash mapping within the connected domain's asset server
* @function Assets.setMapping * @function Assets.setMapping
* @param path {string} * @param path {string}
* @param hash {string} * @param hash {string}
* @param callback {Assets~setMappingCallback} * @param callback {Assets~setMappingCallback}
*/ */
/**jsdoc /**jsdoc
* Called when setMapping is complete * Called when setMapping is complete
* @callback Assets~setMappingCallback * @callback Assets~setMappingCallback
* @param {string} error * @param {string} error
*/ */
Q_INVOKABLE void setMapping(QString path, QString hash, QScriptValue callback); Q_INVOKABLE void setMapping(QString path, QString hash, QScriptValue callback);
/**jsdoc /**jsdoc
* Look up a path to hash mapping within the connected domain's asset server * Look up a path to hash mapping within the connected domain's asset server
* @function Assets.getMapping * @function Assets.getMapping
* @param path {string} * @param path {string}
* @param callback {Assets~getMappingCallback} * @param callback {Assets~getMappingCallback}
*/ */
/**jsdoc /**jsdoc
* Called when getMapping is complete. * Called when getMapping is complete.
* @callback Assets~getMappingCallback * @callback Assets~getMappingCallback
* @param assetID {string} hash value if found, else an empty string * @param assetID {string} hash value if found, else an empty string
* @param error {string} error description if the path could not be resolved; otherwise a null value. * @param error {string} error description if the path could not be resolved; otherwise a null value.
*/ */
/**jsdoc /**jsdoc
* Called when getMapping is complete. * Called when getMapping is complete.
* @callback Assets~getMappingCallback * @callback Assets~getMappingCallback
* @param assetID {string} hash value if found, else an empty string * @param assetID {string} hash value if found, else an empty string
* @param error {string} error description if the path could not be resolved; otherwise a null value. * @param error {string} error description if the path could not be resolved; otherwise a null value.
*/ */
Q_INVOKABLE void getMapping(QString path, QScriptValue callback); Q_INVOKABLE void getMapping(QString path, QScriptValue callback);
/**jsdoc /**jsdoc
* @function Assets.setBakingEnabled * @function Assets.setBakingEnabled
* @param path {string} * @param path {string}
* @param enabled {boolean} * @param enabled {boolean}
* @param callback {} * @param callback {}
*/ */
Q_INVOKABLE void setBakingEnabled(QString path, bool enabled, QScriptValue callback); Q_INVOKABLE void setBakingEnabled(QString path, bool enabled, QScriptValue callback);
@ -119,172 +119,172 @@ public:
#endif #endif
/**jsdoc /**jsdoc
* Request Asset data from the ATP Server * Request Asset data from the ATP Server
* @function Assets.getAsset * @function Assets.getAsset
* @param {URL|Assets.GetOptions} options An atp: style URL, hash, or relative mapped path; or an {@link Assets.GetOptions} object with request parameters * @param {URL|Assets.GetOptions} options An atp: style URL, hash, or relative mapped path; or an {@link Assets.GetOptions} object with request parameters
* @param {Assets~getAssetCallback} scope[callback] A scope callback function to receive (error, results) values * @param {Assets~getAssetCallback} scope[callback] A scope callback function to receive (error, results) values
*/ */
/**jsdoc /**jsdoc
* A set of properties that can be passed to {@link Assets.getAsset}. * A set of properties that can be passed to {@link Assets.getAsset}.
* @typedef {Object} Assets.GetOptions * @typedef {Object} Assets.GetOptions
* @property {URL} [url] an "atp:" style URL, hash, or relative mapped path to fetch * @property {URL} [url] an "atp:" style URL, hash, or relative mapped path to fetch
* @property {string} [responseType=text] the desired reponse type (text | arraybuffer | json) * @property {string} [responseType=text] the desired reponse type (text | arraybuffer | json)
* @property {boolean} [decompress=false] whether to attempt gunzip decompression on the fetched data * @property {boolean} [decompress=false] whether to attempt gunzip decompression on the fetched data
* See: {@link Assets.putAsset} and its .compress=true option * See: {@link Assets.putAsset} and its .compress=true option
*/ */
/**jsdoc /**jsdoc
* Called when Assets.getAsset is complete. * Called when Assets.getAsset is complete.
* @callback Assets~getAssetCallback * @callback Assets~getAssetCallback
* @param {string} error - contains error message or null value if no error occured fetching the asset * @param {string} error - contains error message or null value if no error occured fetching the asset
* @param {Asset~getAssetResult} result - result object containing, on success containing asset metadata and contents * @param {Asset~getAssetResult} result - result object containing, on success containing asset metadata and contents
*/ */
/**jsdoc /**jsdoc
* Result value returned by {@link Assets.getAsset}. * Result value returned by {@link Assets.getAsset}.
* @typedef {Object} Assets~getAssetResult * @typedef {Object} Assets~getAssetResult
* @property {url} [url] the resolved "atp:" style URL for the fetched asset * @property {url} [url] the resolved "atp:" style URL for the fetched asset
* @property {string} [hash] the resolved hash for the fetched asset * @property {string} [hash] the resolved hash for the fetched asset
* @property {string|ArrayBuffer|Object} [response] response data (possibly converted per .responseType value) * @property {string|ArrayBuffer|Object} [response] response data (possibly converted per .responseType value)
* @property {string} [responseType] response type (text | arraybuffer | json) * @property {string} [responseType] response type (text | arraybuffer | json)
* @property {string} [contentType] detected asset mime-type (autodetected) * @property {string} [contentType] detected asset mime-type (autodetected)
* @property {number} [byteLength] response data size in bytes * @property {number} [byteLength] response data size in bytes
* @property {number} [decompressed] flag indicating whether data was decompressed * @property {number} [decompressed] flag indicating whether data was decompressed
*/ */
Q_INVOKABLE void getAsset(QScriptValue options, QScriptValue scope, QScriptValue callback = QScriptValue()); Q_INVOKABLE void getAsset(QScriptValue options, QScriptValue scope, QScriptValue callback = QScriptValue());
/**jsdoc /**jsdoc
* Upload Asset data to the ATP Server * Upload Asset data to the ATP Server
* @function Assets.putAsset * @function Assets.putAsset
* @param {Assets.PutOptions} options A PutOptions object with upload parameters * @param {Assets.PutOptions} options A PutOptions object with upload parameters
* @param {Assets~putAssetCallback} scope[callback] A scoped callback function invoked with (error, results) * @param {Assets~putAssetCallback} scope[callback] A scoped callback function invoked with (error, results)
*/ */
/**jsdoc /**jsdoc
* A set of properties that can be passed to {@link Assets.putAsset}. * A set of properties that can be passed to {@link Assets.putAsset}.
* @typedef {Object} Assets.PutOptions * @typedef {Object} Assets.PutOptions
* @property {ArrayBuffer|string} [data] byte buffer or string value representing the new asset's content * @property {ArrayBuffer|string} [data] byte buffer or string value representing the new asset's content
* @property {string} [path=null] ATP path mapping to automatically create (upon successful upload to hash) * @property {string} [path=null] ATP path mapping to automatically create (upon successful upload to hash)
* @property {boolean} [compress=false] whether to gzip compress data before uploading * @property {boolean} [compress=false] whether to gzip compress data before uploading
*/ */
/**jsdoc /**jsdoc
* Called when Assets.putAsset is complete. * Called when Assets.putAsset is complete.
* @callback Assets~puttAssetCallback * @callback Assets~puttAssetCallback
* @param {string} error - contains error message (or null value if no error occured while uploading/mapping the new asset) * @param {string} error - contains error message (or null value if no error occured while uploading/mapping the new asset)
* @param {Asset~putAssetResult} result - result object containing error or result status of asset upload * @param {Asset~putAssetResult} result - result object containing error or result status of asset upload
*/ */
/**jsdoc /**jsdoc
* Result value returned by {@link Assets.putAsset}. * Result value returned by {@link Assets.putAsset}.
* @typedef {Object} Assets~putAssetResult * @typedef {Object} Assets~putAssetResult
* @property {url} [url] the resolved "atp:" style URL for the uploaded asset (based on .path if specified, otherwise on the resulting ATP hash) * @property {url} [url] the resolved "atp:" style URL for the uploaded asset (based on .path if specified, otherwise on the resulting ATP hash)
* @property {string} [path] the uploaded asset's resulting ATP path (or undefined if no path mapping was assigned) * @property {string} [path] the uploaded asset's resulting ATP path (or undefined if no path mapping was assigned)
* @property {string} [hash] the uploaded asset's resulting ATP hash * @property {string} [hash] the uploaded asset's resulting ATP hash
* @property {boolean} [compressed] flag indicating whether the data was compressed before upload * @property {boolean} [compressed] flag indicating whether the data was compressed before upload
* @property {number} [byteLength] flag indicating final byte size of the data uploaded to the ATP server * @property {number} [byteLength] flag indicating final byte size of the data uploaded to the ATP server
*/ */
Q_INVOKABLE void putAsset(QScriptValue options, QScriptValue scope, QScriptValue callback = QScriptValue()); Q_INVOKABLE void putAsset(QScriptValue options, QScriptValue scope, QScriptValue callback = QScriptValue());
/**jsdoc /**jsdoc
* @function Assets.deleteAsset * @function Assets.deleteAsset
* @property {} options * @property {} options
* @property {} scope * @property {} scope
* @property {} callback * @property {} callback
*/ */
Q_INVOKABLE void deleteAsset(QScriptValue options, QScriptValue scope, QScriptValue callback = QScriptValue()); Q_INVOKABLE void deleteAsset(QScriptValue options, QScriptValue scope, QScriptValue callback = QScriptValue());
/**jsdoc /**jsdoc
* @function Assets.resolveAsset * @function Assets.resolveAsset
* @property {} options * @property {} options
* @property {} scope * @property {} scope
* @property {} callback * @property {} callback
*/ */
Q_INVOKABLE void resolveAsset(QScriptValue options, QScriptValue scope, QScriptValue callback = QScriptValue()); Q_INVOKABLE void resolveAsset(QScriptValue options, QScriptValue scope, QScriptValue callback = QScriptValue());
/**jsdoc /**jsdoc
* @function Assets.decompressData * @function Assets.decompressData
* @property {} options * @property {} options
* @property {} scope * @property {} scope
* @property {} callback * @property {} callback
*/ */
Q_INVOKABLE void decompressData(QScriptValue options, QScriptValue scope, QScriptValue callback = QScriptValue()); Q_INVOKABLE void decompressData(QScriptValue options, QScriptValue scope, QScriptValue callback = QScriptValue());
/**jsdoc /**jsdoc
* @function Assets.compressData * @function Assets.compressData
* @property {} options * @property {} options
* @property {} scope * @property {} scope
* @property {} callback * @property {} callback
*/ */
Q_INVOKABLE void compressData(QScriptValue options, QScriptValue scope, QScriptValue callback = QScriptValue()); Q_INVOKABLE void compressData(QScriptValue options, QScriptValue scope, QScriptValue callback = QScriptValue());
/**jsdoc /**jsdoc
* @function Assets.initializeCache * @function Assets.initializeCache
* @returns {boolean} * @returns {boolean}
*/ */
Q_INVOKABLE bool initializeCache() { return Parent::initializeCache(); } Q_INVOKABLE bool initializeCache() { return Parent::initializeCache(); }
/**jsdoc /**jsdoc
* @function Assets.canWriteCacheValue * @function Assets.canWriteCacheValue
* @property {string} url * @property {string} url
* @returns {boolean} * @returns {boolean}
*/ */
Q_INVOKABLE bool canWriteCacheValue(const QUrl& url); Q_INVOKABLE bool canWriteCacheValue(const QUrl& url);
/**jsdoc /**jsdoc
* @function Assets.getCacheStatus * @function Assets.getCacheStatus
* @property {} scope * @property {} scope
* @property {} callback * @property {} callback
*/ */
Q_INVOKABLE void getCacheStatus(QScriptValue scope, QScriptValue callback = QScriptValue()) { Q_INVOKABLE void getCacheStatus(QScriptValue scope, QScriptValue callback = QScriptValue()) {
jsPromiseReady(Parent::getCacheStatus(), scope, callback); jsPromiseReady(Parent::getCacheStatus(), scope, callback);
} }
/**jsdoc /**jsdoc
* @function Assets.queryCacheMeta * @function Assets.queryCacheMeta
* @property {} options * @property {} options
* @property {} scope * @property {} scope
* @property {} callback * @property {} callback
*/ */
Q_INVOKABLE void queryCacheMeta(QScriptValue options, QScriptValue scope, QScriptValue callback = QScriptValue()); Q_INVOKABLE void queryCacheMeta(QScriptValue options, QScriptValue scope, QScriptValue callback = QScriptValue());
/**jsdoc /**jsdoc
* @function Assets.loadFromCache * @function Assets.loadFromCache
* @property {} options * @property {} options
* @property {} scope * @property {} scope
* @property {} callback * @property {} callback
*/ */
Q_INVOKABLE void loadFromCache(QScriptValue options, QScriptValue scope, QScriptValue callback = QScriptValue()); Q_INVOKABLE void loadFromCache(QScriptValue options, QScriptValue scope, QScriptValue callback = QScriptValue());
/**jsdoc /**jsdoc
* @function Assets.saveToCache * @function Assets.saveToCache
* @property {} options * @property {} options
* @property {} scope * @property {} scope
* @property {} callback * @property {} callback
*/ */
Q_INVOKABLE void saveToCache(QScriptValue options, QScriptValue scope, QScriptValue callback = QScriptValue()); Q_INVOKABLE void saveToCache(QScriptValue options, QScriptValue scope, QScriptValue callback = QScriptValue());
/**jsdoc /**jsdoc
* @function Assets.saveToCache * @function Assets.saveToCache
* @property {} url * @property {} url
* @property {} data * @property {} data
* @property {} metadata * @property {} metadata
* @property {} scope * @property {} scope
* @property {} callback * @property {} callback
*/ */
Q_INVOKABLE void saveToCache(const QUrl& url, const QByteArray& data, const QVariantMap& metadata, Q_INVOKABLE void saveToCache(const QUrl& url, const QByteArray& data, const QVariantMap& metadata,
QScriptValue scope, QScriptValue callback = QScriptValue()); QScriptValue scope, QScriptValue callback = QScriptValue());

22
libraries/trackers/src/trackers/FaceTracker.h
View file

@ -61,31 +61,31 @@ public:
signals: signals:
/**jsdoc /**jsdoc
* @function FaceTracker.muteToggled * @function FaceTracker.muteToggled
* @returns {Signal} * @returns {Signal}
*/ */
void muteToggled(); void muteToggled();
public slots: public slots:
/**jsdoc /**jsdoc
* @function FaceTracker.setEnabled * @function FaceTracker.setEnabled
* @param {boolean} enabled * @param {boolean} enabled
*/ */
virtual void setEnabled(bool enabled) = 0; virtual void setEnabled(bool enabled) = 0;
/**jsdoc /**jsdoc
* @function FaceTracker.toggleMute * @function FaceTracker.toggleMute
*/ */
void toggleMute(); void toggleMute();
/**jsdoc /**jsdoc
* @function FaceTracker.getMuted * @function FaceTracker.getMuted
* @returns {boolean} * @returns {boolean}
*/ */
bool getMuted() { return _isMuted; } bool getMuted() { return _isMuted; }