- Place names are similar to web addresses. Users who want to visit your domain can
+ Place names are similar to web addresses. Users who want to visit your domain can
enter its Place Name in Vircadia's Interface. You can choose a Place Name for your domain.
Your domain may also be reachable by IP address.
@@ -196,8 +196,8 @@
(accessToken, refreshToken)) {
return true;
@@ -871,7 +871,7 @@ void DomainGatekeeper::publicKeyJSONErrorCallback(QNetworkReply* requestReply) {
_inFlightPublicKeyRequests.remove(username);
}
-void DomainGatekeeper::sendProtocolMismatchConnectionDenial(const HifiSockAddr& senderSockAddr) {
+void DomainGatekeeper::sendProtocolMismatchConnectionDenial(const SockAddr& senderSockAddr) {
QString protocolVersionError = "Protocol version mismatch - Domain version: " + QCoreApplication::applicationVersion();
qDebug() << "Protocol Version mismatch - denying connection.";
@@ -880,7 +880,7 @@ void DomainGatekeeper::sendProtocolMismatchConnectionDenial(const HifiSockAddr&
DomainHandler::ConnectionRefusedReason::ProtocolMismatch);
}
-void DomainGatekeeper::sendConnectionDeniedPacket(const QString& reason, const HifiSockAddr& senderSockAddr,
+void DomainGatekeeper::sendConnectionDeniedPacket(const QString& reason, const SockAddr& senderSockAddr,
DomainHandler::ConnectionRefusedReason reasonCode,
QString extraInfo) {
// this is an agent and we've decided we won't let them connect - send them a packet to deny connection
@@ -910,7 +910,7 @@ void DomainGatekeeper::sendConnectionDeniedPacket(const QString& reason, const H
DependencyManager::get()->sendPacket(std::move(connectionDeniedPacket), senderSockAddr);
}
-void DomainGatekeeper::sendConnectionTokenPacket(const QString& username, const HifiSockAddr& senderSockAddr) {
+void DomainGatekeeper::sendConnectionTokenPacket(const QString& username, const SockAddr& senderSockAddr) {
// get the existing connection token or create a new one
QUuid& connectionToken = _connectionTokenHash[username.toLower()];
diff --git a/domain-server/src/DomainGatekeeper.h b/domain-server/src/DomainGatekeeper.h
index cb42baa7e3..94f760d42e 100644
--- a/domain-server/src/DomainGatekeeper.h
+++ b/domain-server/src/DomainGatekeeper.h
@@ -47,7 +47,7 @@ public:
Node::LocalID findOrCreateLocalID(const QUuid& uuid);
- static void sendProtocolMismatchConnectionDenial(const HifiSockAddr& senderSockAddr);
+ static void sendProtocolMismatchConnectionDenial(const SockAddr& senderSockAddr);
public slots:
void processConnectRequestPacket(QSharedPointer message);
void processICEPingPacket(QSharedPointer message);
@@ -90,19 +90,19 @@ private:
SharedNodePointer addVerifiedNodeFromConnectRequest(const NodeConnectionData& nodeConnection);
bool verifyUserSignature(const QString& username, const QByteArray& usernameSignature,
- const HifiSockAddr& senderSockAddr);
+ const SockAddr& senderSockAddr);
bool needToVerifyDomainUserIdentity(const QString& username, const QString& accessToken, const QString& refreshToken);
bool verifyDomainUserIdentity(const QString& username, const QString& accessToken, const QString& refreshToken,
- const HifiSockAddr& senderSockAddr);
+ const SockAddr& senderSockAddr);
bool isWithinMaxCapacity();
bool shouldAllowConnectionFromNode(const QString& username, const QByteArray& usernameSignature,
- const HifiSockAddr& senderSockAddr);
+ const SockAddr& senderSockAddr);
- void sendConnectionTokenPacket(const QString& username, const HifiSockAddr& senderSockAddr);
- static void sendConnectionDeniedPacket(const QString& reason, const HifiSockAddr& senderSockAddr,
+ void sendConnectionTokenPacket(const QString& username, const SockAddr& senderSockAddr);
+ static void sendConnectionDeniedPacket(const QString& reason, const SockAddr& senderSockAddr,
DomainHandler::ConnectionRefusedReason reasonCode = DomainHandler::ConnectionRefusedReason::Unknown,
QString extraInfo = QString());
diff --git a/domain-server/src/DomainServer.cpp b/domain-server/src/DomainServer.cpp
index 3acd17f6af..b221c88f6e 100644
--- a/domain-server/src/DomainServer.cpp
+++ b/domain-server/src/DomainServer.cpp
@@ -777,7 +777,7 @@ void DomainServer::setupNodeListAndAssignments() {
connect(nodeList.data(), &LimitedNodeList::nodeAdded, this, &DomainServer::nodeAdded);
connect(nodeList.data(), &LimitedNodeList::nodeKilled, this, &DomainServer::nodeKilled);
connect(nodeList.data(), &LimitedNodeList::localSockAddrChanged, this,
- [this](const HifiSockAddr& localSockAddr) {
+ [this](const SockAddr& localSockAddr) {
DependencyManager::get()->putLocalPortIntoSharedMemory(DOMAIN_SERVER_LOCAL_PORT_SMEM_KEY, this, localSockAddr.getPort());
});
@@ -1225,7 +1225,7 @@ void DomainServer::handleConnectedNode(SharedNodePointer newNode, quint64 reques
broadcastNewNode(newNode);
}
-void DomainServer::sendDomainListToNode(const SharedNodePointer& node, quint64 requestPacketReceiveTime, const HifiSockAddr &senderSockAddr, bool newConnection) {
+void DomainServer::sendDomainListToNode(const SharedNodePointer& node, quint64 requestPacketReceiveTime, const SockAddr &senderSockAddr, bool newConnection) {
const int NUM_DOMAIN_LIST_EXTENDED_HEADER_BYTES = NUM_BYTES_RFC4122_UUID + NLPacket::NUM_BYTES_LOCALID +
NUM_BYTES_RFC4122_UUID + NLPacket::NUM_BYTES_LOCALID + 4;
@@ -1501,7 +1501,7 @@ void DomainServer::transactionJSONCallback(const QJsonObject& data) {
}
}
-QJsonObject jsonForDomainSocketUpdate(const HifiSockAddr& socket) {
+QJsonObject jsonForDomainSocketUpdate(const SockAddr& socket) {
const QString SOCKET_NETWORK_ADDRESS_KEY = "network_address";
const QString SOCKET_PORT_KEY = "port";
@@ -1512,7 +1512,7 @@ QJsonObject jsonForDomainSocketUpdate(const HifiSockAddr& socket) {
return socketObject;
}
-void DomainServer::performIPAddressPortUpdate(const HifiSockAddr& newPublicSockAddr) {
+void DomainServer::performIPAddressPortUpdate(const SockAddr& newPublicSockAddr) {
const QString& DOMAIN_SERVER_SETTINGS_KEY = "domain_server";
const QString& publicSocketAddress = newPublicSockAddr.getAddress().toString();
const int publicSocketPort = newPublicSockAddr.getPort();
@@ -1770,7 +1770,7 @@ void DomainServer::sendHeartbeatToIceServer() {
QDataStream heartbeatStream(_iceServerHeartbeatPacket.get());
QUuid senderUUID;
- HifiSockAddr publicSocket, localSocket;
+ SockAddr publicSocket, localSocket;
heartbeatStream >> senderUUID >> publicSocket >> localSocket;
if (senderUUID != limitedNodeList->getSessionUUID()
@@ -1928,7 +1928,7 @@ void DomainServer::processNodeJSONStatsPacket(QSharedPointer pa
}
}
-QJsonObject DomainServer::jsonForSocket(const HifiSockAddr& socket) {
+QJsonObject DomainServer::jsonForSocket(const SockAddr& socket) {
QJsonObject socketJSON;
socketJSON["ip"] = socket.getAddress().toString();
@@ -3017,7 +3017,7 @@ static const QString BROADCASTING_SETTINGS_KEY = "broadcasting";
struct ReplicationServerInfo {
NodeType_t nodeType;
- HifiSockAddr sockAddr;
+ SockAddr sockAddr;
};
ReplicationServerInfo serverInformationFromSettings(QVariantMap serverMap, ReplicationServerDirection direction) {
@@ -3038,7 +3038,7 @@ ReplicationServerInfo serverInformationFromSettings(QVariantMap serverMap, Repli
serverInfo.nodeType = NodeType::downstreamType(nodeType);
}
- // read the address and port and construct a HifiSockAddr from them
+ // read the address and port and construct a SockAddr from them
serverInfo.sockAddr = {
serverMap[REPLICATION_SERVER_ADDRESS].toString(),
(quint16) serverMap[REPLICATION_SERVER_PORT].toString().toInt()
@@ -3047,7 +3047,7 @@ ReplicationServerInfo serverInformationFromSettings(QVariantMap serverMap, Repli
return serverInfo;
}
- return { NodeType::Unassigned, HifiSockAddr() };
+ return { NodeType::Unassigned, SockAddr() };
}
void DomainServer::updateReplicationNodes(ReplicationServerDirection direction) {
@@ -3056,7 +3056,7 @@ void DomainServer::updateReplicationNodes(ReplicationServerDirection direction)
if (broadcastSettingsVariant.isValid()) {
auto nodeList = DependencyManager::get();
- std::vector replicationNodesInSettings;
+ std::vector replicationNodesInSettings;
auto replicationSettings = broadcastSettingsVariant.toMap();
@@ -3066,7 +3066,7 @@ void DomainServer::updateReplicationNodes(ReplicationServerDirection direction)
if (replicationSettings.contains(serversKey)) {
auto serversSettings = replicationSettings.value(serversKey).toList();
- std::vector knownReplicationNodes;
+ std::vector knownReplicationNodes;
nodeList->eachNode([direction, &knownReplicationNodes](const SharedNodePointer& otherNode) {
if ((direction == Upstream && NodeType::isUpstream(otherNode->getType()))
|| (direction == Downstream && NodeType::isDownstream(otherNode->getType()))) {
@@ -3620,7 +3620,7 @@ void DomainServer::randomizeICEServerAddress(bool shouldTriggerHostLookup) {
indexToTry = distribution(generator);
}
- _iceServerSocket = HifiSockAddr { candidateICEAddresses[indexToTry], ICE_SERVER_DEFAULT_PORT };
+ _iceServerSocket = SockAddr { candidateICEAddresses[indexToTry], ICE_SERVER_DEFAULT_PORT };
qCInfo(domain_server_ice) << "Set candidate ice-server socket to" << _iceServerSocket;
// clear our number of hearbeat denials, this should be re-set on ice-server change
diff --git a/domain-server/src/DomainServer.h b/domain-server/src/DomainServer.h
index 11d04cb255..deb204de1c 100644
--- a/domain-server/src/DomainServer.h
+++ b/domain-server/src/DomainServer.h
@@ -113,7 +113,7 @@ private slots:
void setupPendingAssignmentCredits();
void sendPendingTransactionsToServer();
- void performIPAddressPortUpdate(const HifiSockAddr& newPublicSockAddr);
+ void performIPAddressPortUpdate(const SockAddr& newPublicSockAddr);
void sendHeartbeatToMetaverse() { sendHeartbeatToMetaverse(QString(), int()); }
void sendHeartbeatToIceServer();
void nodePingMonitor();
@@ -186,7 +186,7 @@ private:
void handleKillNode(SharedNodePointer nodeToKill);
void broadcastNodeDisconnect(const SharedNodePointer& disconnnectedNode);
- void sendDomainListToNode(const SharedNodePointer& node, quint64 requestPacketReceiveTime, const HifiSockAddr& senderSockAddr, bool newConnection);
+ void sendDomainListToNode(const SharedNodePointer& node, quint64 requestPacketReceiveTime, const SockAddr& senderSockAddr, bool newConnection);
bool isInInterestSet(const SharedNodePointer& nodeA, const SharedNodePointer& nodeB);
@@ -212,7 +212,7 @@ private:
QNetworkReply* profileRequestGivenTokenReply(QNetworkReply* tokenReply);
Headers setupCookieHeadersFromProfileReply(QNetworkReply* profileReply);
- QJsonObject jsonForSocket(const HifiSockAddr& socket);
+ QJsonObject jsonForSocket(const SockAddr& socket);
QJsonObject jsonObjectForNode(const SharedNodePointer& node);
bool shouldReplicateNode(const Node& node);
@@ -270,7 +270,7 @@ private:
DomainServerSettingsManager _settingsManager;
- HifiSockAddr _iceServerSocket;
+ SockAddr _iceServerSocket;
std::unique_ptr _iceServerHeartbeatPacket;
// These will be parented to this, they are not dangling
diff --git a/domain-server/src/DomainServerNodeData.h b/domain-server/src/DomainServerNodeData.h
index 370886cbce..0a2e2775e2 100644
--- a/domain-server/src/DomainServerNodeData.h
+++ b/domain-server/src/DomainServerNodeData.h
@@ -4,6 +4,7 @@
//
// Created by Stephen Birarda on 2/6/2014.
// Copyright 2014 High Fidelity, Inc.
+// Copyright 2021 Vircadia contributors.
//
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
@@ -17,7 +18,7 @@
#include
#include
-#include
+#include
#include
#include
#include
@@ -41,8 +42,8 @@ public:
QElapsedTimer& getPaymentIntervalTimer() { return _paymentIntervalTimer; }
- void setSendingSockAddr(const HifiSockAddr& sendingSockAddr) { _sendingSockAddr = sendingSockAddr; }
- const HifiSockAddr& getSendingSockAddr() { return _sendingSockAddr; }
+ void setSendingSockAddr(const SockAddr& sendingSockAddr) { _sendingSockAddr = sendingSockAddr; }
+ const SockAddr& getSendingSockAddr() { return _sendingSockAddr; }
void setIsAuthenticated(bool isAuthenticated) { _isAuthenticated = isAuthenticated; }
bool isAuthenticated() const { return _isAuthenticated; }
@@ -90,7 +91,7 @@ private:
QJsonObject _statsJSONObject;
static StringPairHash _overrideHash;
- HifiSockAddr _sendingSockAddr;
+ SockAddr _sendingSockAddr;
bool _isAuthenticated = true;
NodeSet _nodeInterestSet;
QString _nodeVersion;
diff --git a/domain-server/src/NodeConnectionData.cpp b/domain-server/src/NodeConnectionData.cpp
index 5419014622..1ef8ebf6a9 100644
--- a/domain-server/src/NodeConnectionData.cpp
+++ b/domain-server/src/NodeConnectionData.cpp
@@ -4,6 +4,7 @@
//
// Created by Stephen Birarda on 2015-08-24.
// Copyright 2015 High Fidelity, Inc.
+// Copyright 2021 Vircadia contributors.
//
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
@@ -13,7 +14,7 @@
#include
-NodeConnectionData NodeConnectionData::fromDataStream(QDataStream& dataStream, const HifiSockAddr& senderSockAddr,
+NodeConnectionData NodeConnectionData::fromDataStream(QDataStream& dataStream, const SockAddr& senderSockAddr,
bool isConnectRequest) {
NodeConnectionData newHeader;
diff --git a/domain-server/src/NodeConnectionData.h b/domain-server/src/NodeConnectionData.h
index 3833f5afd3..5976f07787 100644
--- a/domain-server/src/NodeConnectionData.h
+++ b/domain-server/src/NodeConnectionData.h
@@ -4,6 +4,7 @@
//
// Created by Stephen Birarda on 2015-08-24.
// Copyright 2015 High Fidelity, Inc.
+// Copyright 2021 Vircadia contributors.
//
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
@@ -18,15 +19,15 @@
class NodeConnectionData {
public:
- static NodeConnectionData fromDataStream(QDataStream& dataStream, const HifiSockAddr& senderSockAddr,
+ static NodeConnectionData fromDataStream(QDataStream& dataStream, const SockAddr& senderSockAddr,
bool isConnectRequest = true);
QUuid connectUUID;
quint64 lastPingTimestamp{ 0 }; // client-side send time of last connect/domain list request
NodeType_t nodeType;
- HifiSockAddr publicSockAddr;
- HifiSockAddr localSockAddr;
- HifiSockAddr senderSockAddr;
+ SockAddr publicSockAddr;
+ SockAddr localSockAddr;
+ SockAddr senderSockAddr;
QList interestList;
QString placeName;
QString hardwareAddress;
diff --git a/hifi_qt.py b/hifi_qt.py
index 7ee8a787b5..078f80c38d 100644
--- a/hifi_qt.py
+++ b/hifi_qt.py
@@ -10,6 +10,31 @@ import json
import xml.etree.ElementTree as ET
import functools
+# The way Qt is handled is a bit complicated, so I'm documenting it here.
+#
+# 1. User runs cmake
+# 2. cmake calls prebuild.py, which is referenced in /CMakeLists.txt
+# 3. prebuild.py calls this code.
+# 4. hifi_qt.py determines how to handle cmake: do we need to download a package, and which?
+# 4.a - Using system Qt
+# No download, most special paths are turned off.
+# We build in the same way a normal Qt program would.
+# 4.b - Using an user-provided Qt build in a custom directory.
+# We just need to set the cmakePath to the right dir (qt5-install/lib/cmake)
+# 4.c - Using a premade package.
+# We check the OS and distro and set qtUrl to the URL to download.
+# After this, it works on the same pathway as 4.b.
+# 5. We write /qt.cmake, which contains paths that are passed down to SetupQt.cmake
+# The template for this file is in CMAKE_TEMPLATE just below this comment
+# and it sets the QT_CMAKE_PREFIX_PATH variable used by SetupQt.cmake.
+# 6. cmake includes /qt.cmake receiving our information
+# In the case of system Qt, this step is skipped.
+# 7. cmake runs SetupQt.cmake which takes care of the cmake parts of the Qt configuration.
+# In the case of system Qt, SetupQt.cmake is a no-op. It runs but exits immediately.
+#
+# The format for a prebuilt qt is a package containing a top-level directory named
+# 'qt5-install', which contains the result of a "make install" from a build of the Qt source.
+
print = functools.partial(print, flush=True)
# Encapsulates the vcpkg system
@@ -28,32 +53,85 @@ endif()
self.args = args
self.configFilePath = os.path.join(args.build_root, 'qt.cmake')
self.version = os.getenv('VIRCADIA_USE_QT_VERSION', '5.15.2')
-
self.assets_url = hifi_utils.readEnviromentVariableFromFile(args.build_root, 'EXTERNAL_BUILD_ASSETS')
- defaultBasePath = os.path.expanduser('~/hifi/qt')
- self.basePath = os.getenv('HIFI_QT_BASE', defaultBasePath)
- if (not os.path.isdir(self.basePath)):
- os.makedirs(self.basePath)
- self.path = os.path.join(self.basePath, self.version)
- self.fullPath = os.path.join(self.path, 'qt5-install')
- self.cmakePath = os.path.join(self.fullPath, 'lib/cmake')
-
- print("Using qt path {}".format(self.path))
- lockDir, lockName = os.path.split(self.path)
- lockName += '.lock'
- if not os.path.isdir(lockDir):
- os.makedirs(lockDir)
-
- self.lockFile = os.path.join(lockDir, lockName)
-
- if (os.getenv('VIRCADIA_USE_PREBUILT_QT')):
- print("Using pre-built Qt5")
- return
-
# OS dependent information
system = platform.system()
- cpu_architecture = platform.machine()
+
+ qt_found = False
+ system_qt = False
+
+ # Here we handle the 3 possible cases of dealing with Qt:
+ if os.getenv('VIRCADIA_USE_SYSTEM_QT', "") != "":
+ # 1. Using the system provided Qt. This is only recommended for Qt 5.15.0 and above,
+ # as it includes a required fix on Linux.
+ #
+ # This path only works on Linux as neither Windows nor OSX ship Qt.
+
+ if system != "Linux":
+ raise Exception("Using the system Qt is only supported on Linux")
+
+ self.path = None
+ self.cmakePath = None
+
+ qt_found = True
+ system_qt = True
+ print("Using system Qt")
+
+ elif os.getenv('VIRCADIA_QT_PATH', "") != "":
+ # 2. Using an user-provided directory.
+ # VIRCADIA_QT_PATH must point to a directory with a Qt install in it.
+
+ self.path = os.getenv('VIRCADIA_QT_PATH')
+ self.fullPath = self.path
+ self.cmakePath = os.path.join(self.fullPath, 'lib', 'cmake')
+
+ qt_found = True
+ print("Using Qt from " + self.fullPath)
+
+ else:
+ # 3. Using a pre-built Qt.
+ #
+ # This works somewhat differently from above, notice how path and fullPath are
+ # used differently in this case.
+ #
+ # In the case of an user-provided directory, we just use the user-supplied directory.
+ #
+ # For a pre-built qt, however, we have to unpack it. The archive is required to contain
+ # a qt5-install directory in it.
+
+ self.path = os.path.expanduser("~/vircadia-files/qt")
+ self.fullPath = os.path.join(self.path, 'qt5-install')
+ self.cmakePath = os.path.join(self.fullPath, 'lib', 'cmake')
+
+ if (not os.path.isdir(self.path)):
+ os.makedirs(self.path)
+
+ qt_found = os.path.isdir(self.fullPath)
+ print("Using a packaged Qt")
+
+
+ if not system_qt:
+ if qt_found:
+ # Sanity check, ensure we have a good cmake directory
+ qt5_dir = os.path.join(self.cmakePath, "Qt5")
+ if not os.path.isdir(qt5_dir):
+ raise Exception("Failed to find Qt5 directory under " + self.cmakePath + ". There should be a " + qt5_dir)
+ else:
+ print("Qt5 check passed, found " + qt5_dir)
+
+ # I'm not sure why this is needed. It's used by hifi_singleton.
+ # Perhaps it stops multiple build processes from interferring?
+ lockDir, lockName = os.path.split(self.path)
+ lockName += '.lock'
+ if not os.path.isdir(lockDir):
+ os.makedirs(lockDir)
+
+ self.lockFile = os.path.join(lockDir, lockName)
+
+ if qt_found:
+ print("Found pre-built Qt5")
+ return
if 'Windows' == system:
self.qtUrl = self.assets_url + '/dependencies/vcpkg/qt5-install-5.15.2-windows.tar.gz'
@@ -61,7 +139,7 @@ endif()
self.qtUrl = self.assets_url + '/dependencies/vcpkg/qt5-install-5.15.2-macos.tar.gz'
elif 'Linux' == system:
import distro
- dist = distro.linux_distribution()
+ cpu_architecture = platform.machine()
if 'x86_64' == cpu_architecture:
if distro.id() == 'ubuntu':
@@ -71,16 +149,12 @@ endif()
if u_major == 18:
self.qtUrl = self.assets_url + '/dependencies/vcpkg/qt5-install-5.15.2-ubuntu-18.04-amd64.tar.xz'
elif u_major > 19:
- print("We don't support " + distro.name(pretty=True) + " yet. Perhaps consider helping us out?")
- raise Exception('LINUX DISTRO IS NOT SUPPORTED YET!!!')
+ self.__no_qt_package_error()
else:
- print("Sorry, " + distro.name(pretty=True) + " is old and won't be officially supported. Please consider upgrading.");
- raise Exception('UNKNOWN LINUX DISTRO VERSION!!!')
+ self.__unsupported_error()
else:
- print("Sorry, " + distro.name(pretty=True) + " is not supported on x86_64. Please consider helping us out.")
- print("It's also possible to build Qt for your distribution, please see the documentation at:")
- print("https://github.com/vircadia/vircadia/tree/master/tools/qt-builder")
- raise Exception('UNKNOWN LINUX VERSION!!!')
+ self.__no_qt_package_error()
+
elif 'aarch64' == cpu_architecture:
if distro.id() == 'ubuntu':
u_major = int( distro.major_version() )
@@ -89,11 +163,9 @@ endif()
if u_major == 18:
self.qtUrl = 'http://motofckr9k.ddns.net/vircadia_packages/qt5-install-5.15.2-ubuntu-18.04-aarch64_test.tar.xz'
elif u_major > 19:
- print("We don't support " + distro.name(pretty=True) + " on aarch64 yet. Perhaps consider helping us out?")
- raise Exception('LINUX DISTRO IS NOT SUPPORTED YET!!!')
+ self.__no_qt_package_error()
else:
- print("Sorry, " + distro.name(pretty=True) + " is old and won't be officially supported. Please consider upgrading.");
- raise Exception('UNKNOWN LINUX DISTRO VERSION!!!')
+ self.__unsupported_error()
elif distro.id() == 'debian':
u_major = int( distro.major_version() )
@@ -101,20 +173,14 @@ endif()
if u_major == 10:
#self.qtUrl = self.assets_url + '/dependencies/vcpkg/qt5-install-5.12.3-ubuntu-16.04-with-symbols.tar.gz'
- print("We don't support " + distro.name(pretty=True) + " on aarch64 yet. Perhaps consider helping us out?")
- raise Exception('LINUX DISTRO IS NOT SUPPORTED YET!!!')
+ self.__no_qt_package_error()
elif u_major > 10:
- print("We don't support " + distro.name(pretty=True) + " on aarch64 yet. Perhaps consider helping us out?")
- raise Exception('LINUX DISTRO IS NOT SUPPORTED YET!!!')
+ self.__no_qt_package_error()
else:
- print("Sorry, " + distro.name(pretty=True) + " is old and won't be officially supported. Please consider upgrading.");
- raise Exception('UNKNOWN LINUX DISTRO VERSION!!!')
+ self.__unsupported_error()
else:
- print("Sorry, " + distro.name(pretty=True) + " is not supported on aarch64. Please consider helping us out.")
- print("It's also possible to build Qt for your distribution, please see the documentation at:")
- print("https://github.com/vircadia/vircadia/tree/master/tools/qt-builder")
- raise Exception('UNKNOWN LINUX VERSION!!!')
+ self.__no_qt_package_error()
else:
raise Exception('UNKNOWN CPU ARCHITECTURE!!!')
@@ -124,6 +190,14 @@ endif()
print("Machine : " + platform.machine())
raise Exception('UNKNOWN OPERATING SYSTEM!!!')
+ def showQtBuildInfo(self):
+ print("")
+ print("It's also possible to build Qt for your distribution, please see the documentation at:")
+ print("https://github.com/vircadia/vircadia/tree/master/tools/qt-builder")
+ print("")
+ print("Alternatively, you can try building against the system Qt by setting the VIRCADIA_USE_SYSTEM_QT environment variable.")
+ print("You'll need to install the development packages, and to have Qt 5.15.0 or newer. ")
+
def writeConfig(self):
print("Writing cmake config to {}".format(self.configFilePath))
# Write out the configuration for use by CMake
@@ -138,3 +212,40 @@ endif()
hifi_utils.downloadAndExtract(self.qtUrl, self.path)
else:
print ('Qt has already been downloaded')
+
+
+ def __unsupported_error(self):
+ import distro
+ cpu_architecture = platform.machine()
+
+ print('')
+ hifi_utils.color('red')
+ print("Sorry, " + distro.name(pretty=True) + " on " + cpu_architecture + " is too old and won't be officially supported.")
+ hifi_utils.color('white')
+ print("Please upgrade to a more recent Linux distribution.")
+ hifi_utils.color('clear')
+ print('')
+ raise hifi_utils.SilentFatalError(3)
+
+ def __no_qt_package_error(self):
+ import distro
+ cpu_architecture = platform.machine()
+
+ print('')
+ hifi_utils.color('red')
+ print("Sorry, we don't have a prebuilt Qt package for " + distro.name(pretty=True) + " on " + cpu_architecture + ".")
+ hifi_utils.color('white')
+ print('')
+ print("If this is a recent distribution, dating from 2021 or so, you can try building")
+ print("against the system Qt by running this command, and trying again:")
+ print(" export VIRCADIA_USE_SYSTEM_QT=1")
+ print("")
+ hifi_utils.color('clear')
+ print("If you'd like to try to build Qt from source either for building Vircadia, or")
+ print("to contribute a prebuilt package for your distribution, please see the")
+ print("documentation at: ", end='')
+ hifi_utils.color('blue')
+ print("https://github.com/vircadia/vircadia/tree/master/tools/qt-builder")
+ hifi_utils.color('clear')
+ print('')
+ raise hifi_utils.SilentFatalError(2)
diff --git a/hifi_utils.py b/hifi_utils.py
index 157e5858a8..19290dbc42 100644
--- a/hifi_utils.py
+++ b/hifi_utils.py
@@ -16,6 +16,18 @@ import functools
print = functools.partial(print, flush=True)
+ansi_colors = {
+ 'black' : 30,
+ 'red': 31,
+ 'green': 32,
+ 'yellow': 33,
+ 'blue': 34,
+ 'magenta': 35,
+ 'cyan': 36,
+ 'white': 37,
+ 'clear': 0
+}
+
def scriptRelative(*paths):
scriptdir = os.path.dirname(os.path.realpath(sys.argv[0]))
result = os.path.join(scriptdir, *paths)
@@ -125,3 +137,17 @@ def downloadAndExtract(url, destPath, hash=None, hasher=hashlib.sha512(), isZip=
def readEnviromentVariableFromFile(buildRootDir, var):
with open(os.path.join(buildRootDir, '_env', var + ".txt")) as fp:
return fp.read()
+
+class SilentFatalError(Exception):
+ """Thrown when some sort of fatal condition happened, and we already reported it to the user.
+ This excecption exists to give a chance to run any cleanup needed before exiting.
+
+ It should be handled at the bottom of the call stack, where the only action is to call
+ sys.exit(ex.exit_code)
+ """
+ def __init__(self, exit_code):
+ self.exit_code = exit_code
+
+def color(color_name):
+ # Ideally we'd use the termcolor module, but this avoids adding it as a dependency.
+ print("\033[1;{}m".format(ansi_colors[color_name]), end='')
\ No newline at end of file
diff --git a/hifi_vcpkg.py b/hifi_vcpkg.py
index fb77fd2507..642ed1253e 100644
--- a/hifi_vcpkg.py
+++ b/hifi_vcpkg.py
@@ -60,7 +60,7 @@ endif()
self.path = args.vcpkg_root
self.noClean = True
else:
- defaultBasePath = os.path.expanduser('~/hifi/vcpkg')
+ defaultBasePath = os.path.expanduser('~/vircadia-files/vcpkg')
self.basePath = os.getenv('HIFI_VCPKG_BASE', defaultBasePath)
if self.args.android:
self.basePath = os.path.join(self.basePath, 'android')
diff --git a/ice-server/src/IceServer.cpp b/ice-server/src/IceServer.cpp
index a8e50d31a9..d42c0a4e2a 100644
--- a/ice-server/src/IceServer.cpp
+++ b/ice-server/src/IceServer.cpp
@@ -4,6 +4,7 @@
//
// Created by Stephen Birarda on 2014-10-01.
// Copyright 2014 High Fidelity, Inc.
+// Copyright 2021 Vircadia contributors.
//
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
@@ -97,7 +98,7 @@ void IceServer::processPacket(std::unique_ptr packet) {
heartbeatStream >> senderUUID;
// pull the public and private sock addrs for this peer
- HifiSockAddr publicSocket, localSocket;
+ SockAddr publicSocket, localSocket;
heartbeatStream >> publicSocket >> localSocket;
// check if this node also included a UUID that they would like to connect to
@@ -129,7 +130,7 @@ SharedNetworkPeer IceServer::addOrUpdateHeartbeatingPeer(NLPacket& packet) {
// pull the UUID, public and private sock addrs for this peer
QUuid senderUUID;
- HifiSockAddr publicSocket, localSocket;
+ SockAddr publicSocket, localSocket;
QByteArray signature;
QDataStream heartbeatStream(&packet);
@@ -288,7 +289,7 @@ void IceServer::publicKeyReplyFinished(QNetworkReply* reply) {
reply->deleteLater();
}
-void IceServer::sendPeerInformationPacket(const NetworkPeer& peer, const HifiSockAddr* destinationSockAddr) {
+void IceServer::sendPeerInformationPacket(const NetworkPeer& peer, const SockAddr* destinationSockAddr) {
auto peerPacket = NLPacket::create(PacketType::ICEServerPeerInformation);
// get the byte array for this peer
diff --git a/ice-server/src/IceServer.h b/ice-server/src/IceServer.h
index 2aa9a875a7..e68115f7ef 100644
--- a/ice-server/src/IceServer.h
+++ b/ice-server/src/IceServer.h
@@ -4,6 +4,7 @@
//
// Created by Stephen Birarda on 2014-10-01.
// Copyright 2014 High Fidelity, Inc.
+// Copyright 2021 Vircadia contributors.
//
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
@@ -40,7 +41,7 @@ private:
void processPacket(std::unique_ptr packet);
SharedNetworkPeer addOrUpdateHeartbeatingPeer(NLPacket& incomingPacket);
- void sendPeerInformationPacket(const NetworkPeer& peer, const HifiSockAddr* destinationSockAddr);
+ void sendPeerInformationPacket(const NetworkPeer& peer, const SockAddr* destinationSockAddr);
bool isVerifiedHeartbeat(const QUuid& domainID, const QByteArray& plaintext, const QByteArray& signature);
void requestDomainPublicKey(const QUuid& domainID);
diff --git a/interface/CMakeLists.txt b/interface/CMakeLists.txt
index c307c63142..a2a29ed4ba 100644
--- a/interface/CMakeLists.txt
+++ b/interface/CMakeLists.txt
@@ -34,14 +34,14 @@ if (ANDROID)
add_custom_command(
OUTPUT ${RESOURCES_RCC}
DEPENDS ${RESOURCES_QRC} ${GENERATE_QRC_DEPENDS}
- COMMAND "${QT_DIR}/bin/rcc"
+ COMMAND "${RCC_BINARY}"
ARGS ${RESOURCES_QRC} -no-compress -binary -o ${RESOURCES_RCC}
)
else ()
add_custom_command(
OUTPUT ${RESOURCES_RCC}
DEPENDS ${RESOURCES_QRC} ${GENERATE_QRC_DEPENDS}
- COMMAND "${QT_DIR}/bin/rcc"
+ COMMAND "${RCC_BINARY}"
ARGS ${RESOURCES_QRC} -binary -o ${RESOURCES_RCC}
)
endif()
@@ -435,18 +435,20 @@ else()
endif()
endif()
-if (DEV_BUILD AND (APPLE OR UNIX))
- # create a qt.conf file to override hard-coded search paths in Qt libs
- set(QT_LIB_PATH "${QT_CMAKE_PREFIX_PATH}/../..")
- if (APPLE)
- set(QT_CONF_FILE "${RESOURCES_DEV_DIR}/../Resources/qt.conf")
- else ()
- set(QT_CONF_FILE "${INTERFACE_EXEC_DIR}/qt.conf")
- endif ()
- file(GENERATE
- OUTPUT "${QT_CONF_FILE}"
- CONTENT "[Paths]\nPrefix=${QT_LIB_PATH}\n"
- )
+if ("$ENV{VIRCADIA_USE_SYSTEM_QT}" STREQUAL "")
+ if (DEV_BUILD AND (APPLE OR UNIX))
+ # create a qt.conf file to override hard-coded search paths in Qt libs
+ set(QT_LIB_PATH "${QT_CMAKE_PREFIX_PATH}/../..")
+ if (APPLE)
+ set(QT_CONF_FILE "${RESOURCES_DEV_DIR}/../Resources/qt.conf")
+ else ()
+ set(QT_CONF_FILE "${INTERFACE_EXEC_DIR}/qt.conf")
+ endif ()
+ file(GENERATE
+ OUTPUT "${QT_CONF_FILE}"
+ CONTENT "[Paths]\nPrefix=${QT_LIB_PATH}\n"
+ )
+ endif()
endif()
if (SCRIPTS_INSTALL_DIR)
diff --git a/interface/resources/html/tabletHelp.html b/interface/resources/html/tabletHelp.html
index 17b41a1979..f9dc7034f5 100644
--- a/interface/resources/html/tabletHelp.html
+++ b/interface/resources/html/tabletHelp.html
@@ -53,7 +53,7 @@
position: absolute;
top: 0; left: 0; bottom: 0; right: 0;
}
-
+
#image_button {
position: absolute;
width: 463;
@@ -77,13 +77,13 @@
var handControllerImageURL = null;
var index = 0;
var count = 3;
- var handControllerRefURL = "https://docs.vircadia.dev/explore/get-started/vr-controls.html#vr-controls";
- var keyboardRefURL = "https://docs.vircadia.dev/explore/get-started/desktop.html#movement-controls";
- var gamepadRefURL = "https://docs.vircadia.dev/explore/get-started/vr-controls.html#gamepad";
+ var handControllerRefURL = "https://docs.vircadia.com/explore/get-started/vr-controls.html#vr-controls";
+ var keyboardRefURL = "https://docs.vircadia.com/explore/get-started/desktop.html#movement-controls";
+ var gamepadRefURL = "https://docs.vircadia.com/explore/get-started/vr-controls.html#gamepad";
function showKbm() {
document.getElementById("main_image").setAttribute("src", "img/tablet-help-keyboard.jpg");
- document.getElementById("image_button").setAttribute("href", keyboardRefURL);
+ document.getElementById("image_button").setAttribute("href", keyboardRefURL);
}
function showHandControllers() {
@@ -107,7 +107,7 @@
}
function chooseIcon() {
- switch (index)
+ switch (index)
{
case 0:
showGamepad();
diff --git a/interface/resources/qml/hifi/avatarPackager/AvatarPackagerApp.qml b/interface/resources/qml/hifi/avatarPackager/AvatarPackagerApp.qml
index 00d8a29561..3c82fdb32b 100644
--- a/interface/resources/qml/hifi/avatarPackager/AvatarPackagerApp.qml
+++ b/interface/resources/qml/hifi/avatarPackager/AvatarPackagerApp.qml
@@ -229,7 +229,7 @@ Item {
}
function openDocs() {
- Qt.openUrlExternally("https://docs.vircadia.dev/create/avatars/package-avatar.html");
+ Qt.openUrlExternally("https://docs.vircadia.com/create/avatars/package-avatar.html");
}
function openVideo() {
diff --git a/interface/resources/qml/hifi/avatarPackager/AvatarProject.qml b/interface/resources/qml/hifi/avatarPackager/AvatarProject.qml
index 9b59303a7e..62540d34d7 100644
--- a/interface/resources/qml/hifi/avatarPackager/AvatarProject.qml
+++ b/interface/resources/qml/hifi/avatarPackager/AvatarProject.qml
@@ -150,7 +150,7 @@ Item {
id: uploadingItemFooter
anchors.fill: parent
- anchors.topMargin: 1
+ anchors.topMargin: 1
visible: !!root.uploader && !root.finished && root.uploader.state === 4
color: "#00B4EF"
@@ -205,7 +205,7 @@ Item {
function showConfirmUploadPopup() {
popup.titleText = 'Overwrite Avatar';
- popup.bodyText = 'You have previously uploaded the avatar file from this project.' +
+ popup.bodyText = 'You have previously uploaded the avatar file from this project.' +
' This will overwrite that avatar and you won’t be able to access the older version.';
popup.button1text = 'CREATE NEW';
@@ -318,7 +318,7 @@ Item {
text: "This item is not for sale yet, learn more."
onLinkActivated: {
- Qt.openUrlExternally("https://docs.vircadia.dev/sell/add-item/upload-avatar.html");
+ Qt.openUrlExternally("https://docs.vircadia.com/sell/add-item/upload-avatar.html");
}
}
diff --git a/interface/resources/qml/hifi/avatarapp/MessageBoxes.qml b/interface/resources/qml/hifi/avatarapp/MessageBoxes.qml
index ccc28174a1..290bf14877 100644
--- a/interface/resources/qml/hifi/avatarapp/MessageBoxes.qml
+++ b/interface/resources/qml/hifi/avatarapp/MessageBoxes.qml
@@ -7,7 +7,7 @@ MessageBox {
popup.onButton2Clicked = callback;
popup.titleText = 'Specify Avatar URL'
popup.bodyText = 'This will not overwrite your existing favorite if you are wearing one.
' + - '' + + '' + 'Learn to make a custom avatar by opening this link on your desktop.' + '' popup.inputText.visible = true; diff --git a/interface/resources/qml/hifi/commerce/checkout/Checkout.qml b/interface/resources/qml/hifi/commerce/checkout/Checkout.qml index 424b4d616d..2a88cf8c17 100644 --- a/interface/resources/qml/hifi/commerce/checkout/Checkout.qml +++ b/interface/resources/qml/hifi/commerce/checkout/Checkout.qml @@ -6,6 +6,7 @@ // // Created by Zach Fox on 2017-08-25 // Copyright 2017 High Fidelity, Inc. +// Copyright 2021 Vircadia contributors. // // Distributed under the Apache License, Version 2.0. // See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html @@ -196,7 +197,7 @@ Rectangle { root.availableUpdatesReceived = false; root.currentUpdatesPage = 1; Commerce.getAvailableUpdates(root.itemId); - + var MARKETPLACE_API_URL = Account.metaverseServerURL + "/api/v1/marketplace/items/"; http.request({uri: MARKETPLACE_API_URL + root.itemId}, updateCheckoutQMLFromHTTP); } @@ -327,7 +328,7 @@ Rectangle { } } } - } + } HifiCommerceCommon.FirstUseTutorial { id: firstUseTutorial; @@ -374,7 +375,7 @@ Rectangle { hoverEnabled: true; propagateComposedEvents: false; } - + AnimatedImage { id: loadingImage; source: "../common/images/loader-blue.gif" @@ -397,7 +398,7 @@ Rectangle { color: hifi.colors.black; size: 28; } - + HifiControlsUit.Separator { id: separator; colorScheme: 1; @@ -475,7 +476,7 @@ Rectangle { } FiraSansSemiBold { id: itemPriceText; - text: isTradingIn ? "FREE\nUPDATE" : + text: isTradingIn ? "FREE\nUPDATE" : (isStocking ? "Free for creator" : ((root.itemPrice === -1) ? "--" : ((root.itemPrice > 0) ? root.itemPrice : "FREE"))); // Text size @@ -491,7 +492,7 @@ Rectangle { } } } - + HifiControlsUit.Separator { id: separator2; colorScheme: 1; @@ -728,7 +729,7 @@ Rectangle { sendToScript({method: 'checkout_itemLinkClicked', itemId: itemId}); } } - + Rectangle { id: rezzedNotifContainer; z: 997; @@ -778,7 +779,7 @@ Rectangle { lightboxPopup.bodyText = "Rezzing this content set will replace the existing environment and all of the items in this domain. " + "If you want to save the state of the content in this domain, create a backup before proceeding.
" + "For more information about backing up and restoring content, " + - "" + + "" + "click here to open info on your desktop browser."; lightboxPopup.button1text = "CANCEL"; lightboxPopup.button1method = function() { @@ -1069,7 +1070,7 @@ Rectangle { buyButton.color = hifi.buttons.red; root.shouldBuyWithControlledFailure = true; } else { - buyButton.text = (root.isCertified ? + buyButton.text = (root.isCertified ? (dataReady ? (root.alreadyOwned ? "Buy Another" : "Buy") : "--") : @@ -1079,7 +1080,7 @@ Rectangle { } } } - + HifiCommon.RootHttpRequest { id: http; @@ -1211,7 +1212,7 @@ Rectangle { // Else if the user HAS NOT selected a specific edition to update... } else { handleBuyAgainLogic(); - } + } // If the user IS NOT on the checkout page for the updated verison of an owned item... // (i.e. they are checking out an item "normally") } else { diff --git a/interface/resources/qml/hifi/commerce/purchases/Purchases.qml b/interface/resources/qml/hifi/commerce/purchases/Purchases.qml index 8ccfceb03c..2d886ce38e 100644 --- a/interface/resources/qml/hifi/commerce/purchases/Purchases.qml +++ b/interface/resources/qml/hifi/commerce/purchases/Purchases.qml @@ -6,6 +6,7 @@ // // Created by Zach Fox on 2017-08-25 // Copyright 2017 High Fidelity, Inc. +// Copyright 2021 Vircadia contributors. // // Distributed under the Apache License, Version 2.0. // See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html @@ -115,7 +116,7 @@ Rectangle { Component.onCompleted: { isStandalone = PlatformInfo.isStandalone(); } - + HifiCommerceCommon.CommerceLightbox { id: lightboxPopup; z: 999; @@ -174,7 +175,7 @@ Rectangle { Commerce.getWalletStatus(); } } - + Item { id: installedAppsContainer; z: 998; @@ -210,7 +211,7 @@ Rectangle { delegate: Item { width: parent.width; height: 40; - + RalewayRegular { text: model.appUrl; // Text size @@ -251,7 +252,7 @@ Rectangle { Commerce.openApp(model.appUrl); } } - + HiFiGlyphs { id: uninstallGlyph; text: hifi.glyphs.close; @@ -292,7 +293,7 @@ Rectangle { height: 40; text: "SIDELOAD APP FROM LOCAL DISK"; onClicked: { - Window.browseChanged.connect(onFileOpenChanged); + Window.browseChanged.connect(onFileOpenChanged); Window.browseAsync("Locate your app's .app.json file", "", "*.app.json"); } } @@ -602,7 +603,7 @@ Rectangle { lightboxPopup.bodyText = "Rezzing this content set will replace the existing environment and all of the items in this domain. " + "If you want to save the state of the content in this domain, create a backup before proceeding.
" + "For more information about backing up and restoring content, " + - "" + + "" + "click here to open info on your desktop browser."; lightboxPopup.button1text = "CANCEL"; lightboxPopup.button1method = function() { @@ -823,7 +824,7 @@ Rectangle { anchors.right: parent.right; height: 75; color: "#B5EAFF"; - + Rectangle { id: updatesAvailableGlyph; anchors.verticalCenter: parent.verticalCenter; @@ -991,7 +992,7 @@ Rectangle { // // FUNCTION DEFINITIONS START // - + function updateCurrentlyWornWearables(wearables) { for (var i = 0; i < purchasesModel.count; i++) { for (var j = 0; j < wearables.length; j++) { diff --git a/interface/resources/qml/hifi/commerce/wallet/Help.qml b/interface/resources/qml/hifi/commerce/wallet/Help.qml index dbdefc4c79..168a295ada 100644 --- a/interface/resources/qml/hifi/commerce/wallet/Help.qml +++ b/interface/resources/qml/hifi/commerce/wallet/Help.qml @@ -6,6 +6,7 @@ // // Created by Zach Fox on 2017-08-18 // Copyright 2017 High Fidelity, Inc. +// Copyright 2021 Vircadia contributors. // // Distributed under the Apache License, Version 2.0. // See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html @@ -207,7 +208,7 @@ At the moment, there is currently no way to convert HFC to other currencies. Sta if (link === "#privateKeyPath") { Qt.openUrlExternally("file:///" + root.keyFilePath.substring(0, root.keyFilePath.lastIndexOf('/'))); } else if (link === "#blockchain") { - Qt.openUrlExternally("https://docs.vircadia.dev/explore/shop.html"); + Qt.openUrlExternally("https://docs.vircadia.com/explore/shop.html"); } else if (link === "#bank") { if ((Account.metaverseServerURL).toString().indexOf("staging") >= 0) { Qt.openUrlExternally("hifi://hifiqa-master-metaverse-staging"); // So that we can test in staging. diff --git a/interface/src/Application.cpp b/interface/src/Application.cpp index 807b5e55a5..759a96388d 100644 --- a/interface/src/Application.cpp +++ b/interface/src/Application.cpp @@ -164,6 +164,7 @@ #include
#include
#include
+#include
#include "recording/ClipCache.h"
#include "AudioClient.h"
@@ -1972,7 +1973,7 @@ Application::Application(int& argc, char** argv, QElapsedTimer& startupTimer, bo
loadSettings();
updateVerboseLogging();
-
+
setCachebustRequire();
// Make sure we don't time out during slow operations at startup
@@ -2158,6 +2159,32 @@ Application::Application(int& argc, char** argv, QElapsedTimer& startupTimer, bo
return QSizeF(0.0f, 0.0f);
});
+ Texture::setUnboundTextureForUUIDOperator([this](const QUuid& entityID) -> gpu::TexturePointer {
+ if (_aboutToQuit) {
+ return nullptr;
+ }
+
+ auto renderable = getEntities()->renderableForEntityId(entityID);
+ if (renderable) {
+ return renderable->getTexture();
+ }
+
+ return nullptr;
+ });
+
+ ReferenceMaterial::setMaterialForUUIDOperator([this](const QUuid& entityID) -> graphics::MaterialPointer {
+ if (_aboutToQuit) {
+ return nullptr;
+ }
+
+ auto renderable = getEntities()->renderableForEntityId(entityID);
+ if (renderable) {
+ return renderable->getTopMaterial();
+ }
+
+ return nullptr;
+ });
+
connect(this, &Application::aboutToQuit, [this]() {
setKeyboardFocusEntity(UNKNOWN_ENTITY_ID);
});
@@ -2624,7 +2651,7 @@ void Application::setCachebustRequire() {
return;
}
bool enable = menu->isOptionChecked(MenuOption::CachebustRequire);
-
+
Setting::Handle{ CACHEBUST_SCRIPT_REQUIRE_SETTING_NAME, false }.set(enable);
}
@@ -3246,7 +3273,7 @@ void Application::initializeUi() {
safeURLS += settingsSafeURLS;
// END PULL SAFEURLS FROM INTERFACE.JSON Settings
-
+
if (AUTHORIZED_EXTERNAL_QML_SOURCE.isParentOf(url)) {
return true;
} else {
@@ -4004,7 +4031,7 @@ void Application::handleSandboxStatus(QNetworkReply* reply) {
parser.parse(arguments());
if (parser.isSet(urlOption)) {
QUrl url = QUrl(parser.value(urlOption));
- if (url.scheme() == URL_SCHEME_HIFIAPP) {
+ if (url.scheme() == URL_SCHEME_VIRCADIAAPP) {
Setting::Handle("startUpApp").set(url.path());
} else {
addressLookupString = url.toString();
@@ -4022,7 +4049,7 @@ void Application::handleSandboxStatus(QNetworkReply* reply) {
DependencyManager::get()->setHomeLocationToAddress(NetworkingConstants::DEFAULT_VIRCADIA_ADDRESS);
Menu::getInstance()->triggerOption(MenuOption::HomeLocation);
}
-
+
if (!_overrideEntry) {
DependencyManager::get()->goToEntry();
sentTo = SENT_TO_ENTRY;
@@ -7198,7 +7225,7 @@ void Application::updateWindowTitle() const {
QString buildVersion = " - Vircadia - "
+ (BuildInfo::BUILD_TYPE == BuildInfo::BuildType::Stable ? QString("Version") : QString("Build"))
+ " " + applicationVersion();
-
+
if (BuildInfo::RELEASE_NAME != "") {
buildVersion += " - " + BuildInfo::RELEASE_NAME;
}
@@ -7285,7 +7312,7 @@ void Application::clearDomainOctreeDetails(bool clearAll) {
void Application::domainURLChanged(QUrl domainURL) {
// disable physics until we have enough information about our new location to not cause craziness.
- setIsServerlessMode(domainURL.scheme() != URL_SCHEME_HIFI);
+ setIsServerlessMode(domainURL.scheme() != URL_SCHEME_VIRCADIA);
if (isServerlessMode()) {
loadServerlessDomain(domainURL);
}
@@ -7294,7 +7321,7 @@ void Application::domainURLChanged(QUrl domainURL) {
void Application::goToErrorDomainURL(QUrl errorDomainURL) {
// disable physics until we have enough information about our new location to not cause craziness.
- setIsServerlessMode(errorDomainURL.scheme() != URL_SCHEME_HIFI);
+ setIsServerlessMode(errorDomainURL.scheme() != URL_SCHEME_VIRCADIA);
if (isServerlessMode()) {
loadErrorDomain(errorDomainURL);
}
@@ -7658,7 +7685,7 @@ bool Application::canAcceptURL(const QString& urlString) const {
QUrl url(urlString);
if (url.query().contains(WEB_VIEW_TAG)) {
return false;
- } else if (urlString.startsWith(URL_SCHEME_HIFI)) {
+ } else if (urlString.startsWith(URL_SCHEME_VIRCADIA)) {
return true;
}
QString lowerPath = url.path().toLower();
@@ -7673,7 +7700,7 @@ bool Application::canAcceptURL(const QString& urlString) const {
bool Application::acceptURL(const QString& urlString, bool defaultUpload) {
QUrl url(urlString);
- if (url.scheme() == URL_SCHEME_HIFI) {
+ if (url.scheme() == URL_SCHEME_VIRCADIA) {
// this is a hifi URL - have the AddressManager handle it
QMetaObject::invokeMethod(DependencyManager::get().data(), "handleLookupString",
Qt::AutoConnection, Q_ARG(const QString&, urlString));
@@ -7901,7 +7928,7 @@ bool Application::askToReplaceDomainContent(const QString& url) {
static const QString infoText = simpleWordWrap("Your domain's content will be replaced with a new content set. "
"If you want to save what you have now, create a backup before proceeding. For more information about backing up "
"and restoring content, visit the documentation page at: ", MAX_CHARACTERS_PER_LINE) +
- "\nhttps://docs.vircadia.dev/host/maintain-domain/backup-domain.html";
+ "\nhttps://docs.vircadia.com/host/maintain-domain/backup-domain.html";
ModalDialogListener* dig = OffscreenUi::asyncQuestion("Are you sure you want to replace this domain's content set?",
infoText, QMessageBox::Yes | QMessageBox::No, QMessageBox::No);
diff --git a/interface/src/CrashHandler.h b/interface/src/CrashHandler.h
index 5b7e3b4438..27c5d76e1c 100644
--- a/interface/src/CrashHandler.h
+++ b/interface/src/CrashHandler.h
@@ -13,7 +13,10 @@
#define hifi_CrashHandler_h
#include
-class QCoreApplication;
+#include
+#include
+
+Q_DECLARE_LOGGING_CATEGORY(crash_handler)
bool startCrashHandler(std::string appPath);
void setCrashAnnotation(std::string name, std::string value);
diff --git a/interface/src/CrashHandler_Crashpad.cpp b/interface/src/CrashHandler_Crashpad.cpp
index a8195ce6e8..8c8ceed4b3 100644
--- a/interface/src/CrashHandler_Crashpad.cpp
+++ b/interface/src/CrashHandler_Crashpad.cpp
@@ -13,6 +13,8 @@
#include "CrashHandler.h"
+Q_LOGGING_CATEGORY(crash_handler, "vircadia.crash_handler")
+
#include
#include
@@ -141,6 +143,10 @@ static const QString CRASHPAD_HANDLER_NAME{ "crashpad_handler.exe" };
static const QString CRASHPAD_HANDLER_NAME{ "crashpad_handler" };
#endif
+#ifdef Q_OS_LINUX
+#include
+#endif
+
#ifdef Q_OS_WIN
// ------------------------------------------------------------------------------------------------
// The area within this #ifdef is specific to the Microsoft C++ compiler
@@ -311,8 +317,38 @@ void checkUnhandledExceptionHook() {
// ------------------------------------------------------------------------------------------------
#endif // Q_OS_WIN
+// Locate the full path to the binary's directory
+static QString findBinaryDir() {
+ // Normally we'd just use QCoreApplication::applicationDirPath(), but we can't.
+ // That function needs the QApplication to be created first, and Crashpad is initialized as early as possible,
+ // which is well before QApplication, so that function throws out a warning and returns ".".
+ //
+ // So we must do things the hard way here. In particular this is needed to correctly handle things in AppImage
+ // on Linux. On Windows and MacOS falling back to argv[0] should be fine.
+
+#ifdef Q_OS_LINUX
+ // Find outselves by looking at /proc//exe
+ pid_t ourPid = getpid();
+ QString exeLink = QString("/proc/%1/exe").arg(ourPid);
+ qCDebug(crash_handler) << "Looking at" << exeLink;
+
+ QFileInfo exeLinkInfo(exeLink);
+ if (exeLinkInfo.isSymLink()) {
+ QFileInfo exeInfo(exeLinkInfo.symLinkTarget());
+ qCDebug(crash_handler) << "exe symlink points at" << exeInfo;
+ return exeInfo.absoluteDir().absolutePath();
+ } else {
+ qCWarning(crash_handler) << exeLink << "isn't a symlink. /proc not mounted?";
+ }
+
+#endif
+
+ return QString();
+}
+
bool startCrashHandler(std::string appPath) {
if (BACKTRACE_URL.empty() || BACKTRACE_TOKEN.empty()) {
+ qCCritical(crash_handler) << "Backtrace URL or token not set, crash handler disabled.";
return false;
}
@@ -338,11 +374,29 @@ bool startCrashHandler(std::string appPath) {
const auto crashpadDbPath = crashpadDbDir.toStdString() + "/" + crashpadDbName;
// Locate Crashpad handler
- const QFileInfo interfaceBinary{ QString::fromStdString(appPath) };
- const QDir interfaceDir = interfaceBinary.dir();
- assert(interfaceDir.exists(CRASHPAD_HANDLER_NAME));
+ QString binaryDir = findBinaryDir();
+ QDir interfaceDir;
+
+ if (!binaryDir.isEmpty()) {
+ // Locating ourselves by argv[0] fails in the case of AppImage on Linux, as we get the AppImage
+ // itself in there. If we have a platform-specific method, and it succeeds, we use that instead
+ // of argv.
+ qCDebug(crash_handler) << "Locating own directory by platform-specific method";
+ interfaceDir.setPath(binaryDir);
+ } else {
+ qCDebug(crash_handler) << "Locating own directory by argv[0]";
+ interfaceDir.setPath(QString::fromStdString(appPath));
+ }
+
+ if (!interfaceDir.exists(CRASHPAD_HANDLER_NAME)) {
+ qCCritical(crash_handler) << "Failed to find" << CRASHPAD_HANDLER_NAME << "in" << interfaceDir << ", can't start crash handler";
+ return false;
+ }
+
const std::string CRASHPAD_HANDLER_PATH = interfaceDir.filePath(CRASHPAD_HANDLER_NAME).toStdString();
+ qCDebug(crash_handler) << "Crashpad handler found at" << QString::fromStdString(CRASHPAD_HANDLER_PATH);
+
// Setup different file paths
base::FilePath::StringType dbPath;
base::FilePath::StringType handlerPath;
@@ -352,8 +406,10 @@ bool startCrashHandler(std::string appPath) {
base::FilePath db(dbPath);
base::FilePath handler(handlerPath);
+ qCDebug(crash_handler) << "Opening crashpad database" << QString::fromStdString(crashpadDbPath);
auto database = crashpad::CrashReportDatabase::Initialize(db);
if (database == nullptr || database->GetSettings() == nullptr) {
+ qCCritical(crash_handler) << "Failed to open crashpad database" << QString::fromStdString(crashpadDbPath);
return false;
}
@@ -361,6 +417,7 @@ bool startCrashHandler(std::string appPath) {
database->GetSettings()->SetUploadsEnabled(true);
if (!client->StartHandler(handler, db, db, BACKTRACE_URL, annotations, arguments, true, true)) {
+ qCCritical(crash_handler) << "Failed to start crashpad handler";
return false;
}
@@ -369,6 +426,7 @@ bool startCrashHandler(std::string appPath) {
gl_crashpadUnhandledExceptionFilter = SetUnhandledExceptionFilter(unhandledExceptionHandler);
#endif
+ qCInfo(crash_handler) << "Crashpad initialized";
return true;
}
diff --git a/interface/src/CrashHandler_None.cpp b/interface/src/CrashHandler_None.cpp
index 4fe56cd042..2e86472705 100644
--- a/interface/src/CrashHandler_None.cpp
+++ b/interface/src/CrashHandler_None.cpp
@@ -17,8 +17,11 @@
#include
+
+Q_LOGGING_CATEGORY(crash_handler, "vircadia.crash_handler")
+
bool startCrashHandler(std::string appPath) {
- qDebug() << "No crash handler available.";
+ qCWarning(crash_handler) << "No crash handler available.";
return false;
}
diff --git a/interface/src/avatar/AvatarDoctor.cpp b/interface/src/avatar/AvatarDoctor.cpp
index d84383cf4f..e3a5a68621 100644
--- a/interface/src/avatar/AvatarDoctor.cpp
+++ b/interface/src/avatar/AvatarDoctor.cpp
@@ -1,9 +1,9 @@
//
// AvatarDoctor.cpp
//
-//
// Created by Thijs Wenker on 2/12/2019.
// Copyright 2019 High Fidelity, Inc.
+// Copyright 2021 Vircadia contributors.
//
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
@@ -55,7 +55,7 @@ static QStringList HAND_MAPPING_SUFFIXES = {
"HandThumb1",
};
-const QUrl PACKAGE_AVATAR_DOCS_BASE_URL = QUrl("https://docs.vircadia.dev/create/avatars/package-avatar.html");
+const QUrl PACKAGE_AVATAR_DOCS_BASE_URL = QUrl("https://docs.vircadia.com/create/avatars/package-avatar.html");
AvatarDoctor::AvatarDoctor(const QUrl& avatarFSTFileUrl) :
_avatarFSTFileUrl(avatarFSTFileUrl) {
@@ -71,7 +71,7 @@ void AvatarDoctor::startDiagnosing() {
return;
}
_isDiagnosing = true;
-
+
_errors.clear();
_externalTextureCount = 0;
@@ -107,7 +107,7 @@ void AvatarDoctor::startDiagnosing() {
if (avatarModel.joints.length() > NETWORKED_JOINTS_LIMIT) {
addError(tr( "Avatar has over %n bones.", "", NETWORKED_JOINTS_LIMIT), "maximum-bone-limit");
}
- // Avatar does not have Hips bone mapped
+ // Avatar does not have Hips bone mapped
if (!jointNames.contains("Hips")) {
addError("Hips are not mapped.", "hips-not-mapped");
}
@@ -236,7 +236,7 @@ void AvatarDoctor::startDiagnosing() {
for (const auto& jointVariant: jointNameMappings.values()) {
jointValues << jointVariant.toString();
}
-
+
const auto& uniqueJointValues = jointValues.toSet();
for (const auto& jointName: uniqueJointValues) {
if (jointValues.count(jointName) > 1) {
@@ -279,7 +279,7 @@ void AvatarDoctor::startDiagnosing() {
} else {
connect(materialMappingResource.data(), &NetworkTexture::finished, this,
[materialMappingHandled](bool success) mutable {
-
+
materialMappingHandled();
});
}
@@ -302,7 +302,7 @@ void AvatarDoctor::startDiagnosing() {
} else {
addError("Model file cannot be opened", "missing-file");
emit complete(getErrors());
- }
+ }
}
void AvatarDoctor::diagnoseTextures() {
diff --git a/interface/src/avatar/MyAvatar.h b/interface/src/avatar/MyAvatar.h
index cd9f929a62..3fceae534f 100644
--- a/interface/src/avatar/MyAvatar.h
+++ b/interface/src/avatar/MyAvatar.h
@@ -4,6 +4,7 @@
//
// Created by Mark Peng on 8/16/13.
// Copyright 2012 High Fidelity, Inc.
+// Copyright 2021 Vircadia contributors.
//
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
@@ -47,11 +48,11 @@ class DetailedMotionState;
* Value Name Description Default Your walking speed is constant; it doesn't change depending on how far
+ * Default Your walking speed is constant; it doesn't change depending on how far
* forward you push your controller's joystick. Fully pushing your joystick forward makes your avatar run. Analog Your walking speed changes in steps based on how far forward you push your
+ * Analog Your walking speed changes in steps based on how far forward you push your
* controller's joystick. Fully pushing your joystick forward makes your avatar run. AnalogPlus Your walking speed changes proportionally to how far forward you push
+ * AnalogPlus Your walking speed changes proportionally to how far forward you push
* your controller's joystick. Fully pushing your joystick forward makes your avatar run. Value Description Move the user's avatar in the direction of its
+ * Move the user's avatar in the direction of its
* x-axis, if the camera isn't in independent or mirror modes. Move the user's avatar in the direction of its
+ * Move the user's avatar in the direction of its
* -axis, if the camera isn't in independent or mirror modes. Move the user's avatar in the direction of its
+ * Move the user's avatar in the direction of its
* z-axis, if the camera isn't in independent or mirror modes. Rotate the user's avatar about its y-axis at a rate
+ * Rotate the user's avatar about its y-axis at a rate
* proportional to the control value, if the camera isn't in independent or mirror modes. No action. No action. No action. Rotate the user's avatar about its y-axis in a
+ * Rotate the user's avatar about its y-axis in a
* step increment, if the camera isn't in independent or mirror modes. Rotate the user's avatar head and attached camera
- * about its negative x-axis (i.e., positive values pitch down) at a rate proportional to the control value, if the
+ * Rotate the user's avatar head and attached camera
+ * about its negative x-axis (i.e., positive values pitch down) at a rate proportional to the control value, if the
* camera isn't in HMD, independent, or mirror modes. Zoom the camera in or out. Rotate the user's avatar about its y-axis by an
+ * Rotate the user's avatar about its y-axis by an
* amount proportional to the control value, if the camera isn't in independent or mirror modes. Rotate the user's avatar head and attached
- * camera about its negative x-axis (i.e., positive values pitch down) by an amount proportional to the control
+ * Rotate the user's avatar head and attached
+ * camera about its negative x-axis (i.e., positive values pitch down) by an amount proportional to the control
* value, if the camera isn't in HMD, independent, or mirror modes. Value Name Description ForceSit Assumes the user is seated in the real world. Disables avatar
+ * ForceSit Assumes the user is seated in the real world. Disables avatar
* leaning regardless of what the avatar is doing in the virtual world (i.e., avatar always recenters). ForceStand Assumes the user is standing in the real world. Enables avatar
- * leaning regardless of what the avatar is doing in the virtual world (i.e., avatar leans, then if leans too far it
+ * ForceStand Assumes the user is standing in the real world. Enables avatar
+ * leaning regardless of what the avatar is doing in the virtual world (i.e., avatar leans, then if leans too far it
* recenters). Auto Interface detects when the user is standing or seated in the real world.
- * Avatar leaning is disabled when the user is sitting (i.e., avatar always recenters), and avatar leaning is enabled
+ * Auto Interface detects when the user is standing or seated in the real world.
+ * Avatar leaning is disabled when the user is sitting (i.e., avatar always recenters), and avatar leaning is enabled
* when the user is standing (i.e., avatar leans, then if leans too far it recenters). DisableHMDLean DisableHMDLean Play a clapping animation on your avatar for three seconds.
@@ -757,10 +758,10 @@ public:
/*@jsdoc
* Gets the current animation roles.
- * |null} propertiesList - The list of {@link MyAvatar.AnimStateDictionary|AnimStateDictionary}
- * properties that should be included in the parameter that the handler function is called with. If |null} propertiesList - The list of {@link MyAvatar.AnimStateDictionary|AnimStateDictionary}
+ * properties that should be included in the parameter that the handler function is called with. If Log all the animation state dictionary parameters for a short while.
* function animStateHandler(dictionary) {
* print("Anim state dictionary: " + JSON.stringify(dictionary));
* }
- *
+ *
* var handler = MyAvatar.addAnimationStateHandler(animStateHandler, null);
- *
+ *
* Script.setTimeout(function () {
* MyAvatar.removeAnimationStateHandler(handler);
* }, 100);
@@ -881,7 +882,7 @@ public:
/*@jsdoc
* Gets whether you do snap turns in HMD mode.
* @function MyAvatar.getSnapTurn
- * @returns {boolean} Report the position of the avatar you're currently looking at.
* print(JSON.stringify(MyAvatar.getTargetAvatarPosition()));
*/
- // FIXME: If not looking at an avatar, the most recently looked-at position is returned. This should be fixed to return
+ // FIXME: If not looking at an avatar, the most recently looked-at position is returned. This should be fixed to return
// undefined or {NaN, NaN, NaN} or similar.
Q_INVOKABLE glm::vec3 getTargetAvatarPosition() const { return _targetAvatarPosition; }
@@ -1210,18 +1211,18 @@ public:
* @function MyAvatar.getTargetAvatar
* @returns {ScriptAvatar} Information on the avatar being looked at, Report the position of your left hand relative to your avatar.
* print(JSON.stringify(MyAvatar.getLeftHandPosition()));
@@ -1229,12 +1230,12 @@ public:
Q_INVOKABLE glm::vec3 getLeftHandPosition() const;
/*@jsdoc
- * Gets the position of the avatar's right hand, relative to the avatar, as positioned by a hand controller (e.g., Oculus
+ * Gets the position of the avatar's right hand, relative to the avatar, as positioned by a hand controller (e.g., Oculus
* Touch or Vive).
- * Report the position of your right hand relative to your avatar.
* print(JSON.stringify(MyAvatar.getLeftHandPosition()));
@@ -1242,10 +1243,10 @@ public:
Q_INVOKABLE glm::vec3 getRightHandPosition() const;
/*@jsdoc
- * Gets the position 0.3m in front of the left hand's position in the direction along the palm, in avatar coordinates, as
+ * Gets the position 0.3m in front of the left hand's position in the direction along the palm, in avatar coordinates, as
* positioned by a hand controller.
* @function MyAvatar.getLeftHandTipPosition
- * @returns {Vec3} The position 0.3m in front of the left hand's position in the direction along the palm, in avatar
+ * @returns {Vec3} The position 0.3m in front of the left hand's position in the direction along the palm, in avatar
* coordinates. If the hand isn't being positioned by a controller, Report the pose of your avatar's right hand.
* print(JSON.stringify(MyAvatar.getRightHandPose()));
*/
Q_INVOKABLE controller::Pose getRightHandPose() const;
/*@jsdoc
- * Gets the pose (position, rotation, velocity, and angular velocity) of the avatar's left hand, relative to the avatar, as
+ * Gets the pose (position, rotation, velocity, and angular velocity) of the avatar's left hand, relative to the avatar, as
* positioned by a hand controller (e.g., Oculus Touch or Vive), and translated 0.3m along the palm.
* & otherAvatar);
/*@jsdoc
- * Enables and disables flow simulation of physics on the avatar's hair, clothes, and body parts. See
- * {@link https://docs.vircadia.dev/create/avatars/add-flow.html|Add Flow to Your Avatar} for more
+ * Enables and disables flow simulation of physics on the avatar's hair, clothes, and body parts. See
+ * {@link https://docs.vircadia.com/create/avatars/add-flow.html|Add Flow to Your Avatar} for more
* information.
* @function MyAvatar.useFlow
* @param {boolean} isActive - } [physicsConfig] - Physics configurations for particular entity
+ * @param {Object} [physicsConfig] - Physics configurations for particular entity
* and avatar joints.
- * @param {Object} [collisionsConfig] - Collision configurations for particular
+ * @param {Object} [collisionsConfig] - Collision configurations for particular
* entity and avatar joints.
*/
Q_INVOKABLE void useFlow(bool isActive, bool isCollidable, const QVariantMap& physicsConfig = QVariantMap(), const QVariantMap& collisionsConfig = QVariantMap());
@@ -2078,7 +2079,7 @@ public slots:
void setGravity(float gravity);
/*@jsdoc
- * Sets the amount of gravity applied to the avatar in the y-axis direction. (Negative values are downward.) The default
+ * Sets the amount of gravity applied to the avatar in the y-axis direction. (Negative values are downward.) The default
* value is Report when your avatar goes away.
* MyAvatar.wentAway.connect(function () {
* print("My avatar went away");
@@ -2568,7 +2569,7 @@ signals:
/*@jsdoc
* Triggered when your avatar changes from being away to being active.
* @function MyAvatar.wentActive
- * @returns {Signal}
+ * @returns {Signal}
*/
void wentActive();
@@ -2576,7 +2577,7 @@ signals:
* Triggered when the avatar's model (i.e., {@link MyAvatar|skeletonModelURL} property value) is changed.
* ()->handleLookupString(url.toString());
- } else if (scheme == URL_SCHEME_HIFIAPP) {
+ } else if (scheme == URL_SCHEME_VIRCADIAAPP) {
DependencyManager::get()->openSystemApp(url.path());
} else {
#if defined(Q_OS_ANDROID)
diff --git a/libraries/audio-client/src/AudioClient.h b/libraries/audio-client/src/AudioClient.h
index a5de9bd4ca..5e753fbef8 100644
--- a/libraries/audio-client/src/AudioClient.h
+++ b/libraries/audio-client/src/AudioClient.h
@@ -4,6 +4,7 @@
//
// Created by Stephen Birarda on 1/22/13.
// Copyright 2013 High Fidelity, Inc.
+// Copyright 2021 Vircadia contributors.
//
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
@@ -33,7 +34,7 @@
#include
#include
-#include
+#include
#include
#include
#include
diff --git a/libraries/avatars-renderer/src/avatars-renderer/Avatar.h b/libraries/avatars-renderer/src/avatars-renderer/Avatar.h
index 3f5faccb3b..fa5a5cff67 100644
--- a/libraries/avatars-renderer/src/avatars-renderer/Avatar.h
+++ b/libraries/avatars-renderer/src/avatars-renderer/Avatar.h
@@ -3,6 +3,7 @@
// interface/src/avatar
//
// Copyright 2012 High Fidelity, Inc.
+// Copyright 2021 Vircadia contributors.
//
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
@@ -207,7 +208,7 @@ public:
/*@jsdoc
* Gets the default rotation of a joint (in the current avatar) relative to its parent.
* & blendshapeOffsets,
const QVector& blendedMeshSizes, const render::ItemIDs& subItemIDs);
-
+
std::vector _multiSphereShapes;
AABox _fitBoundingBox;
void clearAvatarGrabData(const QUuid& grabID) override;
diff --git a/libraries/avatars-renderer/src/avatars-renderer/ScriptAvatar.h b/libraries/avatars-renderer/src/avatars-renderer/ScriptAvatar.h
index f434498204..aac8236eda 100644
--- a/libraries/avatars-renderer/src/avatars-renderer/ScriptAvatar.h
+++ b/libraries/avatars-renderer/src/avatars-renderer/ScriptAvatar.h
@@ -4,6 +4,7 @@
//
// Created by Stephen Birarda on 4/10/17.
// Copyright 2017 High Fidelity, Inc.
+// Copyright 2021 Vircadia contributors.
//
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
@@ -87,10 +88,10 @@ public slots:
/*@jsdoc
* Gets the default rotation of a joint in the avatar relative to its parent.
* Stretch your avatar's neck. Depending on the avatar you are using, you will either see a gap between
+ * @example Stretch your avatar's neck. Depending on the avatar you are using, you will either see a gap between
* the head and body or you will see the neck stretched.
*
* // Stretch your avatar's neck.
* MyAvatar.setJointTranslation("Neck", Vec3.multiply(2, MyAvatar.getJointTranslation("Neck")));
- *
+ *
* // Restore your avatar's neck after 5s.
* Script.setTimeout(function () {
* MyAvatar.clearJointData("Neck");
@@ -953,7 +954,7 @@ public:
Q_INVOKABLE virtual void setJointTranslation(const QString& name, const glm::vec3& translation);
/*@jsdoc
- * Clears joint translations and rotations set by script for a specific joint. This restores all motion from the default
+ * Clears joint translations and rotations set by script for a specific joint. This restores all motion from the default
* animation system including inverse kinematics for that joint.
* Report the rotations of all your avatar's joints.
* print(JSON.stringify(MyAvatar.getJointRotations()));
@@ -1024,8 +1025,8 @@ public:
* model coordinates.
* getJointTranslations() const;
@@ -1038,7 +1039,7 @@ public:
* joints in the inverse kinematics chain, the inverse kinematics might not function as you expect. For example, if you set
* the rotation of the elbow, the hand inverse kinematics position won't end up in the right place.
* @function Avatar.setJointRotations
- * @param {Quat[]} jointRotations - The rotations for all joints in the avatar. The values are in the same order as the
+ * @param {Quat[]} jointRotations - The rotations for all joints in the avatar. The values are in the same order as the
* array returned by {@link MyAvatar.getJointNames}, or {@link Avatar.getJointNames} if using the Set your avatar to its default T-pose then rotate its right arm.
*
@@ -1051,7 +1052,7 @@ public:
* }
*
* // Get all join rotations.
- * var jointRotations = MyAvatar.getJointRotations();
+ * var jointRotations = MyAvatar.getJointRotations();
*
* // Update the rotation of the right arm in the array.
* jointRotations[MyAvatar.getJointIndex("RightArm")] = { x: 0.47, y: 0.22, z: -0.02, w: 0.87 };
@@ -1067,9 +1068,9 @@ public:
* // Note: If using from the Avatar API, replace all occurrences of "MyAvatar" with "Avatar".
*/
Q_INVOKABLE virtual void setJointRotations(const QVector& jointRotations);
-
+
/*@jsdoc
- * Sets the translations of all joints in the current avatar. Each joint's translation is relative to its parent joint, in
+ * Sets the translations of all joints in the current avatar. Each joint's translation is relative to its parent joint, in
* model coordinates.
* & jointTranslations);
/*@jsdoc
- * Clears all joint translations and rotations that have been set by script. This restores all motion from the default
+ * Clears all joint translations and rotations that have been set by script. This restores all motion from the default
* animation system including inverse kinematics for all joints.
* @function Avatar.clearJointsData
* @example Set your avatar to it's default T-pose for a while.
@@ -1107,7 +1108,7 @@ public:
Q_INVOKABLE virtual void clearJointsData();
/*@jsdoc
- * Gets the joint index for a named joint. The joint index value is the position of the joint in the array returned by
+ * Gets the joint index for a named joint. The joint index value is the position of the joint in the array returned by
* {@link MyAvatar.getJointNames}, or {@link Avatar.getJointNames} if using the Open your avatar's mouth wide.
* MyAvatar.hasScriptedBlendshapes = true;
@@ -1160,7 +1161,7 @@ public:
/*@jsdoc
* Sets all models currently attached to your avatar. For example, if you retrieve attachment data using
- * {@link MyAvatar.getAttachmentsVariant} or {@link Avatar.getAttachmentsVariant}, make changes to it, and then want to
+ * {@link MyAvatar.getAttachmentsVariant} or {@link Avatar.getAttachmentsVariant}, make changes to it, and then want to
* update your avatar's attachments per the changed data.
* @function Avatar.setAttachmentsVariant
* @param {AttachmentData[]} variant - The attachment data defining the models to have attached to your avatar.
@@ -1186,7 +1187,7 @@ public:
* @deprecated This function is deprecated and will be removed.
*/
Q_INVOKABLE virtual void clearAvatarEntity(const QUuid& entityID, bool requiresRemovalFromTree = true);
-
+
// FIXME: Rename to clearAvatarEntity() once the API call is removed.
virtual void clearAvatarEntityInternal(const QUuid& entityID);
@@ -1195,12 +1196,12 @@ public:
QList getAvatarEntityIDs() const;
/*@jsdoc
- * Enables blend shapes set using {@link Avatar.setBlendshape} or {@link MyAvatar.setBlendshape} to be transmitted to other
+ * Enables blend shapes set using {@link Avatar.setBlendshape} or {@link MyAvatar.setBlendshape} to be transmitted to other
* users so that they can see the animation of your avatar's face.
- * Report the sensor to world matrix.
* var sensorToWorldMatrix = MyAvatar.getSensorToWorldMatrix();
@@ -1431,7 +1432,7 @@ public:
/*@jsdoc
* Gets the scale that transforms dimensions in the user's real world to the avatar's size in the virtual world.
* @function Avatar.getSensorToWorldScale
- * @returns {number} The scale that transforms dimensions in the user's real world to the avatar's size in the virtual
+ * @returns {number} The scale that transforms dimensions in the user's real world to the avatar's size in the virtual
* world.
*/
// thread safe
@@ -1661,7 +1662,7 @@ public slots:
virtual bool setAbsoluteJointTranslationInObjectFrame(int index, const glm::vec3& translation) override { return false; }
/*@jsdoc
- * Gets the target scale of the avatar without any restrictions on permissible values imposed by the domain. In contrast, the
+ * Gets the target scale of the avatar without any restrictions on permissible values imposed by the domain. In contrast, the
* getJointRotations() const;
@@ -172,8 +173,8 @@ public:
* model coordinates.
* getJointTranslations() const;
@@ -182,7 +183,7 @@ public:
* Checks that the data for a joint are valid.
* @function ScriptAvatar.isJointDataValid
* @param {number} index - The index of the joint.
- * @returns {boolean} lock(_materialsLock);
+ auto materials = _materials.find("0");
+ if (materials != _materials.end()) {
+ return materials->second.top().material;
+ }
+ return nullptr;
+}
+
EntityRenderer::Pipeline EntityRenderer::getPipelineType(const graphics::MultiMaterial& materials) {
if (materials.top().material && materials.top().material->isProcedural() && materials.top().material->isReady()) {
return Pipeline::PROCEDURAL;
@@ -626,6 +635,7 @@ void EntityRenderer::updateShapeKeyBuilderFromMaterials(ShapeKey::Builder& build
{
std::lock_guard lock(_materialsLock);
materials = _materials.find("0");
+
if (materials != _materials.end()) {
if (materials->second.shouldUpdate()) {
RenderPipelines::updateMultiMaterial(materials->second);
@@ -653,7 +663,6 @@ void EntityRenderer::updateShapeKeyBuilderFromMaterials(ShapeKey::Builder& build
auto pipelineType = getPipelineType(materials->second);
if (pipelineType == Pipeline::MATERIAL) {
builder.withMaterial();
-
if (drawMaterialKey.isNormalMap()) {
builder.withTangents();
}
diff --git a/libraries/entities-renderer/src/RenderableEntityItem.h b/libraries/entities-renderer/src/RenderableEntityItem.h
index 2731fe6a50..3caeef0713 100644
--- a/libraries/entities-renderer/src/RenderableEntityItem.h
+++ b/libraries/entities-renderer/src/RenderableEntityItem.h
@@ -62,7 +62,9 @@ public:
};
virtual void addMaterial(graphics::MaterialLayer material, const std::string& parentMaterialName);
virtual void removeMaterial(graphics::MaterialPointer material, const std::string& parentMaterialName);
+ virtual graphics::MaterialPointer getTopMaterial();
static Pipeline getPipelineType(const graphics::MultiMaterial& materials);
+ virtual gpu::TexturePointer getTexture() { return nullptr; }
virtual scriptable::ScriptableModelBase getScriptableModel() override { return scriptable::ScriptableModelBase(); }
diff --git a/libraries/entities-renderer/src/RenderableImageEntityItem.cpp b/libraries/entities-renderer/src/RenderableImageEntityItem.cpp
index 3fa2174114..9592a3e57f 100644
--- a/libraries/entities-renderer/src/RenderableImageEntityItem.cpp
+++ b/libraries/entities-renderer/src/RenderableImageEntityItem.cpp
@@ -198,10 +198,8 @@ void ImageEntityRenderer::doRender(RenderArgs* args) {
procedural->prepare(*batch, transform.getTranslation(), transform.getScale(), transform.getRotation(), _created, ProceduralProgramKey(transparent));
} else if (pipelineType == Pipeline::SIMPLE) {
batch->setResourceTexture(0, _texture->getGPUTexture());
- } else {
- if (RenderPipelines::bindMaterials(materials, *batch, args->_renderMode, args->_enableTexturing)) {
- args->_details._materialSwitches++;
- }
+ } else if (RenderPipelines::bindMaterials(materials, *batch, args->_renderMode, args->_enableTexturing)) {
+ args->_details._materialSwitches++;
}
DependencyManager::get()->renderQuad(
diff --git a/libraries/entities-renderer/src/RenderableImageEntityItem.h b/libraries/entities-renderer/src/RenderableImageEntityItem.h
index ff82dc157a..cc923daf4b 100644
--- a/libraries/entities-renderer/src/RenderableImageEntityItem.h
+++ b/libraries/entities-renderer/src/RenderableImageEntityItem.h
@@ -24,6 +24,8 @@ public:
ImageEntityRenderer(const EntityItemPointer& entity);
~ImageEntityRenderer();
+ gpu::TexturePointer getTexture() override { return _texture ? _texture->getGPUTexture() : nullptr; }
+
protected:
Item::Bound getBound(RenderArgs* args) override;
ShapeKey getShapeKey() override;
diff --git a/libraries/entities-renderer/src/RenderableMaterialEntityItem.cpp b/libraries/entities-renderer/src/RenderableMaterialEntityItem.cpp
index 8f8a2076f8..b8f829f4ba 100644
--- a/libraries/entities-renderer/src/RenderableMaterialEntityItem.cpp
+++ b/libraries/entities-renderer/src/RenderableMaterialEntityItem.cpp
@@ -79,26 +79,42 @@ void MaterialEntityRenderer::doRenderUpdateAsynchronousTyped(const TypedEntityPo
}
}
+ bool usingMaterialData = _materialURL.startsWith("materialData");
+ bool usingEntityID = _materialURL.startsWith("{");
+ bool materialDataChanged = false;
bool urlChanged = false;
std::string newCurrentMaterialName = _currentMaterialName;
+ QString targetEntityID = _materialURL;
{
QString materialURL = entity->getMaterialURL();
if (materialURL != _materialURL) {
_materialURL = materialURL;
+ usingMaterialData = _materialURL.startsWith("materialData");
+ usingEntityID = _materialURL.startsWith("{");
+ targetEntityID = _materialURL;
if (_materialURL.contains("#")) {
auto split = _materialURL.split("#");
newCurrentMaterialName = split.last().toStdString();
+ if (usingEntityID) {
+ targetEntityID = split.first();
+ }
} else if (_materialURL.contains("?")) {
qDebug() << "DEPRECATED: Use # instead of ? for material URLS:" << _materialURL;
auto split = _materialURL.split("?");
newCurrentMaterialName = split.last().toStdString();
+ if (usingEntityID) {
+ targetEntityID = split.first();
+ }
+ }
+
+ if (usingMaterialData) {
+ materialDataChanged = true;
+ } else {
+ urlChanged = true;
}
- urlChanged = true;
}
}
- bool usingMaterialData = _materialURL.startsWith("materialData");
- bool materialDataChanged = false;
QUuid oldParentID = _parentID;
QString oldParentMaterialName = _parentMaterialName;
{
@@ -135,7 +151,7 @@ void MaterialEntityRenderer::doRenderUpdateAsynchronousTyped(const TypedEntityPo
}
}
- if (urlChanged && !usingMaterialData) {
+ if (urlChanged && !usingMaterialData && !usingEntityID) {
_networkMaterial = DependencyManager::get()->getMaterial(_materialURL);
auto onMaterialRequestFinished = [this, entity, oldParentID, oldParentMaterialName, newCurrentMaterialName](bool success) {
deleteMaterial(oldParentID, oldParentMaterialName);
@@ -159,6 +175,13 @@ void MaterialEntityRenderer::doRenderUpdateAsynchronousTyped(const TypedEntityPo
});
}
}
+ } else if (urlChanged && usingEntityID) {
+ deleteMaterial(oldParentID, oldParentMaterialName);
+ _texturesLoaded = true;
+ _parsedMaterials = NetworkMaterialResource::parseMaterialForUUID(QJsonValue(targetEntityID));
+ // Since our material changed, the current name might not be valid anymore, so we need to update
+ setCurrentMaterialName(newCurrentMaterialName);
+ applyMaterial(entity);
} else if (materialDataChanged && usingMaterialData) {
deleteMaterial(oldParentID, oldParentMaterialName);
_texturesLoaded = false;
@@ -167,6 +190,10 @@ void MaterialEntityRenderer::doRenderUpdateAsynchronousTyped(const TypedEntityPo
setCurrentMaterialName(newCurrentMaterialName);
applyMaterial(entity);
} else {
+ if (newCurrentMaterialName != _currentMaterialName) {
+ setCurrentMaterialName(newCurrentMaterialName);
+ }
+
if (deleteNeeded) {
deleteMaterial(oldParentID, oldParentMaterialName);
}
diff --git a/libraries/entities-renderer/src/RenderableMaterialEntityItem.h b/libraries/entities-renderer/src/RenderableMaterialEntityItem.h
index 340d169f29..25403e8a2b 100644
--- a/libraries/entities-renderer/src/RenderableMaterialEntityItem.h
+++ b/libraries/entities-renderer/src/RenderableMaterialEntityItem.h
@@ -26,6 +26,8 @@ public:
MaterialEntityRenderer(const EntityItemPointer& entity) : Parent(entity) {}
~MaterialEntityRenderer() { deleteMaterial(_parentID, _parentMaterialName); }
+ graphics::MaterialPointer getTopMaterial() override { return getMaterial(); }
+
private:
virtual void doRenderUpdateSynchronousTyped(const ScenePointer& scene, Transaction& transaction, const TypedEntityPointer& entity) override;
virtual void doRenderUpdateAsynchronousTyped(const TypedEntityPointer& entity) override;
diff --git a/libraries/entities-renderer/src/RenderableWebEntityItem.cpp b/libraries/entities-renderer/src/RenderableWebEntityItem.cpp
index 7932a19110..6e436a0dcd 100644
--- a/libraries/entities-renderer/src/RenderableWebEntityItem.cpp
+++ b/libraries/entities-renderer/src/RenderableWebEntityItem.cpp
@@ -274,6 +274,7 @@ void WebEntityRenderer::doRender(RenderArgs* args) {
// Try to update the texture
OffscreenQmlSurface::TextureAndFence newTextureAndFence;
+ QSize windowSize;
bool newTextureAvailable = false;
if (!resultWithReadLock([&] {
if (!_webSurface) {
@@ -281,6 +282,7 @@ void WebEntityRenderer::doRender(RenderArgs* args) {
}
newTextureAvailable = _webSurface->fetchTexture(newTextureAndFence);
+ windowSize = _webSurface->size();
return true;
})) {
return;
@@ -288,6 +290,8 @@ void WebEntityRenderer::doRender(RenderArgs* args) {
if (newTextureAvailable) {
_texture->setExternalTexture(newTextureAndFence.first, newTextureAndFence.second);
+ _texture->setSize(windowSize.width(), windowSize.height());
+ _texture->setOriginalSize(windowSize.width(), windowSize.height());
}
static const glm::vec2 texMin(0.0f), texMax(1.0f), topLeft(-0.5f), bottomRight(0.5f);
diff --git a/libraries/entities-renderer/src/RenderableWebEntityItem.h b/libraries/entities-renderer/src/RenderableWebEntityItem.h
index 1ac415e5e5..fb04e08ec7 100644
--- a/libraries/entities-renderer/src/RenderableWebEntityItem.h
+++ b/libraries/entities-renderer/src/RenderableWebEntityItem.h
@@ -55,6 +55,8 @@ public:
virtual void setProxyWindow(QWindow* proxyWindow) override;
virtual QObject* getEventHandler() override;
+ gpu::TexturePointer getTexture() override { return _texture; }
+
protected:
virtual bool needsRenderUpdateFromTypedEntity(const TypedEntityPointer& entity) const override;
virtual void doRenderUpdateSynchronousTyped(const ScenePointer& scene, Transaction& transaction, const TypedEntityPointer& entity) override;
diff --git a/libraries/entities/src/EntityItemProperties.cpp b/libraries/entities/src/EntityItemProperties.cpp
index 425cfe9439..945804a0fc 100644
--- a/libraries/entities/src/EntityItemProperties.cpp
+++ b/libraries/entities/src/EntityItemProperties.cpp
@@ -951,10 +951,11 @@ EntityPropertyFlags EntityItemProperties::getChangedProperties() const {
*
* @typedef {object} Entities.EntityProperties-Material
* @property {Vec3} dimensions=0.1,0.1,0.1 - Used when EntityTree::sendEntities(EntityEditPacketSender* packetSen
return map.values().toVector();
}
+QJsonValue replaceEntityIDsInJSONHelper(const QJsonValue& jsonValue, std::function getMapped) {
+ if (jsonValue.isString()) {
+ QString stringValue = jsonValue.toString();
+ QUuid oldID = stringValue;
+ if (!oldID.isNull()) {
+ return QJsonValue(getMapped(oldID).toString());
+ }
+ return stringValue;
+ } else if (jsonValue.isArray()) {
+ QJsonArray jsonArray = jsonValue.toArray();
+ for (int i = 0; i < jsonArray.count(); i++) {
+ jsonArray[i] = replaceEntityIDsInJSONHelper(jsonArray[i], getMapped);
+ }
+ return jsonArray;
+ } else if (jsonValue.isObject()) {
+ QJsonObject jsonObject = jsonValue.toObject();
+ auto keys = jsonObject.keys();
+ for (auto& key : keys) {
+ auto value = jsonObject.value(key);
+ jsonObject[key] = replaceEntityIDsInJSONHelper(value, getMapped);
+ }
+ return jsonObject;
+ } else {
+ return jsonValue;
+ }
+}
+
+QString replaceEntityIDsInJSON(const QString& json, std::function getMapped) {
+ QJsonDocument document = QJsonDocument::fromJson(json.toUtf8());
+ if (!document.isNull() && document.isObject()) {
+ QJsonObject jsonObject = document.object();
+ auto keys = jsonObject.keys();
+ for (auto& key : keys) {
+ auto value = jsonObject.value(key);
+ jsonObject[key] = replaceEntityIDsInJSONHelper(value, getMapped);
+ }
+ document = QJsonDocument(jsonObject);
+ }
+ return document.toJson();
+}
+
bool EntityTree::sendEntitiesOperation(const OctreeElementPointer& element, void* extraData) {
SendEntitiesOperationArgs* args = static_cast(extraData);
EntityTreeElementPointer entityTreeElement = std::static_pointer_cast(element);
@@ -2819,6 +2860,61 @@ bool EntityTree::sendEntitiesOperation(const OctreeElementPointer& element, void
QByteArray actionData = properties.getActionData();
properties.setActionData(remapActionDataIDs(actionData, *args->map));
+ {
+ QString materialURL = properties.getMaterialURL();
+ QString uuidString = materialURL;
+ QString materialName = "";
+
+ if (materialURL.contains("?")) {
+ QStringList split = materialURL.split("?");
+ uuidString = split[0];
+ if (split.length() > 1) {
+ materialName = split[1];
+ }
+ } else if (materialURL.contains("#")) {
+ QStringList split = materialURL.split("#");
+ uuidString = split[0];
+ if (split.length() > 1) {
+ materialName = split[1];
+ }
+ }
+
+ QUuid oldID = uuidString;
+ if (!oldID.isNull()) {
+ uuidString = getMapped(oldID).toString();
+ }
+ QUuid oldMaterialName = materialName;
+ if (!oldMaterialName.isNull()) {
+ materialName = getMapped(oldMaterialName).toString();
+ }
+
+ if (!materialName.isEmpty()) {
+ properties.setMaterialURL(uuidString + "?" + materialName);
+ } else {
+ properties.setMaterialURL(uuidString);
+ }
+ }
+
+ QString imageURL = properties.getImageURL();
+ if (imageURL.startsWith("{")) {
+ QUuid oldID = imageURL;
+ if (!oldID.isNull()) {
+ properties.setImageURL(getMapped(oldID).toString());
+ }
+ }
+
+ QString materialData = properties.getMaterialData();
+ if (!materialData.isEmpty()) {
+ materialData = replaceEntityIDsInJSON(materialData, getMapped);
+ properties.setMaterialData(materialData);
+ }
+
+ QString userData = properties.getUserData();
+ if (!userData.isEmpty()) {
+ userData = replaceEntityIDsInJSON(userData, getMapped);
+ properties.setUserData(userData);
+ }
+
// set creation time to "now" for imported entities
properties.setCreated(usecTimestampNow());
diff --git a/libraries/gpu/src/gpu/Texture.cpp b/libraries/gpu/src/gpu/Texture.cpp
index 1edd7d33cf..48159c5da5 100755
--- a/libraries/gpu/src/gpu/Texture.cpp
+++ b/libraries/gpu/src/gpu/Texture.cpp
@@ -322,6 +322,16 @@ bool Texture::isDepthStencilRenderTarget() const {
return (_texelFormat.getSemantic() == gpu::DEPTH) || (_texelFormat.getSemantic() == gpu::DEPTH_STENCIL);
}
+void Texture::setSize(int width, int height) {
+ _width = width;
+ _height = height;
+}
+
+void Texture::setOriginalSize(int width, int height) {
+ _originalWidth = width;
+ _originalHeight = height;
+}
+
uint16 Texture::evalDimMaxNumMips(uint16 size) {
double largerDim = size;
double val = log(largerDim)/log(2.0);
@@ -887,16 +897,34 @@ void SphericalHarmonics::evalFromTexture(const Texture& texture, gpu::BackendTar
// TextureSource
-void TextureSource::resetTexture(gpu::TexturePointer texture) {
+const gpu::TexturePointer TextureSource::getGPUTexture() const {
+ if (_gpuTextureOperator && !_locked) {
+ _locked = true;
+ auto gpuTexture = _gpuTextureOperator();
+ _locked = false;
+ return gpuTexture;
+ }
+ return _gpuTexture;
+}
+
+void TextureSource::resetTexture(const gpu::TexturePointer& texture) {
_gpuTexture = texture;
+ _gpuTextureOperator = nullptr;
+}
+
+void TextureSource::resetTextureOperator(const std::function& textureOperator) {
+ _gpuTexture = nullptr;
+ _gpuTextureOperator = textureOperator;
}
bool TextureSource::isDefined() const {
- if (_gpuTexture) {
- return _gpuTexture->isDefined();
- } else {
- return false;
+ if (_gpuTextureOperator && !_locked) {
+ _locked = true;
+ auto gpuTexture = _gpuTextureOperator();
+ _locked = false;
+ return gpuTexture && gpuTexture->isDefined();
}
+ return _gpuTexture && _gpuTexture->isDefined();
}
bool Texture::setMinMip(uint16 newMinMip) {
@@ -930,6 +958,7 @@ void Texture::setExternalTexture(uint32 externalId, void* externalFence) {
Lock lock(_externalMutex);
assert(_externalRecycler);
_externalUpdates.push_back({ externalId, externalFence });
+ _defined = true;
}
Texture::ExternalUpdates Texture::getUpdates() const {
diff --git a/libraries/gpu/src/gpu/Texture.h b/libraries/gpu/src/gpu/Texture.h
index a525cda1ab..a0cfc60b6e 100755
--- a/libraries/gpu/src/gpu/Texture.h
+++ b/libraries/gpu/src/gpu/Texture.h
@@ -417,11 +417,16 @@ public:
Element getTexelFormat() const { return _texelFormat; }
+ void setSize(int width, int height);
Vec3u getDimensions() const { return Vec3u(_width, _height, _depth); }
uint16 getWidth() const { return _width; }
uint16 getHeight() const { return _height; }
uint16 getDepth() const { return _depth; }
+ void setOriginalSize(int width, int height);
+ int getOriginalWidth() const { return _originalWidth; }
+ int getOriginalHeight() const { return _originalHeight; }
+
// The number of faces is mostly used for cube map, and maybe for stereo ? otherwise it's 1
// For cube maps, this means the pixels of the different faces are supposed to be packed back to back in a mip
// as if the height was NUM_FACES time bigger.
@@ -615,6 +620,8 @@ protected:
uint16 _width { 1 };
uint16 _height { 1 };
uint16 _depth { 1 };
+ int _originalWidth { 0 };
+ int _originalHeight { 0 };
uint16 _numSamples { 1 };
@@ -676,9 +683,10 @@ public:
_element(element)
{};
- TextureView(const TexturePointer& texture, uint16 subresource) :
+ TextureView(const TexturePointer& texture, uint16 subresource, std::function textureOperator = nullptr) :
_texture(texture),
- _subresource(subresource)
+ _subresource(subresource),
+ _textureOperator(textureOperator)
{};
~TextureView() {}
@@ -689,6 +697,12 @@ public:
bool operator !() const { return (!_texture); }
bool isValid() const { return bool(_texture); }
+
+ bool isReference() const { return (bool)_textureOperator; }
+ std::function getTextureOperator() const { return _textureOperator; }
+
+private:
+ std::function _textureOperator { nullptr };
};
typedef std::vector TextureViews;
@@ -700,16 +714,20 @@ public:
void setUrl(const QUrl& url) { _imageUrl = url; }
const QUrl& getUrl() const { return _imageUrl; }
- const gpu::TexturePointer getGPUTexture() const { return _gpuTexture; }
+ const gpu::TexturePointer getGPUTexture() const;
void setType(int type) { _type = type; }
int getType() const { return _type; }
- void resetTexture(gpu::TexturePointer texture);
+ void resetTexture(const gpu::TexturePointer& texture);
+ void resetTextureOperator(const std::function& textureOperator);
bool isDefined() const;
+ std::function getTextureOperator() const { return _gpuTextureOperator; }
protected:
gpu::TexturePointer _gpuTexture;
+ std::function _gpuTextureOperator { nullptr };
+ mutable bool _locked { false };
QUrl _imageUrl;
int _type { 0 };
};
diff --git a/libraries/graphics/src/graphics/Material.cpp b/libraries/graphics/src/graphics/Material.cpp
index 41cd319595..836487de14 100755
--- a/libraries/graphics/src/graphics/Material.cpp
+++ b/libraries/graphics/src/graphics/Material.cpp
@@ -281,4 +281,33 @@ void MultiMaterial::calculateMaterialInfo() const {
}
_hasCalculatedTextureInfo = allTextures;
}
-}
\ No newline at end of file
+}
+
+void MultiMaterial::resetReferenceTexturesAndMaterials() {
+ _referenceTextures.clear();
+ _referenceMaterials.clear();
+}
+
+void MultiMaterial::addReferenceTexture(const std::function& textureOperator) {
+ _referenceTextures.emplace_back(textureOperator, textureOperator());
+}
+
+void MultiMaterial::addReferenceMaterial(const std::function& materialOperator) {
+ _referenceMaterials.emplace_back(materialOperator, materialOperator());
+}
+
+bool MultiMaterial::anyReferenceMaterialsOrTexturesChanged() const {
+ for (auto textureOperatorPair : _referenceTextures) {
+ if (textureOperatorPair.first() != textureOperatorPair.second) {
+ return true;
+ }
+ }
+
+ for (auto materialOperatorPair : _referenceMaterials) {
+ if (materialOperatorPair.first() != materialOperatorPair.second) {
+ return true;
+ }
+ }
+
+ return false;
+}
diff --git a/libraries/graphics/src/graphics/Material.h b/libraries/graphics/src/graphics/Material.h
index 7a411e5b2c..2eb4e0cbe1 100755
--- a/libraries/graphics/src/graphics/Material.h
+++ b/libraries/graphics/src/graphics/Material.h
@@ -341,57 +341,57 @@ public:
virtual ~Material() = default;
Material& operator= (const Material& material);
- const MaterialKey& getKey() const { return _key; }
+ virtual MaterialKey getKey() const { return _key; }
static const float DEFAULT_EMISSIVE;
void setEmissive(const glm::vec3& emissive, bool isSRGB = true);
- glm::vec3 getEmissive(bool SRGB = true) const { return (SRGB ? ColorUtils::tosRGBVec3(_emissive) : _emissive); }
+ virtual glm::vec3 getEmissive(bool SRGB = true) const { return (SRGB ? ColorUtils::tosRGBVec3(_emissive) : _emissive); }
static const float DEFAULT_OPACITY;
void setOpacity(float opacity);
- float getOpacity() const { return _opacity; }
+ virtual float getOpacity() const { return _opacity; }
static const MaterialKey::OpacityMapMode DEFAULT_OPACITY_MAP_MODE;
void setOpacityMapMode(MaterialKey::OpacityMapMode opacityMapMode);
- MaterialKey::OpacityMapMode getOpacityMapMode() const;
+ virtual MaterialKey::OpacityMapMode getOpacityMapMode() const;
static const float DEFAULT_OPACITY_CUTOFF;
void setOpacityCutoff(float opacityCutoff);
- float getOpacityCutoff() const { return _opacityCutoff; }
+ virtual float getOpacityCutoff() const { return _opacityCutoff; }
static const MaterialKey::CullFaceMode DEFAULT_CULL_FACE_MODE;
void setCullFaceMode(MaterialKey::CullFaceMode cullFaceMode) { _cullFaceMode = cullFaceMode; }
- MaterialKey::CullFaceMode getCullFaceMode() const { return _cullFaceMode; }
+ virtual MaterialKey::CullFaceMode getCullFaceMode() const { return _cullFaceMode; }
void setUnlit(bool value);
- bool isUnlit() const { return _key.isUnlit(); }
+ virtual bool isUnlit() const { return _key.isUnlit(); }
static const float DEFAULT_ALBEDO;
void setAlbedo(const glm::vec3& albedo, bool isSRGB = true);
- glm::vec3 getAlbedo(bool SRGB = true) const { return (SRGB ? ColorUtils::tosRGBVec3(_albedo) : _albedo); }
+ virtual glm::vec3 getAlbedo(bool SRGB = true) const { return (SRGB ? ColorUtils::tosRGBVec3(_albedo) : _albedo); }
static const float DEFAULT_METALLIC;
void setMetallic(float metallic);
- float getMetallic() const { return _metallic; }
+ virtual float getMetallic() const { return _metallic; }
static const float DEFAULT_ROUGHNESS;
void setRoughness(float roughness);
- float getRoughness() const { return _roughness; }
+ virtual float getRoughness() const { return _roughness; }
static const float DEFAULT_SCATTERING;
void setScattering(float scattering);
- float getScattering() const { return _scattering; }
+ virtual float getScattering() const { return _scattering; }
// The texture map to channel association
static const int NUM_TEXCOORD_TRANSFORMS { 2 };
void setTextureMap(MapChannel channel, const TextureMapPointer& textureMap);
- const TextureMaps& getTextureMaps() const { return _textureMaps; } // FIXME - not thread safe...
+ virtual TextureMaps getTextureMaps() const { return _textureMaps; } // FIXME - not thread safe...
const TextureMapPointer getTextureMap(MapChannel channel) const;
// Albedo maps cannot have opacity detected until they are loaded
// This method allows const changing of the key/schemaBuffer without touching the map
// return true if the opacity changed, flase otherwise
- bool resetOpacityMap() const;
+ virtual bool resetOpacityMap() const;
// conversion from legacy material properties to PBR equivalent
static float shininessToRoughness(float shininess) { return 1.0f - shininess / 100.0f; }
@@ -404,12 +404,12 @@ public:
const std::string& getModel() const { return _model; }
void setModel(const std::string& model) { _model = model; }
- glm::mat4 getTexCoordTransform(uint i) const { return _texcoordTransforms[i]; }
+ virtual glm::mat4 getTexCoordTransform(uint i) const { return _texcoordTransforms[i]; }
void setTexCoordTransform(uint i, const glm::mat4& mat4) { _texcoordTransforms[i] = mat4; }
- glm::vec2 getLightmapParams() const { return _lightmapParams; }
- glm::vec2 getMaterialParams() const { return _materialParams; }
+ virtual glm::vec2 getLightmapParams() const { return _lightmapParams; }
+ virtual glm::vec2 getMaterialParams() const { return _materialParams; }
- bool getDefaultFallthrough() const { return _defaultFallthrough; }
+ virtual bool getDefaultFallthrough() const { return _defaultFallthrough; }
void setDefaultFallthrough(bool defaultFallthrough) { _defaultFallthrough = defaultFallthrough; }
enum ExtraFlagBit {
@@ -430,6 +430,8 @@ public:
virtual bool isReady() const { return true; }
virtual QString getProceduralString() const { return QString(); }
+ virtual bool isReference() const { return false; }
+
static const std::string HIFI_PBR;
static const std::string HIFI_SHADER_SIMPLE;
@@ -547,12 +549,16 @@ public:
void setTexturesLoading(bool value) { _texturesLoading = value; }
void setInitialized() { _initialized = true; }
- bool shouldUpdate() const { return !_initialized || _needsUpdate || _texturesLoading; }
+ bool shouldUpdate() const { return !_initialized || _needsUpdate || _texturesLoading || anyReferenceMaterialsOrTexturesChanged(); }
int getTextureCount() const { calculateMaterialInfo(); return _textureCount; }
size_t getTextureSize() const { calculateMaterialInfo(); return _textureSize; }
bool hasTextureInfo() const { return _hasCalculatedTextureInfo; }
+ void resetReferenceTexturesAndMaterials();
+ void addReferenceTexture(const std::function& textureOperator);
+ void addReferenceMaterial(const std::function& materialOperator);
+
private:
gpu::BufferView _schemaBuffer;
graphics::MaterialKey::CullFaceMode _cullFaceMode { graphics::Material::DEFAULT_CULL_FACE_MODE };
@@ -565,6 +571,11 @@ private:
mutable int _textureCount { 0 };
mutable bool _hasCalculatedTextureInfo { false };
void calculateMaterialInfo() const;
+
+ bool anyReferenceMaterialsOrTexturesChanged() const;
+
+ std::vector, gpu::TexturePointer>> _referenceTextures;
+ std::vector, graphics::MaterialPointer>> _referenceMaterials;
};
};
diff --git a/libraries/graphics/src/graphics/TextureMap.cpp b/libraries/graphics/src/graphics/TextureMap.cpp
index e2f24d68ff..0590203907 100755
--- a/libraries/graphics/src/graphics/TextureMap.cpp
+++ b/libraries/graphics/src/graphics/TextureMap.cpp
@@ -18,16 +18,12 @@ void TextureMap::setTextureSource(TextureSourcePointer& textureSource) {
}
bool TextureMap::isDefined() const {
- if (_textureSource) {
- return _textureSource->isDefined();
- } else {
- return false;
- }
+ return _textureSource && _textureSource->isDefined();
}
gpu::TextureView TextureMap::getTextureView() const {
if (_textureSource) {
- return gpu::TextureView(_textureSource->getGPUTexture(), 0);
+ return gpu::TextureView(_textureSource->getGPUTexture(), 0, _textureSource->getTextureOperator());
} else {
return gpu::TextureView();
}
diff --git a/libraries/image/src/image/TextureProcessing.h b/libraries/image/src/image/TextureProcessing.h
index ff81e98a77..7bf249ebda 100644
--- a/libraries/image/src/image/TextureProcessing.h
+++ b/libraries/image/src/image/TextureProcessing.h
@@ -4,6 +4,7 @@
//
// Created by Clement Brisset on 4/5/2017.
// Copyright 2017 High Fidelity, Inc.
+// Copyright 2021 Vircadia contributors.
//
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
@@ -23,7 +24,7 @@ namespace image {
std::function getHDRPackingFunction();
std::function getHDRUnpackingFunction();
- void convertToFloatFromPacked(const unsigned char* source, int width, int height, size_t srcLineByteStride, gpu::Element sourceFormat,
+ void convertToFloatFromPacked(const unsigned char* source, int width, int height, size_t srcLineByteStride, gpu::Element sourceFormat,
glm::vec4* output, size_t outputLinePixelStride);
void convertToPackedFromFloat(unsigned char* output, int width, int height, size_t outputLineByteStride, gpu::Element outputFormat,
const glm::vec4* source, size_t srcLinePixelStride);
@@ -32,8 +33,8 @@ namespace TextureUsage {
/*@jsdoc
*
*
*
- Would you like use automatic threading for your server's avatars and audio?
- If you are hosting this server on your local computer and it is not very powerful, then consider leaving this off because the server will use more resources if it is being utilized extensively, thereby slowing down your computer.
+ Would you like use automatic threading for your server's avatars and audio?
+ If you are hosting this server on your local computer and it is not very powerful, then consider leaving this off because the server will use more resources if it is being utilized extensively, thereby slowing down your computer.
If you are running this server on a powerful system and intend to have a large audience, then turn this setting on.
diff --git a/domain-server/src/DomainGatekeeper.cpp b/domain-server/src/DomainGatekeeper.cpp
index 035caaa328..d55a00dcf1 100644
--- a/domain-server/src/DomainGatekeeper.cpp
+++ b/domain-server/src/DomainGatekeeper.cpp
@@ -357,7 +357,7 @@ void DomainGatekeeper::updateNodePermissions() {
} else {
// at this point we don't have a sending socket for packets from this node - assume it is the active socket
// or the public socket if we haven't activated a socket for the node yet
- HifiSockAddr connectingAddr = node->getActiveSocket() ? *node->getActiveSocket() : node->getPublicSocket();
+ SockAddr connectingAddr = node->getActiveSocket() ? *node->getActiveSocket() : node->getPublicSocket();
QString hardwareAddress;
QUuid machineFingerprint;
@@ -651,7 +651,7 @@ SharedNodePointer DomainGatekeeper::processAgentConnectRequest(const NodeConnect
}
SharedNodePointer DomainGatekeeper::addVerifiedNodeFromConnectRequest(const NodeConnectionData& nodeConnection) {
- HifiSockAddr discoveredSocket = nodeConnection.senderSockAddr;
+ SockAddr discoveredSocket = nodeConnection.senderSockAddr;
SharedNetworkPeer connectedPeer = _icePeers.value(nodeConnection.connectUUID);
if (connectedPeer && connectedPeer->getActiveSocket()) {
@@ -690,7 +690,7 @@ void DomainGatekeeper::cleanupICEPeerForNode(const QUuid& nodeID) {
bool DomainGatekeeper::verifyUserSignature(const QString& username,
const QByteArray& usernameSignature,
- const HifiSockAddr& senderSockAddr) {
+ const SockAddr& senderSockAddr) {
// it's possible this user can be allowed to connect, but we need to check their username signature
auto lowerUsername = username.toLower();
KeyFlagPair publicKeyPair = _userPublicKeys.value(lowerUsername);
@@ -773,7 +773,7 @@ bool DomainGatekeeper::needToVerifyDomainUserIdentity(const QString& username, c
}
bool DomainGatekeeper::verifyDomainUserIdentity(const QString& username, const QString& accessToken,
- const QString& refreshToken, const HifiSockAddr& senderSockAddr) {
+ const QString& refreshToken, const SockAddr& senderSockAddr) {
if (_verifiedDomainUserIdentities.contains(username)
&& _verifiedDomainUserIdentities.value(username) == QPair' + - '' + + '' + 'Learn to make a custom avatar by opening this link on your desktop.' + '' popup.inputText.visible = true; diff --git a/interface/resources/qml/hifi/commerce/checkout/Checkout.qml b/interface/resources/qml/hifi/commerce/checkout/Checkout.qml index 424b4d616d..2a88cf8c17 100644 --- a/interface/resources/qml/hifi/commerce/checkout/Checkout.qml +++ b/interface/resources/qml/hifi/commerce/checkout/Checkout.qml @@ -6,6 +6,7 @@ // // Created by Zach Fox on 2017-08-25 // Copyright 2017 High Fidelity, Inc. +// Copyright 2021 Vircadia contributors. // // Distributed under the Apache License, Version 2.0. // See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html @@ -196,7 +197,7 @@ Rectangle { root.availableUpdatesReceived = false; root.currentUpdatesPage = 1; Commerce.getAvailableUpdates(root.itemId); - + var MARKETPLACE_API_URL = Account.metaverseServerURL + "/api/v1/marketplace/items/"; http.request({uri: MARKETPLACE_API_URL + root.itemId}, updateCheckoutQMLFromHTTP); } @@ -327,7 +328,7 @@ Rectangle { } } } - } + } HifiCommerceCommon.FirstUseTutorial { id: firstUseTutorial; @@ -374,7 +375,7 @@ Rectangle { hoverEnabled: true; propagateComposedEvents: false; } - + AnimatedImage { id: loadingImage; source: "../common/images/loader-blue.gif" @@ -397,7 +398,7 @@ Rectangle { color: hifi.colors.black; size: 28; } - + HifiControlsUit.Separator { id: separator; colorScheme: 1; @@ -475,7 +476,7 @@ Rectangle { } FiraSansSemiBold { id: itemPriceText; - text: isTradingIn ? "FREE\nUPDATE" : + text: isTradingIn ? "FREE\nUPDATE" : (isStocking ? "Free for creator" : ((root.itemPrice === -1) ? "--" : ((root.itemPrice > 0) ? root.itemPrice : "FREE"))); // Text size @@ -491,7 +492,7 @@ Rectangle { } } } - + HifiControlsUit.Separator { id: separator2; colorScheme: 1; @@ -728,7 +729,7 @@ Rectangle { sendToScript({method: 'checkout_itemLinkClicked', itemId: itemId}); } } - + Rectangle { id: rezzedNotifContainer; z: 997; @@ -778,7 +779,7 @@ Rectangle { lightboxPopup.bodyText = "Rezzing this content set will replace the existing environment and all of the items in this domain. " + "If you want to save the state of the content in this domain, create a backup before proceeding.
" + "For more information about backing up and restoring content, " + - "" + + "" + "click here to open info on your desktop browser."; lightboxPopup.button1text = "CANCEL"; lightboxPopup.button1method = function() { @@ -1069,7 +1070,7 @@ Rectangle { buyButton.color = hifi.buttons.red; root.shouldBuyWithControlledFailure = true; } else { - buyButton.text = (root.isCertified ? + buyButton.text = (root.isCertified ? (dataReady ? (root.alreadyOwned ? "Buy Another" : "Buy") : "--") : @@ -1079,7 +1080,7 @@ Rectangle { } } } - + HifiCommon.RootHttpRequest { id: http; @@ -1211,7 +1212,7 @@ Rectangle { // Else if the user HAS NOT selected a specific edition to update... } else { handleBuyAgainLogic(); - } + } // If the user IS NOT on the checkout page for the updated verison of an owned item... // (i.e. they are checking out an item "normally") } else { diff --git a/interface/resources/qml/hifi/commerce/purchases/Purchases.qml b/interface/resources/qml/hifi/commerce/purchases/Purchases.qml index 8ccfceb03c..2d886ce38e 100644 --- a/interface/resources/qml/hifi/commerce/purchases/Purchases.qml +++ b/interface/resources/qml/hifi/commerce/purchases/Purchases.qml @@ -6,6 +6,7 @@ // // Created by Zach Fox on 2017-08-25 // Copyright 2017 High Fidelity, Inc. +// Copyright 2021 Vircadia contributors. // // Distributed under the Apache License, Version 2.0. // See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html @@ -115,7 +116,7 @@ Rectangle { Component.onCompleted: { isStandalone = PlatformInfo.isStandalone(); } - + HifiCommerceCommon.CommerceLightbox { id: lightboxPopup; z: 999; @@ -174,7 +175,7 @@ Rectangle { Commerce.getWalletStatus(); } } - + Item { id: installedAppsContainer; z: 998; @@ -210,7 +211,7 @@ Rectangle { delegate: Item { width: parent.width; height: 40; - + RalewayRegular { text: model.appUrl; // Text size @@ -251,7 +252,7 @@ Rectangle { Commerce.openApp(model.appUrl); } } - + HiFiGlyphs { id: uninstallGlyph; text: hifi.glyphs.close; @@ -292,7 +293,7 @@ Rectangle { height: 40; text: "SIDELOAD APP FROM LOCAL DISK"; onClicked: { - Window.browseChanged.connect(onFileOpenChanged); + Window.browseChanged.connect(onFileOpenChanged); Window.browseAsync("Locate your app's .app.json file", "", "*.app.json"); } } @@ -602,7 +603,7 @@ Rectangle { lightboxPopup.bodyText = "Rezzing this content set will replace the existing environment and all of the items in this domain. " + "If you want to save the state of the content in this domain, create a backup before proceeding.
" + "For more information about backing up and restoring content, " + - "" + + "" + "click here to open info on your desktop browser."; lightboxPopup.button1text = "CANCEL"; lightboxPopup.button1method = function() { @@ -823,7 +824,7 @@ Rectangle { anchors.right: parent.right; height: 75; color: "#B5EAFF"; - + Rectangle { id: updatesAvailableGlyph; anchors.verticalCenter: parent.verticalCenter; @@ -991,7 +992,7 @@ Rectangle { // // FUNCTION DEFINITIONS START // - + function updateCurrentlyWornWearables(wearables) { for (var i = 0; i < purchasesModel.count; i++) { for (var j = 0; j < wearables.length; j++) { diff --git a/interface/resources/qml/hifi/commerce/wallet/Help.qml b/interface/resources/qml/hifi/commerce/wallet/Help.qml index dbdefc4c79..168a295ada 100644 --- a/interface/resources/qml/hifi/commerce/wallet/Help.qml +++ b/interface/resources/qml/hifi/commerce/wallet/Help.qml @@ -6,6 +6,7 @@ // // Created by Zach Fox on 2017-08-18 // Copyright 2017 High Fidelity, Inc. +// Copyright 2021 Vircadia contributors. // // Distributed under the Apache License, Version 2.0. // See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html @@ -207,7 +208,7 @@ At the moment, there is currently no way to convert HFC to other currencies. Sta if (link === "#privateKeyPath") { Qt.openUrlExternally("file:///" + root.keyFilePath.substring(0, root.keyFilePath.lastIndexOf('/'))); } else if (link === "#blockchain") { - Qt.openUrlExternally("https://docs.vircadia.dev/explore/shop.html"); + Qt.openUrlExternally("https://docs.vircadia.com/explore/shop.html"); } else if (link === "#bank") { if ((Account.metaverseServerURL).toString().indexOf("staging") >= 0) { Qt.openUrlExternally("hifi://hifiqa-master-metaverse-staging"); // So that we can test in staging. diff --git a/interface/src/Application.cpp b/interface/src/Application.cpp index 807b5e55a5..759a96388d 100644 --- a/interface/src/Application.cpp +++ b/interface/src/Application.cpp @@ -164,6 +164,7 @@ #include
001122Note: This property will automatically be set to true if the controller system has
* valid facial blend shape actions.
true if avatars blink automatically by animating
- * facial blend shapes, false if automatic blinking is disabled. Set to false to fully control
+ * facial blend shapes, false if automatic blinking is disabled. Set to false to fully control
* the blink facial blend shapes via the {@link MyAvatar.setBlendshape} method.
* @property {boolean} hasProceduralEyeFaceMovement=true - true if the facial blend shapes for an avatar's eyes
* adjust automatically as the eyes move, false if this automatic movement is disabled. Set this property
- * to true to prevent the iris from being obscured by the upper or lower lids. Set to false to
+ * to true to prevent the iris from being obscured by the upper or lower lids. Set to false to
* fully control the eye blend shapes via the {@link MyAvatar.setBlendshape} method.
* @property {boolean} hasAudioEnabledFaceMovement=true - true if the avatar's mouth blend shapes animate
* automatically based on detected microphone input, false if this automatic movement is disabled. Set
@@ -175,16 +176,16 @@ class MyAvatar : public Avatar {
* @property {boolean} shouldRenderLocally=true - If true then your avatar is rendered for you in Interface,
* otherwise it is not rendered for you (but it is still rendered for other users).
* @property {Vec3} motorVelocity=Vec3.ZERO - The target velocity of your avatar to be achieved by a scripted motor.
- * @property {number} motorTimescale=1000000 - The timescale for the scripted motor to achieve the target
+ * @property {number} motorTimescale=1000000 - The timescale for the scripted motor to achieve the target
* motorVelocity avatar velocity. Smaller values result in higher acceleration.
- * @property {string} motorReferenceFrame="camera" - Reference frame of the motorVelocity. Must be one of the
+ * @property {string} motorReferenceFrame="camera" - Reference frame of the motorVelocity. Must be one of the
* following: "camera", "avatar", and "world".
- * @property {string} motorMode="simple" - The Type of scripted motor behavior: "simple" to use the
+ * @property {string} motorMode="simple" - The Type of scripted motor behavior: "simple" to use the
* motorTimescale time scale; "dynamic" to use character controller timescales.
- * @property {string} collisionSoundURL="Body_Hits_Impact.wav" - The sound that's played when the avatar experiences a
- * collision. It can be a mono or stereo 16-bit WAV file running at either 24kHz or 48kHz. The latter is down-sampled
+ * @property {string} collisionSoundURL="Body_Hits_Impact.wav" - The sound that's played when the avatar experiences a
+ * collision. It can be a mono or stereo 16-bit WAV file running at either 24kHz or 48kHz. The latter is down-sampled
* by the audio mixer, so all audio effectively plays back at a 24khz. 48kHz RAW files are also supported.
- * @property {number} audioListenerMode=0 - Specifies the listening position when hearing spatialized audio. Must be one
+ * @property {number} audioListenerMode=0 - Specifies the listening position when hearing spatialized audio. Must be one
* of the following property values:
* -
*
MyAvatar.audioListenerModeHead
@@ -193,93 +194,93 @@ class MyAvatar : public Avatar {
*
customListenPosition and customListenOrientation property values. Read-only.
* @property {Vec3} customListenPosition=Vec3.ZERO - The listening position used when the audioListenerMode
* property value is audioListenerModeCustom.
* @property {Quat} customListenOrientation=Quat.IDENTITY - The listening orientation used when the
* audioListenerMode property value is audioListenerModeCustom.
- * @property {number} rotationRecenterFilterLength - Configures how quickly the avatar root rotates to recenter its facing
- * direction to match that of the user's torso based on head and hands orientation. A smaller value makes the
+ * @property {number} rotationRecenterFilterLength - Configures how quickly the avatar root rotates to recenter its facing
+ * direction to match that of the user's torso based on head and hands orientation. A smaller value makes the
* recentering happen more quickly. The minimum value is 0.01.
- * @property {number} rotationThreshold - The angle in radians that the user's torso facing direction (based on head and
+ * @property {number} rotationThreshold - The angle in radians that the user's torso facing direction (based on head and
* hands orientation) can differ from that of the avatar before the avatar's root is rotated to match the user's torso.
- * @property {boolean} enableStepResetRotation - If true then after the user's avatar takes a step, the
- * avatar's root immediately rotates to recenter its facing direction to match that of the user's torso based on head
+ * @property {boolean} enableStepResetRotation - If true then after the user's avatar takes a step, the
+ * avatar's root immediately rotates to recenter its facing direction to match that of the user's torso based on head
* and hands orientation.
- * @property {boolean} enableDrawAverageFacing - If true, debug graphics are drawn that show the average
- * facing direction of the user's torso (based on head and hands orientation). This can be useful if you want to try
+ * @property {boolean} enableDrawAverageFacing - If true, debug graphics are drawn that show the average
+ * facing direction of the user's torso (based on head and hands orientation). This can be useful if you want to try
* out different filter lengths and thresholds.
*
- * @property {Vec3} leftHandPosition - The position of the left hand in avatar coordinates if it's being positioned by
+ * @property {Vec3} leftHandPosition - The position of the left hand in avatar coordinates if it's being positioned by
* controllers, otherwise {@link Vec3(0)|Vec3.ZERO}. Read-only.
* @property {Vec3} rightHandPosition - The position of the right hand in avatar coordinates if it's being positioned by
* controllers, otherwise {@link Vec3(0)|Vec3.ZERO}. Read-only.
- * @property {Vec3} leftHandTipPosition - The position 0.3m in front of the left hand's position, in the direction along the
- * palm, in avatar coordinates. If the hand isn't being positioned by a controller, the value is
+ * @property {Vec3} leftHandTipPosition - The position 0.3m in front of the left hand's position, in the direction along the
+ * palm, in avatar coordinates. If the hand isn't being positioned by a controller, the value is
* {@link Vec3(0)|Vec3.ZERO}. Read-only.
- * @property {Vec3} rightHandTipPosition - The position 0.3m in front of the right hand's position, in the direction along
- * the palm, in avatar coordinates. If the hand isn't being positioned by a controller, the value is
+ * @property {Vec3} rightHandTipPosition - The position 0.3m in front of the right hand's position, in the direction along
+ * the palm, in avatar coordinates. If the hand isn't being positioned by a controller, the value is
* {@link Vec3(0)|Vec3.ZERO}. Read-only.
*
- * @property {Pose} leftHandPose - The left hand's pose as determined by the hand controllers, relative to the avatar.
+ * @property {Pose} leftHandPose - The left hand's pose as determined by the hand controllers, relative to the avatar.
* Read-only.
* @property {Pose} rightHandPose - The right hand's pose as determined by the hand controllers, relative to the avatar.
* Read-only.
- * @property {Pose} leftHandTipPose - The left hand's pose as determined by the hand controllers, relative to the avatar,
+ * @property {Pose} leftHandTipPose - The left hand's pose as determined by the hand controllers, relative to the avatar,
* with the position adjusted by 0.3m along the direction of the palm. Read-only.
- * @property {Pose} rightHandTipPose - The right hand's pose as determined by the hand controllers, relative to the avatar,
+ * @property {Pose} rightHandTipPose - The right hand's pose as determined by the hand controllers, relative to the avatar,
* with the position adjusted by 0.3m along the direction of the palm. Read-only.
*
* @property {number} energy - Deprecated: This property will be removed.
- * @property {boolean} isAway - true if your avatar is away (i.e., inactive), false if it is
+ * @property {boolean} isAway - true if your avatar is away (i.e., inactive), false if it is
* active.
*
* @property {boolean} centerOfGravityModelEnabled=true - true if the avatar hips are placed according to
* the center of gravity model that balances the center of gravity over the base of support of the feet. Set the
* value to false for default behavior where the hips are positioned under the head.
- * @property {boolean} hmdLeanRecenterEnabled=true - true IF the avatar is re-centered to be under the
- * head's position. In room-scale VR, this behavior is what causes your avatar to follow your HMD as you walk around
+ * @property {boolean} hmdLeanRecenterEnabled=true - true IF the avatar is re-centered to be under the
+ * head's position. In room-scale VR, this behavior is what causes your avatar to follow your HMD as you walk around
* the room. Setting the value false is useful if you want to pin the avatar to a fixed position.
- * @property {boolean} collisionsEnabled - Set to true to enable the avatar to collide with the environment,
- * false to disable collisions with the environment. May return true even though the value
+ * @property {boolean} collisionsEnabled - Set to true to enable the avatar to collide with the environment,
+ * false to disable collisions with the environment. May return true even though the value
* was set false because the zone may disallow collisionless avatars.
- * @property {boolean} otherAvatarsCollisionsEnabled - Set to true to enable the avatar to collide with other
+ * @property {boolean} otherAvatarsCollisionsEnabled - Set to true to enable the avatar to collide with other
* avatars, false to disable collisions with other avatars.
* @property {boolean} characterControllerEnabled - Synonym of collisionsEnabled.
- * Deprecated: This property is deprecated and will be removed. Use collisionsEnabled
+ *
Deprecated: This property is deprecated and will be removed. Use collisionsEnabled
* instead.
Note: Setting the value has no effect unless Interface is restarted.
* * @property {number} yawSpeed=75 - The mouse X sensitivity value in Settings > General. Read-only. * @property {number} pitchSpeed=50 - The mouse Y sensitivity value in Settings > General. Read-only. * - * @property {boolean} hmdRollControlEnabled=true - Iftrue, the roll angle of your HMD turns your avatar
+ * @property {boolean} hmdRollControlEnabled=true - If true, the roll angle of your HMD turns your avatar
* while flying.
- * @property {number} hmdRollControlDeadZone=8 - The amount of HMD roll, in degrees, required before your avatar turns if
+ * @property {number} hmdRollControlDeadZone=8 - The amount of HMD roll, in degrees, required before your avatar turns if
* hmdRollControlEnabled is enabled.
- * @property {number} hmdRollControlRate If MyAvatar.hmdRollControlEnabled is true, this value determines the
+ * @property {number} hmdRollControlRate If MyAvatar.hmdRollControlEnabled is true, this value determines the
* maximum turn rate of your avatar when rolling your HMD in degrees per second.
*
* @property {number} userHeight=1.75 - The height of the user in sensor space.
* @property {number} userEyeHeight=1.65 - The estimated height of the user's eyes in sensor space. Read-only.
*
- * @property {Uuid} SELF_ID - UUID representing "my avatar". Only use for local-only entities in situations
- * where MyAvatar.sessionUUID is not available (e.g., if not connected to a domain). Note: Likely to be deprecated.
+ * @property {Uuid} SELF_ID - UUID representing "my avatar". Only use for local-only entities in situations
+ * where MyAvatar.sessionUUID is not available (e.g., if not connected to a domain). Note: Likely to be deprecated.
* Read-only.
*
- * @property {number} walkSpeed - The walk speed of your avatar for the current control scheme (see
+ * @property {number} walkSpeed - The walk speed of your avatar for the current control scheme (see
* {@link MyAvatar.getControlScheme|getControlScheme}).
- * @property {number} walkBackwardSpeed - The walk backward speed of your avatar for the current control scheme (see
+ * @property {number} walkBackwardSpeed - The walk backward speed of your avatar for the current control scheme (see
* {@link MyAvatar.getControlScheme|getControlScheme}).
- * @property {number} sprintSpeed - The sprint (run) speed of your avatar for the current control scheme (see
+ * @property {number} sprintSpeed - The sprint (run) speed of your avatar for the current control scheme (see
* {@link MyAvatar.getControlScheme|getControlScheme}).
* @property {number} analogPlusWalkSpeed - The walk speed of your avatar for the "AnalogPlus" control scheme.
- * Warning: Setting this value also sets the value of analogPlusSprintSpeed to twice
+ *
Warning: Setting this value also sets the value of analogPlusSprintSpeed to twice
* the value.
true to lock the avatar sitting/standing state, i.e., use this
+ * @property {boolean} isSitStandStateLocked - true to lock the avatar sitting/standing state, i.e., use this
* to disable automatically changing state.
- * Deprecated: This property is deprecated and will be removed. + *
Deprecated: This property is deprecated and will be removed.
* See also: getUserRecenterModel and setUserRecenterModel.
true if teleporting is enabled in the Interface settings,
+ * @property {boolean} allowTeleporting - true if teleporting is enabled in the Interface settings,
* false if it isn't. Read-only.
*
* @borrows Avatar.getDomainMinScale as getDomainMinScale
@@ -435,7 +436,7 @@ class MyAvatar : public Avatar {
public:
/*@jsdoc
- * The DriveKeys API provides constant numeric values that represent different logical keys that drive your
+ * The DriveKeys API provides constant numeric values that represent different logical keys that drive your
* avatar and camera.
*
* @namespace DriveKeys
@@ -444,27 +445,27 @@ public:
* @hifi-client-entity
* @hifi-avatar
*
- * @property {number} TRANSLATE_X - Move the user's avatar in the direction of its x-axis, if the camera isn't in
+ * @property {number} TRANSLATE_X - Move the user's avatar in the direction of its x-axis, if the camera isn't in
* independent or mirror modes.
- * @property {number} TRANSLATE_Y - Move the user's avatar in the direction of its y-axis, if the camera isn't in
+ * @property {number} TRANSLATE_Y - Move the user's avatar in the direction of its y-axis, if the camera isn't in
* independent or mirror modes.
- * @property {number} TRANSLATE_Z - Move the user's avatar in the direction of its z-axis, if the camera isn't in
+ * @property {number} TRANSLATE_Z - Move the user's avatar in the direction of its z-axis, if the camera isn't in
* independent or mirror modes.
- * @property {number} YAW - Rotate the user's avatar about its y-axis at a rate proportional to the control value, if the
+ * @property {number} YAW - Rotate the user's avatar about its y-axis at a rate proportional to the control value, if the
* camera isn't in independent or mirror modes.
* @property {number} STEP_TRANSLATE_X - No action.
* @property {number} STEP_TRANSLATE_Y - No action.
* @property {number} STEP_TRANSLATE_Z - No action.
- * @property {number} STEP_YAW - Rotate the user's avatar about its y-axis in a step increment, if the camera isn't in
+ * @property {number} STEP_YAW - Rotate the user's avatar about its y-axis in a step increment, if the camera isn't in
* independent or mirror modes.
- * @property {number} PITCH - Rotate the user's avatar head and attached camera about its negative x-axis (i.e., positive
- * values pitch down) at a rate proportional to the control value, if the camera isn't in HMD, independent, or mirror
+ * @property {number} PITCH - Rotate the user's avatar head and attached camera about its negative x-axis (i.e., positive
+ * values pitch down) at a rate proportional to the control value, if the camera isn't in HMD, independent, or mirror
* modes.
* @property {number} ZOOM - Zoom the camera in or out.
- * @property {number} DELTA_YAW - Rotate the user's avatar about its y-axis by an amount proportional to the control value,
+ * @property {number} DELTA_YAW - Rotate the user's avatar about its y-axis by an amount proportional to the control value,
* if the camera isn't in independent or mirror modes.
- * @property {number} DELTA_PITCH - Rotate the user's avatar head and attached camera about its negative x-axis (i.e.,
- * positive values pitch down) by an amount proportional to the control value, if the camera isn't in HMD, independent,
+ * @property {number} DELTA_PITCH - Rotate the user's avatar head and attached camera about its negative x-axis (i.e.,
+ * positive values pitch down) by an amount proportional to the control value, if the camera isn't in HMD, independent,
* or mirror modes.
*/
@@ -475,27 +476,27 @@ public:
* {@link DriveKeys|DriveKeys.TRANSLATE_X}{@link DriveKeys|DriveKeys.TRANSLATE_X}{@link DriveKeys|DriveKeys.TRANSLATE_Y}{@link DriveKeys|DriveKeys.TRANSLATE_Y}{@link DriveKeys|DriveKeys.TRANSLATE_Z}{@link DriveKeys|DriveKeys.TRANSLATE_Z}{@link DriveKeys|DriveKeys.YAW}{@link DriveKeys|DriveKeys.YAW}{@link DriveKeys|DriveKeys.STEP_TRANSLATE_X}{@link DriveKeys|DriveKeys.STEP_TRANSLATE_Y}{@link DriveKeys|DriveKeys.STEP_TRANSLATE_Z}{@link DriveKeys|DriveKeys.STEP_YAW}{@link DriveKeys|DriveKeys.STEP_YAW}{@link DriveKeys|DriveKeys.PITCH}{@link DriveKeys|DriveKeys.PITCH}{@link DriveKeys|DriveKeys.ZOOM}{@link DriveKeys|DriveKeys.DELTA_YAW}{@link DriveKeys|DriveKeys.DELTA_YAW}{@link DriveKeys|DriveKeys.DELTA_PITCH}{@link DriveKeys|DriveKeys.DELTA_PITCH}0011223Both avatar leaning and recentering are disabled regardless of - * what the user is doing in the real world and no matter what their avatar is doing in the virtual world. Enables + *
3Both avatar leaning and recentering are disabled regardless of + * what the user is doing in the real world and no matter what their avatar is doing in the virtual world. Enables * the avatar to sit on the floor when the user sits on the floor.
*Note: Experimental.
The internal inverse-kinematics system maintains a record of which joints are "locked". Sometimes it is useful to + *
The internal inverse-kinematics system maintains a record of which joints are "locked". Sometimes it is useful to * forget this history to prevent contorted joints, e.g., after finishing with an override animation.
* @function MyAvatar.clearIKJointLimitHistory */ @@ -657,7 +658,7 @@ public: /*@jsdoc * Gets the position in world coordinates of the point directly between your avatar's eyes assuming your avatar was in its - * default pose. This is a reference position; it does not change as your avatar's head moves relative to the avatar + * default pose. This is a reference position; it does not change as your avatar's head moves relative to the avatar * position. * @function MyAvatar.getDefaultEyePosition * @returns {Vec3} Default position between your avatar's eyes in world coordinates. @@ -672,17 +673,17 @@ public: /*@jsdoc * Overrides the default avatar animations. *The avatar animation system includes a set of default animations along with rules for how those animations are blended
- * together with procedural data (such as look at vectors, hand sensors etc.). overrideAnimation() is used to
- * completely override all motion from the default animation system (including inverse kinematics for hand and head
- * controllers) and play a set of specified animations. To end these animations and restore the default animations, use
+ * together with procedural data (such as look at vectors, hand sensors etc.). overrideAnimation() is used to
+ * completely override all motion from the default animation system (including inverse kinematics for hand and head
+ * controllers) and play a set of specified animations. To end these animations and restore the default animations, use
* {@link MyAvatar.restoreAnimation}.
Note: When using pre-built animation data, it's critical that the joint orientation of the source animation and target - * rig are equivalent, since the animation data applies absolute values onto the joints. If the orientations are different, - * the avatar will move in unpredictable ways. For more information about avatar joint orientation standards, see - * Avatar Standards.
+ *Note: When using pre-built animation data, it's critical that the joint orientation of the source animation and target + * rig are equivalent, since the animation data applies absolute values onto the joints. If the orientations are different, + * the avatar will move in unpredictable ways. For more information about avatar joint orientation standards, see + * Avatar Standards.
* @function MyAvatar.overrideAnimation - * @param {string} url - The URL to the animation file. Animation files may be in glTF or FBX format, but only need to - * contain the avatar skeleton and animation data. glTF models may be in JSON or binary format (".gltf" or ".glb" URLs + * @param {string} url - The URL to the animation file. Animation files may be in glTF or FBX format, but only need to + * contain the avatar skeleton and animation data. glTF models may be in JSON or binary format (".gltf" or ".glb" URLs * respectively). *Warning: glTF animations currently do not always animate correctly.
* @param {number} fps - The frames per second (FPS) rate for the animation playback. 30 FPS is normal speed. @@ -704,8 +705,8 @@ public: * Use {@link MyAvatar.restoreHandAnimation} to restore the default poses. * @function MyAvatar.overrideHandAnimation * @param isLeft {boolean}true to override the left hand, false to override the right hand.
- * @param {string} url - The URL of the animation file. Animation files need to be in glTF or FBX format, but only need to
- * contain the avatar skeleton and animation data. glTF models may be in JSON or binary format (".gltf" or ".glb" URLs
+ * @param {string} url - The URL of the animation file. Animation files need to be in glTF or FBX format, but only need to
+ * contain the avatar skeleton and animation data. glTF models may be in JSON or binary format (".gltf" or ".glb" URLs
* respectively).
* Warning: glTF animations currently do not always animate correctly.
* @param {number} fps - The frames per second (FPS) rate for the animation playback. 30 FPS is normal speed. @@ -723,10 +724,10 @@ public: /*@jsdoc * Restores the default animations. - *The avatar animation system includes a set of default animations along with rules for how those animations are blended
- * together with procedural data (such as look at vectors, hand sensors etc.). Playing your own custom animations will
- * override the default animations. restoreAnimation() is used to restore all motion from the default
- * animation system including inverse kinematics for hand and head controllers. If you aren't currently playing an override
+ *
The avatar animation system includes a set of default animations along with rules for how those animations are blended
+ * together with procedural data (such as look at vectors, hand sensors etc.). Playing your own custom animations will
+ * override the default animations. restoreAnimation() is used to restore all motion from the default
+ * animation system including inverse kinematics for hand and head controllers. If you aren't currently playing an override
* animation, this function has no effect.
Each avatar has an avatar-animation.json file that defines which animations are used and how they are blended together
- * with procedural data (such as look at vectors, hand sensors etc.). Each animation specified in the avatar-animation.json
- * file is known as an animation role. Animation roles map to easily understandable actions that the avatar can perform,
- * such as "idleStand", "idleTalk", or "walkFwd". getAnimationRoles()
+ *
Each avatar has an avatar-animation.json file that defines which animations are used and how they are blended together
+ * with procedural data (such as look at vectors, hand sensors etc.). Each animation specified in the avatar-animation.json
+ * file is known as an animation role. Animation roles map to easily understandable actions that the avatar can perform,
+ * such as "idleStand", "idleTalk", or "walkFwd". getAnimationRoles()
* is used get the list of animation roles defined in the avatar-animation.json.
Each avatar has an avatar-animation.json file that defines a set of animation roles. Animation roles map to easily
- * understandable actions that the avatar can perform, such as "idleStand", "idleTalk", or
+ *
Each avatar has an avatar-animation.json file that defines a set of animation roles. Animation roles map to easily
+ * understandable actions that the avatar can perform, such as "idleStand", "idleTalk", or
* "walkFwd". To get the full list of roles, use {@ link MyAvatar.getAnimationRoles}.
- * For each role, the avatar-animation.json defines when the animation is used, the animation clip (glTF or FBX) used, and
+ * For each role, the avatar-animation.json defines when the animation is used, the animation clip (glTF or FBX) used, and
* how animations are blended together with procedural data (such as look at vectors, hand sensors etc.).
- * overrideRoleAnimation() is used to change the animation clip (glTF or FBX) associated with a specified
+ * overrideRoleAnimation() is used to change the animation clip (glTF or FBX) associated with a specified
* animation role. To end the role animation and restore the default, use {@link MyAvatar.restoreRoleAnimation}.
Note: Hand roles only affect the hand. Other "main" roles, like "idleStand", "idleTalk", and "takeoffStand", are full + *
Note: Hand roles only affect the hand. Other "main" roles, like "idleStand", "idleTalk", and "takeoffStand", are full * body.
*Note: When using pre-built animation data, it's critical that the joint orientation of the source animation and target * rig are equivalent, since the animation data applies absolute values onto the joints. If the orientations are different, - * the avatar will move in unpredictable ways. For more information about avatar joint orientation standards, see - * Avatar Standards. + * the avatar will move in unpredictable ways. For more information about avatar joint orientation standards, see + * Avatar Standards. * @function MyAvatar.overrideRoleAnimation * @param {string} role - The animation role to override - * @param {string} url - The URL to the animation file. Animation files need to be in glTF or FBX format, but only need to - * contain the avatar skeleton and animation data. glTF models may be in JSON or binary format (".gltf" or ".glb" URLs + * @param {string} url - The URL to the animation file. Animation files need to be in glTF or FBX format, but only need to + * contain the avatar skeleton and animation data. glTF models may be in JSON or binary format (".gltf" or ".glb" URLs * respectively). *
Warning: glTF animations currently do not always animate correctly.
* @param {number} fps - The frames per second (FPS) rate for the animation playback. 30 FPS is normal speed. @@ -815,13 +816,13 @@ public: /*@jsdoc * Restores a default role animation. - *Each avatar has an avatar-animation.json file that defines a set of animation roles. Animation roles map to easily
- * understandable actions that the avatar can perform, such as "idleStand", "idleTalk", or
+ *
Each avatar has an avatar-animation.json file that defines a set of animation roles. Animation roles map to easily
+ * understandable actions that the avatar can perform, such as "idleStand", "idleTalk", or
* "walkFwd". To get the full list of roles, use {@link MyAvatar.getAnimationRoles}. For each role,
- * the avatar-animation.json defines when the animation is used, the animation clip (glTF or FBX) used, and how animations
- * are blended together with procedural data (such as look-at vectors, hand sensors etc.). You can change the animation
+ * the avatar-animation.json defines when the animation is used, the animation clip (glTF or FBX) used, and how animations
+ * are blended together with procedural data (such as look-at vectors, hand sensors etc.). You can change the animation
* clip (glTF or FBX) associated with a specified animation role using {@link MyAvatar.overrideRoleAnimation}.
- * restoreRoleAnimation() is used to restore a specified animation role's default animation clip. If you have
+ * restoreRoleAnimation() is used to restore a specified animation role's default animation clip. If you have
* not specified an override animation for the specified role, this function has no effect.
* @function MyAvatar.restoreRoleAnimation
* @param role {string} The animation role clip to restore.
@@ -838,31 +839,31 @@ public:
// a handler must not remove properties from animStateDictionaryIn, nor change property values that it does not intend to change.
// It is not specified in what order multiple handlers are called.
/*@jsdoc
- * Adds an animation state handler function that is invoked just before each animation graph update. More than one
- * animation state handler function may be added by calling addAnimationStateHandler multiple times. It is not
+ * Adds an animation state handler function that is invoked just before each animation graph update. More than one
+ * animation state handler function may be added by calling addAnimationStateHandler multiple times. It is not
* specified in what order multiple handlers are called.
*
The animation state handler function is called with an {@link MyAvatar.AnimStateDictionary|AnimStateDictionary}
- * "animStateDictionaryIn" parameter and is expected to return an
- * {@link MyAvatar.AnimStateDictionary|AnimStateDictionary} "animStateDictionaryOut" object. The
- * animStateDictionaryOut object can be the same object as animStateDictionaryIn, or it can be a
- * different object. The animStateDictionaryIn may be shared among multiple handlers and thus may contain
+ * "animStateDictionaryIn" parameter and is expected to return an
+ * {@link MyAvatar.AnimStateDictionary|AnimStateDictionary} "animStateDictionaryOut" object. The
+ * animStateDictionaryOut object can be the same object as animStateDictionaryIn, or it can be a
+ * different object. The animStateDictionaryIn may be shared among multiple handlers and thus may contain
* additional properties specified when adding the different handlers.
A handler may change a value from animStateDictionaryIn or add different values in the
- * animStateDictionaryOut returned. Any property values set in animStateDictionaryOut will
+ *
A handler may change a value from animStateDictionaryIn or add different values in the
+ * animStateDictionaryOut returned. Any property values set in animStateDictionaryOut will
* override those of the internal animation machinery.
null
+ * @param {Arraynull
* then all properties are included in the call parameter.
* @returns {number} The ID of the animation state handler function if successfully added, undefined if not.
* @example true if you do snap turns in HMD mode; false if you do smooth turns in HMD
+ * @returns {boolean} true if you do snap turns in HMD mode; false if you do smooth turns in HMD
* mode.
*/
Q_INVOKABLE bool getSnapTurn() const { return _useSnapTurn; }
@@ -906,11 +907,11 @@ public:
* @param {MyAvatar.LocomotionControlsMode} controlScheme - The control scheme to use.
*/
Q_INVOKABLE void setControlScheme(int index) { _controlSchemeIndex = (index >= 0 && index <= 2) ? index : 0; }
-
+
/*@jsdoc
* Gets whether your avatar hovers when its feet are not on the ground.
* @function MyAvatar.hoverWhenUnsupported
- * @returns {boolean} true if your avatar hovers when its feet are not on the ground, false if it
+ * @returns {boolean} true if your avatar hovers when its feet are not on the ground, false if it
* falls.
*/
// FIXME: Should be named, getHoverWhenUnsupported().
@@ -919,7 +920,7 @@ public:
/*@jsdoc
* Sets whether your avatar hovers when its feet are not on the ground.
* @function MyAvatar.setHoverWhenUnsupported
- * @param {boolean} hover - true if your avatar hovers when its feet are not on the ground, false
+ * @param {boolean} hover - true if your avatar hovers when its feet are not on the ground, false
* if it falls.
*/
Q_INVOKABLE void setHoverWhenUnsupported(bool on) { _hoverWhenUnsupported = on; }
@@ -927,7 +928,7 @@ public:
/*@jsdoc
* Sets the avatar's dominant hand.
* @function MyAvatar.setDominantHand
- * @param {string} hand - The dominant hand: "left" for the left hand or "right" for the right
+ * @param {string} hand - The dominant hand: "left" for the left hand or "right" for the right
* hand. Any other value has no effect.
*/
Q_INVOKABLE void setDominantHand(const QString& hand);
@@ -956,7 +957,7 @@ public:
/*@jsdoc
* Sets the HMD alignment relative to your avatar.
* @function MyAvatar.setHmdAvatarAlignmentType
- * @param {string} type - "head" to align your head and your avatar's head, "eyes" to align your
+ * @param {string} type - "head" to align your head and your avatar's head, "eyes" to align your
* eyes and your avatar's eyes.
*/
Q_INVOKABLE void setHmdAvatarAlignmentType(const QString& type);
@@ -964,7 +965,7 @@ public:
/*@jsdoc
* Gets the HMD alignment relative to your avatar.
* @function MyAvatar.getHmdAvatarAlignmentType
- * @returns {string} "head" if aligning your head and your avatar's head, "eyes" if aligning your
+ * @returns {string} "head" if aligning your head and your avatar's head, "eyes" if aligning your
* eyes and your avatar's eyes.
*/
Q_INVOKABLE QString getHmdAvatarAlignmentType() const;
@@ -972,7 +973,7 @@ public:
/*@jsdoc
* Sets whether the avatar's hips are balanced over the feet or positioned under the head.
* @function MyAvatar.setCenterOfGravityModelEnabled
- * @param {boolean} enabled - true to balance the hips over the feet, false to position the hips
+ * @param {boolean} enabled - true to balance the hips over the feet, false to position the hips
* under the head.
*/
Q_INVOKABLE void setCenterOfGravityModelEnabled(bool value) { _centerOfGravityModelEnabled = value; }
@@ -980,17 +981,17 @@ public:
/*@jsdoc
* Gets whether the avatar hips are being balanced over the feet or placed under the head.
* @function MyAvatar.getCenterOfGravityModelEnabled
- * @returns {boolean} true if the hips are being balanced over the feet, false if the hips are
+ * @returns {boolean} true if the hips are being balanced over the feet, false if the hips are
* being positioned under the head.
*/
Q_INVOKABLE bool getCenterOfGravityModelEnabled() const { return _centerOfGravityModelEnabled; }
/*@jsdoc
- * Sets whether the avatar's position updates to recenter the avatar under the head. In room-scale VR, recentering
- * causes your avatar to follow your HMD as you walk around the room. Disabling recentering is useful if you want to pin
+ * Sets whether the avatar's position updates to recenter the avatar under the head. In room-scale VR, recentering
+ * causes your avatar to follow your HMD as you walk around the room. Disabling recentering is useful if you want to pin
* the avatar to a fixed position.
* @function MyAvatar.setHMDLeanRecenterEnabled
- * @param {boolean} enabled - true to recenter the avatar under the head as it moves, false to
+ * @param {boolean} enabled - true to recenter the avatar under the head as it moves, false to
* disable recentering.
*/
Q_INVOKABLE void setHMDLeanRecenterEnabled(bool value) { _hmdLeanRecenterEnabled = value; }
@@ -1004,9 +1005,9 @@ public:
Q_INVOKABLE bool getHMDLeanRecenterEnabled() const { return _hmdLeanRecenterEnabled; }
/*@jsdoc
- * Requests that the hand touch effect is disabled for your avatar. Any resulting change in the status of the hand touch
+ * Requests that the hand touch effect is disabled for your avatar. Any resulting change in the status of the hand touch
* effect will be signaled by {@link MyAvatar.shouldDisableHandTouchChanged}.
- * The hand touch effect makes the avatar's fingers adapt to the shape of any object grabbed, creating the effect that + *
The hand touch effect makes the avatar's fingers adapt to the shape of any object grabbed, creating the effect that * it is really touching that object.
* @function MyAvatar.requestEnableHandTouch */ @@ -1081,7 +1082,7 @@ public: Q_INVOKABLE float getRawDriveKey(DriveKeys key) const; void relayDriveKeysToCharacterController(); - + /*@jsdoc * Disables the action associated with a drive key. * @function MyAvatar.disableDriveKey @@ -1097,7 +1098,7 @@ public: Q_INVOKABLE void disableDriveKey(DriveKeys key); /*@jsdoc - * Enables the action associated with a drive key. The action may have been disabled with + * Enables the action associated with a drive key. The action may have been disabled with * {@link MyAvatar.disableDriveKey|disableDriveKey}. * @function MyAvatar.enableDriveKey * @param {DriveKey} key - The drive key to enable. @@ -1114,14 +1115,14 @@ public: /*@jsdoc - * Recenter the avatar in the vertical direction, if{@link MyAvatar|MyAvatar.hmdLeanRecenterEnabled} is
+ * Recenter the avatar in the vertical direction, if {@link MyAvatar|MyAvatar.hmdLeanRecenterEnabled} is
* false.
* @function MyAvatar.triggerVerticalRecenter
*/
Q_INVOKABLE void triggerVerticalRecenter();
/*@jsdoc
- * Recenter the avatar in the horizontal direction, if {@link MyAvatar|MyAvatar.hmdLeanRecenterEnabled} is
+ * Recenter the avatar in the horizontal direction, if {@link MyAvatar|MyAvatar.hmdLeanRecenterEnabled} is
* false.
* @function MyAvatar.triggerHorizontalRecenter
*/
@@ -1136,7 +1137,7 @@ public:
/*@jsdoc
* Gets whether the avatar is configured to keep its center of gravity under its head.
* @function MyAvatar.isRecenteringHorizontally
- * @returns {boolean} true if the avatar is keeping its center of gravity under its head position,
+ * @returns {boolean} true if the avatar is keeping its center of gravity under its head position,
* false if not.
*/
Q_INVOKABLE bool isRecenteringHorizontally() const;
@@ -1176,7 +1177,7 @@ public:
Q_INVOKABLE float getHeadFinalPitch() const { return getHead()->getFinalPitch(); }
/*@jsdoc
- * If a face tracker is connected and being used, gets the estimated pitch of the user's head scaled. This is scale such
+ * If a face tracker is connected and being used, gets the estimated pitch of the user's head scaled. This is scale such
* that the avatar looks at the edge of the view frustum when the user looks at the edge of their screen.
* @function MyAvatar.getHeadDeltaPitch
* @returns {number} The pitch that the avatar's head should be if a face tracker is connected and being used, otherwise
@@ -1201,7 +1202,7 @@ public:
* @example null if no avatar is being looked at.
*/
- // FIXME: The return type doesn't have a conversion to a script value so the function always returns undefined in
+ // FIXME: The return type doesn't have a conversion to a script value so the function always returns undefined in
// JavaScript. Note: When fixed, JSDoc is needed for the return type.
Q_INVOKABLE ScriptAvatarData* getTargetAvatar() const;
/*@jsdoc
- * Gets the position of the avatar's left hand, relative to the avatar, as positioned by a hand controller (e.g., Oculus
+ * Gets the position of the avatar's left hand, relative to the avatar, as positioned by a hand controller (e.g., Oculus
* Touch or Vive).
- * Note: The Leap Motion isn't part of the hand controller input system. (Instead, it manipulates the avatar's joints + *
Note: The Leap Motion isn't part of the hand controller input system. (Instead, it manipulates the avatar's joints * for hand animation.)
* @function MyAvatar.getLeftHandPosition - * @returns {Vec3} The position of the left hand in avatar coordinates if positioned by a hand controller, otherwise + * @returns {Vec3} The position of the left hand in avatar coordinates if positioned by a hand controller, otherwise *{@link Vec3(0)|Vec3.ZERO}.
* @example Note: The Leap Motion isn't part of the hand controller input system. (Instead, it manipulates the avatar's joints + *
Note: The Leap Motion isn't part of the hand controller input system. (Instead, it manipulates the avatar's joints * for hand animation.)
* @function MyAvatar.getRightHandPosition - * @returns {Vec3} The position of the right hand in avatar coordinates if positioned by a hand controller, otherwise + * @returns {Vec3} The position of the right hand in avatar coordinates if positioned by a hand controller, otherwise *{@link Vec3(0)|Vec3.ZERO}.
* @example {@link Vec3(0)|Vec3.ZERO} is returned.
*/
Q_INVOKABLE glm::vec3 getLeftHandTipPosition() const;
@@ -1254,17 +1255,17 @@ public:
* Gets the position 0.3m in front of the right hand's position in the direction along the palm, in avatar coordinates, as
* positioned by a hand controller.
* @function MyAvatar.getRightHandTipPosition
- * @returns {Vec3} The position 0.3m in front of the right hand's position in the direction along the palm, in avatar
+ * @returns {Vec3} The position 0.3m in front of the right hand's position in the direction along the palm, in avatar
* coordinates. If the hand isn't being positioned by a controller, {@link Vec3(0)|Vec3.ZERO} is returned.
*/
Q_INVOKABLE glm::vec3 getRightHandTipPosition() const;
/*@jsdoc
- * Gets the pose (position, rotation, velocity, and angular velocity) of the avatar's left hand as positioned by a
+ * Gets the pose (position, rotation, velocity, and angular velocity) of the avatar's left hand as positioned by a
* hand controller (e.g., Oculus Touch or Vive).
- * Note: The Leap Motion isn't part of the hand controller input system. (Instead, it manipulates the avatar's joints
- * for hand animation.) If you are using the Leap Motion, the return value's valid property will be
+ *
Note: The Leap Motion isn't part of the hand controller input system. (Instead, it manipulates the avatar's joints
+ * for hand animation.) If you are using the Leap Motion, the return value's valid property will be
* false and any pose values returned will not be meaningful.
Note: The Leap Motion isn't part of the hand controller input system. (Instead, it manipulates the avatar's joints
- * for hand animation.) If you are using the Leap Motion, the return value's valid property will be
+ *
Note: The Leap Motion isn't part of the hand controller input system. (Instead, it manipulates the avatar's joints
+ * for hand animation.) If you are using the Leap Motion, the return value's valid property will be
* false and any pose values returned will not be meaningful.
Note: Leap Motion isn't part of the hand controller input system. (Instead, it manipulates the avatar's joints
* for hand animation.) If you are using Leap Motion, the return value's valid property will be
* false and any pose values returned will not be meaningful.
true if your avatar is taking off, flying, or falling, otherwise false
+ * @returns {boolean} true if your avatar is taking off, flying, or falling, otherwise false
* because your avatar is on the ground.
*/
Q_INVOKABLE bool isInAir();
/*@jsdoc
- * Sets your preference for flying in your current desktop or HMD display mode. Note that your ability to fly also depends
+ * Sets your preference for flying in your current desktop or HMD display mode. Note that your ability to fly also depends
* on whether the domain you're in allows you to fly.
* @function MyAvatar.setFlyingEnabled
- * @param {boolean} enabled - Set true if you want to enable flying in your current desktop or HMD display
+ * @param {boolean} enabled - Set true if you want to enable flying in your current desktop or HMD display
* mode, otherwise set false.
*/
Q_INVOKABLE void setFlyingEnabled(bool enabled);
/*@jsdoc
- * Gets your preference for flying in your current desktop or HMD display mode. Note that your ability to fly also depends
+ * Gets your preference for flying in your current desktop or HMD display mode. Note that your ability to fly also depends
* on whether the domain you're in allows you to fly.
* @function MyAvatar.getFlyingEnabled
- * @returns {boolean} true if your preference is to enable flying in your current desktop or HMD display mode,
+ * @returns {boolean} true if your preference is to enable flying in your current desktop or HMD display mode,
* otherwise false.
*/
Q_INVOKABLE bool getFlyingEnabled();
/*@jsdoc
- * Sets your preference for flying in desktop display mode. Note that your ability to fly also depends on whether the domain
+ * Sets your preference for flying in desktop display mode. Note that your ability to fly also depends on whether the domain
* you're in allows you to fly.
* @function MyAvatar.setFlyingDesktopPref
- * @param {boolean} enabled - Set true if you want to enable flying in desktop display mode, otherwise set
+ * @param {boolean} enabled - Set true if you want to enable flying in desktop display mode, otherwise set
* false.
*/
Q_INVOKABLE void setFlyingDesktopPref(bool enabled);
@@ -1502,7 +1503,7 @@ public:
* Gets your preference for flying in desktop display mode. Note that your ability to fly also depends on whether the domain
* you're in allows you to fly.
* @function MyAvatar.getFlyingDesktopPref
- * @returns {boolean} true if your preference is to enable flying in desktop display mode, otherwise
+ * @returns {boolean} true if your preference is to enable flying in desktop display mode, otherwise
* false.
*/
Q_INVOKABLE bool getFlyingDesktopPref();
@@ -1624,8 +1625,8 @@ public:
Q_INVOKABLE float getAvatarScale() const;
/*@jsdoc
- * Sets the target scale of the avatar. The target scale is the desired scale of the avatar without any restrictions on
- * permissible scale values imposed by the domain.
+ * Sets the target scale of the avatar. The target scale is the desired scale of the avatar without any restrictions on
+ * permissible scale values imposed by the domain.
* @function MyAvatar.setAvatarScale
* @param {number} scale - The target scale for the avatar, range 0.005 – 1000.0.
*/
@@ -1633,11 +1634,11 @@ public:
/*@jsdoc
* Sets whether the avatar should collide with entities.
- * Note: A false value won't disable collisions if the avatar is in a zone that disallows
- * collisionless avatars. However, the false value will be set so that collisions are disabled as soon as the
+ *
Note: A false value won't disable collisions if the avatar is in a zone that disallows
+ * collisionless avatars. However, the false value will be set so that collisions are disabled as soon as the
* avatar moves to a position where collisionless avatars are allowed.
* @function MyAvatar.setCollisionsEnabled
- * @param {boolean} enabled - true to enable the avatar to collide with entities, false to
+ * @param {boolean} enabled - true to enable the avatar to collide with entities, false to
* disable.
*/
Q_INVOKABLE void setCollisionsEnabled(bool enabled);
@@ -1653,7 +1654,7 @@ public:
/*@jsdoc
* Sets whether the avatar should collide with other avatars.
* @function MyAvatar.setOtherAvatarsCollisionsEnabled
- * @param {boolean} enabled - true to enable the avatar to collide with other avatars, false
+ * @param {boolean} enabled - true to enable the avatar to collide with other avatars, false
* to disable.
*/
Q_INVOKABLE void setOtherAvatarsCollisionsEnabled(bool enabled);
@@ -1667,7 +1668,7 @@ public:
/*@jsdoc
* Gets the avatar's collision capsule: a cylinder with hemispherical ends that approximates the extents or the avatar.
- *
Warning: The values returned are in world coordinates but aren't necessarily up to date with the + *
Warning: The values returned are in world coordinates but aren't necessarily up to date with the * avatar's current position.
* @function MyAvatar.getCollisionCapsule * @returns {MyAvatar.CollisionCapsule} The avatar's collision capsule. @@ -1746,21 +1747,21 @@ public: glm::mat4 deriveBodyUsingCgModel(); /*@jsdoc - * Tests whether a vector is pointing in the general direction of the avatar's "up" direction (i.e., dot product of vectors + * Tests whether a vector is pointing in the general direction of the avatar's "up" direction (i.e., dot product of vectors * is> 0).
* @function MyAvatar.isUp
* @param {Vec3} direction - The vector to test.
- * @returns {boolean} true if the direction vector is pointing generally in the direction of the avatar's "up"
+ * @returns {boolean} true if the direction vector is pointing generally in the direction of the avatar's "up"
* direction.
*/
Q_INVOKABLE bool isUp(const glm::vec3& direction) { return glm::dot(direction, _worldUpDirection) > 0.0f; }; // true iff direction points up wrt avatar's definition of up.
/*@jsdoc
- * Tests whether a vector is pointing in the general direction of the avatar's "down" direction (i.e., dot product of
+ * Tests whether a vector is pointing in the general direction of the avatar's "down" direction (i.e., dot product of
* vectors is < 0).
* @function MyAvatar.isDown
* @param {Vec3} direction - The vector to test.
- * @returns {boolean} true if the direction vector is pointing generally in the direction of the avatar's
+ * @returns {boolean} true if the direction vector is pointing generally in the direction of the avatar's
* "down" direction.
*/
Q_INVOKABLE bool isDown(const glm::vec3& direction) { return glm::dot(direction, _worldUpDirection) < 0.0f; };
@@ -1844,7 +1845,7 @@ public:
/*@jsdoc
* Forces the avatar's eyes to look at a specified location. Once this method is called, API calls
- * full control of the eyes for a limited time. If this method is not called for 2 seconds,
+ * full control of the eyes for a limited time. If this method is not called for 2 seconds,
* the engine regains control of the eyes.
* @function MyAvatar.setEyesLookAt
* @param {Vec3} lookAtTarget - The target point in world coordinates.
@@ -1865,7 +1866,7 @@ public:
Q_INVOKABLE void releaseEyesLookAtControl();
/*@jsdoc
- * Sets the point-at target for the "point" reaction that may be started with {@link MyAvatar.beginReaction}.
+ * Sets the point-at target for the "point" reaction that may be started with {@link MyAvatar.beginReaction}.
* The point-at target is set only if it is in front of the avatar.
* Note: The "point" reaction should be started before calling this method.
true if flow simulation is enabled on the joint, false if it isn't.
- * @param {boolean} isCollidable - true to enable collisions in the flow simulation, false to
+ * @param {boolean} isCollidable - true to enable collisions in the flow simulation, false to
* disable.
- * @param {Object-5 m/s2.
* @function MyAvatar.getGravity
* @returns {number} The amount of gravity currently applied to the avatar, in m/s2.
@@ -2086,7 +2087,7 @@ public slots:
float getGravity();
/*@jsdoc
- * Moves the avatar to a new position and/or orientation in the domain, with safe landing, while taking into account avatar
+ * Moves the avatar to a new position and/or orientation in the domain, with safe landing, while taking into account avatar
* leg length.
* @function MyAvatar.goToFeetLocation
* @param {Vec3} position - The new position for the avatar, in world coordinates.
@@ -2095,7 +2096,7 @@ public slots:
* @param {boolean} [shouldFaceLocation=false] - Set to true to position the avatar a short distance away from
* the new position and orientate the avatar to face the position.
*/
- void goToFeetLocation(const glm::vec3& newPosition, bool hasOrientation = false,
+ void goToFeetLocation(const glm::vec3& newPosition, bool hasOrientation = false,
const glm::quat& newOrientation = glm::quat(), bool shouldFaceLocation = false);
/*@jsdoc
@@ -2104,7 +2105,7 @@ public slots:
* @param {Vec3} position - The new position for the avatar, in world coordinates.
* @param {boolean} [hasOrientation=false] - Set to true to set the orientation of the avatar.
* @param {Quat} [orientation=Quat.IDENTITY] - The new orientation for the avatar.
- * @param {boolean} [shouldFaceLocation=false] - Set to true to position the avatar a short distance away from
+ * @param {boolean} [shouldFaceLocation=false] - Set to true to position the avatar a short distance away from
* the new position and orientate the avatar to face the position.
* @param {boolean} [withSafeLanding=true] - Set to false to disable safe landing when teleporting.
*/
@@ -2152,7 +2153,7 @@ public slots:
* Adds a thrust to your avatar's current thrust to be applied for a short while.
* @function MyAvatar.addThrust
* @param {Vec3} thrust - The thrust direction and magnitude.
- * @deprecated This function is deprecated and will be removed. Use {@link MyAvatar|MyAvatar.motorVelocity} and related
+ * @deprecated This function is deprecated and will be removed. Use {@link MyAvatar|MyAvatar.motorVelocity} and related
* properties instead.
*/
// Set/Get update the thrust that will move the avatar around
@@ -2162,7 +2163,7 @@ public slots:
* Gets the thrust currently being applied to your avatar.
* @function MyAvatar.getThrust
* @returns {Vec3} The thrust currently being applied to your avatar.
- * @deprecated This function is deprecated and will be removed. Use {@link MyAvatar|MyAvatar.motorVelocity} and related
+ * @deprecated This function is deprecated and will be removed. Use {@link MyAvatar|MyAvatar.motorVelocity} and related
* properties instead.
*/
glm::vec3 getThrust() { return _thrust; };
@@ -2171,14 +2172,14 @@ public slots:
* Sets the thrust to be applied to your avatar for a short while.
* @function MyAvatar.setThrust
* @param {Vec3} thrust - The thrust direction and magnitude.
- * @deprecated This function is deprecated and will be removed. Use {@link MyAvatar|MyAvatar.motorVelocity} and related
+ * @deprecated This function is deprecated and will be removed. Use {@link MyAvatar|MyAvatar.motorVelocity} and related
* properties instead.
*/
void setThrust(glm::vec3 newThrust) { _thrust = newThrust; }
/*@jsdoc
- * Updates avatar motion behavior from the Developer > Avatar > Enable Default Motor Control and Enable Scripted
+ * Updates avatar motion behavior from the Developer > Avatar > Enable Default Motor Control and Enable Scripted
* Motor Control menu items.
* @function MyAvatar.updateMotionBehaviorFromMenu
*/
@@ -2192,8 +2193,8 @@ public slots:
void setToggleHips(bool followHead);
/*@jsdoc
- * Displays the base of support area debug graphics if in HMD mode. If your head goes outside this area your avatar's hips
- * are moved to counterbalance your avatar, and if your head moves too far then your avatar's position is moved (i.e., a
+ * Displays the base of support area debug graphics if in HMD mode. If your head goes outside this area your avatar's hips
+ * are moved to counterbalance your avatar, and if your head moves too far then your avatar's position is moved (i.e., a
* step happens).
* @function MyAvatar.setEnableDebugDrawBaseOfSupport
* @param {boolean} enabled - true to show the debug graphics, false to hide.
@@ -2208,7 +2209,7 @@ public slots:
void setEnableDebugDrawDefaultPose(bool isEnabled);
/*@jsdoc
- * Displays animation debug graphics. By default, the animation poses used for rendering are displayed. However,
+ * Displays animation debug graphics. By default, the animation poses used for rendering are displayed. However,
* {@link MyAvatar.setDebugDrawAnimPoseName} can be used to set a specific animation node to display.
* @function MyAvatar.setEnableDebugDrawAnimPose
* @param {boolean} enabled - true to show the debug graphics, false to hide.
@@ -2216,10 +2217,10 @@ public slots:
void setEnableDebugDrawAnimPose(bool isEnabled);
/*@jsdoc
- * Sets the animation node to display when animation debug graphics are enabled with
+ * Sets the animation node to display when animation debug graphics are enabled with
* {@link MyAvatar.setEnableDebugDrawAnimPose}.
* @function MyAvatar.setDebugDrawAnimPoseName
- * @param {string} poseName - The name of the animation node to display debug graphics for. Use "" to reset to
+ * @param {string} poseName - The name of the animation node to display debug graphics for. Use "" to reset to
* default.
*/
void setDebugDrawAnimPoseName(QString poseName);
@@ -2314,17 +2315,17 @@ public slots:
/*@jsdoc
* Gets the URL of the override animation graph.
- * See {@link https://docs.vircadia.dev/create/avatars/custom-animations.html|Custom Avatar Animations} for + *
See {@link https://docs.vircadia.com/create/avatars/custom-animations.html|Custom Avatar Animations} for * information on animation graphs.
* @function MyAvatar.getAnimGraphOverrideUrl - * @returns {string} The URL of the override animation graph JSON file."" if there is no override animation
+ * @returns {string} The URL of the override animation graph JSON file. "" if there is no override animation
* graph.
*/
QUrl getAnimGraphOverrideUrl() const; // thread-safe
/*@jsdoc
* Sets the animation graph to use in preference to the default animation graph.
- * See {@link https://docs.vircadia.dev/create/avatars/custom-animations.html|Custom Avatar Animations} for + *
See {@link https://docs.vircadia.com/create/avatars/custom-animations.html|Custom Avatar Animations} for * information on animation graphs.
* @function MyAvatar.setAnimGraphOverrideUrl * @param {string} url - The URL of the animation graph JSON file to use. Set to"" to clear an override.
@@ -2333,7 +2334,7 @@ public slots:
/*@jsdoc
* Gets the URL of animation graph (i.e., the avatar animation JSON) that's currently being used for avatar animations.
- * See {@link https://docs.vircadia.dev/create/avatars/custom-animations.html|Custom Avatar Animations} for + *
See {@link https://docs.vircadia.com/create/avatars/custom-animations.html|Custom Avatar Animations} for * information on animation graphs.
* @function MyAvatar.getAnimGraphUrl * @returns {string} The URL of the current animation graph JSON file. @@ -2344,7 +2345,7 @@ public slots: /*@jsdoc * Sets the current animation graph (i.e., the avatar animation JSON) to use for avatar animations and makes it the default. - *See {@link https://docs.vircadia.dev/create/avatars/custom-animations.html|Custom Avatar Animations} for + *
See {@link https://docs.vircadia.com/create/avatars/custom-animations.html|Custom Avatar Animations} for * information on animation graphs.
* @function MyAvatar.setAnimGraphUrl * @param {string} url - The URL of the animation graph JSON file to use. @@ -2360,7 +2361,7 @@ public slots: glm::vec3 getPositionForAudio(); /*@jsdoc - * Gets the orientation of your listening position for spatialized audio. The orientation depends on the value of the + * Gets the orientation of your listening position for spatialized audio. The orientation depends on the value of the * {@link Myavatar|audioListenerMode} property. * @function MyAvatar.getOrientationForAudio * @returns {Quat} The orientation of your listening position. @@ -2386,7 +2387,7 @@ public slots: /*@jsdoc - * Gets the list of reactions names that can be enabled using {@link MyAvatar.beginReaction} and + * Gets the list of reactions names that can be enabled using {@link MyAvatar.beginReaction} and * {@link MyAvatar.endReaction}. *See also: {@link MyAvatar.getTriggerReactions}. * @function MyAvatar.getBeginEndReactions @@ -2407,7 +2408,7 @@ public slots: bool triggerReaction(QString reactionName); /*@jsdoc - * Starts playing a reaction on the avatar. The reaction will continue to play until stopped using + * Starts playing a reaction on the avatar. The reaction will continue to play until stopped using * {@link MyAvatar.endReaction} or superseded by another reaction. *
Only reactions returned by {@link MyAvatar.getBeginEndReactions} are available.
* @function MyAvatar.beginReaction @@ -2429,7 +2430,7 @@ signals: /*@jsdoc * Triggered when the {@link MyAvatar|audioListenerMode} property value changes. * @function MyAvatar.audioListenerModeChanged - * @returns {Signal} + * @returns {Signal} */ void audioListenerModeChanged(); @@ -2437,7 +2438,7 @@ signals: * Triggered when the walk speed set for the "AnalogPlus" control scheme changes. * @function MyAvatar.analogPlusWalkSpeedChanged * @param {number} speed - The new walk speed set for the "AnalogPlus" control scheme. - * @returns {Signal} + * @returns {Signal} */ void analogPlusWalkSpeedChanged(float value); @@ -2445,31 +2446,31 @@ signals: * Triggered when the sprint (run) speed set for the "AnalogPlus" control scheme changes. * @function MyAvatar.analogPlusSprintSpeedChanged * @param {number} speed - The new sprint speed set for the "AnalogPlus" control scheme. - * @returns {Signal} + * @returns {Signal} */ void analogPlusSprintSpeedChanged(float value); /*@jsdoc - * Triggered when the sprint (run) speed set for the current control scheme (see + * Triggered when the sprint (run) speed set for the current control scheme (see * {@link MyAvatar.getControlScheme|getControlScheme}) changes. * @function MyAvatar.sprintSpeedChanged * @param {number} speed -The new sprint speed set for the current control scheme. - * @returns {Signal} + * @returns {Signal} */ void sprintSpeedChanged(float value); /*@jsdoc - * Triggered when the walk backward speed set for the current control scheme (see + * Triggered when the walk backward speed set for the current control scheme (see * {@link MyAvatar.getControlScheme|getControlScheme}) changes. * @function MyAvatar.walkBackwardSpeedChanged * @param {number} speed - The new walk backward speed set for the current control scheme. - * @returns {Signal} + * @returns {Signal} */ void walkBackwardSpeedChanged(float value); /*@jsdoc * @function MyAvatar.transformChanged - * @returns {Signal} + * @returns {Signal} * @deprecated This signal is deprecated and will be removed. */ void transformChanged(); @@ -2478,7 +2479,7 @@ signals: * Triggered when the {@link MyAvatar|collisionSoundURL} property value changes. * @function MyAvatar.newCollisionSoundURL * @param {string} url - The URL of the new collision sound. - * @returns {Signal} + * @returns {Signal} */ void newCollisionSoundURL(const QUrl& url); @@ -2497,7 +2498,7 @@ signals: /*@jsdoc * Triggered when collisions with the environment are enabled or disabled. * @function MyAvatar.collisionsEnabledChanged - * @param {boolean} enabled -true if collisions with the environment are enabled, false if
+ * @param {boolean} enabled - true if collisions with the environment are enabled, false if
* they're not.
* @returns {Signal}
*/
@@ -2506,7 +2507,7 @@ signals:
/*@jsdoc
* Triggered when collisions with other avatars are enabled or disabled.
* @function MyAvatar.otherAvatarsCollisionsEnabledChanged
- * @param {boolean} enabled - true if collisions with other avatars are enabled, false if they're
+ * @param {boolean} enabled - true if collisions with other avatars are enabled, false if they're
* not.
* @returns {Signal}
*/
@@ -2526,7 +2527,7 @@ signals:
/*@jsdoc
* @function MyAvatar.energyChanged
* @param {number} energy - Avatar energy.
- * @returns {Signal}
+ * @returns {Signal}
* @deprecated This signal is deprecated and will be removed.
*/
void energyChanged(float newEnergy);
@@ -2534,7 +2535,7 @@ signals:
/*@jsdoc
* Triggered when the avatar has been moved to a new position by one of the MyAvatar "goTo" functions.
* @function MyAvatar.positionGoneTo
- * @returns {Signal}
+ * @returns {Signal}
*/
// FIXME: Better name would be goneToLocation().
void positionGoneTo();
@@ -2556,7 +2557,7 @@ signals:
/*@jsdoc
* Triggered when your avatar changes from being active to being away.
* @function MyAvatar.wentAway
- * @returns {Signal}
+ * @returns {Signal}
* @example Synonym of {@link MyAvatar.skeletonModelURLChanged|skeletonModelURLChanged}.
* @function MyAvatar.skeletonChanged - * @returns {Signal} + * @returns {Signal} */ void skeletonChanged(); @@ -2584,14 +2585,14 @@ signals: * Triggered when the avatar's dominant hand changes. * @function MyAvatar.dominantHandChanged * @param {string} hand - The dominant hand:"left" for the left hand, "right" for the right hand.
- * @returns {Signal}
+ * @returns {Signal}
*/
void dominantHandChanged(const QString& hand);
/*@jsdoc
* Triggered when the HMD alignment for your avatar changes.
* @function MyAvatar.hmdAvatarAlignmentTypeChanged
- * @param {string} type - "head" if aligning your head and your avatar's head, "eyes" if aligning
+ * @param {string} type - "head" if aligning your head and your avatar's head, "eyes" if aligning
* your eyes and your avatar's eyes.
* @returns {Signal}
*/
@@ -2600,27 +2601,27 @@ signals:
/*@jsdoc
* Triggered when the avatar's sensorToWorldScale property value changes.
* @function MyAvatar.sensorToWorldScaleChanged
- * @param {number} scale - The scale that transforms dimensions in the user's real world to the avatar's size in the virtual
+ * @param {number} scale - The scale that transforms dimensions in the user's real world to the avatar's size in the virtual
* world.
- * @returns {Signal}
+ * @returns {Signal}
*/
void sensorToWorldScaleChanged(float sensorToWorldScale);
/*@jsdoc
- * Triggered when the a model is attached to or detached from one of the avatar's joints using one of
- * {@link MyAvatar.attach|attach}, {@link MyAvatar.detachOne|detachOne}, {@link MyAvatar.detachAll|detachAll}, or
+ * Triggered when the a model is attached to or detached from one of the avatar's joints using one of
+ * {@link MyAvatar.attach|attach}, {@link MyAvatar.detachOne|detachOne}, {@link MyAvatar.detachAll|detachAll}, or
* {@link MyAvatar.setAttachmentData|setAttachmentData}.
* @function MyAvatar.attachmentsChanged
- * @returns {Signal}
+ * @returns {Signal}
* @deprecated This signal is deprecated and will be removed. Use avatar entities instead.
*/
void attachmentsChanged();
/*@jsdoc
- * Triggered when the avatar's size changes. This can be due to the user changing the size of their avatar or the domain
+ * Triggered when the avatar's size changes. This can be due to the user changing the size of their avatar or the domain
* limiting the size of their avatar.
* @function MyAvatar.scaleChanged
- * @returns {Signal}
+ * @returns {Signal}
*/
void scaleChanged();
@@ -2629,7 +2630,7 @@ signals:
* The hand touch effect makes the avatar's fingers adapt to the shape of any object grabbed, creating the effect that * it is really touching that object.
* @function MyAvatar.shouldDisableHandTouchChanged - * @param {boolean} disabled -true if the hand touch effect is disabled for the avatar,
+ * @param {boolean} disabled - true if the hand touch effect is disabled for the avatar,
* false if it isn't disabled.
* @returns {Signal}
*/
@@ -2703,7 +2704,7 @@ private:
virtual void detachOne(const QString& modelURL, const QString& jointName = QString()) override;
virtual void detachAll(const QString& modelURL, const QString& jointName = QString()) override;
-
+
// Attachments/Avatar Entity
void attachmentDataToEntityProperties(const AttachmentData& data, EntityItemProperties& properties);
AttachmentData entityPropertiesToAttachmentData(const EntityItemProperties& properties) const;
diff --git a/interface/src/main.cpp b/interface/src/main.cpp
index d190e3f3da..4e338a629b 100644
--- a/interface/src/main.cpp
+++ b/interface/src/main.cpp
@@ -265,7 +265,7 @@ int main(int argc, const char* argv[]) {
if (socket.waitForConnected(LOCAL_SERVER_TIMEOUT_MS)) {
if (parser.isSet(urlOption)) {
QUrl url = QUrl(parser.value(urlOption));
- if (url.isValid() && (url.scheme() == URL_SCHEME_HIFI || url.scheme() == URL_SCHEME_HIFIAPP
+ if (url.isValid() && (url.scheme() == URL_SCHEME_VIRCADIA || url.scheme() == URL_SCHEME_VIRCADIAAPP
|| url.scheme() == HIFI_URL_SCHEME_HTTP || url.scheme() == HIFI_URL_SCHEME_HTTPS
|| url.scheme() == HIFI_URL_SCHEME_FILE)) {
qDebug() << "Writing URL to local socket";
diff --git a/interface/src/scripting/WindowScriptingInterface.cpp b/interface/src/scripting/WindowScriptingInterface.cpp
index c8714e2a8f..e594ecd536 100644
--- a/interface/src/scripting/WindowScriptingInterface.cpp
+++ b/interface/src/scripting/WindowScriptingInterface.cpp
@@ -139,9 +139,9 @@ void WindowScriptingInterface::disconnectedFromDomain() {
void WindowScriptingInterface::openUrl(const QUrl& url) {
if (!url.isEmpty()) {
auto scheme = url.scheme();
- if (scheme == URL_SCHEME_HIFI) {
+ if (scheme == URL_SCHEME_VIRCADIA) {
DependencyManager::getFor information on the joint hierarchy used, see - * Avatar Standards.
+ * Avatar Standards. * @function MyAvatar.getDefaultJointRotation * @param {number} index - The joint index. * @returns {Quat} The default rotation of the joint if the joint index is valid, otherwise {@link Quat(0)|Quat.IDENTITY}. @@ -218,10 +219,10 @@ public: * Gets the default translation of a joint (in the current avatar) relative to its parent, in model coordinates. *Warning: These coordinates are not necessarily in meters.
*For information on the joint hierarchy used, see - * Avatar Standards.
+ * Avatar Standards. * @function MyAvatar.getDefaultJointTranslation * @param {number} index - The joint index. - * @returns {Vec3} The default translation of the joint (in model coordinates) if the joint index is valid, otherwise + * @returns {Vec3} The default translation of the joint (in model coordinates) if the joint index is valid, otherwise * {@link Vec3(0)|Vec3.ZERO}. */ Q_INVOKABLE virtual glm::vec3 getDefaultJointTranslation(int index) const; @@ -283,7 +284,7 @@ public: // world-space to avatar-space rigconversion functions /*@jsdoc - * Transforms a position in world coordinates to a position in a joint's coordinates, or avatar coordinates if no joint is + * Transforms a position in world coordinates to a position in a joint's coordinates, or avatar coordinates if no joint is * specified. * @function MyAvatar.worldToJointPoint * @param {Vec3} position - The position in world coordinates. @@ -293,7 +294,7 @@ public: Q_INVOKABLE glm::vec3 worldToJointPoint(const glm::vec3& position, const int jointIndex = -1) const; /*@jsdoc - * Transforms a direction in world coordinates to a direction in a joint's coordinates, or avatar coordinates if no joint + * Transforms a direction in world coordinates to a direction in a joint's coordinates, or avatar coordinates if no joint * is specified. * @function MyAvatar.worldToJointDirection * @param {Vec3} direction - The direction in world coordinates. @@ -303,7 +304,7 @@ public: Q_INVOKABLE glm::vec3 worldToJointDirection(const glm::vec3& direction, const int jointIndex = -1) const; /*@jsdoc - * Transforms a rotation in world coordinates to a rotation in a joint's coordinates, or avatar coordinates if no joint is + * Transforms a rotation in world coordinates to a rotation in a joint's coordinates, or avatar coordinates if no joint is * specified. * @function MyAvatar.worldToJointRotation * @param {Quat} rotation - The rotation in world coordinates. @@ -313,7 +314,7 @@ public: Q_INVOKABLE glm::quat worldToJointRotation(const glm::quat& rotation, const int jointIndex = -1) const; /*@jsdoc - * Transforms a position in a joint's coordinates, or avatar coordinates if no joint is specified, to a position in world + * Transforms a position in a joint's coordinates, or avatar coordinates if no joint is specified, to a position in world * coordinates. * @function MyAvatar.jointToWorldPoint * @param {Vec3} position - The position in joint coordinates, or avatar coordinates if no joint is specified. @@ -323,7 +324,7 @@ public: Q_INVOKABLE glm::vec3 jointToWorldPoint(const glm::vec3& position, const int jointIndex = -1) const; /*@jsdoc - * Transforms a direction in a joint's coordinates, or avatar coordinates if no joint is specified, to a direction in world + * Transforms a direction in a joint's coordinates, or avatar coordinates if no joint is specified, to a direction in world * coordinates. * @function MyAvatar.jointToWorldDirection * @param {Vec3} direction - The direction in joint coordinates, or avatar coordinates if no joint is specified. @@ -333,7 +334,7 @@ public: Q_INVOKABLE glm::vec3 jointToWorldDirection(const glm::vec3& direction, const int jointIndex = -1) const; /*@jsdoc - * Transforms a rotation in a joint's coordinates, or avatar coordinates if no joint is specified, to a rotation in world + * Transforms a rotation in a joint's coordinates, or avatar coordinates if no joint is specified, to a rotation in world * coordinates. * @function MyAvatar.jointToWorldRotation * @param {Quat} rotation - The rotation in joint coordinates, or avatar coordinates if no joint is specified. @@ -351,7 +352,7 @@ public: virtual int parseDataFromBuffer(const QByteArray& buffer) override; /*@jsdoc - * Sets the offset applied to the current avatar. The offset adjusts the position that the avatar is rendered. For example, + * Sets the offset applied to the current avatar. The offset adjusts the position that the avatar is rendered. For example, * with an offset of{ x: 0, y: 0.1, z: 0 }, your avatar will appear to be raised off the ground slightly.
* @function MyAvatar.setSkeletonOffset
* @param {Vec3} offset - The skeleton offset to set.
@@ -367,7 +368,7 @@ public:
Q_INVOKABLE void setSkeletonOffset(const glm::vec3& offset);
/*@jsdoc
- * Gets the offset applied to the current avatar. The offset adjusts the position that the avatar is rendered. For example,
+ * Gets the offset applied to the current avatar. The offset adjusts the position that the avatar is rendered. For example,
* with an offset of { x: 0, y: 0.1, z: 0 }, your avatar will appear to be raised off the ground slightly.
* @function MyAvatar.getSkeletonOffset
* @returns {Vec3} The current skeleton offset.
@@ -452,7 +453,7 @@ public:
/*@jsdoc
* Sets the ID of the entity or avatar that the avatar is parented to.
* @function MyAvatar.setParentID
- * @param {Uuid} parentID - The ID of the entity or avatar that the avatar should be parented to. Set to
+ * @param {Uuid} parentID - The ID of the entity or avatar that the avatar should be parented to. Set to
* {@link Uuid(0)|Uuid.NULL} to unparent.
*/
// This calls through to the SpatiallyNestable versions, but is here to expose these to JavaScript.
@@ -461,17 +462,17 @@ public:
/*@jsdoc
* Gets the joint of the entity or avatar that the avatar is parented to.
* @function MyAvatar.getParentJointIndex
- * @returns {number} The joint of the entity or avatar that the avatar is parented to. 65535 or
+ * @returns {number} The joint of the entity or avatar that the avatar is parented to. 65535 or
* -1 if parented to the entity or avatar's position and orientation rather than a joint.
*/
// This calls through to the SpatiallyNestable versions, but is here to expose these to JavaScript.
Q_INVOKABLE virtual quint16 getParentJointIndex() const override { return SpatiallyNestable::getParentJointIndex(); }
/*@jsdoc
- * Sets the joint of the entity or avatar that the avatar is parented to.
+ * Sets the joint of the entity or avatar that the avatar is parented to.
* @function MyAvatar.setParentJointIndex
* @param {number} parentJointIndex - The joint of the entity or avatar that the avatar should be parented to. Use
- * 65535 or -1 to parent to the entity or avatar's position and orientation rather than a
+ * 65535 or -1 to parent to the entity or avatar's position and orientation rather than a
* joint.
*/
// This calls through to the SpatiallyNestable versions, but is here to expose these to JavaScript.
@@ -557,7 +558,7 @@ public:
signals:
/*@jsdoc
- * Triggered when the avatar's target scale is changed. The target scale is the desired scale of the avatar without any
+ * Triggered when the avatar's target scale is changed. The target scale is the desired scale of the avatar without any
* restrictions on permissible scale values imposed by the domain.
* @function MyAvatar.targetScaleChanged
* @param {number} targetScale - The avatar's target scale.
@@ -758,7 +759,7 @@ protected:
static void metaBlendshapeOperator(render::ItemID renderItemID, int blendshapeNumber, const QVectorFor information on the joint hierarchy used, see - * Avatar Standards.
+ * Avatar Standards. * @function ScriptAvatar.getDefaultJointRotation * @param {number} index - The joint index. - * @returns {Quat} The default rotation of the joint if avatar data are available and the joint index is valid, otherwise + * @returns {Quat} The default rotation of the joint if avatar data are available and the joint index is valid, otherwise * {@link Quat(0)|Quat.IDENTITY}. */ glm::quat getDefaultJointRotation(int index) const; @@ -99,10 +100,10 @@ public slots: * Gets the default translation of a joint in the avatar relative to its parent, in model coordinates. *Warning: These coordinates are not necessarily in meters.
*For information on the joint hierarchy used, see - * Avatar Standards.
+ * Avatar Standards. * @function ScriptAvatar.getDefaultJointTranslation * @param {number} index - The joint index. - * @returns {Vec3} The default translation of the joint (in model coordinates) if avatar data are available and the joint + * @returns {Vec3} The default translation of the joint (in model coordinates) if avatar data are available and the joint * index is valid, otherwise {@link Vec3(0)|Vec3.ZERO}. */ glm::vec3 getDefaultJointTranslation(int index) const; @@ -120,7 +121,7 @@ public slots: * Gets the position of a joint in the avatar. * @function ScriptAvatar.getJointPosition * @param {number} index - The index of the joint. - * @returns {Vec3} The position of the joint in world coordinates, or {@link Vec3(0)|Vec3.ZERO} if avatar data aren't + * @returns {Vec3} The position of the joint in world coordinates, or {@link Vec3(0)|Vec3.ZERO} if avatar data aren't * available. */ glm::vec3 getJointPosition(int index) const; @@ -154,7 +155,7 @@ public slots: /*@jsdoc * Gets the ID of the entity or avatar that the avatar is parented to. * @function ScriptAvatar.getParentID - * @returns {Uuid} The ID of the entity or avatar that the avatar is parented to. {@link Uuid(0)|Uuid.NULL} if not parented + * @returns {Uuid} The ID of the entity or avatar that the avatar is parented to. {@link Uuid(0)|Uuid.NULL} if not parented * or avatar data aren't available. */ QUuid getParentID() const; @@ -163,7 +164,7 @@ public slots: * Gets the joint of the entity or avatar that the avatar is parented to. * @function ScriptAvatar.getParentJointIndex * @returns {number} The joint of the entity or avatar that the avatar is parented to.65535 or
- * -1 if parented to the entity or avatar's position and orientation rather than a joint, or avatar data
+ * -1 if parented to the entity or avatar's position and orientation rather than a joint, or avatar data
* aren't available.
*/
quint16 getParentJointIndex() const;
@@ -189,7 +190,7 @@ public slots:
/*@jsdoc
* Gets the position of the left palm in world coordinates.
* @function ScriptAvatar.getLeftPalmPosition
- * @returns {Vec3} The position of the left palm in world coordinates, or {@link Vec3(0)|Vec3.ZERO} if avatar data aren't
+ * @returns {Vec3} The position of the left palm in world coordinates, or {@link Vec3(0)|Vec3.ZERO} if avatar data aren't
* available.
*/
glm::vec3 getLeftPalmPosition() const;
@@ -197,7 +198,7 @@ public slots:
/*@jsdoc
* Gets the rotation of the left palm in world coordinates.
* @function ScriptAvatar.getLeftPalmRotation
- * @returns {Quat} The rotation of the left palm in world coordinates, or {@link Quat(0)|Quat.IDENTITY} if the avatar data
+ * @returns {Quat} The rotation of the left palm in world coordinates, or {@link Quat(0)|Quat.IDENTITY} if the avatar data
* aren't available.
*/
glm::quat getLeftPalmRotation() const;
diff --git a/libraries/avatars/src/AvatarData.h b/libraries/avatars/src/AvatarData.h
index ff00f9d68b..e17ba8f09d 100755
--- a/libraries/avatars/src/AvatarData.h
+++ b/libraries/avatars/src/AvatarData.h
@@ -4,6 +4,7 @@
//
// Created by Stephen Birarda on 4/9/13.
// Copyright 2013 High Fidelity, Inc.
+// Copyright 2021 Vircadia contributors.
//
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
@@ -530,23 +531,23 @@ class AvatarData : public QObject, public SpatiallyNestable {
* avatar. Read-only.
* @property {number} sensorToWorldScale - The scale that transforms dimensions in the user's real world to the avatar's
* size in the virtual world. Read-only.
- * @property {boolean} hasPriority - true if the avatar is in a "hero" zone, false if it isn't.
+ * @property {boolean} hasPriority - true if the avatar is in a "hero" zone, false if it isn't.
* Read-only.
- * @property {boolean} hasScriptedBlendshapes=false - true if blend shapes are controlled by scripted actions,
- * otherwise false. Set this to true before using the {@link Avatar.setBlendshape} method,
+ * @property {boolean} hasScriptedBlendshapes=false - true if blend shapes are controlled by scripted actions,
+ * otherwise false. Set this to true before using the {@link Avatar.setBlendshape} method,
* and set back to false after you no longer want scripted control over the blend shapes.
- * Note: This property will automatically be set to true if the controller system has
+ *
Note: This property will automatically be set to true if the controller system has
* valid facial blend shape actions.
true if avatars blink automatically by animating
- * facial blend shapes, false if automatic blinking is disabled. Set to false to fully control
+ * @property {boolean} hasProceduralBlinkFaceMovement=true - true if avatars blink automatically by animating
+ * facial blend shapes, false if automatic blinking is disabled. Set to false to fully control
* the blink facial blend shapes via the {@link Avatar.setBlendshape} method.
- * @property {boolean} hasProceduralEyeFaceMovement=true - true if the facial blend shapes for an avatar's eyes
- * adjust automatically as the eyes move, false if this automatic movement is disabled. Set this property
+ * @property {boolean} hasProceduralEyeFaceMovement=true - true if the facial blend shapes for an avatar's eyes
+ * adjust automatically as the eyes move, false if this automatic movement is disabled. Set this property
* to true to prevent the iris from being obscured by the upper or lower lids. Set to false to
* fully control the eye blend shapes via the {@link Avatar.setBlendshape} method.
- * @property {boolean} hasAudioEnabledFaceMovement=true - true if the avatar's mouth blend shapes animate
- * automatically based on detected microphone input, false if this automatic movement is disabled. Set
- * this property to false to fully control the mouth facial blend shapes via the
+ * @property {boolean} hasAudioEnabledFaceMovement=true - true if the avatar's mouth blend shapes animate
+ * automatically based on detected microphone input, false if this automatic movement is disabled. Set
+ * this property to false to fully control the mouth facial blend shapes via the
* {@link Avatar.setBlendshape} method.
*/
Q_PROPERTY(glm::vec3 position READ getWorldPosition WRITE setPositionViaScript)
@@ -758,7 +759,7 @@ public:
void setDomainMaximumHeight(float domainMaximumHeight);
/*@jsdoc
- * Sets the pointing state of the hands to control where the laser emanates from. If the right index finger is pointing, the
+ * Sets the pointing state of the hands to control where the laser emanates from. If the right index finger is pointing, the
* laser emanates from the tip of that finger, otherwise it emanates from the palm.
* @function Avatar.setHandState
* @param {HandState} state - The pointing state of the hand.
@@ -787,9 +788,9 @@ public:
* Sets a specific joint's rotation and position relative to its parent, in model coordinates.
* Warning: These coordinates are not necessarily in meters.
*Setting joint data completely overrides/replaces all motion from the default animation system including inverse - * kinematics, but just for the specified joint. So for example, if you were to procedurally manipulate the finger joints, - * the avatar's hand and head would still do inverse kinematics properly. However, as soon as you start to manipulate - * joints in the inverse kinematics chain, the inverse kinematics might not function as you expect. For example, if you set + * kinematics, but just for the specified joint. So for example, if you were to procedurally manipulate the finger joints, + * the avatar's hand and head would still do inverse kinematics properly. However, as soon as you start to manipulate + * joints in the inverse kinematics chain, the inverse kinematics might not function as you expect. For example, if you set * the rotation of the elbow, the hand inverse kinematics position won't end up in the right place.
* @function Avatar.setJointData * @param {number} index - The index of the joint. @@ -816,10 +817,10 @@ public: /*@jsdoc * Sets a specific joint's rotation relative to its parent. - *Setting joint data completely overrides/replaces all motion from the default animation system including inverse - * kinematics, but just for the specified joint. So for example, if you were to procedurally manipulate the finger joints, - * the avatar's hand and head would still do inverse kinematics properly. However, as soon as you start to manipulate - * joints in the inverse kinematics chain, the inverse kinematics might not function as you expect. For example, if you set + *
Setting joint data completely overrides/replaces all motion from the default animation system including inverse + * kinematics, but just for the specified joint. So for example, if you were to procedurally manipulate the finger joints, + * the avatar's hand and head would still do inverse kinematics properly. However, as soon as you start to manipulate + * joints in the inverse kinematics chain, the inverse kinematics might not function as you expect. For example, if you set * the rotation of the elbow, the hand inverse kinematics position won't end up in the right place.
* @function Avatar.setJointRotation * @param {number} index - The index of the joint. @@ -831,9 +832,9 @@ public: * Sets a specific joint's translation relative to its parent, in model coordinates. *Warning: These coordinates are not necessarily in meters.
*Setting joint data completely overrides/replaces all motion from the default animation system including inverse - * kinematics, but just for the specified joint. So for example, if you were to procedurally manipulate the finger joints, - * the avatar's hand and head would still do inverse kinematics properly. However, as soon as you start to manipulate - * joints in the inverse kinematics chain, the inverse kinematics might not function as you expect. For example, if you set + * kinematics, but just for the specified joint. So for example, if you were to procedurally manipulate the finger joints, + * the avatar's hand and head would still do inverse kinematics properly. However, as soon as you start to manipulate + * joints in the inverse kinematics chain, the inverse kinematics might not function as you expect. For example, if you set * the rotation of the elbow, the hand inverse kinematics position won't end up in the right place.
* @function Avatar.setJointTranslation * @param {number} index - The index of the joint. @@ -842,7 +843,7 @@ public: Q_INVOKABLE virtual void setJointTranslation(int index, const glm::vec3& translation); /*@jsdoc - * Clears joint translations and rotations set by script for a specific joint. This restores all motion from the default + * Clears joint translations and rotations set by script for a specific joint. This restores all motion from the default * animation system including inverse kinematics for that joint. *Note: This is slightly faster than the function variation that specifies the joint name.
* @function Avatar.clearJointData @@ -859,8 +860,8 @@ public: Q_INVOKABLE bool isJointDataValid(int index) const; /*@jsdoc - * Gets the rotation of a joint relative to its parent. For information on the joint hierarchy used, see - * Avatar Standards. + * Gets the rotation of a joint relative to its parent. For information on the joint hierarchy used, see + * Avatar Standards. * @function Avatar.getJointRotation * @param {number} index - The index of the joint. * @returns {Quat} The rotation of the joint relative to its parent. @@ -870,8 +871,8 @@ public: /*@jsdoc * Gets the translation of a joint relative to its parent, in model coordinates. *Warning: These coordinates are not necessarily in meters.
- *For information on the joint hierarchy used, see - * Avatar Standards.
+ *For information on the joint hierarchy used, see + * Avatar Standards.
* @function Avatar.getJointTranslation * @param {number} index - The index of the joint. * @returns {Vec3} The translation of the joint relative to its parent, in model coordinates. @@ -882,9 +883,9 @@ public: * Sets a specific joint's rotation and position relative to its parent, in model coordinates. *Warning: These coordinates are not necessarily in meters.
*Setting joint data completely overrides/replaces all motion from the default animation system including inverse - * kinematics, but just for the specified joint. So for example, if you were to procedurally manipulate the finger joints, - * the avatar's hand and head would still do inverse kinematics properly. However, as soon as you start to manipulate - * joints in the inverse kinematics chain, the inverse kinematics might not function as you expect. For example, if you set + * kinematics, but just for the specified joint. So for example, if you were to procedurally manipulate the finger joints, + * the avatar's hand and head would still do inverse kinematics properly. However, as soon as you start to manipulate + * joints in the inverse kinematics chain, the inverse kinematics might not function as you expect. For example, if you set * the rotation of the elbow, the hand inverse kinematics position won't end up in the right place.
* @function Avatar.setJointData * @param {string} name - The name of the joint. @@ -895,10 +896,10 @@ public: /*@jsdoc * Sets a specific joint's rotation relative to its parent. - *Setting joint data completely overrides/replaces all motion from the default animation system including inverse - * kinematics, but just for the specified joint. So for example, if you were to procedurally manipulate the finger joints, - * the avatar's hand and head would still do inverse kinematics properly. However, as soon as you start to manipulate - * joints in the inverse kinematics chain, the inverse kinematics might not function as you expect. For example, if you set + *
Setting joint data completely overrides/replaces all motion from the default animation system including inverse + * kinematics, but just for the specified joint. So for example, if you were to procedurally manipulate the finger joints, + * the avatar's hand and head would still do inverse kinematics properly. However, as soon as you start to manipulate + * joints in the inverse kinematics chain, the inverse kinematics might not function as you expect. For example, if you set * the rotation of the elbow, the hand inverse kinematics position won't end up in the right place.
* @function Avatar.setJointRotation * @param {string} name - The name of the joint. @@ -930,19 +931,19 @@ public: * Sets a specific joint's translation relative to its parent, in model coordinates. *Warning: These coordinates are not necessarily in meters.
*Setting joint data completely overrides/replaces all motion from the default animation system including inverse - * kinematics, but just for the specified joint. So for example, if you were to procedurally manipulate the finger joints, - * the avatar's hand and head would still do inverse kinematics properly. However, as soon as you start to manipulate - * joints in the inverse kinematics chain, the inverse kinematics might not function as you expect. For example, if you set + * kinematics, but just for the specified joint. So for example, if you were to procedurally manipulate the finger joints, + * the avatar's hand and head would still do inverse kinematics properly. However, as soon as you start to manipulate + * joints in the inverse kinematics chain, the inverse kinematics might not function as you expect. For example, if you set * the rotation of the elbow, the hand inverse kinematics position won't end up in the right place.
* @function Avatar.setJointTranslation * @param {string} name - The name of the joint. * @param {Vec3} translation - The translation of the joint relative to its parent, in model coordinates. - * @example*
Note: This is slightly slower than the function variation that specifies the joint index.
* @function Avatar.clearJointData @@ -980,8 +981,8 @@ public: Q_INVOKABLE virtual bool isJointDataValid(const QString& name) const; /*@jsdoc - * Gets the rotation of a joint relative to its parent. For information on the joint hierarchy used, see - * Avatar Standards. + * Gets the rotation of a joint relative to its parent. For information on the joint hierarchy used, see + * Avatar Standards. * @function Avatar.getJointRotation * @param {string} name - The name of the joint. * @returns {Quat} The rotation of the joint relative to its parent. @@ -996,7 +997,7 @@ public: * Gets the translation of a joint relative to its parent, in model coordinates. *Warning: These coordinates are not necessarily in meters.
*For information on the joint hierarchy used, see - * Avatar Standards.
+ * Avatar Standards. * @function Avatar.getJointTranslation * @param {number} name - The name of the joint. * @returns {Vec3} The translation of the joint relative to its parent, in model coordinates. @@ -1010,7 +1011,7 @@ public: /*@jsdoc * Gets the rotations of all joints in the current avatar. Each joint's rotation is relative to its parent joint. * @function Avatar.getJointRotations - * @returns {Quat[]} The rotations of all joints relative to each's parent. The values are in the same order as the array + * @returns {Quat[]} The rotations of all joints relative to each's parent. The values are in the same order as the array * returned by {@link MyAvatar.getJointNames}, or {@link Avatar.getJointNames} if using theAvatar API.
* @example Warning: These coordinates are not necessarily in meters.
* @function Avatar.getJointTranslations - * @returns {Vec3[]} The translations of all joints relative to each's parent, in model coordinates. The values are in the - * same order as the array returned by {@link MyAvatar.getJointNames}, or {@link Avatar.getJointNames} if using the + * @returns {Vec3[]} The translations of all joints relative to each's parent, in model coordinates. The values are in the + * same order as the array returned by {@link MyAvatar.getJointNames}, or {@link Avatar.getJointNames} if using the *Avatar API.
*/
Q_INVOKABLE virtual QVectorAvatar API.
* @example *
Warning: These coordinates are not necessarily in meters.
*Setting joint data completely overrides/replaces all motion from the default animation system including inverse @@ -1078,14 +1079,14 @@ public: * joints in the inverse kinematics chain, the inverse kinematics might not function as you expect. For example, if you set * the rotation of the elbow, the hand inverse kinematics position won't end up in the right place.
* @function Avatar.setJointTranslations - * @param {Vec3[]} translations - The translations for all joints in the avatar, in model coordinates. The values are in - * the same order as the array returned by {@link MyAvatar.getJointNames}, or {@link Avatar.getJointNames} if using the + * @param {Vec3[]} translations - The translations for all joints in the avatar, in model coordinates. The values are in + * the same order as the array returned by {@link MyAvatar.getJointNames}, or {@link Avatar.getJointNames} if using the *Avatar API.
*/
Q_INVOKABLE virtual void setJointTranslations(const QVectorAvatar API.
* @function Avatar.getJointIndex
* @param {string} name - The name of the joint.
@@ -1133,12 +1134,12 @@ public:
/*@jsdoc
- * Sets the value of a blend shape to animate your avatar's face. In order for other users to see the resulting animations
- * on your avatar's face, set hasScriptedBlendshapes to true. When you are done using this API,
- * set hasScriptedBlendshapes back to false when the animation is complete.
+ * Sets the value of a blend shape to animate your avatar's face. In order for other users to see the resulting animations
+ * on your avatar's face, set hasScriptedBlendshapes to true. When you are done using this API,
+ * set hasScriptedBlendshapes back to false when the animation is complete.
* @function Avatar.setBlendshape
- * @param {string} name - The name of the blendshape, per the
- * {@link https://docs.vircadia.dev/create/avatars/avatar-standards.html#blendshapes Avatar Standards}.
+ * @param {string} name - The name of the blendshape, per the
+ * {@link https://docs.vircadia.com/create/avatars/avatar-standards.html#blendshapes Avatar Standards}.
* @param {number} value - A value between 0.0 and 1.0.
* @example Deprecated: This method is deprecated and will be removed. Use the + *
Deprecated: This method is deprecated and will be removed. Use the
* Avatar.hasScriptedBlendshapes or MyAvatar.hasScriptedBlendshapes property instead.
true to enable blend shape changes to be transmitted to other users,
+ * @param {boolean} connected - true to enable blend shape changes to be transmitted to other users,
* false to disable.
*/
Q_INVOKABLE void setForceFaceTrackerConnected(bool connected) { setHasScriptedBlendshapes(connected); }
@@ -1274,7 +1275,7 @@ public:
/*@jsdoc
* Sets all models currently attached to your avatar. For example, if you retrieve attachment data using
- * {@link MyAvatar.getAttachmentData} or {@link Avatar.getAttachmentData}, make changes to it, and then want to update your avatar's attachments per the
+ * {@link MyAvatar.getAttachmentData} or {@link Avatar.getAttachmentData}, make changes to it, and then want to update your avatar's attachments per the
* changed data. You can also remove all attachments by using setting attachmentData to null.
* @function Avatar.setAttachmentData
* @param {AttachmentData[]} attachmentData - The attachment data defining the models to have attached to your avatar. Use
@@ -1300,19 +1301,19 @@ public:
* Attaches a model to your avatar. For example, you can give your avatar a hat to wear, a guitar to hold, or a surfboard to
* stand on.
* @function Avatar.attach
- * @param {string} modelURL - The URL of the glTF, FBX, or OBJ model to attach. glTF models may be in JSON or binary format
+ * @param {string} modelURL - The URL of the glTF, FBX, or OBJ model to attach. glTF models may be in JSON or binary format
* (".gltf" or ".glb" URLs respectively).
- * @param {string} [jointName=""] - The name of the avatar joint (see {@link MyAvatar.getJointNames} or
+ * @param {string} [jointName=""] - The name of the avatar joint (see {@link MyAvatar.getJointNames} or
* {@link Avatar.getJointNames}) to attach the model to.
* @param {Vec3} [translation=Vec3.ZERO] - The offset to apply to the model relative to the joint position.
* @param {Quat} [rotation=Quat.IDENTITY] - The rotation to apply to the model relative to the joint orientation.
* @param {number} [scale=1.0] - The scale to apply to the model.
- * @param {boolean} [isSoft=false] - If the model has a skeleton, set this to true so that the bones of the
- * attached model's skeleton are rotated to fit the avatar's current pose. isSoft is used, for example,
+ * @param {boolean} [isSoft=false] - If the model has a skeleton, set this to true so that the bones of the
+ * attached model's skeleton are rotated to fit the avatar's current pose. isSoft is used, for example,
* to have clothing that moves with the avatar.
- * If true, the translation, rotation, and scale parameters are
+ *
If true, the translation, rotation, and scale parameters are
* ignored.
true then more than one copy of any particular model may be
+ * @param {boolean} [allowDuplicates=false] - If true then more than one copy of any particular model may be
* attached to the same joint; if false then the same model cannot be attached to the same joint.
* @param {boolean} [useSaved=true] - Not used.
* @deprecated This function is deprecated and will be removed. Use avatar entities instead.
@@ -1344,7 +1345,7 @@ public:
* Detaches the most recently attached instance of a particular model from either a specific joint or any joint.
* @function Avatar.detachOne
* @param {string} modelURL - The URL of the model to detach.
- * @param {string} [jointName=""] - The name of the joint to detach the model from. If "", then the most
+ * @param {string} [jointName=""] - The name of the joint to detach the model from. If "", then the most
* recently attached model is removed from which ever joint it was attached to.
* @deprecated This function is deprecated and will be removed. Use avatar entities instead.
*/
@@ -1354,7 +1355,7 @@ public:
* Detaches all instances of a particular model from either a specific joint or all joints.
* @function Avatar.detachAll
* @param {string} modelURL - The URL of the model to detach.
- * @param {string} [jointName=""] - The name of the joint to detach the model from. If "", then the model is
+ * @param {string} [jointName=""] - The name of the joint to detach the model from. If "", then the model is
* detached from all joints.
* @deprecated This function is deprecated and will be removed. Use avatar entities instead.
*/
@@ -1414,7 +1415,7 @@ public:
/*@jsdoc
* Gets the transform from the user's real world to the avatar's size, orientation, and position in the virtual world.
* @function Avatar.getSensorToWorldMatrix
- * @returns {Mat4} The scale, rotation, and translation transform from the user's real world to the avatar's size,
+ * @returns {Mat4} The scale, rotation, and translation transform from the user's real world to the avatar's size,
* orientation, and position in the virtual world.
* @example scale property's value may be limited by the domain's settings.
* @function Avatar.getTargetScale
* @returns {number} The target scale of the avatar.
@@ -1703,7 +1704,7 @@ protected:
void unpackSkeletonModelURL(const QByteArray& data);
void unpackSkeletonData(const QByteArray& data);
-
+
// isReplicated will be true on downstream Avatar Mixers and their clients, but false on the upstream "master"
// Audio Mixer that the replicated avatar is connected to.
bool _isReplicated{ false };
diff --git a/libraries/avatars/src/ScriptAvatarData.h b/libraries/avatars/src/ScriptAvatarData.h
index a9deb81a27..3982c32b29 100644
--- a/libraries/avatars/src/ScriptAvatarData.h
+++ b/libraries/avatars/src/ScriptAvatarData.h
@@ -4,6 +4,7 @@
//
// Created by Zach Fox on 2017-04-10.
// Copyright 2017 High Fidelity, Inc.
+// Copyright 2021 Vircadia contributors.
//
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
@@ -117,10 +118,10 @@ public:
/*@jsdoc
* Gets the rotation of a joint relative to its parent. For information on the joint hierarchy used, see
- * Avatar Standards.
+ * Avatar Standards.
* @function ScriptAvatar.getJointRotation
* @param {number} index - The index of the joint.
- * @returns {Quat} The rotation of the joint relative to its parent, or {@link Quat(0)|Quat.IDENTITY} if the avatar data
+ * @returns {Quat} The rotation of the joint relative to its parent, or {@link Quat(0)|Quat.IDENTITY} if the avatar data
* aren't available.
*/
Q_INVOKABLE glm::quat getJointRotation(int index) const;
@@ -129,20 +130,20 @@ public:
* Gets the translation of a joint relative to its parent, in model coordinates.
* Warning: These coordinates are not necessarily in meters.
*For information on the joint hierarchy used, see - * Avatar Standards.
+ * Avatar Standards. * @function ScriptAvatar.getJointTranslation * @param {number} index - The index of the joint. - * @returns {Vec3} The translation of the joint relative to its parent, in model coordinates, or {@link Vec3(0)|Vec3.ZERO} + * @returns {Vec3} The translation of the joint relative to its parent, in model coordinates, or {@link Vec3(0)|Vec3.ZERO} * if the avatar data aren't available. */ Q_INVOKABLE glm::vec3 getJointTranslation(int index) const; /*@jsdoc * Gets the rotation of a joint relative to its parent. For information on the joint hierarchy used, see - * Avatar Standards. + * Avatar Standards. * @function ScriptAvatar.getJointRotation * @param {string} name - The name of the joint. - * @returns {Quat} The rotation of the joint relative to its parent, or {@link Quat(0)|Quat.IDENTITY} if the avatar data + * @returns {Quat} The rotation of the joint relative to its parent, or {@link Quat(0)|Quat.IDENTITY} if the avatar data * aren't available. */ Q_INVOKABLE glm::quat getJointRotation(const QString& name) const; @@ -151,10 +152,10 @@ public: * Gets the translation of a joint relative to its parent, in model coordinates. *Warning: These coordinates are not necessarily in meters.
*For information on the joint hierarchy used, see - * Avatar Standards.
+ * Avatar Standards. * @function ScriptAvatar.getJointTranslation * @param {number} name - The name of the joint. - * @returns {Vec3} The translation of the joint relative to its parent, in model coordinates, or {@link Vec3(0)|Vec3.ZERO} + * @returns {Vec3} The translation of the joint relative to its parent, in model coordinates, or {@link Vec3(0)|Vec3.ZERO} * if the avatar data aren't available. */ Q_INVOKABLE glm::vec3 getJointTranslation(const QString& name) const; @@ -162,7 +163,7 @@ public: /*@jsdoc * Gets the rotations of all joints in the avatar. Each joint's rotation is relative to its parent joint. * @function ScriptAvatar.getJointRotations - * @returns {Quat[]} The rotations of all joints relative to each's parent, or[] if the avatar data aren't
+ * @returns {Quat[]} The rotations of all joints relative to each's parent, or [] if the avatar data aren't
* available. The values are in the same order as the array returned by {@link ScriptAvatar.getJointNames}.
*/
Q_INVOKABLE QVectorWarning: These coordinates are not necessarily in meters.
* @function ScriptAvatar.getJointTranslations - * @returns {Vec3[]} The translations of all joints relative to each's parent, in model coordinates, or[] if
- * the avatar data aren't available. The values are in the same order as the array returned by
+ * @returns {Vec3[]} The translations of all joints relative to each's parent, in model coordinates, or [] if
+ * the avatar data aren't available. The values are in the same order as the array returned by
* {@link ScriptAvatar.getJointNames}.
*/
Q_INVOKABLE QVectortrue if the joint data are valid, false if not or the avatar data aren't
+ * @returns {boolean} true if the joint data are valid, false if not or the avatar data aren't
* available.
*/
Q_INVOKABLE bool isJointDataValid(const QString& name) const;
@@ -206,7 +207,7 @@ public:
/*@jsdoc
* Gets information about the models currently attached to the avatar.
* @function ScriptAvatar.getAttachmentData
- * @returns {AttachmentData[]} Information about all models attached to the avatar, or [] if the avatar data
+ * @returns {AttachmentData[]} Information about all models attached to the avatar, or [] if the avatar data
* aren't available.
* @deprecated This function is deprecated and will be removed. Use avatar entities instead.
*/
@@ -228,7 +229,7 @@ public:
glm::mat4 getSensorToWorldMatrix() const;
glm::mat4 getControllerLeftHandMatrix() const;
glm::mat4 getControllerRightHandMatrix() const;
-
+
bool getHasPriority() const;
signals:
@@ -268,7 +269,7 @@ public slots:
* Gets the rotation of a joint relative to the avatar.
* @function ScriptAvatar.getAbsoluteJointRotationInObjectFrame
* @param {number} index - The index of the joint.
- * @returns {Quat} The rotation of the joint relative to the avatar, or {@link Quat(0)|Quat.IDENTITY} if the avatar data
+ * @returns {Quat} The rotation of the joint relative to the avatar, or {@link Quat(0)|Quat.IDENTITY} if the avatar data
* aren't available.
*/
glm::quat getAbsoluteJointRotationInObjectFrame(int index) const;
@@ -277,7 +278,7 @@ public slots:
* Gets the translation of a joint relative to the avatar.
* @function ScriptAvatar.getAbsoluteJointTranslationInObjectFrame
* @param {number} index - The index of the joint.
- * @returns {Vec3} The translation of the joint relative to the avatar, or {@link Vec3(0)|Vec3.ZERO} if the avatar data
+ * @returns {Vec3} The translation of the joint relative to the avatar, or {@link Vec3(0)|Vec3.ZERO} if the avatar data
* aren't available.
*/
glm::vec3 getAbsoluteJointTranslationInObjectFrame(int index) const;
diff --git a/libraries/controllers/src/controllers/UserInputMapper.cpp b/libraries/controllers/src/controllers/UserInputMapper.cpp
index 6333792b3f..6a46dea7d9 100755
--- a/libraries/controllers/src/controllers/UserInputMapper.cpp
+++ b/libraries/controllers/src/controllers/UserInputMapper.cpp
@@ -738,7 +738,7 @@ Mapping::Pointer UserInputMapper::newMapping(const QString& mappingName) {
// if (request->getResult() == ResourceRequest::Success) {
// result = parseMapping(QString(request->getData()));
// } else {
-// qCWarning(controllers) << "Failed to load mapping url <" << jsonUrl << ">" << endl;
+// qCWarning(controllers) << "Failed to load mapping url <" << jsonUrl << ">" << Qt::endl;
// }
// request->deleteLater();
// }
@@ -1177,13 +1177,13 @@ Mapping::Pointer UserInputMapper::parseMapping(const QString& json) {
if (doc.isNull()) {
qCDebug(controllers) << "Invalid JSON...\n";
qCDebug(controllers) << error.errorString();
- qCDebug(controllers) << "JSON was:\n" << json << endl;
+ qCDebug(controllers) << "JSON was:\n" << json << Qt::endl;
return Mapping::Pointer();
}
if (!doc.isObject()) {
- qWarning() << "Mapping json Document is not an object" << endl;
- qCDebug(controllers) << "JSON was:\n" << json << endl;
+ qWarning() << "Mapping json Document is not an object" << Qt::endl;
+ qCDebug(controllers) << "JSON was:\n" << json << Qt::endl;
return Mapping::Pointer();
}
return parseMapping(doc.object());
diff --git a/libraries/entities-renderer/src/RenderableEntityItem.cpp b/libraries/entities-renderer/src/RenderableEntityItem.cpp
index b7cfcde224..212baa6634 100644
--- a/libraries/entities-renderer/src/RenderableEntityItem.cpp
+++ b/libraries/entities-renderer/src/RenderableEntityItem.cpp
@@ -495,6 +495,15 @@ void EntityRenderer::removeMaterial(graphics::MaterialPointer material, const st
emit requestRenderUpdate();
}
+graphics::MaterialPointer EntityRenderer::getTopMaterial() {
+ std::lock_guardmaterialMappingMode == "projected".
- * @property {string} materialURL="" - URL to a {@link Entities.MaterialResource|MaterialResource}. If you append
- * "#name" to the URL, the material with that name in the {@link Entities.MaterialResource|MaterialResource}
- * will be applied to the entity. Alternatively, set the property value to "materialData" to use the
- * materialData property for the {@link Entities.MaterialResource|MaterialResource} values.
+ * @property {string} materialURL="" - URL to a {@link Entities.MaterialResource|MaterialResource}. Alternatively, set the
+ * property value to "materialData" to use the materialData property for the
+ * {@link Entities.MaterialResource|MaterialResource} values. If you append "#name" to the URL, the material
+ * with that name will be applied to the entity. You can also use the ID of another Material entity as the URL, in which
+ * case this material will act as a copy of that material, with its own unique material transform, priority, etc.
* @property {string} materialData="" - Used to store {@link Entities.MaterialResource|MaterialResource} data as a JSON string.
* You can use JSON.parse() to parse the string into a JavaScript object which you can manipulate the
* properties of, and use JSON.stringify() to convert the object into a string to put in the property.
@@ -1379,7 +1380,8 @@ EntityPropertyFlags EntityItemProperties::getChangedProperties() const {
/*@jsdoc
* The "Web" {@link Entities.EntityType|EntityType} displays a browsable web page. Each user views their own copy
* of the web page: if one user navigates to another page on the entity, other users do not see the change; if a video is being
- * played, users don't see it in sync. It has properties in addition to the common
+ * played, users don't see it in sync. Internally, a Web entity is rendered as a non-repeating, upside down texture, so additional
+ * transformations may be necessary if you reference a Web entity texture by UUID. It has properties in addition to the common
* {@link Entities.EntityProperties|EntityProperties}.
*
* @typedef {object} Entities.EntityProperties-Web
diff --git a/libraries/entities/src/EntityTree.cpp b/libraries/entities/src/EntityTree.cpp
index eeb42626c2..63d8842a91 100644
--- a/libraries/entities/src/EntityTree.cpp
+++ b/libraries/entities/src/EntityTree.cpp
@@ -2751,6 +2751,47 @@ QVectorDescribes the type of texture.
- *See also: {@link Material} and - * {@link https://docs.vircadia.dev/create/3d-models/pbr-materials-guide.html|PBR Materials Guide}.
+ *See also: {@link Material} and + * {@link https://docs.vircadia.com/create/3d-models/pbr-materials-guide.html|PBR Materials Guide}.
*| Value | Name | Description |
|---|