Mirrors/overte-HifiExperiments
3
0
Fork 0
mirror of https://github.com/HifiExperiments/overte.git synced 2025-08-09 05:48:26 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge branch 'master' of github.com:highfidelity/hifi into feat/hasScriptedBlendshapes

Browse source
This commit is contained in:
Thijs Wenker 2018-04-26 22:37:15 +02:00
commit 20b9e44844
30 changed files with 801 additions and 780 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
cmake/externals/serverless-content/CMakeLists.txt vendored
View file

@ -4,8 +4,8 @@ set(EXTERNAL_NAME serverless-content)
ExternalProject_Add( ExternalProject_Add(
${EXTERNAL_NAME} ${EXTERNAL_NAME}
URL http://cdn.highfidelity.com/content-sets/serverless-tutorial-RC67-v2.zip URL http://cdn.highfidelity.com/content-sets/serverless-tutorial-RC67-v3.zip
URL_MD5 2c69a1df69816b4b0b81630396fbd36e URL_MD5 327292eb87bc249cbb4d670d8a6ce746
CONFIGURE_COMMAND "" CONFIGURE_COMMAND ""
BUILD_COMMAND "" BUILD_COMMAND ""
INSTALL_COMMAND "" INSTALL_COMMAND ""

87
interface/src/Application.cpp
View file

@ -1322,49 +1322,48 @@ Application::Application(int& argc, char** argv, QElapsedTimer& startupTimer, bo
// Make sure we don't time out during slow operations at startup // Make sure we don't time out during slow operations at startup
updateHeartbeat(); updateHeartbeat();
// sessionRunTime will be reset soon by loadSettings. Grab it now to get previous session value. constexpr auto INSTALLER_INI_NAME = "installer.ini";
// The value will be 0 if the user blew away settings this session, which is both a feature and a bug. auto iniPath = QDir(applicationDirPath()).filePath(INSTALLER_INI_NAME);
static const QString TESTER = "HIFI_TESTER"; QFile installerFile { iniPath };
auto gpuIdent = GPUIdent::getInstance(); std::unordered_map<QString, QString> installerKeyValues;
auto glContextData = getGLContextData(); if (installerFile.open(QIODevice::ReadOnly)) {
QJsonObject properties = { while (!installerFile.atEnd()) {
{ "version", applicationVersion() }, auto line = installerFile.readLine();
{ "tester", QProcessEnvironment::systemEnvironment().contains(TESTER) }, if (!line.isEmpty()) {
{ "previousSessionCrashed", _previousSessionCrashed }, auto index = line.indexOf("=");
{ "previousSessionRuntime", sessionRunTime.get() }, if (index >= 0) {
{ "cpu_architecture", QSysInfo::currentCpuArchitecture() }, installerKeyValues[line.mid(0, index).trimmed()] = line.mid(index + 1).trimmed();
{ "kernel_type", QSysInfo::kernelType() }, }
{ "kernel_version", QSysInfo::kernelVersion() }, }
{ "os_type", QSysInfo::productType() }, }
{ "os_version", QSysInfo::productVersion() },
{ "gpu_name", gpuIdent->getName() },
{ "gpu_driver", gpuIdent->getDriver() },
{ "gpu_memory", static_cast<qint64>(gpuIdent->getMemory()) },
{ "gl_version_int", glVersionToInteger(glContextData.value("version").toString()) },
{ "gl_version", glContextData["version"] },
{ "gl_vender", glContextData["vendor"] },
{ "gl_sl_version", glContextData["sl_version"] },
{ "gl_renderer", glContextData["renderer"] },
{ "ideal_thread_count", QThread::idealThreadCount() }
};
auto macVersion = QSysInfo::macVersion();
if (macVersion != QSysInfo::MV_None) {
properties["os_osx_version"] = QSysInfo::macVersion();
}
auto windowsVersion = QSysInfo::windowsVersion();
if (windowsVersion != QSysInfo::WV_None) {
properties["os_win_version"] = QSysInfo::windowsVersion();
} }
ProcessorInfo procInfo; // In practice we shouldn't run across installs that don't have a known installer type.
if (getProcessorInfo(procInfo)) { // Client or Client+Server installs should always have the installer.ini next to their
properties["processor_core_count"] = procInfo.numProcessorCores; // respective interface.exe, and Steam installs will be detected as such. If a user were
properties["logical_processor_count"] = procInfo.numLogicalProcessors; // to delete the installer.ini, though, and as an example, we won't know the context of the
properties["processor_l1_cache_count"] = procInfo.numProcessorCachesL1; // original install.
properties["processor_l2_cache_count"] = procInfo.numProcessorCachesL2; constexpr auto INSTALLER_KEY_TYPE = "type";
properties["processor_l3_cache_count"] = procInfo.numProcessorCachesL3; constexpr auto INSTALLER_KEY_CAMPAIGN = "campaign";
constexpr auto INSTALLER_TYPE_UNKNOWN = "unknown";
constexpr auto INSTALLER_TYPE_STEAM = "steam";
auto typeIt = installerKeyValues.find(INSTALLER_KEY_TYPE);
QString installerType = INSTALLER_TYPE_UNKNOWN;
if (typeIt == installerKeyValues.end()) {
if (property(hifi::properties::STEAM).toBool()) {
installerType = INSTALLER_TYPE_STEAM;
}
} else {
installerType = typeIt->second;
} }
auto campaignIt = installerKeyValues.find(INSTALLER_KEY_CAMPAIGN);
QString installerCampaign = campaignIt != installerKeyValues.end() ? campaignIt->second : "";
qDebug() << "Detected installer type:" << installerType;
qDebug() << "Detected installer campaign:" << installerCampaign;
// add firstRun flag from settings to launch event // add firstRun flag from settings to launch event
Setting::Handle<bool> firstRun { Settings::firstRun, true }; Setting::Handle<bool> firstRun { Settings::firstRun, true };
@ -1386,6 +1385,8 @@ Application::Application(int& argc, char** argv, QElapsedTimer& startupTimer, bo
QJsonObject properties = { QJsonObject properties = {
{ "version", applicationVersion() }, { "version", applicationVersion() },
{ "tester", QProcessEnvironment::systemEnvironment().contains(TESTER) }, { "tester", QProcessEnvironment::systemEnvironment().contains(TESTER) },
{ "installer_campaign", installerCampaign },
{ "installer_type", installerType },
{ "previousSessionCrashed", _previousSessionCrashed }, { "previousSessionCrashed", _previousSessionCrashed },
{ "previousSessionRuntime", sessionRunTime.get() }, { "previousSessionRuntime", sessionRunTime.get() },
{ "cpu_architecture", QSysInfo::currentCpuArchitecture() }, { "cpu_architecture", QSysInfo::currentCpuArchitecture() },
@ -1705,7 +1706,15 @@ Application::Application(int& argc, char** argv, QElapsedTimer& startupTimer, bo
const QString HIFI_NO_UPDATER_COMMAND_LINE_KEY = "--no-updater"; const QString HIFI_NO_UPDATER_COMMAND_LINE_KEY = "--no-updater";
bool noUpdater = arguments().indexOf(HIFI_NO_UPDATER_COMMAND_LINE_KEY) != -1; bool noUpdater = arguments().indexOf(HIFI_NO_UPDATER_COMMAND_LINE_KEY) != -1;
if (!noUpdater) { if (!noUpdater) {
constexpr auto INSTALLER_TYPE_CLIENT_ONLY = "client_only";
auto applicationUpdater = DependencyManager::get<AutoUpdater>(); auto applicationUpdater = DependencyManager::get<AutoUpdater>();
AutoUpdater::InstallerType type = installerType == INSTALLER_TYPE_CLIENT_ONLY
? AutoUpdater::InstallerType::CLIENT_ONLY : AutoUpdater::InstallerType::FULL;
applicationUpdater->setInstallerType(type);
applicationUpdater->setInstallerCampaign(installerCampaign);
connect(applicationUpdater.data(), &AutoUpdater::newVersionIsAvailable, dialogsManager.data(), &DialogsManager::showUpdateDialog); connect(applicationUpdater.data(), &AutoUpdater::newVersionIsAvailable, dialogsManager.data(), &DialogsManager::showUpdateDialog);
applicationUpdater->checkForUpdate(); applicationUpdater->checkForUpdate();
} }

15
interface/src/AvatarBookmarks.h
View file

@ -16,7 +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.
* @namespace AvatarBookmarks
*/ */
class AvatarBookmarks: public Bookmarks, public Dependency { class AvatarBookmarks: public Bookmarks, public Dependency {
@ -27,16 +28,12 @@ public:
AvatarBookmarks(); AvatarBookmarks();
void setupMenus(Menu* menubar, MenuWrapper* menu) override; void setupMenus(Menu* menubar, MenuWrapper* menu) override;
/**jsdoc
* Add the current Avatar to your Avatar Bookmarks
* @function AvatarBookmarks.addBookMark
*/
/**jsdoc
* @function AvatarBookmarks.deleteBookMark
*/
public slots: public slots:
/**jsdoc
* Add the current Avatar to your avatar bookmarks.
* @function AvatarBookmarks.addBookMark
*/
void addBookmark(); void addBookmark();
protected: protected:

1
interface/src/Bookmarks.h
View file

@ -49,7 +49,6 @@ protected:
protected slots: protected slots:
/**jsdoc /**jsdoc
* Delete
* @function AvatarBookmarks.deleteBookmark * @function AvatarBookmarks.deleteBookmark
*/ */
void deleteBookmark(); void deleteBookmark();

35
interface/src/LODManager.h
View file

@ -49,21 +49,18 @@ public:
* @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 {number} value
*/ */
Q_INVOKABLE void setDesktopLODDecreaseFPS(float value); Q_INVOKABLE void setDesktopLODDecreaseFPS(float value);
/**jsdoc /**jsdoc
@ -77,28 +74,25 @@ public:
* @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
@ -106,61 +100,54 @@ public:
* @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 {number} presentTime <em>Read-only.</em>
* @property engineRunTime {number} * @property {number} engineRunTime <em>Read-only.</em>
* @property gpuTime {number} * @property {number} gpuTime <em>Read-only.</em>
* @property avgRenderTime {number} * @property {number} avgRenderTime <em>Read-only.</em>
* @property fps {number} * @property {number} fps <em>Read-only.</em>
* @property lodLevel {number} * @property {number} lodLevel <em>Read-only.</em>
* @property lodDecreaseFPS {number} * @property {number} lodDecreaseFPS <em>Read-only.</em>
* @property lodIncreaseFPS {number} * @property {number} lodIncreaseFPS <em>Read-only.</em>
*/ */
Q_PROPERTY(float presentTime READ getPresentTime) Q_PROPERTY(float presentTime READ getPresentTime)
@ -195,14 +182,12 @@ signals:
* @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();
private: private:

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

@ -28,12 +28,12 @@ class AudioScope : public QObject, public 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 {number} scopeInput <em>Read-only.</em>
* @property {int} scopeOutputLeft * @property {number} scopeOutputLeft <em>Read-only.</em>
* @property {int} scopeOutputRight * @property {number} scopeOutputRight <em>Read-only.</em>
* @property {int} triggerInput * @property {number} triggerInput <em>Read-only.</em>
* @property {int} triggerOutputLeft * @property {number} triggerOutputLeft <em>Read-only.</em>
* @property {int} triggerOutputRight * @property {number} triggerOutputRight <em>Read-only.</em>
*/ */
Q_PROPERTY(QVector<int> scopeInput READ getScopeInput) Q_PROPERTY(QVector<int> scopeInput READ getScopeInput)
@ -55,62 +55,52 @@ 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
* @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} paused
*/ */
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
@ -118,109 +108,93 @@ public slots:
* @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} localEcho
*/ */
void setLocalEcho(bool localEcho);
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:
@ -229,14 +203,12 @@ signals:
* @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();
protected: protected:

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

@ -38,75 +38,6 @@ class AvatarManager : public AvatarHashMap {
public: public:
// JSDOCS Copied over from AvatarHashMap (see AvatarHashMap.h for reason)
/**jsdoc
* @function AvatarManager.getAvatarIdentifiers
*/
/**jsdoc
* @function AvatarManager.getAvatarsInRange
* @param {Vec3} position
* @param {float} rangeMeters
* @returns {string[]}
*/
/**jsdoc
* @function AvatarManager.getAvatar
* @param {string} avatarID
* @returns {ScriptAvatarData}
*/
/**jsdoc
* @function AvatarManager.avatarAddedEvent
* @param {string} sessionUUID
* @returns {Signal}
*/
/**jsdoc
* @function AvatarManager.avatarRemovedEvent
* @param {string} sessionUUID
* @returns {Signal}
*/
/**jsdoc
* @function AvatarManager.avatarSessionChangedEvent
* @param {string} sessionUUID
* @param {string} oldUUID
* @returns {Signal}
*/
/**jsdoc
* @function AvatarManager.isAvatarInRange
* @param {string} position
* @param {string} range
* @returns {boolean}
*/
/**jsdoc
* @function AvatarManager.sessionUUIDChanged
* @param {string} sessionUUID
* @param {string} oldUUID
*/
/**jsdoc
* @function AvatarManager.processAvatarDataPacket
* @param {} message
* @param {} sendingNode
*/
/**jsdoc
* @function AvatarManager.processAvatarIdentityPacket
* @param {} message
* @param {} sendingNode
*/
/**jsdoc
* @function AvatarManager.processKillAvatar
* @param {} message
* @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);
@ -119,10 +50,9 @@ public:
/**jsdoc /**jsdoc
* @function AvatarManager.getAvatar * @function AvatarManager.getAvatar
* @param {string} avatarID * @param {Uuid} avatarID
* @returns {} * @returns {AvatarData}
*/ */
// 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)); }
@ -148,16 +78,15 @@ public:
/**jsdoc /**jsdoc
* @function AvatarManager.getAvatarDataRate * @function AvatarManager.getAvatarDataRate
* @param {string} sessionID * @param {Uuid} 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 {Uuid} sessionID
* @param {string} [rateName=""] * @param {string} [rateName=""]
* @returns {number} * @returns {number}
*/ */
@ -166,51 +95,47 @@ public:
/**jsdoc /**jsdoc
* @function AvatarManager.getAvatarSimulationRate * @function AvatarManager.getAvatarSimulationRate
* @param {string} sessionID * @param {Uuid} 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 {Uuid[]} [avatarsToInclude=[]]
* @param {} avatarIdsToDiscard * @param {Uuid[]} [avatarsToDiscard=[]]
* @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
* @function AvatarManager.findRayIntersectionVector * @function AvatarManager.findRayIntersectionVector
* @param {PickRay} ray * @param {PickRay} ray
* @param {} avatarsToInclude * @param {Uuid[]} avatarsToInclude
* @param {} avatarIdsToDiscard * @param {Uuid[]} avatarsToDiscard
* @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,
const QVector<EntityItemID>& avatarsToDiscard); const QVector<EntityItemID>& avatarsToDiscard);
// 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}
*/ */
// TODO: remove this HACK once we settle on optimal default sort coefficients
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 {number} value
*/ */
Q_INVOKABLE void setAvatarSortCoefficient(const QString& name, const QScriptValue& value); Q_INVOKABLE void setAvatarSortCoefficient(const QString& name, const QScriptValue& value);
float getMyAvatarSendRate() const { return _myAvatarSendRate.rate(); } float getMyAvatarSendRate() const { return _myAvatarSendRate.rate(); }
@ -221,7 +146,6 @@ public slots:
* @function AvatarManager.updateAvatarRenderStatus * @function AvatarManager.updateAvatarRenderStatus
* @param {boolean} shouldRenderAvatars * @param {boolean} shouldRenderAvatars
*/ */
void updateAvatarRenderStatus(bool shouldRenderAvatars); void updateAvatarRenderStatus(bool shouldRenderAvatars);
private: private:

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

@ -67,13 +67,11 @@ public slots:
* @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();
private slots: private slots:

4
interface/src/raypick/PickScriptingInterface.h
View file

@ -109,7 +109,7 @@ public:
* *
* @typedef {Object} Picks.RayPickResult * @typedef {Object} Picks.RayPickResult
* @property {number} type The intersection type. * @property {number} type The intersection type.
* @property {bool} intersects If there was a valid intersection (type != INTERSECTED_NONE) * @property {boolean} intersects If there was a valid intersection (type != INTERSECTED_NONE)
* @property {Uuid} objectID The ID of the intersected object. Uuid.NULL for the HUD or invalid intersections. * @property {Uuid} objectID The ID of the intersected object. Uuid.NULL for the HUD or invalid intersections.
* @property {float} distance The distance to the intersection point from the origin of the ray. * @property {float} distance The distance to the intersection point from the origin of the ray.
* @property {Vec3} intersection The intersection point in world-space. * @property {Vec3} intersection The intersection point in world-space.
@ -123,7 +123,7 @@ public:
* *
* @typedef {Object} Picks.StylusPickResult * @typedef {Object} Picks.StylusPickResult
* @property {number} type The intersection type. * @property {number} type The intersection type.
* @property {bool} intersects If there was a valid intersection (type != INTERSECTED_NONE) * @property {boolean} intersects If there was a valid intersection (type != INTERSECTED_NONE)
* @property {Uuid} objectID The ID of the intersected object. Uuid.NULL for the HUD or invalid intersections. * @property {Uuid} objectID The ID of the intersected object. Uuid.NULL for the HUD or invalid intersections.
* @property {float} distance The distance to the intersection point from the origin of the ray. * @property {float} distance The distance to the intersection point from the origin of the ray.
* @property {Vec3} intersection The intersection point in world-space. * @property {Vec3} intersection The intersection point in world-space.

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

@ -39,10 +39,10 @@ class AccountServicesScriptingInterface : public QObject {
* 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 <em>Read-only.</em>
* @property {boolean} loggedIn * @property {boolean} loggedIn <em>Read-only.</em>
* @property {string} findableBy * @property {string} findableBy
* @property {string} metaverseServerURL * @property {string} metaverseServerURL <em>Read-only.</em>
*/ */
Q_PROPERTY(QString username READ getUsername NOTIFY myUsernameChanged) Q_PROPERTY(QString username READ getUsername NOTIFY myUsernameChanged)
@ -63,33 +63,28 @@ public slots:
* @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();
private slots: private slots:
@ -108,47 +103,41 @@ signals:
* @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 * @param {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 * @param {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 * @param {} info
* @returns {Signal} * @returns {Signal}
*/ */
void downloadInfoChanged(DownloadInfoResult info); void downloadInfoChanged(DownloadInfoResult info);
/**jsdoc /**jsdoc
* @function AccountServices.findableByChanged * @function AccountServices.findableByChanged
* @params {string} discoverabilityMode * @param {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 * @param {boolean} loggedIn
* @returns {Signal} * @returns {Signal}
*/ */
void loggedInChanged(bool loggedIn); void loggedInChanged(bool loggedIn);
private: private:

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

@ -31,10 +31,10 @@ class Audio : public AudioScriptingInterface, protected ReadWriteLockable {
* @namespace Audio * @namespace Audio
* @property {boolean} muted * @property {boolean} muted
* @property {boolean} noiseReduction * @property {boolean} noiseReduction
* @property {boolean} inputVolume * @property {number} inputVolume
* @property {boolean} inputLevel * @property {number} inputLevel <em>Read-only.</em>
* @property {string} context * @property {string} context <em>Read-only.</em>
* @property {} devices * @property {} devices <em>Read-only.</em>
*/ */
Q_PROPERTY(bool muted READ isMuted WRITE setMuted NOTIFY mutedChanged) Q_PROPERTY(bool muted READ isMuted WRITE setMuted NOTIFY mutedChanged)
@ -66,7 +66,6 @@ public:
* @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
@ -74,40 +73,36 @@ public:
* @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.startRecording
* @param {string} filename * @param {string} filename
* @returns {boolean}
*/ */
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
* @returns {boolean}
*/ */
Q_INVOKABLE bool getRecording(); Q_INVOKABLE bool getRecording();
signals: signals:
@ -116,39 +111,34 @@ signals:
* @function Audio.nop * @function Audio.nop
* @returns {Signal} * @returns {Signal}
*/ */
void nop(); void nop();
/**jsdoc /**jsdoc
* @function Audio.nop * @function Audio.mutedChanged
* @param {bool} isMuted * @param {boolean} 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 {boolean} 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 {number} 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 {number} level
* @returns {Signal} * @returns {Signal}
*/ */
void inputLevelChanged(float level); void inputLevelChanged(float level);
/**jsdoc /**jsdoc
@ -156,7 +146,6 @@ signals:
* @param {string} context * @param {string} context
* @returns {Signal} * @returns {Signal}
*/ */
void contextChanged(const QString& context); void contextChanged(const QString& context);
public slots: public slots:
@ -165,7 +154,6 @@ public slots:
* @function Audio.onContextChanged * @function Audio.onContextChanged
* @returns {Signal} * @returns {Signal}
*/ */
void onContextChanged(); void onContextChanged();
private slots: private slots:

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

@ -32,7 +32,6 @@ public slots:
* @function GooglePoly.setAPIKey * @function GooglePoly.setAPIKey
* @param {string} key * @param {string} key
*/ */
void setAPIKey(const QString& key); void setAPIKey(const QString& key);
/**jsdoc /**jsdoc
@ -42,7 +41,6 @@ public slots:
* @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
@ -51,7 +49,6 @@ public slots:
* @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
@ -60,7 +57,6 @@ public slots:
* @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
@ -69,7 +65,6 @@ public slots:
* @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
@ -78,7 +73,6 @@ public slots:
* @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
@ -87,7 +81,6 @@ public slots:
* @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
@ -96,7 +89,6 @@ public slots:
* @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
@ -104,7 +96,6 @@ public slots:
* @param {string} input * @param {string} input
* @returns {string} * @returns {string}
*/ */
QString getModelInfo(const QString& input); QString getModelInfo(const QString& input);
private: private:

66
interface/src/scripting/WindowScriptingInterface.h
View file

@ -87,7 +87,7 @@ public slots:
* Display a dialog with the specified message and an "OK" button. The dialog is non-modal; the script continues without * Display a dialog with the specified message and an "OK" button. The dialog is non-modal; the script continues without
* waiting for a user response. * waiting for a user response.
* @function Window.alert * @function Window.alert
* @param {string} message="" - The message to display. * @param {string} [message=""] - The message to display.
* @example <caption>Display a friendly greeting.</caption> * @example <caption>Display a friendly greeting.</caption>
* Window.alert("Welcome!"); * Window.alert("Welcome!");
* print("Script continues without waiting"); * print("Script continues without waiting");
@ -98,7 +98,7 @@ public slots:
* Prompt the user to confirm something. Displays a modal dialog with a message plus "Yes" and "No" buttons. * Prompt the user to confirm something. Displays a modal dialog with a message plus "Yes" and "No" buttons.
* responds. * responds.
* @function Window.confirm * @function Window.confirm
* @param {string} message="" - The question to display. * @param {string} [message=""] - The question to display.
* @returns {boolean} <code>true</code> if the user selects "Yes", otherwise <code>false</code>. * @returns {boolean} <code>true</code> if the user selects "Yes", otherwise <code>false</code>.
* @example <caption>Ask the user a question requiring a yes/no answer.</caption> * @example <caption>Ask the user a question requiring a yes/no answer.</caption>
* var answer = Window.confirm("Are you sure?"); * var answer = Window.confirm("Are you sure?");
@ -128,8 +128,8 @@ public slots:
* buttons. A {@link Window.promptTextChanged|promptTextChanged} signal is emitted when the user OKs the dialog; no signal * buttons. A {@link Window.promptTextChanged|promptTextChanged} signal is emitted when the user OKs the dialog; no signal
* is emitted if the user cancels the dialog. * is emitted if the user cancels the dialog.
* @function Window.promptAsync * @function Window.promptAsync
* @param {string} message - The question to display. * @param {string} [message=""] - The question to display.
* @param {string} defaultText - The default answer text. * @param {string} [defaultText=""] - The default answer text.
* @example <caption>Ask the user a question requiring a text answer without waiting for the answer.</caption> * @example <caption>Ask the user a question requiring a text answer without waiting for the answer.</caption>
* function onPromptTextChanged(text) { * function onPromptTextChanged(text) {
* print("User answer: " + text); * print("User answer: " + text);
@ -144,8 +144,8 @@ public slots:
/**jsdoc /**jsdoc
* Prompt the user to choose a directory. Displays a modal dialog that navigates the directory tree. * Prompt the user to choose a directory. Displays a modal dialog that navigates the directory tree.
* @function Window.browseDir * @function Window.browseDir
* @param {string} title="" - The title to display at the top of the dialog. * @param {string} [title=""] - The title to display at the top of the dialog.
* @param {string} directory="" - The initial directory to start browsing at. * @param {string} [directory=""] - The initial directory to start browsing at.
* @returns {string} The path of the directory if one is chosen, otherwise <code>null</code>. * @returns {string} The path of the directory if one is chosen, otherwise <code>null</code>.
* @example <caption>Ask the user to choose a directory.</caption> * @example <caption>Ask the user to choose a directory.</caption>
* var directory = Window.browseDir("Select Directory", Paths.resources); * var directory = Window.browseDir("Select Directory", Paths.resources);
@ -158,8 +158,8 @@ public slots:
* {@link Window.browseDirChanged|browseDirChanged} signal is emitted when a directory is chosen; no signal is emitted if * {@link Window.browseDirChanged|browseDirChanged} signal is emitted when a directory is chosen; no signal is emitted if
* the user cancels the dialog. * the user cancels the dialog.
* @function Window.browseDirAsync * @function Window.browseDirAsync
* @param {string} title="" - The title to display at the top of the dialog. * @param {string} [title=""] - The title to display at the top of the dialog.
* @param {string} directory="" - The initial directory to start browsing at. * @param {string} [directory=""] - The initial directory to start browsing at.
* @example <caption>Ask the user to choose a directory without waiting for the answer.</caption> * @example <caption>Ask the user to choose a directory without waiting for the answer.</caption>
* function onBrowseDirChanged(directory) { * function onBrowseDirChanged(directory) {
* print("Directory: " + directory); * print("Directory: " + directory);
@ -174,9 +174,9 @@ public slots:
/**jsdoc /**jsdoc
* Prompt the user to choose a file. Displays a modal dialog that navigates the directory tree. * Prompt the user to choose a file. Displays a modal dialog that navigates the directory tree.
* @function Window.browse * @function Window.browse
* @param {string} title="" - The title to display at the top of the dialog. * @param {string} [title=""] - The title to display at the top of the dialog.
* @param {string} directory="" - The initial directory to start browsing at. * @param {string} [directory=""] - The initial directory to start browsing at.
* @param {string} nameFilter="" - The types of files to display. Examples: <code>"*.json"</code> and * @param {string} [nameFilter=""] - The types of files to display. Examples: <code>"*.json"</code> and
* <code>"Images (*.png *.jpg *.svg)"</code>. All files are displayed if a filter isn't specified. * <code>"Images (*.png *.jpg *.svg)"</code>. All files are displayed if a filter isn't specified.
* @returns {string} The path and name of the file if one is chosen, otherwise <code>null</code>. * @returns {string} The path and name of the file if one is chosen, otherwise <code>null</code>.
* @example <caption>Ask the user to choose an image file.</caption> * @example <caption>Ask the user to choose an image file.</caption>
@ -190,9 +190,9 @@ public slots:
* {@link Window.browseChanged|browseChanged} signal is emitted when a file is chosen; no signal is emitted if the user * {@link Window.browseChanged|browseChanged} signal is emitted when a file is chosen; no signal is emitted if the user
* cancels the dialog. * cancels the dialog.
* @function Window.browseAsync * @function Window.browseAsync
* @param {string} title="" - The title to display at the top of the dialog. * @param {string} [title=""] - The title to display at the top of the dialog.
* @param {string} directory="" - The initial directory to start browsing at. * @param {string} [directory=""] - The initial directory to start browsing at.
* @param {string} nameFilter="" - The types of files to display. Examples: <code>"*.json"</code> and * @param {string} [nameFilter=""] - The types of files to display. Examples: <code>"*.json"</code> and
* <code>"Images (*.png *.jpg *.svg)"</code>. All files are displayed if a filter isn't specified. * <code>"Images (*.png *.jpg *.svg)"</code>. All files are displayed if a filter isn't specified.
* @example <caption>Ask the user to choose an image file without waiting for the answer.</caption> * @example <caption>Ask the user to choose an image file without waiting for the answer.</caption>
* function onBrowseChanged(filename) { * function onBrowseChanged(filename) {
@ -209,9 +209,9 @@ public slots:
* Prompt the user to specify the path and name of a file to save to. Displays a model dialog that navigates the directory * Prompt the user to specify the path and name of a file to save to. Displays a model dialog that navigates the directory
* tree and allows the user to type in a file name. * tree and allows the user to type in a file name.
* @function Window.save * @function Window.save
* @param {string} title="" - The title to display at the top of the dialog. * @param {string} [title=""] - The title to display at the top of the dialog.
* @param {string} directory="" - The initial directory to start browsing at. * @param {string} [directory=""] - The initial directory to start browsing at.
* @param {string} nameFilter="" - The types of files to display. Examples: <code>"*.json"</code> and * @param {string} [nameFilter=""] - The types of files to display. Examples: <code>"*.json"</code> and
* <code>"Images (*.png *.jpg *.svg)"</code>. All files are displayed if a filter isn't specified. * <code>"Images (*.png *.jpg *.svg)"</code>. All files are displayed if a filter isn't specified.
* @returns {string} The path and name of the file if one is specified, otherwise <code>null</code>. If a single file type * @returns {string} The path and name of the file if one is specified, otherwise <code>null</code>. If a single file type
* is specified in the nameFilter, that file type extension is automatically appended to the result when appropriate. * is specified in the nameFilter, that file type extension is automatically appended to the result when appropriate.
@ -226,9 +226,9 @@ public slots:
* directory tree and allows the user to type in a file name. A {@link Window.saveFileChanged|saveFileChanged} signal is * directory tree and allows the user to type in a file name. A {@link Window.saveFileChanged|saveFileChanged} signal is
* emitted when a file is specified; no signal is emitted if the user cancels the dialog. * emitted when a file is specified; no signal is emitted if the user cancels the dialog.
* @function Window.saveAsync * @function Window.saveAsync
* @param {string} title="" - The title to display at the top of the dialog. * @param {string} [title=""] - The title to display at the top of the dialog.
* @param {string} directory="" - The initial directory to start browsing at. * @param {string} [directory=""] - The initial directory to start browsing at.
* @param {string} nameFilter="" - The types of files to display. Examples: <code>"*.json"</code> and * @param {string} [nameFilter=""] - The types of files to display. Examples: <code>"*.json"</code> and
* <code>"Images (*.png *.jpg *.svg)"</code>. All files are displayed if a filter isn't specified. * <code>"Images (*.png *.jpg *.svg)"</code>. All files are displayed if a filter isn't specified.
* @example <caption>Ask the user to specify a file to save to without waiting for an answer.</caption> * @example <caption>Ask the user to specify a file to save to without waiting for an answer.</caption>
* function onSaveFileChanged(filename) { * function onSaveFileChanged(filename) {
@ -245,9 +245,9 @@ public slots:
* Prompt the user to choose an Asset Server item. Displays a modal dialog that navigates the tree of assets on the Asset * Prompt the user to choose an Asset Server item. Displays a modal dialog that navigates the tree of assets on the Asset
* Server. * Server.
* @function Window.browseAssets * @function Window.browseAssets
* @param {string} title="" - The title to display at the top of the dialog. * @param {string} [title=""] - The title to display at the top of the dialog.
* @param {string} directory="" - The initial directory to start browsing at. * @param {string} [directory=""] - The initial directory to start browsing at.
* @param {string} nameFilter="" - The types of files to display. Examples: <code>"*.json"</code> and * @param {string} [nameFilter=""] - The types of files to display. Examples: <code>"*.json"</code> and
* <code>"Images (*.png *.jpg *.svg)"</code>. All files are displayed if a filter isn't specified. * <code>"Images (*.png *.jpg *.svg)"</code>. All files are displayed if a filter isn't specified.
* @returns {string} The path and name of the asset if one is chosen, otherwise <code>null</code>. * @returns {string} The path and name of the asset if one is chosen, otherwise <code>null</code>.
* @example <caption>Ask the user to select an FBX asset.</caption> * @example <caption>Ask the user to select an FBX asset.</caption>
@ -261,9 +261,9 @@ public slots:
* Asset Server. A {@link Window.assetsDirChanged|assetsDirChanged} signal is emitted when an asset is chosen; no signal is * Asset Server. A {@link Window.assetsDirChanged|assetsDirChanged} signal is emitted when an asset is chosen; no signal is
* emitted if the user cancels the dialog. * emitted if the user cancels the dialog.
* @function Window.browseAssetsAsync * @function Window.browseAssetsAsync
* @param {string} title="" - The title to display at the top of the dialog. * @param {string} [title=""] - The title to display at the top of the dialog.
* @param {string} directory="" - The initial directory to start browsing at. * @param {string} [directory=""] - The initial directory to start browsing at.
* @param {string} nameFilter="" - The types of files to display. Examples: <code>"*.json"</code> and * @param {string} [nameFilter=""] - The types of files to display. Examples: <code>"*.json"</code> and
* <code>"Images (*.png *.jpg *.svg)"</code>. All files are displayed if a filter isn't specified. * <code>"Images (*.png *.jpg *.svg)"</code>. All files are displayed if a filter isn't specified.
* @example * @example
* function onAssetsDirChanged(asset) { * function onAssetsDirChanged(asset) {
@ -280,7 +280,7 @@ public slots:
* Open the Asset Browser dialog. If a file to upload is specified, the user is prompted to enter the folder and name to * Open the Asset Browser dialog. If a file to upload is specified, the user is prompted to enter the folder and name to
* map the file to on the asset server. * map the file to on the asset server.
* @function Window.showAssetServer * @function Window.showAssetServer
* @param {string} uploadFile="" - The path and name of a file to upload to the asset server. * @param {string} [uploadFile=""] - The path and name of a file to upload to the asset server.
* @example <caption>Upload a file to the asset server.</caption> * @example <caption>Upload a file to the asset server.</caption>
* var filename = Window.browse("Select File to Add to Asset Server", Paths.resources); * var filename = Window.browse("Select File to Add to Asset Server", Paths.resources);
* print("File: " + filename); * print("File: " + filename);
@ -317,14 +317,14 @@ public slots:
* NOTE: to provide a non-default value - all previous parameters must be provided. * NOTE: to provide a non-default value - all previous parameters must be provided.
* General > Snapshots. * General > Snapshots.
* @function Window.takeSnapshot * @function Window.takeSnapshot
* @param {boolean} notify=true - This value is passed on through the {@link Window.stillSnapshotTaken|stillSnapshotTaken} * @param {boolean} [notify=true] - This value is passed on through the {@link Window.stillSnapshotTaken|stillSnapshotTaken}
* signal. * signal.
* @param {boolean} includeAnimated=false - If <code>true</code>, a moving image is captured as an animated GIF in addition * @param {boolean} [includeAnimated=false] - If <code>true</code>, a moving image is captured as an animated GIF in addition
* to a still image. * to a still image.
* @param {number} aspectRatio=0 - The width/height ratio of the snapshot required. If the value is <code>0</code> the * @param {number} [aspectRatio=0] - The width/height ratio of the snapshot required. If the value is <code>0</code> the
* full resolution is used (window dimensions in desktop mode; HMD display dimensions in HMD mode), otherwise one of the * full resolution is used (window dimensions in desktop mode; HMD display dimensions in HMD mode), otherwise one of the
* dimensions is adjusted in order to match the aspect ratio. * dimensions is adjusted in order to match the aspect ratio.
* @param {string} filename="" - If this parameter is not given, the image will be saved as 'hifi-snap-by-<user name>-YYYY-MM-DD_HH-MM-SS'. * @param {string} [filename=""] - If this parameter is not given, the image will be saved as 'hifi-snap-by-<user name>-YYYY-MM-DD_HH-MM-SS'.
* If this parameter is <code>""</code> then the image will be saved as ".jpg". * If this parameter is <code>""</code> then the image will be saved as ".jpg".
* Otherwise, the image will be saved to this filename, with an appended ".jpg". * Otherwise, the image will be saved to this filename, with an appended ".jpg".
* *
@ -358,7 +358,7 @@ public slots:
* Takes a still snapshot of the current view from the secondary camera that can be set up through the {@link Render} API. * Takes a still snapshot of the current view from the secondary camera that can be set up through the {@link Render} API.
* NOTE: to provide a non-default value - all previous parameters must be provided. * NOTE: to provide a non-default value - all previous parameters must be provided.
* @function Window.takeSecondaryCameraSnapshot * @function Window.takeSecondaryCameraSnapshot
* @param {string} filename="" - If this parameter is not given, the image will be saved as 'hifi-snap-by-<user name>-YYYY-MM-DD_HH-MM-SS'. * @param {string} [filename=""] - If this parameter is not given, the image will be saved as 'hifi-snap-by-<user name>-YYYY-MM-DD_HH-MM-SS'.
* If this parameter is <code>""</code> then the image will be saved as ".jpg". * If this parameter is <code>""</code> then the image will be saved as ".jpg".
* Otherwise, the image will be saved to this filename, with an appended ".jpg". * Otherwise, the image will be saved to this filename, with an appended ".jpg".
* *
@ -397,7 +397,7 @@ public slots:
* has been prepared. * has been prepared.
* @function Window.shareSnapshot * @function Window.shareSnapshot
* @param {string} path - The path and name of the image file to share. * @param {string} path - The path and name of the image file to share.
* @param {string} href="" - The metaverse location where the snapshot was taken. * @param {string} [href=""] - The metaverse location where the snapshot was taken.
*/ */
void shareSnapshot(const QString& path, const QUrl& href = QUrl("")); void shareSnapshot(const QString& path, const QUrl& href = QUrl(""));

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

@ -26,10 +26,10 @@ class AvatarInputs : public QObject {
/**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 * @property {boolean} cameraEnabled <em>Read-only.</em>
* @param {boolean} cameraMuted * @property {boolean} cameraMuted <em>Read-only.</em>
* @param {boolean} isHMD * @property {boolean} isHMD <em>Read-only.</em>
* @param {boolean} showAudioTools * @property {boolean} showAudioTools
*/ */
AI_PROPERTY(bool, cameraEnabled, false) AI_PROPERTY(bool, cameraEnabled, false)
@ -46,8 +46,8 @@ public:
* @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);
void update(); void update();
bool showAudioTools() const { return _showAudioTools; } bool showAudioTools() const { return _showAudioTools; }
@ -58,7 +58,6 @@ public slots:
* @function AvatarInputs.setShowAudioTools * @function AvatarInputs.setShowAudioTools
* @param {boolean} showAudioTools * @param {boolean} showAudioTools
*/ */
void setShowAudioTools(bool showAudioTools); void setShowAudioTools(bool showAudioTools);
signals: signals:
@ -67,14 +66,12 @@ signals:
* @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
@ -89,7 +86,6 @@ signals:
* @param {boolean} show * @param {boolean} show
* @returns {Signal} * @returns {Signal}
*/ */
void showAudioToolsChanged(bool show); void showAudioToolsChanged(bool show);
protected: protected:
@ -97,13 +93,11 @@ 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();
private: private:

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

@ -20,11 +20,6 @@
#include <FBXReader.h> #include <FBXReader.h>
#include <ResourceCache.h> #include <ResourceCache.h>
/**jsdoc
* API to manage Animation Cache resources
* @namespace AnimationCache
*/
class Animation; class Animation;
typedef QSharedPointer<Animation> AnimationPointer; typedef QSharedPointer<Animation> AnimationPointer;
@ -35,79 +30,67 @@ class AnimationCache : public ResourceCache, public Dependency {
SINGLETON_DEPENDENCY SINGLETON_DEPENDENCY
public: public:
// Copied over from ResourceCache (see ResourceCache.h for reason)
// Properties are copied over from ResourceCache (see ResourceCache.h for reason).
/**jsdoc /**jsdoc
* API to manage animation cache resources.
* @namespace AnimationCache * @namespace AnimationCache
* @property numTotal {number} total number of total resources *
* @property numCached {number} total number of cached resource * @property {number} numTotal - Total number of total resources. <em>Read-only.</em>
* @property sizeTotal {number} size in bytes of all resources * @property {number} numCached - Total number of cached resource. <em>Read-only.</em>
* @property sizeCached {number} size in bytes of all cached resources * @property {number} sizeTotal - Size in bytes of all resources. <em>Read-only.</em>
* @property {number} sizeCached - Size in bytes of all cached resources. <em>Read-only.</em>
*/ */
/**jsdoc // Functions are copied over from ResourceCache (see ResourceCache.h for reason).
* Returns the total number of resources
* @function AnimationCache.getNumTotalResources
* @returns {number}
*/
/**jsdoc /**jsdoc
* Returns the total size in bytes of all resources * Get the list of all resource URLs.
* @function AnimationCache.getSizeTotalResources
* @returns {number}
*/
/**jsdoc
* Returns the total number of cached resources
* @function AnimationCache.getNumCachedResources
* @returns {number}
*/
/**jsdoc
* Returns the total size in bytes of cached resources
* @function AnimationCache.getSizeCachedResources
* @returns {number}
*/
/**jsdoc
* Returns list of all resource urls
* @function AnimationCache.getResourceList * @function AnimationCache.getResourceList
* @returns {string[]} * @return {string[]}
*/ */
/**jsdoc /**jsdoc
* Asynchronously loads a resource from the spedified URL and returns it.
* @param url {string} url of resource to load
* @param fallback {string} fallback URL if load of the desired url fails
* @function AnimationCache.getResource
* @returns {Resource}
*/
/**jsdoc
* Prefetches a resource.
* @param url {string} url of resource to load
* @function AnimationCache.prefetch
* @returns {Resource}
*/
/**jsdoc
* @param {number} deltaSize
* @function AnimationCache.updateTotalSize
* @returns {Resource}
*/
/**jsdoc
* @function AnimationCache.dirty * @function AnimationCache.dirty
* @returns {Signal} * @returns {Signal}
*/ */
/**jsdoc
* @function AnimationCache.updateTotalSize
* @param {number} deltaSize
*/
/**jsdoc
* @function AnimationCache.prefetch
* @param {string} url
* @param {object} extra
* @returns {object}
*/
/**jsdoc
* Asynchronously loads a resource from the specified URL and returns it.
* @function AnimationCache.getResource
* @param {string} url - URL of the resource to load.
* @param {string} [fallback=""] - Fallback URL if load of the desired URL fails.
* @param {} [extra=null]
* @return {Resource}
*/
/**jsdoc
* Prefetches a resource.
* @function AnimationCache.prefetch
* @param {string} url - URL of the resource to prefetch.
* @return {Resource}
*/
/**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 {string} url - 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);

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

@ -40,65 +40,135 @@ class AudioStreamStatsInterface : public QObject {
Q_OBJECT Q_OBJECT
/**jsdoc /**jsdoc
* Audio stats from the Audio Mixer * @class AudioStats.AudioStreamStats
* @namespace AudioStats.mixerStream * @property {number} lossRate <em>Read-only.</em>
* @param {number} lossRate * @property {number} lossCount <em>Read-only.</em>
* @param {number} lossCount * @property {number} lossRateWindow <em>Read-only.</em>
* @param {number} lossRateWindow * @property {number} lossCountWindow <em>Read-only.</em>
* @param {number} lossCountWindow * @property {number} framesDesired <em>Read-only.</em>
* @param {number} framesDesired * @property {number} framesAvailable <em>Read-only.</em>
* @param {number} framesAvailable * @property {number} framesAvailableAvg <em>Read-only.</em>
* @param {number} framesAvailableAvg * @property {number} unplayedMsMax <em>Read-only.</em>
* @param {number} unplayedMsMax * @property {number} starveCount <em>Read-only.</em>
* @param {number} starveCount * @property {number} lastStarveDurationCount <em>Read-only.</em>
* @param {number} lastStarveDurationCount * @property {number} dropCount <em>Read-only.</em>
* @param {number} dropCount * @property {number} overflowCount <em>Read-only.</em>
* @param {number} overflowCount * @property {number} timegapMsMax <em>Read-only.</em>
* @param {number} timegapMsMax * @property {number} timegapMsAvg <em>Read-only.</em>
* @param {number} timegapMsAvg * @property {number} timegapMsMaxWindow <em>Read-only.</em>
* @param {number} timegapMsMaxWindow * @property {number} timegapMsAvgWindow <em>Read-only.</em>
* @param {number} timegapMsAvgWindow
*/ */
/**jsdoc /**jsdoc
* Audio stats from the Client Mixer * @function AudioStats.AudioStreamStats.lossRateChanged
* @namespace AudioStats.clientMixer
* @param {number} lossRate * @param {number} lossRate
* @param {number} lossCount * @returns {Signal}
* @param {number} lossRateWindow
* @param {number} lossCountWindow
* @param {number} framesDesired
* @param {number} framesAvailable
* @param {number} framesAvailableAvg
* @param {number} unplayedMsMax
* @param {number} starveCount
* @param {number} lastStarveDurationCount
* @param {number} dropCount
* @param {number} overflowCount
* @param {number} timegapMsMax
* @param {number} timegapMsAvg
* @param {number} timegapMsMaxWindow
* @param {number} timegapMsAvgWindow
*/ */
AUDIO_PROPERTY(float, lossRate) AUDIO_PROPERTY(float, lossRate)
/**jsdoc
* @function AudioStats.AudioStreamStats.lossCountChanged
* @param {number} lossCount
* @returns {Signal}
*/
AUDIO_PROPERTY(float, lossCount) AUDIO_PROPERTY(float, lossCount)
/**jsdoc
* @function AudioStats.AudioStreamStats.lossRateWindowChanged
* @param {number} lossRateWindow
* @returns {Signal}
*/
AUDIO_PROPERTY(float, lossRateWindow) AUDIO_PROPERTY(float, lossRateWindow)
/**jsdoc
* @function AudioStats.AudioStreamStats.lossCountWindowChanged
* @param {number} lossCountWindow
* @returns {Signal}
*/
AUDIO_PROPERTY(float, lossCountWindow) AUDIO_PROPERTY(float, lossCountWindow)
/**jsdoc
* @function AudioStats.AudioStreamStats.framesDesiredChanged
* @param {number} framesDesired
* @returns {Signal}
*/
AUDIO_PROPERTY(int, framesDesired) AUDIO_PROPERTY(int, framesDesired)
/**jsdoc
* @function AudioStats.AudioStreamStats.framesAvailableChanged
* @param {number} framesAvailable
* @returns {Signal}
*/
AUDIO_PROPERTY(int, framesAvailable) AUDIO_PROPERTY(int, framesAvailable)
/**jsdoc
* @function AudioStats.AudioStreamStats.framesAvailableAvgChanged
* @param {number} framesAvailableAvg
* @returns {Signal}
*/
AUDIO_PROPERTY(int, framesAvailableAvg) AUDIO_PROPERTY(int, framesAvailableAvg)
/**jsdoc
* @function AudioStats.AudioStreamStats.unplayedMsMaxChanged
* @param {number} unplayedMsMax
* @returns {Signal}
*/
AUDIO_PROPERTY(float, unplayedMsMax) AUDIO_PROPERTY(float, unplayedMsMax)
/**jsdoc
* @function AudioStats.AudioStreamStats.starveCountChanged
* @param {number} starveCount
* @returns {Signal}
*/
AUDIO_PROPERTY(int, starveCount) AUDIO_PROPERTY(int, starveCount)
/**jsdoc
* @function AudioStats.AudioStreamStats.lastStarveDurationCountChanged
* @param {number} lastStarveDurationCount
* @returns {Signal}
*/
AUDIO_PROPERTY(int, lastStarveDurationCount) AUDIO_PROPERTY(int, lastStarveDurationCount)
/**jsdoc
* @function AudioStats.AudioStreamStats.dropCountChanged
* @param {number} dropCount
* @returns {Signal}
*/
AUDIO_PROPERTY(int, dropCount) AUDIO_PROPERTY(int, dropCount)
/**jsdoc
* @function AudioStats.AudioStreamStats.overflowCountChanged
* @param {number} overflowCount
* @returns {Signal}
*/
AUDIO_PROPERTY(int, overflowCount) AUDIO_PROPERTY(int, overflowCount)
/**jsdoc
* @function AudioStats.AudioStreamStats.timegapMsMaxChanged
* @param {number} timegapMsMax
* @returns {Signal}
*/
AUDIO_PROPERTY(quint64, timegapMsMax) AUDIO_PROPERTY(quint64, timegapMsMax)
/**jsdoc
* @function AudioStats.AudioStreamStats.timegapMsAvgChanged
* @param {number} timegapMsAvg
* @returns {Signal}
*/
AUDIO_PROPERTY(quint64, timegapMsAvg) AUDIO_PROPERTY(quint64, timegapMsAvg)
/**jsdoc
* @function AudioStats.AudioStreamStats.timegapMsMaxWindowChanged
* @param {number} timegapMsMaxWindow
* @returns {Signal}
*/
AUDIO_PROPERTY(quint64, timegapMsMaxWindow) AUDIO_PROPERTY(quint64, timegapMsMaxWindow)
/**jsdoc
* @function AudioStats.AudioStreamStats.timegapMsAvgWindowChanged
* @param {number} timegapMsAvgWindow
* @returns {Signal}
*/
AUDIO_PROPERTY(quint64, timegapMsAvgWindow) AUDIO_PROPERTY(quint64, timegapMsAvgWindow)
public: public:
@ -113,31 +183,82 @@ 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 * @property {number} pingMs <em>Read-only.</em>
* @param {number} inputReadMsMax * @property {number} inputReadMsMax <em>Read-only.</em>
* @param {number} inputUnplayedMsMax * @property {number} inputUnplayedMsMax <em>Read-only.</em>
* @param {number} outputUnplayedMsMax * @property {number} outputUnplayedMsMax <em>Read-only.</em>
* @param {number} sentTimegapMsMax * @property {number} sentTimegapMsMax <em>Read-only.</em>
* @param {number} sentTimegapMsAvg * @property {number} sentTimegapMsAvg <em>Read-only.</em>
* @param {number} sentTimegapMsMaxWindow * @property {number} sentTimegapMsMaxWindow <em>Read-only.</em>
* @param {number} sentTimegapMsAvgWindow * @property {number} sentTimegapMsAvgWindow <em>Read-only.</em>
* @property {AudioStats.AudioStreamStats} clientStream <em>Read-only.</em>
* @property {AudioStats.AudioStreamStats} mixerStream <em>Read-only.</em>
*/ */
/**jsdoc
* @function AudioStats.pingMsChanged
* @param {number} pingMs
* @returns {Signal}
*/
AUDIO_PROPERTY(float, pingMs); AUDIO_PROPERTY(float, pingMs);
/**jsdoc
* @function AudioStats.inputReadMsMaxChanged
* @param {number} inputReadMsMax
* @returns {Signal}
*/
AUDIO_PROPERTY(float, inputReadMsMax); AUDIO_PROPERTY(float, inputReadMsMax);
/**jsdoc
* @function AudioStats.inputUnplayedMsMaxChanged
* @param {number} inputUnplayedMsMax
* @returns {Signal}
*/
AUDIO_PROPERTY(float, inputUnplayedMsMax); AUDIO_PROPERTY(float, inputUnplayedMsMax);
/**jsdoc
* @function AudioStats.outputUnplayedMsMaxChanged
* @param {number} outputUnplayedMsMax
* @returns {Signal}
*/
AUDIO_PROPERTY(float, outputUnplayedMsMax); AUDIO_PROPERTY(float, outputUnplayedMsMax);
/**jsdoc
* @function AudioStats.sentTimegapMsMaxChanged
* @param {number} sentTimegapMsMax
* @returns {Signal}
*/
AUDIO_PROPERTY(quint64, sentTimegapMsMax); AUDIO_PROPERTY(quint64, sentTimegapMsMax);
/**jsdoc
* @function AudioStats.sentTimegapMsAvgChanged
* @param {number} sentTimegapMsAvg
* @returns {Signal}
*/
AUDIO_PROPERTY(quint64, sentTimegapMsAvg); AUDIO_PROPERTY(quint64, sentTimegapMsAvg);
/**jsdoc
* @function AudioStats.sentTimegapMsMaxWindowChanged
* @param {number} sentTimegapMsMaxWindow
* @returns {Signal}
*/
AUDIO_PROPERTY(quint64, sentTimegapMsMaxWindow); AUDIO_PROPERTY(quint64, sentTimegapMsMaxWindow);
/**jsdoc
* @function AudioStats.sentTimegapMsAvgWindowChanged
* @param {number} sentTimegapMsAvgWindow
* @returns {Signal}
*/
AUDIO_PROPERTY(quint64, sentTimegapMsAvgWindow); AUDIO_PROPERTY(quint64, sentTimegapMsAvgWindow);
Q_PROPERTY(AudioStreamStatsInterface* mixerStream READ getMixerStream NOTIFY mixerStreamChanged); Q_PROPERTY(AudioStreamStatsInterface* mixerStream READ getMixerStream NOTIFY mixerStreamChanged);
Q_PROPERTY(AudioStreamStatsInterface* clientStream READ getClientStream NOTIFY clientStreamChanged); Q_PROPERTY(AudioStreamStatsInterface* clientStream READ getClientStream NOTIFY clientStreamChanged);
// FIXME: The injectorStreams property isn't available in JavaScript but the notification signal is.
Q_PROPERTY(QObject* injectorStreams READ getInjectorStreams NOTIFY injectorStreamsChanged); Q_PROPERTY(QObject* injectorStreams READ getInjectorStreams NOTIFY injectorStreamsChanged);
public: public:
@ -159,21 +280,18 @@ signals:
* @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();
private: private:

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

@ -16,84 +16,32 @@
#include "Sound.h" #include "Sound.h"
/**jsdoc
* API to manage Sound Cache resources
* @namespace SoundCache
*/
/// Scriptable interface for sound loading. /// Scriptable interface for sound loading.
class SoundCache : public ResourceCache, public Dependency { class SoundCache : public ResourceCache, public Dependency {
Q_OBJECT Q_OBJECT
SINGLETON_DEPENDENCY SINGLETON_DEPENDENCY
public: public:
// Copied over from ResourceCache (see ResourceCache.h for reason)
// Properties are copied over from ResourceCache (see ResourceCache.h for reason).
/**jsdoc /**jsdoc
* API to manage sound cache resources.
* @namespace SoundCache * @namespace SoundCache
* @property numTotal {number} total number of total resources *
* @property numCached {number} total number of cached resource * @property {number} numTotal - Total number of total resources. <em>Read-only.</em>
* @property sizeTotal {number} size in bytes of all resources * @property {number} numCached - Total number of cached resource. <em>Read-only.</em>
* @property sizeCached {number} size in bytes of all cached resources * @property {number} sizeTotal - Size in bytes of all resources. <em>Read-only.</em>
* @property {number} sizeCached - Size in bytes of all cached resources. <em>Read-only.</em>
*/ */
/**jsdoc
* Returns the total number of resources // Functions are copied over from ResourceCache (see ResourceCache.h for reason).
* @function SoundCache.getNumTotalResources
* @returns {number}
*/
/**jsdoc /**jsdoc
* Returns the total size in bytes of all resources * Get the list of all resource URLs.
* @function SoundCache.getSizeTotalResources
* @returns {number}
*/
/**jsdoc
* Returns the total number of cached resources
* @function SoundCache.getNumCachedResources
* @returns {number}
*/
/**jsdoc
* Returns the total size in bytes of cached resources
* @function SoundCache.getSizeCachedResources
* @returns {number}
*/
/**jsdoc
* Returns list of all resource urls
* @function SoundCache.getResourceList * @function SoundCache.getResourceList
* @returns {string[]} * @return {string[]}
*/
/**jsdoc
* Returns animation resource for particular animation
* @function SoundCache.getAnimation
* @param url {string} url to load
* @returns {Resource} animation
*/
/**jsdoc
* Asynchronously loads a resource from the spedified URL and returns it.
* @param url {string} url of resource to load
* @param fallback {string} fallback URL if load of the desired url fails
* @function SoundCache.getResource
* @returns {Resource}
*/
/**jsdoc
* Prefetches a resource.
* @param url {string} url of resource to load
* @function SoundCache.prefetch
* @returns {Resource}
*/
/**jsdoc
* @param {number} deltaSize
* @function SoundCache.updateTotalSize
* @returns {Resource}
*/ */
/**jsdoc /**jsdoc
@ -101,12 +49,40 @@ public:
* @returns {Signal} * @returns {Signal}
*/ */
/**jsdoc
* @function SoundCache.updateTotalSize
* @param {number} deltaSize
*/
/**jsdoc
* @function SoundCache.prefetch
* @param {string} url
* @param {object} extra
* @returns {object}
*/
/**jsdoc
* Asynchronously loads a resource from the specified URL and returns it.
* @function SoundCache.getResource
* @param {string} url - URL of the resource to load.
* @param {string} [fallback=""] - Fallback URL if load of the desired URL fails.
* @param {} [extra=null]
* @return {Resource}
*/
/**jsdoc
* Prefetches a resource.
* @function SoundCache.prefetch
* @param {string} url - URL of the resource to prefetch.
* @return {Resource}
*/
/**jsdoc /**jsdoc
* @function SoundCache.getSound * @function SoundCache.getSound
* @param {string} url * @param {string} url
* @returns {} * @returns {object}
*/ */
Q_INVOKABLE SharedSoundPointer getSound(const QUrl& url); Q_INVOKABLE SharedSoundPointer getSound(const QUrl& url);
protected: protected:
virtual QSharedPointer<Resource> createResource(const QUrl& url, const QSharedPointer<Resource>& fallback, virtual QSharedPointer<Resource> createResource(const QUrl& url, const QSharedPointer<Resource>& fallback,

130
libraries/auto-updater/src/AutoUpdater.cpp
View file

@ -13,6 +13,7 @@
#include <NetworkAccessManager.h> #include <NetworkAccessManager.h>
#include <SharedUtil.h> #include <SharedUtil.h>
#include <unordered_map>
AutoUpdater::AutoUpdater() { AutoUpdater::AutoUpdater() {
#if defined Q_OS_WIN32 #if defined Q_OS_WIN32
@ -43,63 +44,114 @@ void AutoUpdater::parseLatestVersionData() {
QNetworkReply* sender = qobject_cast<QNetworkReply*>(QObject::sender()); QNetworkReply* sender = qobject_cast<QNetworkReply*>(QObject::sender());
QXmlStreamReader xml(sender); QXmlStreamReader xml(sender);
struct InstallerURLs {
QString full;
QString clientOnly;
};
int version; int version { 0 };
QString downloadUrl; QString downloadUrl;
QString releaseTime; QString releaseTime;
QString releaseNotes; QString releaseNotes;
QString commitSha; QString commitSha;
QString pullRequestNumber; QString pullRequestNumber;
while (!xml.atEnd() && !xml.hasError()) { while (xml.readNextStartElement()) {
if (xml.name().toString() == "project" && if (xml.name() == "projects") {
xml.attributes().hasAttribute("name") && while (xml.readNextStartElement()) {
xml.attributes().value("name").toString() == "interface") { if (xml.name().toString() == "project" &&
xml.readNext();
while (!xml.atEnd() && !xml.hasError() && xml.name().toString() != "project") {
if (xml.name().toString() == "platform" &&
xml.attributes().hasAttribute("name") && xml.attributes().hasAttribute("name") &&
xml.attributes().value("name").toString() == _operatingSystem) { xml.attributes().value("name").toString() == "interface") {
xml.readNext();
while (!xml.atEnd() && !xml.hasError() && while (xml.readNextStartElement()) {
xml.name().toString() != "platform") {
if (xml.name().toString() == "platform" &&
if (xml.name().toString() == "build" && xml.tokenType() != QXmlStreamReader::EndElement) { xml.attributes().hasAttribute("name") &&
xml.readNext(); xml.attributes().value("name").toString() == _operatingSystem) {
version = xml.readElementText().toInt();
xml.readNext(); while (xml.readNextStartElement()) {
downloadUrl = xml.readElementText(); if (xml.name() == "build") {
xml.readNext(); QHash<QString, InstallerURLs> campaignInstallers;
releaseTime = xml.readElementText();
xml.readNext(); while (xml.readNextStartElement()) {
if (xml.name().toString() == "notes" && xml.tokenType() != QXmlStreamReader::EndElement) { if (xml.name() == "version") {
xml.readNext(); version = xml.readElementText().toInt();
while (!xml.atEnd() && !xml.hasError() && xml.name().toString() != "notes") { } else if (xml.name() == "url") {
if (xml.name().toString() == "note" && xml.tokenType() != QXmlStreamReader::EndElement) { downloadUrl = xml.readElementText();
releaseNotes = releaseNotes + "\n" + xml.readElementText(); } else if (xml.name() == "installers") {
while (xml.readNextStartElement()) {
QString campaign = xml.name().toString();
QString full;
QString clientOnly;
while (xml.readNextStartElement()) {
if (xml.name() == "full") {
full = xml.readElementText();
} else if (xml.name() == "client_only") {
clientOnly = xml.readElementText();
} else {
xml.skipCurrentElement();
}
}
campaignInstallers[campaign] = { full, clientOnly };
}
} else if (xml.name() == "timestamp") {
releaseTime = xml.readElementText();
} else if (xml.name() == "notes") {
while (xml.readNextStartElement()) {
if (xml.name() == "note") {
releaseNotes = releaseNotes + "\n" + xml.readElementText();
} else {
xml.skipCurrentElement();
}
}
} else if (xml.name() == "sha") {
commitSha = xml.readElementText();
} else if (xml.name() == "pull_request") {
pullRequestNumber = xml.readElementText();
} else {
xml.skipCurrentElement();
}
} }
xml.readNext();
static const QString DEFAULT_INSTALLER_CAMPAIGN_NAME = "standard";
for (auto& campaign : { _installerCampaign, DEFAULT_INSTALLER_CAMPAIGN_NAME }) {
auto it = campaignInstallers.find(campaign);
if (it != campaignInstallers.end()) {
auto& urls = *it;
if (_installerType == InstallerType::CLIENT_ONLY) {
if (!urls.clientOnly.isEmpty()) {
downloadUrl = urls.clientOnly;
break;
}
} else {
if (!urls.full.isEmpty()) {
downloadUrl = urls.full;
break;
}
}
}
}
appendBuildData(version, downloadUrl, releaseTime, releaseNotes, pullRequestNumber);
releaseNotes = "";
} else {
xml.skipCurrentElement();
} }
} }
xml.readNext(); } else {
commitSha = xml.readElementText(); xml.skipCurrentElement();
xml.readNext();
pullRequestNumber = xml.readElementText();
appendBuildData(version, downloadUrl, releaseTime, releaseNotes, pullRequestNumber);
releaseNotes = "";
} }
xml.readNext();
} }
} else {
xml.skipCurrentElement();
} }
xml.readNext();
} }
} else { } else {
xml.readNext(); xml.skipCurrentElement();
} }
} }
sender->deleteLater(); sender->deleteLater();
emit latestVersionDataParsed(); emit latestVersionDataParsed();
} }

9
libraries/auto-updater/src/AutoUpdater.h
View file

@ -36,10 +36,17 @@ class AutoUpdater : public QObject, public Dependency {
public: public:
AutoUpdater(); AutoUpdater();
enum class InstallerType {
CLIENT_ONLY = 0,
FULL
};
void checkForUpdate(); void checkForUpdate();
const QMap<int, QMap<QString, QString>>& getBuildData() { return _builds; } const QMap<int, QMap<QString, QString>>& getBuildData() { return _builds; }
void performAutoUpdate(int version); void performAutoUpdate(int version);
void setInstallerType(InstallerType type) { _installerType = type; }
void setInstallerCampaign(QString campaign) { _installerCampaign = campaign; }
signals: signals:
void latestVersionDataParsed(); void latestVersionDataParsed();
@ -49,6 +56,8 @@ signals:
private: private:
QMap<int, QMap<QString, QString>> _builds; QMap<int, QMap<QString, QString>> _builds;
QString _operatingSystem; QString _operatingSystem;
InstallerType _installerType { InstallerType::FULL };
QString _installerCampaign { "" };
void getLatestVersionData(); void getLatestVersionData();
void downloadUpdateVersion(int version); void downloadUpdateVersion(int version);

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

@ -30,15 +30,6 @@
#include "AvatarData.h" #include "AvatarData.h"
/**jsdoc
* The AvatarHashMap API deals with functionality related to Avatar information and connectivity
* @namespace AvatarHashMap
*/
// JSDoc 3.5.5 doesn't augment @property definitions.
// These functions are being copied into Avatar classes which inherit the AvatarHashMap
class AvatarHashMap : public QObject, public Dependency { class AvatarHashMap : public QObject, public Dependency {
Q_OBJECT Q_OBJECT
SINGLETON_DEPENDENCY SINGLETON_DEPENDENCY
@ -51,26 +42,20 @@ 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 AvatarManager.getAvatarIdentifiers
* @returns {Uuid[]}
*/ */
Q_INVOKABLE QVector<QUuid> getAvatarIdentifiers(); Q_INVOKABLE QVector<QUuid> getAvatarIdentifiers();
/**jsdoc /**jsdoc
* @function AvatarHashMap.getAvatarsInRange * @function AvatarManager.getAvatarsInRange
* @param {Vec3} position * @param {Vec3} position
* @param {float} rangeMeters * @param {number} range
* @returns {string[]} * @returns {Uuid[]}
*/ */
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 // No JSDod because it's documwented in AvatarManager.
* @function AvatarHashMap.getAvatar
* @param {string} avatarID
* @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,73 +65,65 @@ public:
signals: signals:
/**jsdoc /**jsdoc
* @function AvatarHashMap.avatarAddedEvent * @function AvatarManager.avatarAddedEvent
* @param {string} sessionUUID * @param {Uuid} sessionUUID
* @returns {Signal} * @returns {Signal}
*/ */
void avatarAddedEvent(const QUuid& sessionUUID); void avatarAddedEvent(const QUuid& sessionUUID);
/**jsdoc /**jsdoc
* @function AvatarHashMap.avatarRemovedEvent * @function AvatarManager.avatarRemovedEvent
* @param {string} sessionUUID * @param {Uuid} sessionUUID
* @returns {Signal} * @returns {Signal}
*/ */
void avatarRemovedEvent(const QUuid& sessionUUID); void avatarRemovedEvent(const QUuid& sessionUUID);
/**jsdoc /**jsdoc
* @function AvatarHashMap.avatarSessionChangedEvent * @function AvatarManager.avatarSessionChangedEvent
* @param {string} sessionUUID * @param {Uuid} sessionUUID
* @param {string} oldUUID * @param {Uuid} oldSessionUUID
* @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 AvatarManager.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 AvatarManager.sessionUUIDChanged
* @param {string} sessionUUID * @param {Uuid} sessionUUID
* @param {string} oldUUID * @param {Uuid} oldSessionUUID
*/ */
void sessionUUIDChanged(const QUuid& sessionUUID, const QUuid& oldUUID); void sessionUUIDChanged(const QUuid& sessionUUID, const QUuid& oldUUID);
/**jsdoc /**jsdoc
* @function AvatarHashMap.processAvatarDataPacket * @function AvatarManager.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 AvatarManager.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 AvatarManager.processKillAvatar
* @param {} message * @param {} message
* @param {} sendingNode * @param {} sendingNode
*/ */
void processKillAvatar(QSharedPointer<ReceivedMessage> message, SharedNodePointer sendingNode); void processKillAvatar(QSharedPointer<ReceivedMessage> message, SharedNodePointer sendingNode);
protected: protected:

2
libraries/entities/src/EntityScriptingInterface.h
View file

@ -393,7 +393,7 @@ public slots:
* @param {Entities.EntityType} entityName - The name of the entity to search for. * @param {Entities.EntityType} entityName - The name of the entity to search for.
* @param {Vec3} center - The point about which to search. * @param {Vec3} center - The point about which to search.
* @param {number} radius - The radius within which to search. * @param {number} radius - The radius within which to search.
* @param {bool} caseSensitiveSearch - Choose whether to to return case sensitive results back. * @param {boolean} caseSensitiveSearch - Choose whether to to return case sensitive results back.
* @returns {Uuid[]} An array of entity IDs of the specified type that intersect the search sphere. The array is empty if * @returns {Uuid[]} An array of entity IDs of the specified type that intersect the search sphere. The array is empty if
* no entities could be found. * no entities could be found.
* @example <caption>Get back a list of entities</caption> * @example <caption>Get back a list of entities</caption>

93
libraries/model-networking/src/model-networking/ModelCache.h
View file

@ -21,11 +21,6 @@
#include "FBXReader.h" #include "FBXReader.h"
#include "TextureCache.h" #include "TextureCache.h"
/**jsdoc
* API to manage Model Cache resources
* @namespace ModelCache
*/
// Alias instead of derive to avoid copying // Alias instead of derive to avoid copying
class NetworkTexture; class NetworkTexture;
@ -141,72 +136,62 @@ class ModelCache : public ResourceCache, public Dependency {
Q_OBJECT Q_OBJECT
SINGLETON_DEPENDENCY SINGLETON_DEPENDENCY
public: public:
/**jsdoc // Properties are copied over from ResourceCache (see ResourceCache.h for reason).
* @namespace ModelCache
* @property numTotal {number} total number of total resources
* @property numCached {number} total number of cached resource
* @property sizeTotal {number} size in bytes of all resources
* @property sizeCached {number} size in bytes of all cached resources
*/
/**jsdoc /**jsdoc
* Returns the total number of resources * API to manage model cache resources.
* @function ModelCache.getNumTotalResources * @namespace ModelCache
* @returns {number} *
*/ * @property {number} numTotal - Total number of total resources. <em>Read-only.</em>
* @property {number} numCached - Total number of cached resource. <em>Read-only.</em>
* @property {number} sizeTotal - Size in bytes of all resources. <em>Read-only.</em>
* @property {number} sizeCached - Size in bytes of all cached resources. <em>Read-only.</em>
*/
// Functions are copied over from ResourceCache (see ResourceCache.h for reason).
/**jsdoc /**jsdoc
* Returns the total size in bytes of all resources * Get the list of all resource URLs.
* @function ModelCache.getSizeTotalResources * @function ModelCache.getResourceList
* @returns {number} * @return {string[]}
*/ */
/**jsdoc /**jsdoc
* Returns the total number of cached resources * @function ModelCache.dirty
* @function ModelCache.getNumCachedResources * @returns {Signal}
* @returns {number} */
*/
/**jsdoc /**jsdoc
* Returns the total size in bytes of cached resources * @function ModelCache.updateTotalSize
* @function ModelCache.getSizeCachedResources * @param {number} deltaSize
* @returns {number} */
*/
/**jsdoc /**jsdoc
* Returns list of all resource urls * @function ModelCache.prefetch
* @function ModelCache.getResourceList * @param {string} url
* @returns {string[]} * @param {object} extra
*/ * @returns {object}
*/
/**jsdoc /**jsdoc
* Asynchronously loads a resource from the spedified URL and returns it. * Asynchronously loads a resource from the specified URL and returns it.
* @param url {string} url of resource to load * @function ModelCache.getResource
* @param fallback {string} fallback URL if load of the desired url fails * @param {string} url - URL of the resource to load.
* @function ModelCache.getResource * @param {string} [fallback=""] - Fallback URL if load of the desired URL fails.
* @returns {Resource} * @param {} [extra=null]
*/ * @return {Resource}
*/
/**jsdoc /**jsdoc
* Prefetches a resource. * Prefetches a resource.
* @param url {string} url of resource to load * @function ModelCache.prefetch
* @function ModelCache.prefetch * @param {string} url - URL of the resource to prefetch.
* @returns {Resource} * @return {Resource}
*/ */
/**jsdoc
* @param {number} deltaSize
* @function ModelCache.updateTotalSize
* @returns {Resource}
*/
/**jsdoc
* @function ModelCache.dirty
* @returns {Signal}
*/
GeometryResource::Pointer getGeometryResource(const QUrl& url, GeometryResource::Pointer getGeometryResource(const QUrl& url,
const QVariantHash& mapping = QVariantHash(), const QVariantHash& mapping = QVariantHash(),

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

@ -137,10 +137,6 @@ using NetworkTexturePointer = QSharedPointer<NetworkTexture>;
Q_DECLARE_METATYPE(QWeakPointer<NetworkTexture>) Q_DECLARE_METATYPE(QWeakPointer<NetworkTexture>)
/**jsdoc
* API to manage Texture Cache resources
* @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 {
@ -148,78 +144,61 @@ class TextureCache : public ResourceCache, public Dependency {
SINGLETON_DEPENDENCY SINGLETON_DEPENDENCY
public: public:
// Copied over from ResourceCache (see ResourceCache.h for reason)
// Properties are copied over from ResourceCache (see ResourceCache.h for reason).
/**jsdoc /**jsdoc
* @namespace TextureCache * API to manage texture cache resources.
* @property numTotal {number} total number of total resources * @namespace TextureCache
* @property numCached {number} total number of cached resource *
* @property sizeTotal {number} size in bytes of all resources * @property {number} numTotal - Total number of total resources. <em>Read-only.</em>
* @property sizeCached {number} size in bytes of all cached resources * @property {number} numCached - Total number of cached resource. <em>Read-only.</em>
*/ * @property {number} sizeTotal - Size in bytes of all resources. <em>Read-only.</em>
* @property {number} sizeCached - Size in bytes of all cached resources. <em>Read-only.</em>
*/
/**jsdoc
* Returns the total number of resources
* @function TextureCache.getNumTotalResources
* @returns {number}
*/
/**jsdoc // Functions are copied over from ResourceCache (see ResourceCache.h for reason).
* Returns the total size in bytes of all resources
* @function TextureCache.getSizeTotalResources
* @returns {number}
*/
/**jsdoc /**jsdoc
* Returns the total number of cached resources * Get the list of all resource URLs.
* @function TextureCache.getNumCachedResources * @function TextureCache.getResourceList
* @returns {number} * @return {string[]}
*/ */
/**jsdoc /**jsdoc
* Returns the total size in bytes of cached resources * @function TextureCache.dirty
* @function TextureCache.getSizeCachedResources * @returns {Signal}
* @returns {number} */
*/
/**jsdoc /**jsdoc
* Returns list of all resource urls * @function TextureCache.updateTotalSize
* @function TextureCache.getResourceList * @param {number} deltaSize
* @returns {string[]} */
*/
/**jsdoc /**jsdoc
* Returns animation resource for particular animation * @function TextureCache.prefetch
* @function TextureCache.getAnimation * @param {string} url
* @param url {string} url to load * @param {object} extra
* @returns {Resource} animation * @returns {object}
*/ */
/**jsdoc /**jsdoc
* Asynchronously loads a resource from the spedified URL and returns it. * Asynchronously loads a resource from the specified URL and returns it.
* @param url {string} url of resource to load * @function TextureCache.getResource
* @param fallback {string} fallback URL if load of the desired url fails * @param {string} url - URL of the resource to load.
* @function TextureCache.getResource * @param {string} [fallback=""] - Fallback URL if load of the desired URL fails.
* @returns {Resource} * @param {} [extra=null]
*/ * @return {Resource}
*/
/**jsdoc /**jsdoc
* Prefetches a resource. * Prefetches a resource.
* @param url {string} url of resource to load * @function TextureCache.prefetch
* @function TextureCache.prefetch * @param {string} url - URL of the resource to prefetch.
* @returns {Resource} * @return {Resource}
*/ */
/**jsdoc
* @param {number} deltaSize
* @function TextureCache.updateTotalSize
* @returns {Resource}
*/
/**jsdoc
* @function TextureCache.dirty
* @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
@ -265,6 +244,13 @@ signals:
void spectatorCameraFramebufferReset(); void spectatorCameraFramebufferReset();
protected: protected:
/**jsdoc
* @function TextureCache.prefect
* @param {string} url
* @param {number} type
* @param {number} [maxNumPixels=67108864]
*/
// Overload ResourceCache::prefetch to allow specifying texture type for loads // Overload ResourceCache::prefetch to allow specifying texture type for loads
Q_INVOKABLE ScriptableResource* prefetch(const QUrl& url, int type, int maxNumPixels = ABSOLUTE_MAX_TEXTURE_NUM_PIXELS); Q_INVOKABLE ScriptableResource* prefetch(const QUrl& url, int type, int maxNumPixels = ABSOLUTE_MAX_TEXTURE_NUM_PIXELS);

42
libraries/networking/src/BaseAssetScriptingInterface.h
View file

@ -31,12 +31,54 @@ public:
BaseAssetScriptingInterface(QObject* parent = nullptr); BaseAssetScriptingInterface(QObject* parent = nullptr);
public slots: public slots:
/**jsdoc
* @function Assets.isValidPath
* @param {string} input
* @returns {boolean}
*/
bool isValidPath(QString input) { return AssetUtils::isValidPath(input); } bool isValidPath(QString input) { return AssetUtils::isValidPath(input); }
/**jsdoc
* @function Assets.isValidFilePath
* @param {string} input
* @returns {boolean}
*/
bool isValidFilePath(QString input) { return AssetUtils::isValidFilePath(input); } bool isValidFilePath(QString input) { return AssetUtils::isValidFilePath(input); }
/**jsdoc
* @function Assets.getATPUrl
* @param {string} input
* @returns {string}
*/
QUrl getATPUrl(QString input) { return AssetUtils::getATPUrl(input); } QUrl getATPUrl(QString input) { return AssetUtils::getATPUrl(input); }
/**jsdoc
* @function Assets.extractAssetHash
* @param {string} input
* @returns {string}
*/
QString extractAssetHash(QString input) { return AssetUtils::extractAssetHash(input); } QString extractAssetHash(QString input) { return AssetUtils::extractAssetHash(input); }
/**jsdoc
* @function Assets.isValidHash
* @param {string} input
* @returns {boolean}
*/
bool isValidHash(QString input) { return AssetUtils::isValidHash(input); } bool isValidHash(QString input) { return AssetUtils::isValidHash(input); }
/**jsdoc
* @function Assets.hashData
* @param {} data
* @returns {object}
*/
QByteArray hashData(const QByteArray& data) { return AssetUtils::hashData(data); } QByteArray hashData(const QByteArray& data) { return AssetUtils::hashData(data); }
/**jsdoc
* @function Assets.hashDataHex
* @param {} data
* @returns {string}
*/
QString hashDataHex(const QByteArray& data) { return hashData(data).toHex(); } QString hashDataHex(const QByteArray& data) { return hashData(data).toHex(); }
protected: protected:

3
libraries/networking/src/LimitedNodeList.cpp
View file

@ -715,10 +715,11 @@ SharedNodePointer LimitedNodeList::addOrUpdateNode(const QUuid& uuid, NodeType_t
// insert the new node and release our read lock // insert the new node and release our read lock
#if defined(Q_OS_ANDROID) || (defined(__clang__) && defined(Q_OS_LINUX)) #if defined(Q_OS_ANDROID) || (defined(__clang__) && defined(Q_OS_LINUX))
_nodeHash.insert(UUIDNodePair(newNode->getUUID(), newNodePointer)); _nodeHash.insert(UUIDNodePair(newNode->getUUID(), newNodePointer));
_localIDMap.insert(std::pair<Node::LocalID, SharedNodePointer>(localID, newNodePointer));
#else #else
_nodeHash.emplace(newNode->getUUID(), newNodePointer); _nodeHash.emplace(newNode->getUUID(), newNodePointer);
#endif
_localIDMap.emplace(localID, newNodePointer); _localIDMap.emplace(localID, newNodePointer);
#endif
readLocker.unlock(); readLocker.unlock();
qCDebug(networking) << "Added" << *newNode; qCDebug(networking) << "Added" << *newNode;

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

@ -89,14 +89,13 @@ class ScriptableResource : public QObject {
/**jsdoc /**jsdoc
* @constructor Resource * @constructor Resource
* @property url {string} url of this resource * @property {string} url - URL of this resource.
* @property state {Resource.State} current loading state * @property {Resource.State} state - Current loading state.
*/ */
Q_OBJECT Q_OBJECT
Q_PROPERTY(QUrl url READ getURL) Q_PROPERTY(QUrl url READ getURL)
Q_PROPERTY(int state READ getState NOTIFY stateChanged) Q_PROPERTY(int state READ getState NOTIFY stateChanged)
public: public:
@ -104,11 +103,11 @@ public:
/**jsdoc /**jsdoc
* @name Resource.State * @name Resource.State
* @static * @static
* @property QUEUED {int} The resource is queued up, waiting to be loaded. * @property {number} QUEUED - The resource is queued up, waiting to be loaded.
* @property LOADING {int} The resource is downloading * @property {number} LOADING - The resource is downloading.
* @property LOADED {int} The resource has finished downloaded by is not complete * @property {number} LOADED - The resource has finished downloaded by is not complete.
* @property FINISHED {int} The resource has completly finished loading and is ready. * @property {number} FINISHED - The resource has completely finished loading and is ready.
* @property FAILED {int} Downloading the resource has failed. * @property {number} FAILED - Downloading the resource has failed.
*/ */
enum State { enum State {
@ -124,7 +123,7 @@ public:
virtual ~ScriptableResource() = default; virtual ~ScriptableResource() = default;
/**jsdoc /**jsdoc
* Release this resource * Release this resource.
* @function Resource#release * @function Resource#release
*/ */
Q_INVOKABLE void release(); Q_INVOKABLE void release();
@ -139,18 +138,18 @@ public:
signals: signals:
/**jsdoc /**jsdoc
* Signaled when download progress for this resource has changed * Triggered when download progress for this resource has changed.
* @function Resource#progressChanged * @function Resource#progressChanged
* @param bytesReceived {int} bytes downloaded so far * @param {number} bytesReceived - Byytes downloaded so far.
* @param bytesTotal {int} total number of bytes in the resource * @param {number} bytesTotal - 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 * Triggered when resource loading state has changed.
* @function Resource#stateChanged * @function Resource#stateChanged
* @param bytesReceived {Resource.State} new state * @param {Resource.State} state - New state.
* @returns {Signal} * @returns {Signal}
*/ */
void stateChanged(int state); void stateChanged(int state);
@ -185,14 +184,15 @@ Q_DECLARE_METATYPE(ScriptableResource*);
/// Base class for resource caches. /// Base class for resource caches.
class ResourceCache : public QObject { class ResourceCache : public QObject {
Q_OBJECT Q_OBJECT
// JSDoc 3.5.5 doesn't augment @property definitions.
// These functions are being copied into the different exposed cache classes // JSDoc 3.5.5 doesn't augment namespaces with @property or @function definitions.
// The ResourceCache properties and functions are copied to the different exposed cache classes.
/**jsdoc /**jsdoc
* @namespace ResourceCache * @property {number} numTotal - Total number of total resources. <em>Read-only.</em>
* @property numTotal {number} total number of total resources * @property {number} numCached - Total number of cached resource. <em>Read-only.</em>
* @property numCached {number} total number of cached resource * @property {number} sizeTotal - Size in bytes of all resources. <em>Read-only.</em>
* @property sizeTotal {number} size in bytes of all resources * @property {number} sizeCached - Size in bytes of all cached resources. <em>Read-only.</em>
* @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)
@ -200,36 +200,14 @@ class ResourceCache : public QObject {
Q_PROPERTY(size_t sizeCached READ getSizeCachedResources NOTIFY dirty) Q_PROPERTY(size_t sizeCached READ getSizeCachedResources NOTIFY dirty)
public: public:
/**jsdoc
* Returns the total number of resources
* @function ResourceCache.getNumTotalResources
* @return {number}
*/
size_t getNumTotalResources() const { return _numTotalResources; } size_t getNumTotalResources() const { return _numTotalResources; }
/**jsdoc
* Returns the total size in bytes of all resources
* @function ResourceCache.getSizeTotalResources
* @return {number}
*/
size_t getSizeTotalResources() const { return _totalResourcesSize; } size_t getSizeTotalResources() const { return _totalResourcesSize; }
/**jsdoc
* Returns the total number of cached resources
* @function ResourceCache.getNumCachedResources
* @return {number}
*/
size_t getNumCachedResources() const { return _numUnusedResources; } size_t getNumCachedResources() const { return _numUnusedResources; }
/**jsdoc
* Returns the total size in bytes of cached resources
* @function ResourceCache.getSizeCachedResources
* @return {number}
*/
size_t getSizeCachedResources() const { return _unusedResourcesSize; } size_t getSizeCachedResources() const { return _unusedResourcesSize; }
/**jsdoc /**jsdoc
* Returns list of all resource urls * Get the list of all resource URLs.
* @function ResourceCache.getResourceList * @function ResourceCache.getResourceList
* @return {string[]} * @return {string[]}
*/ */
@ -257,28 +235,45 @@ public:
void clearUnusedResources(); void clearUnusedResources();
signals: signals:
/**jsdoc
* @function ResourceCache.dirty
* @returns {Signal}
*/
void dirty(); void dirty();
protected slots: protected slots:
/**jsdoc
* @function ResourceCache.updateTotalSize
* @param {number} deltaSize
*/
void updateTotalSize(const qint64& deltaSize); void updateTotalSize(const qint64& deltaSize);
/**jsdoc
* @function ResourceCache.prefetch
* @param {string} url
* @param {object} extra
* @returns {object}
*/
// Prefetches a resource to be held by the QScriptEngine. // Prefetches a resource to be held by the QScriptEngine.
// Left as a protected member so subclasses can overload prefetch // Left as a protected member so subclasses can overload prefetch
// and delegate to it (see TextureCache::prefetch(const QUrl&, int). // and delegate to it (see TextureCache::prefetch(const QUrl&, int).
ScriptableResource* prefetch(const QUrl& url, void* extra); ScriptableResource* prefetch(const QUrl& url, void* extra);
/**jsdoc
* Asynchronously loads a resource from the specified URL and returns it.
* @function ResourceCache.getResource
* @param {string} url - URL of the resource to load.
* @param {string} [fallback=""] - Fallback URL if load of the desired URL fails.
* @param {} [extra=null]
* @return {Resource}
*/
/// Loads a resource from the specified URL and returns it. /// Loads a resource from the specified URL and returns it.
/// If the caller is on a different thread than the ResourceCache, /// If the caller is on a different thread than the ResourceCache,
/// returns an empty smart pointer and loads its asynchronously. /// returns an empty smart pointer and loads its asynchronously.
/// \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
* Asynchronously loads a resource from the spedified URL and returns it.
* @param url {string} url of resource to load
* @param fallback {string} fallback URL if load of the desired url fails
* @function ResourceCache.getResource
* @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);
@ -292,8 +287,8 @@ protected:
// 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
* @function ResourceCache.prefetch * @function ResourceCache.prefetch
* @param {string} url - URL of the resource to 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); }

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

@ -25,7 +25,7 @@
#include <QtNetwork/QNetworkDiskCache> #include <QtNetwork/QNetworkDiskCache>
/**jsdoc /**jsdoc
* The Assets API allows you to communicate with the Asset Browser * The Assets API allows you to communicate with the Asset Browser.
* @namespace Assets * @namespace Assets
*/ */
class AssetScriptingInterface : public BaseAssetScriptingInterface, QScriptable { class AssetScriptingInterface : public BaseAssetScriptingInterface, QScriptable {
@ -41,14 +41,12 @@ public:
* @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
@ -57,13 +55,11 @@ public:
* @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
@ -73,13 +69,11 @@ public:
* @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
@ -88,21 +82,12 @@ public:
* @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
* Called when getMapping is complete.
* @callback Assets~getMappingCallback
* @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.
*/
Q_INVOKABLE void getMapping(QString path, QScriptValue callback); Q_INVOKABLE void getMapping(QString path, QScriptValue callback);
/**jsdoc /**jsdoc
@ -111,7 +96,10 @@ public:
* @param enabled {boolean} * @param enabled {boolean}
* @param callback {} * @param callback {}
*/ */
/**jsdoc
* Called when setBakingEnabled is complete.
* @callback Assets~setBakingEnabledCallback
*/
Q_INVOKABLE void setBakingEnabled(QString path, bool enabled, QScriptValue callback); Q_INVOKABLE void setBakingEnabled(QString path, bool enabled, QScriptValue callback);
#if (PR_BUILD || DEV_BUILD) #if (PR_BUILD || DEV_BUILD)
@ -122,13 +110,14 @@ public:
* 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 A scope callback function to receive (error, results) values
* @param {function} [callback=undefined]
*/ */
/**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 {string} [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
@ -144,7 +133,7 @@ public:
/**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 {string} [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)
@ -160,6 +149,7 @@ public:
* @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)
* @param {function} [callback=undefined]
*/ */
/**jsdoc /**jsdoc
@ -180,7 +170,7 @@ public:
/**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 {string} [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
@ -243,7 +233,7 @@ public:
/**jsdoc /**jsdoc
* @function Assets.getCacheStatus * @function Assets.getCacheStatus
* @property {} scope * @property {} scope
* @property {} [callback = ""] * @property {} [callback=undefined]
*/ */
Q_INVOKABLE void getCacheStatus(QScriptValue scope, QScriptValue callback = QScriptValue()) { Q_INVOKABLE void getCacheStatus(QScriptValue scope, QScriptValue callback = QScriptValue()) {
@ -254,7 +244,7 @@ public:
* @function Assets.queryCacheMeta * @function Assets.queryCacheMeta
* @property {} options * @property {} options
* @property {} scope * @property {} scope
* @property {} [callback = ""] * @property {} [callback=undefined]
*/ */
Q_INVOKABLE void queryCacheMeta(QScriptValue options, QScriptValue scope, QScriptValue callback = QScriptValue()); Q_INVOKABLE void queryCacheMeta(QScriptValue options, QScriptValue scope, QScriptValue callback = QScriptValue());
@ -263,7 +253,7 @@ public:
* @function Assets.loadFromCache * @function Assets.loadFromCache
* @property {} options * @property {} options
* @property {} scope * @property {} scope
* @property {} [callback = ""] * @property {} [callback=undefined]
*/ */
Q_INVOKABLE void loadFromCache(QScriptValue options, QScriptValue scope, QScriptValue callback = QScriptValue()); Q_INVOKABLE void loadFromCache(QScriptValue options, QScriptValue scope, QScriptValue callback = QScriptValue());
@ -272,7 +262,7 @@ public:
* @function Assets.saveToCache * @function Assets.saveToCache
* @property {} options * @property {} options
* @property {} scope * @property {} scope
* @property {} [callback = ""] * @property {} [callback=undefined]
*/ */
Q_INVOKABLE void saveToCache(QScriptValue options, QScriptValue scope, QScriptValue callback = QScriptValue()); Q_INVOKABLE void saveToCache(QScriptValue options, QScriptValue scope, QScriptValue callback = QScriptValue());
@ -283,7 +273,7 @@ public:
* @property {} data * @property {} data
* @property {} metadata * @property {} metadata
* @property {} scope * @property {} scope
* @property {} [callback = ""] * @property {} [callback=undefined]
*/ */
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,

81
libraries/script-engine/src/AudioScriptingInterface.h
View file

@ -31,21 +31,88 @@ protected:
AudioScriptingInterface() {} AudioScriptingInterface() {}
// these methods are protected to stop C++ callers from calling, but invokable from script // these methods are protected to stop C++ callers from calling, but invokable from script
/**jsdoc
* @function Audio.playSound
* @param {} sound
* @param {} [injectorOptions=null]
* @returns {object}
*/
Q_INVOKABLE ScriptAudioInjector* playSound(SharedSoundPointer sound, const AudioInjectorOptions& injectorOptions = AudioInjectorOptions()); Q_INVOKABLE ScriptAudioInjector* playSound(SharedSoundPointer sound, const AudioInjectorOptions& injectorOptions = AudioInjectorOptions());
/**jsdoc
* @function Audio.playSystemSound
* @param {} sound
* @param {} position
* @returns {object}
*/
// FIXME: there is no way to play a positionless sound // FIXME: there is no way to play a positionless sound
Q_INVOKABLE ScriptAudioInjector* playSystemSound(SharedSoundPointer sound, const QVector3D& position); Q_INVOKABLE ScriptAudioInjector* playSystemSound(SharedSoundPointer sound, const QVector3D& position);
/**jsdoc
* @function Audio.setStereoInput
* @param {boolean} stereo
* @returns {boolean}
*/
Q_INVOKABLE bool setStereoInput(bool stereo); Q_INVOKABLE bool setStereoInput(bool stereo);
/**jsdoc
* @function Audio.isStereoInput
* @returns {boolean}
*/
Q_INVOKABLE bool isStereoInput(); Q_INVOKABLE bool isStereoInput();
signals: signals:
void mutedByMixer(); /// the client has been muted by the mixer
void environmentMuted(); /// the entire environment has been muted by the mixer /**jsdoc
void receivedFirstPacket(); /// the client has received its first packet from the audio mixer * The client has been muted by the mixer.
void disconnected(); /// the client has been disconnected from the audio mixer * @function Audio.mutedByMixer
void noiseGateOpened(); /// the noise gate has opened * @returns {Signal}
void noiseGateClosed(); /// the noise gate has closed */
void inputReceived(const QByteArray& inputSamples); /// a frame of mic input audio has been received and processed void mutedByMixer();
/**jsdoc
* The entire environment has been muted by the mixer.
* @function Audio.environmentMuted
* @returns {Signal}
*/
void environmentMuted();
/**jsdoc
* The client has received its first packet from the audio mixer.
* @function Audio.receivedFirstPacket
* @returns {Signal}
*/
void receivedFirstPacket();
/**jsdoc
* The client has been disconnected from the audio mixer.
* @function Audio.disconnected
* @returns {Signal}
*/
void disconnected();
/**jsdoc
* The noise gate has opened.
* @function Audio.noiseGateOpened
* @returns {Signal}
*/
void noiseGateOpened();
/**jsdoc
* The noise gate has closed.
* @function Audio.noiseGateClosed
* @returns {Signal}
*/
void noiseGateClosed();
/**jsdoc
* A frame of mic input audio has been received and processed.
* @function Audio.inputReceived
* @param {} inputSamples
* @returns {Signal}
*/
void inputReceived(const QByteArray& inputSamples);
private: private:
AbstractAudioInterface* _localAudioInterface { nullptr }; AbstractAudioInterface* _localAudioInterface { nullptr };

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

@ -64,29 +64,22 @@ signals:
* @function FaceTracker.muteToggled * @function FaceTracker.muteToggled
* @returns {Signal} * @returns {Signal}
*/ */
void muteToggled(); void muteToggled();
public slots: public slots:
/**jsdoc // No JSDoc here because it's overridden in DdeFaceTracker.
* @function FaceTracker.setEnabled
* @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; }
protected: protected:

1
tools/jsdoc/plugins/hifi.js
View file

@ -47,6 +47,7 @@ exports.handlers = {
'../../libraries/script-engine/src', '../../libraries/script-engine/src',
'../../libraries/shared/src', '../../libraries/shared/src',
'../../libraries/shared/src/shared', '../../libraries/shared/src/shared',
'../../libraries/trackers/src/trackers',
'../../libraries/ui/src/ui', '../../libraries/ui/src/ui',
'../../plugins/oculus/src', '../../plugins/oculus/src',
'../../plugins/openvr/src', '../../plugins/openvr/src',