diff --git a/BUILD_WIN.md b/BUILD_WIN.md index a81fca5900..01ba2887a3 100644 --- a/BUILD_WIN.md +++ b/BUILD_WIN.md @@ -53,6 +53,10 @@ Open `%HIFI_DIR%\build\hifi.sln` using Visual Studio. Change the Solution Configuration (menu ribbon under the menu bar, next to the green play button) from "Debug" to "Release" for best performance. +Create another environment variable (see Step #4) +* Set "Variable name": `PreferredToolArchitecture` +* Set "Variable value": `x64` + Run from the menu bar `Build > Build Solution`. ### Step 7. Testing Interface diff --git a/CMakeLists.txt b/CMakeLists.txt index 49994d27b7..49d16ffa4e 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -62,7 +62,7 @@ endif() # Use default time server if none defined in environment set_from_env(TIMESERVER_URL TIMESERVER_URL "http://sha256timestamp.ws.symantec.com/sha256/timestamp") -set(HIFI_USE_OPTIMIZED_IK OFF) +set(HIFI_USE_OPTIMIZED_IK_OPTION OFF) set(BUILD_CLIENT_OPTION ON) set(BUILD_SERVER_OPTION ON) set(BUILD_TESTS_OPTION OFF) @@ -126,7 +126,7 @@ if (USE_GLES AND (NOT ANDROID)) set(DISABLE_QML_OPTION ON) endif() -option(HIFI_USE_OPTIMIZED_IK "USE OPTIMIZED IK" ${HIFI_USE_OPTIMIZED_IK_OPTION}) +option(HIFI_USE_OPTIMIZED_IK "Use optimized IK" ${HIFI_USE_OPTIMIZED_IK_OPTION}) option(BUILD_CLIENT "Build client components" ${BUILD_CLIENT_OPTION}) option(BUILD_SERVER "Build server components" ${BUILD_SERVER_OPTION}) option(BUILD_TESTS "Build tests" ${BUILD_TESTS_OPTION}) @@ -157,7 +157,7 @@ foreach(PLATFORM_QT_COMPONENT ${PLATFORM_QT_COMPONENTS}) list(APPEND PLATFORM_QT_LIBRARIES "Qt5::${PLATFORM_QT_COMPONENT}") endforeach() -MESSAGE(STATUS "USE OPTIMIZED IK: " ${HIFI_USE_OPTIMIZED_IK}) +MESSAGE(STATUS "Use optimized IK: " ${HIFI_USE_OPTIMIZED_IK}) MESSAGE(STATUS "Build server: " ${BUILD_SERVER}) MESSAGE(STATUS "Build client: " ${BUILD_CLIENT}) MESSAGE(STATUS "Build tests: " ${BUILD_TESTS}) diff --git a/assignment-client/src/AssignmentClient.cpp b/assignment-client/src/AssignmentClient.cpp index c1943de2cc..1ef375b562 100644 --- a/assignment-client/src/AssignmentClient.cpp +++ b/assignment-client/src/AssignmentClient.cpp @@ -307,7 +307,7 @@ void AssignmentClient::assignmentCompleted() { // reset our NodeList by switching back to unassigned and clearing the list nodeList->setOwnerType(NodeType::Unassigned); - nodeList->reset(); + nodeList->reset("Assignment completed"); nodeList->resetNodeInterestSet(); _isAssigned = false; diff --git a/assignment-client/src/audio/AvatarAudioStream.cpp b/assignment-client/src/audio/AvatarAudioStream.cpp index 1b3ca9a8b1..24b14ac9e5 100644 --- a/assignment-client/src/audio/AvatarAudioStream.cpp +++ b/assignment-client/src/audio/AvatarAudioStream.cpp @@ -45,6 +45,7 @@ int AvatarAudioStream::parseStreamProperties(PacketType type, const QByteArray& : AudioConstants::NETWORK_FRAME_SAMPLES_PER_CHANNEL); // restart the codec if (_codec) { + QMutexLocker lock(&_decoderMutex); if (_decoder) { _codec->releaseDecoder(_decoder); } diff --git a/assignment-client/src/entities/EntityTreeHeadlessViewer.cpp b/assignment-client/src/entities/EntityTreeHeadlessViewer.cpp index 3649cf1129..5f43627763 100644 --- a/assignment-client/src/entities/EntityTreeHeadlessViewer.cpp +++ b/assignment-client/src/entities/EntityTreeHeadlessViewer.cpp @@ -37,6 +37,7 @@ void EntityTreeHeadlessViewer::update() { if (_tree) { EntityTreePointer tree = std::static_pointer_cast(_tree); tree->withTryWriteLock([&] { + tree->preUpdate(); tree->update(); }); } diff --git a/assignment-client/src/entities/EntityTreeSendThread.cpp b/assignment-client/src/entities/EntityTreeSendThread.cpp index a6542689e0..2b964ae674 100644 --- a/assignment-client/src/entities/EntityTreeSendThread.cpp +++ b/assignment-client/src/entities/EntityTreeSendThread.cpp @@ -372,7 +372,7 @@ bool EntityTreeSendThread::traverseTreeAndBuildNextPacketPayload(EncodeBitstream // Record explicitly filtered-in entity so that extra entities can be flagged. entityNodeData->insertSentFilteredEntity(entityID); } - OctreeElement::AppendState appendEntityState = entity->appendEntityData(&_packetData, params, _extraEncodeData); + OctreeElement::AppendState appendEntityState = entity->appendEntityData(&_packetData, params, _extraEncodeData, entityNode->getCanGetAndSetPrivateUserData()); if (appendEntityState != OctreeElement::COMPLETED) { if (appendEntityState == OctreeElement::PARTIAL) { diff --git a/domain-server/resources/describe-settings.json b/domain-server/resources/describe-settings.json index 74c744aced..488b2091f3 100644 --- a/domain-server/resources/describe-settings.json +++ b/domain-server/resources/describe-settings.json @@ -1,5 +1,5 @@ { - "version": 2.2, + "version": 2.3, "settings": [ { "name": "metaverse", @@ -224,7 +224,7 @@ "name": "standard_permissions", "type": "table", "label": "Domain-Wide User Permissions", - "help": "Indicate which types of users can have which domain-wide permissions.", + "help": "Indicate which types of users can have which domain-wide permissions.", "caption": "Standard Permissions", "can_add_new_rows": false, "groups": [ @@ -233,8 +233,8 @@ "span": 1 }, { - "label": "Permissions ?", - "span": 10 + "label": "Permissions ?", + "span": 11 } ], "columns": [ @@ -311,6 +311,13 @@ "type": "checkbox", "editable": true, "default": false + }, + { + "name": "id_can_get_and_set_private_user_data", + "label": "Can Get and Set Private User Data", + "type": "checkbox", + "editable": true, + "default": false } ], "non-deletable-row-key": "permissions_id", @@ -337,6 +344,7 @@ "id_can_rez_tmp": true, "id_can_rez_tmp_certified": true, "id_can_write_to_asset_server": true, + "id_can_get_and_set_private_user_data": true, "permissions_id": "localhost" }, { @@ -361,8 +369,8 @@ "span": 1 }, { - "label": "Permissions ?", - "span": 10 + "label": "Permissions ?", + "span": 11 } ], "columns": [ @@ -464,6 +472,13 @@ "type": "checkbox", "editable": true, "default": false + }, + { + "name": "id_can_get_and_set_private_user_data", + "label": "Can Get and Set Private User Data", + "type": "checkbox", + "editable": true, + "default": false } ] }, @@ -482,8 +497,8 @@ "span": 1 }, { - "label": "Permissions ?", - "span": 10 + "label": "Permissions ?", + "span": 11 } ], "columns": [ @@ -582,6 +597,13 @@ "type": "checkbox", "editable": true, "default": false + }, + { + "name": "id_can_get_and_set_private_user_data", + "label": "Can Get and Set Private User Data", + "type": "checkbox", + "editable": true, + "default": false } ] }, @@ -596,8 +618,8 @@ "span": 1 }, { - "label": "Permissions ?", - "span": 10 + "label": "Permissions ?", + "span": 11 } ], "columns": [ @@ -674,6 +696,13 @@ "type": "checkbox", "editable": true, "default": false + }, + { + "name": "id_can_get_and_set_private_user_data", + "label": "Can Get and Set Private User Data", + "type": "checkbox", + "editable": true, + "default": false } ] }, @@ -688,8 +717,8 @@ "span": 1 }, { - "label": "Permissions ?", - "span": 10 + "label": "Permissions ?", + "span": 11 } ], "columns": [ @@ -766,6 +795,13 @@ "type": "checkbox", "editable": true, "default": false + }, + { + "name": "id_can_get_and_set_private_user_data", + "label": "Can Get and Set Private User Data", + "type": "checkbox", + "editable": true, + "default": false } ] }, @@ -780,8 +816,8 @@ "span": 1 }, { - "label": "Permissions ?", - "span": 10 + "label": "Permissions ?", + "span": 11 } ], "columns": [ @@ -858,7 +894,14 @@ "type": "checkbox", "editable": true, "default": false - } + }, + { + "name": "id_can_get_and_set_private_user_data", + "label": "Can Get and Set Private User Data", + "type": "checkbox", + "editable": true, + "default": false + } ] }, { @@ -872,8 +915,8 @@ "span": 1 }, { - "label": "Permissions ?", - "span": 10 + "label": "Permissions ?", + "span": 11 } ], "columns": [ @@ -950,6 +993,13 @@ "type": "checkbox", "editable": true, "default": false + }, + { + "name": "id_can_get_and_set_private_user_data", + "label": "Can Get and Set Private User Data", + "type": "checkbox", + "editable": true, + "default": false } ] }, diff --git a/domain-server/src/DomainGatekeeper.cpp b/domain-server/src/DomainGatekeeper.cpp index 8c7beaa614..29656f4465 100644 --- a/domain-server/src/DomainGatekeeper.cpp +++ b/domain-server/src/DomainGatekeeper.cpp @@ -282,6 +282,7 @@ void DomainGatekeeper::updateNodePermissions() { userPerms.permissions |= NodePermissions::Permission::canRezTemporaryCertifiedEntities; userPerms.permissions |= NodePermissions::Permission::canWriteToAssetServer; userPerms.permissions |= NodePermissions::Permission::canReplaceDomainContent; + userPerms.permissions |= NodePermissions::Permission::canGetAndSetPrivateUserData; } 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 @@ -374,6 +375,7 @@ SharedNodePointer DomainGatekeeper::processAssignmentConnectRequest(const NodeCo userPerms.permissions |= NodePermissions::Permission::canRezTemporaryCertifiedEntities; userPerms.permissions |= NodePermissions::Permission::canWriteToAssetServer; userPerms.permissions |= NodePermissions::Permission::canReplaceDomainContent; + userPerms.permissions |= NodePermissions::Permission::canGetAndSetPrivateUserData; newNode->setPermissions(userPerms); return newNode; } @@ -811,26 +813,23 @@ void DomainGatekeeper::processICEPeerInformationPacket(QSharedPointergetMessage()); - NetworkPeer* receivedPeer = new NetworkPeer; + auto receivedPeer = SharedNetworkPeer::create(); iceResponseStream >> *receivedPeer; if (!_icePeers.contains(receivedPeer->getUUID())) { - qDebug() << "New peer requesting ICE connection being added to hash -" << *receivedPeer; - SharedNetworkPeer newPeer = SharedNetworkPeer(receivedPeer); - _icePeers[receivedPeer->getUUID()] = newPeer; + qCDebug(domain_server_ice) << "New peer requesting ICE connection being added to hash -" << *receivedPeer; + _icePeers[receivedPeer->getUUID()] = receivedPeer; // make sure we know when we should ping this peer - connect(newPeer.data(), &NetworkPeer::pingTimerTimeout, this, &DomainGatekeeper::handlePeerPingTimeout); + connect(receivedPeer.data(), &NetworkPeer::pingTimerTimeout, this, &DomainGatekeeper::handlePeerPingTimeout); // immediately ping the new peer, and start a timer to continue pinging it until we connect to it - newPeer->startPingTimer(); + receivedPeer->startPingTimer(); - qDebug() << "Sending ping packets to establish connectivity with ICE peer with ID" - << newPeer->getUUID(); + qCDebug(domain_server_ice) << "Sending ping packets to establish connectivity with ICE peer with ID" + << receivedPeer->getUUID(); - pingPunchForConnectingPeer(newPeer); - } else { - delete receivedPeer; + pingPunchForConnectingPeer(receivedPeer); } } diff --git a/domain-server/src/DomainServer.cpp b/domain-server/src/DomainServer.cpp index f73c59dc32..051dd989f5 100644 --- a/domain-server/src/DomainServer.cpp +++ b/domain-server/src/DomainServer.cpp @@ -58,6 +58,7 @@ #include Q_LOGGING_CATEGORY(domain_server, "hifi.domain_server") +Q_LOGGING_CATEGORY(domain_server_ice, "hifi.domain_server.ice") const QString ACCESS_TOKEN_KEY_PATH = "metaverse.access_token"; const QString DomainServer::REPLACEMENT_FILE_EXTENSION = ".replace"; @@ -374,7 +375,7 @@ void DomainServer::parseCommandLine(int argc, char* argv[]) { } if (_iceServerAddr.isEmpty()) { - qWarning() << "Could not parse an IP address and port combination from" << hostnamePortString; + qCWarning(domain_server_ice) << "Could not parse an IP address and port combination from" << hostnamePortString; ::exit(0); } } @@ -1570,12 +1571,8 @@ void DomainServer::sendICEServerAddressToMetaverseAPI() { callbackParameters.errorCallbackMethod = "handleFailedICEServerAddressUpdate"; callbackParameters.jsonCallbackMethod = "handleSuccessfulICEServerAddressUpdate"; - static bool printedIceServerMessage = false; - if (!printedIceServerMessage) { - printedIceServerMessage = true; - qDebug() << "Updating ice-server address in High Fidelity Metaverse API to" - << (_iceServerSocket.isNull() ? "" : _iceServerSocket.getAddress().toString()); - } + qCDebug(domain_server_ice) << "Updating ice-server address in High Fidelity Metaverse API to" + << (_iceServerSocket.isNull() ? "" : _iceServerSocket.getAddress().toString()); static const QString DOMAIN_ICE_ADDRESS_UPDATE = "/api/v1/domains/%1/ice_server_address"; @@ -1589,11 +1586,11 @@ void DomainServer::sendICEServerAddressToMetaverseAPI() { void DomainServer::handleSuccessfulICEServerAddressUpdate(QNetworkReply* requestReply) { _sendICEServerAddressToMetaverseAPIInProgress = false; if (_sendICEServerAddressToMetaverseAPIRedo) { - qDebug() << "ice-server address updated with metaverse, but has since changed. redoing update..."; + qCDebug(domain_server_ice) << "ice-server address (" << _iceServerSocket << ") updated with metaverse, but has since changed. redoing update..."; _sendICEServerAddressToMetaverseAPIRedo = false; sendICEServerAddressToMetaverseAPI(); } else { - qDebug() << "ice-server address updated with metaverse."; + qCDebug(domain_server_ice) << "ice-server address (" << _iceServerSocket << ") updated with metaverse."; } } @@ -1606,9 +1603,9 @@ void DomainServer::handleFailedICEServerAddressUpdate(QNetworkReply* requestRepl } else { const int ICE_SERVER_UPDATE_RETRY_MS = 2 * 1000; - qWarning() << "Failed to update ice-server address with High Fidelity Metaverse - error was" + qCWarning(domain_server_ice) << "Failed to update ice-server address (" << _iceServerSocket << ") with High Fidelity Metaverse - error was" << requestReply->errorString(); - qWarning() << "\tRe-attempting in" << ICE_SERVER_UPDATE_RETRY_MS / 1000 << "seconds"; + qCWarning(domain_server_ice) << "\tRe-attempting in" << ICE_SERVER_UPDATE_RETRY_MS / 1000 << "seconds"; QTimer::singleShot(ICE_SERVER_UPDATE_RETRY_MS, this, SLOT(sendICEServerAddressToMetaverseAPI())); } @@ -1621,26 +1618,26 @@ void DomainServer::sendHeartbeatToIceServer() { auto limitedNodeList = DependencyManager::get(); if (!accountManager->getAccountInfo().hasPrivateKey()) { - qWarning() << "Cannot send an ice-server heartbeat without a private key for signature."; - qWarning() << "Waiting for keypair generation to complete before sending ICE heartbeat."; + qCWarning(domain_server_ice) << "Cannot send an ice-server heartbeat without a private key for signature."; + qCWarning(domain_server_ice) << "Waiting for keypair generation to complete before sending ICE heartbeat."; if (!limitedNodeList->getSessionUUID().isNull()) { accountManager->generateNewDomainKeypair(limitedNodeList->getSessionUUID()); } else { - qWarning() << "Attempting to send ICE server heartbeat with no domain ID. This is not supported"; + qCWarning(domain_server_ice) << "Attempting to send ICE server heartbeat with no domain ID. This is not supported"; } return; } - const int FAILOVER_NO_REPLY_ICE_HEARTBEATS { 3 }; + const int FAILOVER_NO_REPLY_ICE_HEARTBEATS { 6 }; // increase the count of no reply ICE heartbeats and check the current value ++_noReplyICEHeartbeats; if (_noReplyICEHeartbeats > FAILOVER_NO_REPLY_ICE_HEARTBEATS) { - qWarning() << "There have been" << _noReplyICEHeartbeats - 1 << "heartbeats sent with no reply from the ice-server"; - qWarning() << "Clearing the current ice-server socket and selecting a new candidate ice-server"; + qCWarning(domain_server_ice) << "There have been" << _noReplyICEHeartbeats - 1 << "heartbeats sent with no reply from the ice-server"; + qCWarning(domain_server_ice) << "Clearing the current ice-server socket and selecting a new candidate ice-server"; // add the current address to our list of failed addresses _failedIceServerAddresses << _iceServerSocket.getAddress(); @@ -1713,8 +1710,8 @@ void DomainServer::sendHeartbeatToIceServer() { limitedNodeList->sendUnreliablePacket(*_iceServerHeartbeatPacket, _iceServerSocket); } else { - qDebug() << "Not sending ice-server heartbeat since there is no selected ice-server."; - qDebug() << "Waiting for" << _iceServerAddr << "host lookup response"; + qCDebug(domain_server_ice) << "Not sending ice-server heartbeat since there is no selected ice-server."; + qCDebug(domain_server_ice) << "Waiting for" << _iceServerAddr << "host lookup response"; } } @@ -3294,7 +3291,7 @@ void DomainServer::processICEServerHeartbeatDenialPacket(QSharedPointer NUM_HEARTBEAT_DENIALS_FOR_KEYPAIR_REGEN) { - qDebug() << "Received" << NUM_HEARTBEAT_DENIALS_FOR_KEYPAIR_REGEN << "heartbeat denials from ice-server" + qCDebug(domain_server_ice) << "Received" << NUM_HEARTBEAT_DENIALS_FOR_KEYPAIR_REGEN << "heartbeat denials from ice-server" << "- re-generating keypair now"; // we've hit our threshold of heartbeat denials, trigger a keypair re-generation @@ -3316,7 +3313,7 @@ void DomainServer::processICEServerHeartbeatACK(QSharedPointer if (!_connectedToICEServer) { _connectedToICEServer = true; sendICEServerAddressToMetaverseAPI(); - qInfo() << "Connected to ice-server at" << _iceServerSocket; + qCInfo(domain_server_ice) << "Connected to ice-server at" << _iceServerSocket; } } @@ -3347,7 +3344,7 @@ void DomainServer::handleICEHostInfo(const QHostInfo& hostInfo) { } if (hostInfo.error() != QHostInfo::NoError || sanitizedAddresses.empty()) { - qWarning() << "IP address lookup failed for" << _iceServerAddr << ":" << hostInfo.errorString(); + qCWarning(domain_server_ice) << "IP address lookup failed for" << _iceServerAddr << ":" << hostInfo.errorString(); // if we don't have an ICE server to use yet, trigger a retry if (_iceServerSocket.isNull()) { @@ -3362,7 +3359,7 @@ void DomainServer::handleICEHostInfo(const QHostInfo& hostInfo) { _iceServerAddresses = sanitizedAddresses; if (countBefore == 0) { - qInfo() << "Found" << _iceServerAddresses.count() << "ice-server IP addresses for" << _iceServerAddr; + qCInfo(domain_server_ice) << "Found" << _iceServerAddresses.count() << "ice-server IP addresses for" << _iceServerAddr; } if (_iceServerSocket.isNull()) { @@ -3396,7 +3393,7 @@ void DomainServer::randomizeICEServerAddress(bool shouldTriggerHostLookup) { // we ended up with an empty list since everything we've tried has failed // so clear the set of failed addresses and start going through them again - qWarning() << "All current ice-server addresses have failed - re-attempting all current addresses for" + qCWarning(domain_server_ice) << "All current ice-server addresses have failed - re-attempting all current addresses for" << _iceServerAddr; _failedIceServerAddresses.clear(); @@ -3416,7 +3413,7 @@ void DomainServer::randomizeICEServerAddress(bool shouldTriggerHostLookup) { } _iceServerSocket = HifiSockAddr { candidateICEAddresses[indexToTry], ICE_SERVER_DEFAULT_PORT }; - qInfo() << "Set candidate ice-server socket to" << _iceServerSocket; + 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 _numHeartbeatDenials = 0; diff --git a/domain-server/src/DomainServer.h b/domain-server/src/DomainServer.h index f0c20241a2..8276566233 100644 --- a/domain-server/src/DomainServer.h +++ b/domain-server/src/DomainServer.h @@ -40,6 +40,7 @@ #include Q_DECLARE_LOGGING_CATEGORY(domain_server) +Q_DECLARE_LOGGING_CATEGORY(domain_server_ice) typedef QSharedPointer SharedAssignmentPointer; typedef QMultiHash TransactionHash; diff --git a/domain-server/src/DomainServerSettingsManager.cpp b/domain-server/src/DomainServerSettingsManager.cpp index 4e833f6b77..2deb51f2e3 100644 --- a/domain-server/src/DomainServerSettingsManager.cpp +++ b/domain-server/src/DomainServerSettingsManager.cpp @@ -441,6 +441,12 @@ void DomainServerSettingsManager::setupConfigMap(const QString& userConfigFilena } } + if (oldVersion < 2.3) { + unpackPermissions(); + _standardAgentPermissions[NodePermissions::standardNameLocalhost]->set(NodePermissions::Permission::canGetAndSetPrivateUserData); + packPermissions(); + } + // write the current description version to our settings *versionVariant = _descriptionVersion; diff --git a/hifi_singleton.py b/hifi_singleton.py index 692948c80b..70871a9f60 100644 --- a/hifi_singleton.py +++ b/hifi_singleton.py @@ -1,3 +1,5 @@ +import json +import logging import os import platform import time @@ -7,6 +9,15 @@ try: except ImportError: fcntl = None +try: + import msvcrt +except ImportError: + msvcrt = None + + +logger = logging.getLogger(__name__) + + # Used to ensure only one instance of the script runs at a time class Singleton: def __init__(self, path): @@ -33,7 +44,10 @@ class Singleton: else: self.fh.close() self.fh = None - print("Couldn't aquire lock, retrying in 10 seconds") + # print is horked here so write directly to stdout. + with open(1, mode="w", closefd=False) as _stdout: + _stdout.write("Couldn't aquire lock, retrying in 10 seconds\n") + _stdout.flush() time.sleep(10) return self @@ -43,4 +57,104 @@ class Singleton: else: fcntl.lockf(self.fh, fcntl.LOCK_UN) self.fh.close() - os.unlink(self.path) \ No newline at end of file + os.unlink(self.path) + + +class FLock: + """ + File locking context manager + + >> with FLock("/tmp/foo.lock"): + >> do_something_that_must_be_synced() + + The lock file must stick around forever. The author is not aware of a no cross platform way to clean it up w/o introducting race conditions. + """ + def __init__(self, path): + self.fh = os.open(path, os.O_CREAT | os.O_RDWR) + self.path = path + + def _lock_posix(self): + try: + fcntl.lockf(self.fh, fcntl.LOCK_EX | fcntl.LOCK_NB) + except BlockingIOError: + # Windows sleeps for 10 seconds before giving up on a lock. + # Lets mimic that behavior. + time.sleep(10) + return False + else: + return True + + def _lock_windows(self): + try: + msvcrt.locking(self.fh, msvcrt.LK_LOCK, 1) + except OSError: + return False + else: + return True + + if fcntl is not None: + _lock = _lock_posix + elif msvcrt is not None: + _lock = _lock_windows + else: + raise RuntimeError("No locking library found") + + def read_stats(self): + data = {} + with open(self.fh, mode="r", closefd=False) as stats_file: + stats_file.seek(0) + try: + data = json.loads(stats_file.read()) + except json.decoder.JSONDecodeError: + logger.warning("couldn't decode json in lock file") + except PermissionError: + # Can't read a locked file on Windows :( + pass + + lock_age = time.time() - os.fstat(self.fh).st_mtime + if lock_age > 0: + data["Age"] = "%0.2f" % lock_age + + with open(1, mode="w", closefd=False) as _stdout: + _stdout.write("Lock stats:\n") + for key, value in sorted(data.items()): + _stdout.write("* %s: %s\n" % (key, value)) + _stdout.flush() + + def write_stats(self): + stats = { + "Owner PID": os.getpid(), + } + flock_env_vars = os.getenv("FLOCK_ENV_VARS") + if flock_env_vars: + for env_var_name in flock_env_vars.split(":"): + stats[env_var_name] = os.getenv(env_var_name) + + with open(self.fh, mode="w", closefd=False) as stats_file: + stats_file.truncate() + return stats_file.write(json.dumps(stats, indent=2)) + + def __enter__(self): + while not self._lock(): + try: + self.read_stats() + except (IOError, ValueError) as exc: + logger.exception("couldn't read stats") + time.sleep(3.33) # don't hammer the file + + self.write_stats() + + return self + + def __exit__(self, type, value, traceback): + os.close(self.fh) + # WARNING: `os.close` gives up the lock on `fh` then we attempt the `os.unlink`. On posix platforms this can lead to us deleting a lock file that another process owns. This step is required to maintain compatablity with Singleton. When and if FLock is completely rolled out to the build fleet this unlink should be removed. + try: + os.unlink(self.path) + except (FileNotFoundError, PermissionError): + logger.exception("couldn't unlink lock file") + + +if os.getenv("USE_FLOCK_CLS") is not None: + logger.warning("Using FLock locker") + Singleton = FLock diff --git a/interface/src/Application.cpp b/interface/src/Application.cpp index 0594acec6a..d8df9ea62d 100644 --- a/interface/src/Application.cpp +++ b/interface/src/Application.cpp @@ -245,11 +245,8 @@ #include "webbrowser/WebBrowserSuggestionsEngine.h" #include - #include "AboutUtil.h" -#include - #if defined(Q_OS_WIN) #include @@ -331,6 +328,7 @@ static const unsigned int THROTTLED_SIM_FRAMERATE = 15; static const int THROTTLED_SIM_FRAME_PERIOD_MS = MSECS_PER_SECOND / THROTTLED_SIM_FRAMERATE; static const int ENTITY_SERVER_ADDED_TIMEOUT = 5000; static const int ENTITY_SERVER_CONNECTION_TIMEOUT = 5000; +static const int WATCHDOG_TIMER_TIMEOUT = 100; static const float INITIAL_QUERY_RADIUS = 10.0f; // priority radius for entities before physics enabled @@ -443,6 +441,7 @@ public: auto elapsedMovingAverage = _movingAverage.getAverage(); if (elapsedMovingAverage > _maxElapsedAverage) { +#if !defined(NDEBUG) qCDebug(interfaceapp_deadlock) << "DEADLOCK WATCHDOG WARNING:" << "lastHeartbeatAge:" << lastHeartbeatAge << "elapsedMovingAverage:" << elapsedMovingAverage @@ -450,9 +449,11 @@ public: << "PREVIOUS maxElapsedAverage:" << _maxElapsedAverage << "NEW maxElapsedAverage:" << elapsedMovingAverage << "** NEW MAX ELAPSED AVERAGE **" << "samples:" << _movingAverage.getSamples(); +#endif _maxElapsedAverage = elapsedMovingAverage; } if (lastHeartbeatAge > _maxElapsed) { +#if !defined(NDEBUG) qCDebug(interfaceapp_deadlock) << "DEADLOCK WATCHDOG WARNING:" << "lastHeartbeatAge:" << lastHeartbeatAge << "elapsedMovingAverage:" << elapsedMovingAverage @@ -460,8 +461,11 @@ public: << "NEW maxElapsed:" << lastHeartbeatAge << "** NEW MAX ELAPSED **" << "maxElapsedAverage:" << _maxElapsedAverage << "samples:" << _movingAverage.getSamples(); +#endif _maxElapsed = lastHeartbeatAge; } + +#if !defined(NDEBUG) if (elapsedMovingAverage > WARNING_ELAPSED_HEARTBEAT) { qCDebug(interfaceapp_deadlock) << "DEADLOCK WATCHDOG WARNING:" << "lastHeartbeatAge:" << lastHeartbeatAge @@ -470,6 +474,7 @@ public: << "maxElapsedAverage:" << _maxElapsedAverage << "samples:" << _movingAverage.getSamples(); } +#endif if (lastHeartbeatAge > MAX_HEARTBEAT_AGE_USECS) { qCDebug(interfaceapp_deadlock) << "DEADLOCK DETECTED -- " @@ -987,6 +992,7 @@ const bool DEFAULT_PREFER_STYLUS_OVER_LASER = false; const bool DEFAULT_PREFER_AVATAR_FINGER_OVER_STYLUS = false; const QString DEFAULT_CURSOR_NAME = "DEFAULT"; const bool DEFAULT_MINI_TABLET_ENABLED = true; +const bool DEFAULT_AWAY_STATE_WHEN_FOCUS_LOST_IN_VR_ENABLED = true; QSharedPointer getOffscreenUI() { #if !defined(DISABLE_QML) @@ -1017,6 +1023,7 @@ Application::Application(int& argc, char** argv, QElapsedTimer& startupTimer, bo _preferStylusOverLaserSetting("preferStylusOverLaser", DEFAULT_PREFER_STYLUS_OVER_LASER), _preferAvatarFingerOverStylusSetting("preferAvatarFingerOverStylus", DEFAULT_PREFER_AVATAR_FINGER_OVER_STYLUS), _constrainToolbarPosition("toolbar/constrainToolbarToCenterX", true), + _awayStateWhenFocusLostInVREnabled("awayStateWhenFocusLostInVREnabled", DEFAULT_AWAY_STATE_WHEN_FOCUS_LOST_IN_VR_ENABLED), _preferredCursor("preferredCursor", DEFAULT_CURSOR_NAME), _miniTabletEnabledSetting("miniTabletEnabled", DEFAULT_MINI_TABLET_ENABLED), _scaleMirror(1.0f), @@ -1069,6 +1076,14 @@ Application::Application(int& argc, char** argv, QElapsedTimer& startupTimer, bo } } + { + // identify gpu as early as possible to help identify OpenGL initialization errors. + auto gpuIdent = GPUIdent::getInstance(); + setCrashAnnotation("gpu_name", gpuIdent->getName().toStdString()); + setCrashAnnotation("gpu_driver", gpuIdent->getDriver().toStdString()); + setCrashAnnotation("gpu_memory", std::to_string(gpuIdent->getMemory())); + } + // make sure the debug draw singleton is initialized on the main thread. DebugDraw::getInstance().removeMarker(""); @@ -1130,6 +1145,18 @@ Application::Application(int& argc, char** argv, QElapsedTimer& startupTimer, bo auto deadlockWatchdogThread = new DeadlockWatchdogThread(); deadlockWatchdogThread->setMainThreadID(QThread::currentThreadId()); deadlockWatchdogThread->start(); + + + // Main thread timer to keep the watchdog updated + QTimer* watchdogUpdateTimer = new QTimer(this); + connect(watchdogUpdateTimer, &QTimer::timeout, [this] { updateHeartbeat(); }); + connect(this, &QCoreApplication::aboutToQuit, [watchdogUpdateTimer] { + watchdogUpdateTimer->stop(); + watchdogUpdateTimer->deleteLater(); + }); + watchdogUpdateTimer->setSingleShot(false); + watchdogUpdateTimer->setInterval(WATCHDOG_TIMER_TIMEOUT); // 100ms, Qt::CoarseTimer acceptable + watchdogUpdateTimer->start(); } // Set File Logger Session UUID @@ -1280,8 +1307,8 @@ Application::Application(int& argc, char** argv, QElapsedTimer& startupTimer, bo connect(nodeList.data(), &NodeList::packetVersionMismatch, this, &Application::notifyPacketVersionMismatch); // you might think we could just do this in NodeList but we only want this connection for Interface - connect(&nodeList->getDomainHandler(), SIGNAL(limitOfSilentDomainCheckInsReached()), - nodeList.data(), SLOT(reset())); + connect(&nodeList->getDomainHandler(), &DomainHandler::limitOfSilentDomainCheckInsReached, + nodeList.data(), [nodeList]() {nodeList->reset("Domain checkin limit"); }); auto dialogsManager = DependencyManager::get(); #if defined(Q_OS_ANDROID) @@ -2688,7 +2715,7 @@ void Application::cleanupBeforeQuit() { auto nodeList = DependencyManager::get(); // send the domain a disconnect packet, force stoppage of domain-server check-ins - nodeList->getDomainHandler().disconnect(); + nodeList->getDomainHandler().disconnect("Quitting"); nodeList->setIsShuttingDown(true); // tell the packet receiver we're shutting down, so it can drop packets @@ -2782,21 +2809,15 @@ Application::~Application() { // remove avatars from physics engine auto avatarManager = DependencyManager::get(); avatarManager->clearOtherAvatars(); + auto myCharacterController = getMyAvatar()->getCharacterController(); + myCharacterController->clearDetailedMotionStates(); PhysicsEngine::Transaction transaction; avatarManager->buildPhysicsTransaction(transaction); _physicsEngine->processTransaction(transaction); avatarManager->handleProcessedPhysicsTransaction(transaction); - avatarManager->deleteAllAvatars(); - auto myCharacterController = getMyAvatar()->getCharacterController(); - myCharacterController->clearDetailedMotionStates(); - - myCharacterController->buildPhysicsTransaction(transaction); - _physicsEngine->processTransaction(transaction); - myCharacterController->handleProcessedPhysicsTransaction(transaction); - _physicsEngine->setCharacterController(nullptr); // the _shapeManager should have zero references @@ -3015,7 +3036,7 @@ void Application::initializeDisplayPlugins() { void Application::initializeRenderEngine() { // FIXME: on low end systems os the shaders take up to 1 minute to compile, so we pause the deadlock watchdog thread. DeadlockWatchdogThread::withPause([&] { - _graphicsEngine.initializeRender(DISABLE_DEFERRED); + _graphicsEngine.initializeRender(); DependencyManager::get()->registerKeyboardHighlighting(); }); } @@ -3630,6 +3651,11 @@ void Application::setSettingConstrainToolbarPosition(bool setting) { getOffscreenUI()->setConstrainToolbarToCenterX(setting); } +void Application::setAwayStateWhenFocusLostInVREnabled(bool enabled) { + _awayStateWhenFocusLostInVREnabled.set(enabled); + emit awayStateWhenFocusLostInVRChanged(enabled); +} + void Application::setMiniTabletEnabled(bool enabled) { _miniTabletEnabledSetting.set(enabled); emit miniTabletEnabledChanged(enabled); @@ -4988,9 +5014,6 @@ void setupCpuMonitorThread() { void Application::idle() { PerformanceTimer perfTimer("idle"); - // Update the deadlock watchdog - updateHeartbeat(); - #if !defined(DISABLE_QML) auto offscreenUi = getOffscreenUI(); @@ -5537,7 +5560,7 @@ void Application::pauseUntilLoginDetermined() { cameraModeChanged(); // disconnect domain handler. - nodeList->getDomainHandler().disconnect(); + nodeList->getDomainHandler().disconnect("Pause until login determined"); // From now on, it's permissible to call resumeAfterLoginDialogActionTaken() _resumeAfterLoginDialogActionTaken_SafeToRun = true; @@ -5917,7 +5940,7 @@ void Application::reloadResourceCaches() { DependencyManager::get()->refreshAll(); DependencyManager::get()->refreshAll(); - DependencyManager::get()->reset(); // Force redownload of .fst models + DependencyManager::get()->reset("Reloading resources"); // Force redownload of .fst models DependencyManager::get()->reloadAllScripts(); getOffscreenUI()->clearCache(); @@ -6406,64 +6429,42 @@ void Application::update(float deltaTime) { PROFILE_RANGE(simulation_physics, "Simulation"); PerformanceTimer perfTimer("simulation"); - if (_physicsEnabled) { - auto t0 = std::chrono::high_resolution_clock::now(); - auto t1 = t0; + getEntities()->preUpdate(); + + auto t0 = std::chrono::high_resolution_clock::now(); + auto t1 = t0; + { + PROFILE_RANGE(simulation_physics, "PrePhysics"); + PerformanceTimer perfTimer("prePhysics)"); { - PROFILE_RANGE(simulation_physics, "PrePhysics"); - PerformanceTimer perfTimer("prePhysics)"); - { - PROFILE_RANGE(simulation_physics, "RemoveEntities"); - const VectorOfMotionStates& motionStates = _entitySimulation->getObjectsToRemoveFromPhysics(); - { - PROFILE_RANGE_EX(simulation_physics, "NumObjs", 0xffff0000, (uint64_t)motionStates.size()); - _physicsEngine->removeObjects(motionStates); - } - _entitySimulation->deleteObjectsRemovedFromPhysics(); - } + PROFILE_RANGE(simulation_physics, "Entities"); + PhysicsEngine::Transaction transaction; + _entitySimulation->buildPhysicsTransaction(transaction); + _physicsEngine->processTransaction(transaction); + _entitySimulation->handleProcessedPhysicsTransaction(transaction); + } - { - PROFILE_RANGE(simulation_physics, "AddEntities"); - VectorOfMotionStates motionStates; - getEntities()->getTree()->withReadLock([&] { - _entitySimulation->getObjectsToAddToPhysics(motionStates); - PROFILE_RANGE_EX(simulation_physics, "NumObjs", 0xffff0000, (uint64_t)motionStates.size()); - _physicsEngine->addObjects(motionStates); - }); - } - { - VectorOfMotionStates motionStates; - PROFILE_RANGE(simulation_physics, "ChangeEntities"); - getEntities()->getTree()->withReadLock([&] { - _entitySimulation->getObjectsToChange(motionStates); - VectorOfMotionStates stillNeedChange = _physicsEngine->changeObjects(motionStates); - _entitySimulation->setObjectsToChange(stillNeedChange); - }); - } + t1 = std::chrono::high_resolution_clock::now(); + { + PROFILE_RANGE(simulation_physics, "Avatars"); + PhysicsEngine::Transaction transaction; + avatarManager->buildPhysicsTransaction(transaction); + _physicsEngine->processTransaction(transaction); + avatarManager->handleProcessedPhysicsTransaction(transaction); + + myAvatar->prepareForPhysicsSimulation(); + _physicsEngine->enableGlobalContactAddedCallback(myAvatar->isFlying()); + } + } + + if (_physicsEnabled) { + { + PROFILE_RANGE(simulation_physics, "PrepareActions"); _entitySimulation->applyDynamicChanges(); - - t1 = std::chrono::high_resolution_clock::now(); - - { - PROFILE_RANGE(simulation_physics, "Avatars"); - PhysicsEngine::Transaction transaction; - avatarManager->buildPhysicsTransaction(transaction); - _physicsEngine->processTransaction(transaction); - avatarManager->handleProcessedPhysicsTransaction(transaction); - myAvatar->getCharacterController()->buildPhysicsTransaction(transaction); - _physicsEngine->processTransaction(transaction); - myAvatar->getCharacterController()->handleProcessedPhysicsTransaction(transaction); - myAvatar->prepareForPhysicsSimulation(); - _physicsEngine->enableGlobalContactAddedCallback(myAvatar->isFlying()); - } - - { - PROFILE_RANGE(simulation_physics, "PrepareActions"); - _physicsEngine->forEachDynamic([&](EntityDynamicPointer dynamic) { - dynamic->prepareForPhysicsSimulation(); - }); - } + _physicsEngine->forEachDynamic([&](EntityDynamicPointer dynamic) { + dynamic->prepareForPhysicsSimulation(); + }); } auto t2 = std::chrono::high_resolution_clock::now(); { @@ -6717,7 +6718,7 @@ void Application::updateRenderArgs(float deltaTime) { } appRenderArgs._renderArgs = RenderArgs(_graphicsEngine.getGPUContext(), lodManager->getOctreeSizeScale(), lodManager->getBoundaryLevelAdjust(), lodManager->getLODAngleHalfTan(), RenderArgs::DEFAULT_RENDER_MODE, - RenderArgs::MONO, RenderArgs::RENDER_DEBUG_NONE); + RenderArgs::MONO, RenderArgs::DEFERRED, RenderArgs::RENDER_DEBUG_NONE); appRenderArgs._renderArgs._scene = getMain3DScene(); { @@ -9390,7 +9391,7 @@ void Application::showUrlHandler(const QUrl& url) { void Application::beforeEnterBackground() { auto nodeList = DependencyManager::get(); nodeList->setSendDomainServerCheckInEnabled(false); - nodeList->reset(true); + nodeList->reset("Entering background", true); clearDomainOctreeDetails(); } diff --git a/interface/src/Application.h b/interface/src/Application.h index 300769b349..e64101d2fd 100644 --- a/interface/src/Application.h +++ b/interface/src/Application.h @@ -211,6 +211,8 @@ public: float getNumCollisionObjects() const; float getTargetRenderFrameRate() const; // frames/second + static void setupQmlSurface(QQmlContext* surfaceContext, bool setAdditionalContextProperties); + float getFieldOfView() { return _fieldOfView.get(); } void setFieldOfView(float fov); @@ -239,6 +241,9 @@ public: float getSettingConstrainToolbarPosition() { return _constrainToolbarPosition.get(); } void setSettingConstrainToolbarPosition(bool setting); + float getAwayStateWhenFocusLostInVREnabled() { return _awayStateWhenFocusLostInVREnabled.get(); } + void setAwayStateWhenFocusLostInVREnabled(bool setting); + Q_INVOKABLE void setMinimumGPUTextureMemStabilityCount(int stabilityCount) { _minimumGPUTextureMemSizeStabilityCount = stabilityCount; } NodeToOctreeSceneStats* getOcteeSceneStats() { return &_octreeServerSceneStats; } @@ -369,6 +374,7 @@ signals: void loginDialogFocusDisabled(); void miniTabletEnabledChanged(bool enabled); + void awayStateWhenFocusLostInVRChanged(bool enabled); public slots: QVector pasteEntities(float x, float y, float z); @@ -604,7 +610,6 @@ private: void maybeToggleMenuVisible(QMouseEvent* event) const; void toggleTabletUI(bool shouldOpen = false) const; - static void setupQmlSurface(QQmlContext* surfaceContext, bool setAdditionalContextProperties); void userKickConfirmation(const QUuid& nodeID); MainWindow* _window; @@ -672,6 +677,7 @@ private: Setting::Handle _preferStylusOverLaserSetting; Setting::Handle _preferAvatarFingerOverStylusSetting; Setting::Handle _constrainToolbarPosition; + Setting::Handle _awayStateWhenFocusLostInVREnabled; Setting::Handle _preferredCursor; Setting::Handle _miniTabletEnabledSetting; Setting::Handle _keepLogWindowOnTop { "keepLogWindowOnTop", false }; diff --git a/interface/src/FancyCamera.h b/interface/src/FancyCamera.h index aead54d0fd..0cfe147138 100644 --- a/interface/src/FancyCamera.h +++ b/interface/src/FancyCamera.h @@ -20,6 +20,7 @@ class FancyCamera : public Camera { /**jsdoc * The Camera API provides access to the "camera" that defines your view in desktop and HMD display modes. + * The High Fidelity camera has axes x = right, y = up, -z = forward. * * @namespace Camera * diff --git a/interface/src/SecondaryCamera.cpp b/interface/src/SecondaryCamera.cpp index da2874a3f4..704d7963e7 100644 --- a/interface/src/SecondaryCamera.cpp +++ b/interface/src/SecondaryCamera.cpp @@ -272,10 +272,10 @@ public: } }; -void SecondaryCameraRenderTask::build(JobModel& task, const render::Varying& inputs, render::Varying& outputs, render::CullFunctor cullFunctor, bool isDeferred) { +void SecondaryCameraRenderTask::build(JobModel& task, const render::Varying& inputs, render::Varying& outputs, render::CullFunctor cullFunctor) { const auto cachedArg = task.addJob("SecondaryCamera"); - task.addJob("RenderSecondView", cullFunctor, isDeferred, render::ItemKey::TAG_BITS_1, render::ItemKey::TAG_BITS_1); + task.addJob("RenderSecondView", cullFunctor, render::ItemKey::TAG_BITS_1, render::ItemKey::TAG_BITS_1); task.addJob("EndSecondaryCamera", cachedArg); } \ No newline at end of file diff --git a/interface/src/SecondaryCamera.h b/interface/src/SecondaryCamera.h index 941ccc5f93..463034527a 100644 --- a/interface/src/SecondaryCamera.h +++ b/interface/src/SecondaryCamera.h @@ -65,7 +65,7 @@ public: using JobModel = render::Task::Model; SecondaryCameraRenderTask() {} void configure(const Config& config) {} - void build(JobModel& task, const render::Varying& inputs, render::Varying& outputs, render::CullFunctor cullFunctor, bool isDeferred = true); + void build(JobModel& task, const render::Varying& inputs, render::Varying& outputs, render::CullFunctor cullFunctor); }; #endif diff --git a/interface/src/avatar/AvatarManager.cpp b/interface/src/avatar/AvatarManager.cpp index 00e743312f..df620b9a08 100755 --- a/interface/src/avatar/AvatarManager.cpp +++ b/interface/src/avatar/AvatarManager.cpp @@ -101,7 +101,7 @@ AvatarSharedPointer AvatarManager::addAvatar(const QUuid& sessionUUID, const QWe } AvatarManager::~AvatarManager() { - assert(_avatarsToChangeInPhysics.empty()); + assert(_otherAvatarsToChangeInPhysics.empty()); } void AvatarManager::init() { @@ -295,7 +295,7 @@ void AvatarManager::updateOtherAvatars(float deltaTime) { render::Transaction renderTransaction; workload::Transaction workloadTransaction; - + for (int p = kHero; p < NumVariants; p++) { auto& priorityQueue = avatarPriorityQueues[p]; // Sorting the current queue HERE as part of the measured timing. @@ -314,7 +314,7 @@ void AvatarManager::updateOtherAvatars(float deltaTime) { // remove the orb if it is there avatar->removeOrb(); if (avatar->needsPhysicsUpdate()) { - _avatarsToChangeInPhysics.insert(avatar); + _otherAvatarsToChangeInPhysics.insert(avatar); } } else { avatar->updateOrbPosition(); @@ -419,69 +419,111 @@ AvatarSharedPointer AvatarManager::newSharedAvatar(const QUuid& sessionUUID) { } void AvatarManager::queuePhysicsChange(const OtherAvatarPointer& avatar) { - _avatarsToChangeInPhysics.insert(avatar); + _otherAvatarsToChangeInPhysics.insert(avatar); +} + +DetailedMotionState* AvatarManager::createDetailedMotionState(OtherAvatarPointer avatar, int32_t jointIndex) { + bool isBound = false; + std::vector boundJoints; + const btCollisionShape* shape = avatar->createCollisionShape(jointIndex, isBound, boundJoints); + if (shape) { + DetailedMotionState* motionState = new DetailedMotionState(avatar, shape, jointIndex); + motionState->setMass(0.0f); // DetailedMotionState has KINEMATIC MotionType, so zero mass is ok + motionState->setIsBound(isBound, boundJoints); + return motionState; + } + return nullptr; +} + +void AvatarManager::rebuildAvatarPhysics(PhysicsEngine::Transaction& transaction, OtherAvatarPointer avatar) { + if (!avatar->_motionState) { + avatar->_motionState = new AvatarMotionState(avatar, nullptr); + } + AvatarMotionState* motionState = avatar->_motionState; + ShapeInfo shapeInfo; + avatar->computeShapeInfo(shapeInfo); + const btCollisionShape* shape = ObjectMotionState::getShapeManager()->getShape(shapeInfo); + assert(shape); + motionState->setShape(shape); + motionState->setMass(avatar->computeMass()); + if (motionState->getRigidBody()) { + transaction.objectsToReinsert.push_back(motionState); + } else { + transaction.objectsToAdd.push_back(motionState); + } + motionState->clearIncomingDirtyFlags(); + + // Rather than reconcile numbers of joints after change to model or LOD + // we blow away old detailedMotionStates and create anew all around. + + // delete old detailedMotionStates + auto& detailedMotionStates = avatar->getDetailedMotionStates(); + if (detailedMotionStates.size() != 0) { + for (auto& detailedMotionState : detailedMotionStates) { + transaction.objectsToRemove.push_back(detailedMotionState); + } + avatar->resetDetailedMotionStates(); + } + + // build new detailedMotionStates + OtherAvatar::BodyLOD lod = avatar->getBodyLOD(); + if (lod == OtherAvatar::BodyLOD::Sphere) { + auto dMotionState = createDetailedMotionState(avatar, -1); + if (dMotionState) { + detailedMotionStates.push_back(dMotionState); + transaction.objectsToAdd.push_back(dMotionState); + } + } else { + int32_t numJoints = avatar->getJointCount(); + for (int32_t i = 0; i < numJoints; i++) { + auto dMotionState = createDetailedMotionState(avatar, i); + if (dMotionState) { + detailedMotionStates.push_back(dMotionState); + transaction.objectsToAdd.push_back(dMotionState); + } + } + } + avatar->_needsReinsertion = false; } void AvatarManager::buildPhysicsTransaction(PhysicsEngine::Transaction& transaction) { - SetOfOtherAvatars failedShapeBuilds; - for (auto avatar : _avatarsToChangeInPhysics) { + _myAvatar->getCharacterController()->buildPhysicsTransaction(transaction); + for (auto avatar : _otherAvatarsToChangeInPhysics) { bool isInPhysics = avatar->isInPhysicsSimulation(); if (isInPhysics != avatar->shouldBeInPhysicsSimulation()) { if (isInPhysics) { transaction.objectsToRemove.push_back(avatar->_motionState); avatar->_motionState = nullptr; auto& detailedMotionStates = avatar->getDetailedMotionStates(); - for (auto& mState : detailedMotionStates) { - transaction.objectsToRemove.push_back(mState); + for (auto& motionState : detailedMotionStates) { + transaction.objectsToRemove.push_back(motionState); } avatar->resetDetailedMotionStates(); } else { - if (avatar->getDetailedMotionStates().size() == 0) { - avatar->createDetailedMotionStates(avatar); - for (auto dMotionState : avatar->getDetailedMotionStates()) { - transaction.objectsToAdd.push_back(dMotionState); - } - } - if (avatar->getDetailedMotionStates().size() > 0) { - ShapeInfo shapeInfo; - avatar->computeShapeInfo(shapeInfo); - btCollisionShape* shape = const_cast(ObjectMotionState::getShapeManager()->getShape(shapeInfo)); - if (shape) { - AvatarMotionState* motionState = new AvatarMotionState(avatar, shape); - motionState->setMass(avatar->computeMass()); - avatar->_motionState = motionState; - transaction.objectsToAdd.push_back(motionState); - } else { - failedShapeBuilds.insert(avatar); - } - } else { - failedShapeBuilds.insert(avatar); - } + rebuildAvatarPhysics(transaction, avatar); } } else if (isInPhysics) { - transaction.objectsToChange.push_back(avatar->_motionState); - - auto& detailedMotionStates = avatar->getDetailedMotionStates(); - for (auto& mState : detailedMotionStates) { - if (mState) { - transaction.objectsToChange.push_back(mState); - } + AvatarMotionState* motionState = avatar->_motionState; + uint32_t flags = motionState->getIncomingDirtyFlags(); + if (flags & EASY_DIRTY_PHYSICS_FLAGS) { + motionState->handleEasyChanges(flags); + } + // NOTE: we don't call detailedMotionState->handleEasyChanges() here because they are KINEMATIC + // and Bullet will automagically call DetailedMotionState::getWorldTransform() on all that are active. + + if (motionState->needsNewShape()) { + rebuildAvatarPhysics(transaction, avatar); + } else { + if (flags & (Simulation::DIRTY_MOTION_TYPE | Simulation::DIRTY_COLLISION_GROUP)) { + transaction.objectsToReinsert.push_back(motionState); + } + motionState->clearIncomingDirtyFlags(); } - } } - _avatarsToChangeInPhysics.swap(failedShapeBuilds); } void AvatarManager::handleProcessedPhysicsTransaction(PhysicsEngine::Transaction& transaction) { - // things on objectsToChange correspond to failed changes - // so we push them back onto _avatarsToChangeInPhysics - for (auto object : transaction.objectsToChange) { - AvatarMotionState* motionState = static_cast(object); - assert(motionState); - assert(motionState->_avatar); - _avatarsToChangeInPhysics.insert(motionState->_avatar); - } // things on objectsToRemove are ready for delete for (auto object : transaction.objectsToRemove) { delete object; @@ -490,13 +532,32 @@ void AvatarManager::handleProcessedPhysicsTransaction(PhysicsEngine::Transaction } void AvatarManager::removeDeadAvatarEntities(const SetOfEntities& deadEntities) { + auto treeRenderer = DependencyManager::get(); + EntityTreePointer entityTree = treeRenderer ? treeRenderer->getTree() : nullptr; for (auto entity : deadEntities) { - QUuid sessionID = entity->getOwningAvatarID(); - AvatarSharedPointer avatar = getAvatarBySessionID(sessionID); + QUuid entityOwnerID = entity->getOwningAvatarID(); + AvatarSharedPointer avatar = getAvatarBySessionID(entityOwnerID); + const bool REQUIRES_REMOVAL_FROM_TREE = false; if (avatar) { - const bool REQUIRES_REMOVAL_FROM_TREE = false; avatar->clearAvatarEntity(entity->getID(), REQUIRES_REMOVAL_FROM_TREE); } + if (entityTree && entity->isMyAvatarEntity()) { + entityTree->withWriteLock([&] { + // We only need to delete the direct children (rather than the descendants) because + // when the child is deleted, it will take care of its own children. If the child + // is also an avatar-entity, we'll end up back here. If it's not, the entity-server + // will take care of it in the usual way. + entity->forEachChild([&](SpatiallyNestablePointer child) { + EntityItemPointer childEntity = std::dynamic_pointer_cast(child); + if (childEntity) { + entityTree->deleteEntity(childEntity->getID(), true, true); + if (avatar) { + avatar->clearAvatarEntity(childEntity->getID(), REQUIRES_REMOVAL_FROM_TREE); + } + } + }); + }); + } } } @@ -536,14 +597,20 @@ void AvatarManager::handleRemovedAvatar(const AvatarSharedPointer& removedAvatar workload::SpacePointer space = _space; transaction.transitionFinishedOperator(avatar->getRenderItemID(), [space, avatar]() { - const render::ScenePointer& scene = qApp->getMain3DScene(); - render::Transaction transaction; - avatar->removeFromScene(avatar, scene, transaction); - scene->enqueueTransaction(transaction); + if (avatar->getLastFadeRequested() != render::Transition::Type::USER_LEAVE_DOMAIN) { + // The avatar is using another transition besides the fade-out transition, which means it is still in use. + // Deleting the avatar now could cause state issues, so abort deletion and show message. + qCWarning(interfaceapp) << "An ending fade-out transition wants to delete an avatar, but the avatar is still in use. Avatar deletion has aborted. (avatar ID: " << avatar->getSessionUUID() << ")"; + } else { + const render::ScenePointer& scene = qApp->getMain3DScene(); + render::Transaction transaction; + avatar->removeFromScene(avatar, scene, transaction); + scene->enqueueTransaction(transaction); - workload::Transaction workloadTransaction; - workloadTransaction.remove(avatar->getSpaceIndex()); - space->enqueueTransaction(workloadTransaction); + workload::Transaction workloadTransaction; + workloadTransaction.remove(avatar->getSpaceIndex()); + space->enqueueTransaction(workloadTransaction); + } }); scene->enqueueTransaction(transaction); } @@ -570,7 +637,7 @@ void AvatarManager::clearOtherAvatars() { ++avatarIterator; } } - } + } for (auto& av : removedAvatars) { handleRemovedAvatar(av); @@ -578,7 +645,7 @@ void AvatarManager::clearOtherAvatars() { } void AvatarManager::deleteAllAvatars() { - assert(_avatarsToChangeInPhysics.empty()); + assert(_otherAvatarsToChangeInPhysics.empty()); QReadLocker locker(&_hashLock); AvatarHash::iterator avatarIterator = _avatarHash.begin(); while (avatarIterator != _avatarHash.end()) { @@ -588,7 +655,7 @@ void AvatarManager::deleteAllAvatars() { if (avatar != _myAvatar) { auto otherAvatar = std::static_pointer_cast(avatar); assert(!otherAvatar->_motionState); - assert(otherAvatar->getDetailedMotionStates().size() == 0); + assert(otherAvatar->getDetailedMotionStates().size() == 0); } } } diff --git a/interface/src/avatar/AvatarManager.h b/interface/src/avatar/AvatarManager.h index 98deebe919..db1bc125a4 100644 --- a/interface/src/avatar/AvatarManager.h +++ b/interface/src/avatar/AvatarManager.h @@ -273,6 +273,8 @@ public slots: protected: AvatarSharedPointer addAvatar(const QUuid& sessionUUID, const QWeakPointer& mixerWeakPointer) override; + DetailedMotionState* createDetailedMotionState(OtherAvatarPointer avatar, int32_t jointIndex); + void rebuildAvatarPhysics(PhysicsEngine::Transaction& transaction, OtherAvatarPointer avatar); private: explicit AvatarManager(QObject* parent = 0); @@ -288,7 +290,7 @@ private: void handleTransitAnimations(AvatarTransit::Status status); using SetOfOtherAvatars = std::set; - SetOfOtherAvatars _avatarsToChangeInPhysics; + SetOfOtherAvatars _otherAvatarsToChangeInPhysics; std::shared_ptr _myAvatar; quint64 _lastSendAvatarDataTime = 0; // Controls MyAvatar send data rate. diff --git a/interface/src/avatar/AvatarMotionState.cpp b/interface/src/avatar/AvatarMotionState.cpp index 77fc81fa04..97085c8443 100755 --- a/interface/src/avatar/AvatarMotionState.cpp +++ b/interface/src/avatar/AvatarMotionState.cpp @@ -29,23 +29,19 @@ void AvatarMotionState::handleEasyChanges(uint32_t& flags) { } } -bool AvatarMotionState::handleHardAndEasyChanges(uint32_t& flags, PhysicsEngine* engine) { - return ObjectMotionState::handleHardAndEasyChanges(flags, engine); -} - AvatarMotionState::~AvatarMotionState() { assert(_avatar); _avatar = nullptr; } // virtual -uint32_t AvatarMotionState::getIncomingDirtyFlags() { +uint32_t AvatarMotionState::getIncomingDirtyFlags() const { return _body ? _dirtyFlags : 0; } -void AvatarMotionState::clearIncomingDirtyFlags() { +void AvatarMotionState::clearIncomingDirtyFlags(uint32_t mask) { if (_body) { - _dirtyFlags = 0; + _dirtyFlags &= ~mask; } } @@ -54,13 +50,6 @@ PhysicsMotionType AvatarMotionState::computePhysicsMotionType() const { return MOTION_TYPE_DYNAMIC; } -// virtual and protected -const btCollisionShape* AvatarMotionState::computeNewShape() { - ShapeInfo shapeInfo; - _avatar->computeShapeInfo(shapeInfo); - return getShapeManager()->getShape(shapeInfo); -} - // virtual bool AvatarMotionState::isMoving() const { return false; diff --git a/interface/src/avatar/AvatarMotionState.h b/interface/src/avatar/AvatarMotionState.h index 3103341622..a752d2c8fb 100644 --- a/interface/src/avatar/AvatarMotionState.h +++ b/interface/src/avatar/AvatarMotionState.h @@ -23,44 +23,44 @@ class AvatarMotionState : public ObjectMotionState { public: AvatarMotionState(OtherAvatarPointer avatar, const btCollisionShape* shape); - virtual void handleEasyChanges(uint32_t& flags) override; - virtual bool handleHardAndEasyChanges(uint32_t& flags, PhysicsEngine* engine) override; + void handleEasyChanges(uint32_t& flags) override; - virtual PhysicsMotionType getMotionType() const override { return _motionType; } + PhysicsMotionType getMotionType() const override { return _motionType; } - virtual uint32_t getIncomingDirtyFlags() override; - virtual void clearIncomingDirtyFlags() override; + uint32_t getIncomingDirtyFlags() const override; + void clearIncomingDirtyFlags(uint32_t mask = DIRTY_PHYSICS_FLAGS) override; - virtual PhysicsMotionType computePhysicsMotionType() const override; + PhysicsMotionType computePhysicsMotionType() const override; - virtual bool isMoving() const override; + bool isMoving() const override; // this relays incoming position/rotation to the RigidBody - virtual void getWorldTransform(btTransform& worldTrans) const override; + void getWorldTransform(btTransform& worldTrans) const override; // this relays outgoing position/rotation to the EntityItem - virtual void setWorldTransform(const btTransform& worldTrans) override; + void setWorldTransform(const btTransform& worldTrans) override; // These pure virtual methods must be implemented for each MotionState type // and make it possible to implement more complicated methods in this base class. // pure virtual overrides from ObjectMotionState - virtual float getObjectRestitution() const override; - virtual float getObjectFriction() const override; - virtual float getObjectLinearDamping() const override; - virtual float getObjectAngularDamping() const override; + float getObjectRestitution() const override; + float getObjectFriction() const override; + float getObjectLinearDamping() const override; + float getObjectAngularDamping() const override; - virtual glm::vec3 getObjectPosition() const override; - virtual glm::quat getObjectRotation() const override; - virtual glm::vec3 getObjectLinearVelocity() const override; - virtual glm::vec3 getObjectAngularVelocity() const override; - virtual glm::vec3 getObjectGravity() const override; + glm::vec3 getObjectPosition() const override; + glm::quat getObjectRotation() const override; + glm::vec3 getObjectLinearVelocity() const override; + glm::vec3 getObjectAngularVelocity() const override; + glm::vec3 getObjectGravity() const override; - virtual const QUuid getObjectID() const override; + const QUuid getObjectID() const override; - virtual QString getName() const override; - virtual QUuid getSimulatorID() const override; + QString getName() const override; + ShapeType getShapeType() const override { return SHAPE_TYPE_CAPSULE_Y; } + QUuid getSimulatorID() const override; void setBoundingBox(const glm::vec3& corner, const glm::vec3& diagonal); @@ -69,9 +69,9 @@ public: void setCollisionGroup(int32_t group) { _collisionGroup = group; } int32_t getCollisionGroup() { return _collisionGroup; } - virtual void computeCollisionGroupAndMask(int32_t& group, int32_t& mask) const override; + void computeCollisionGroupAndMask(int32_t& group, int32_t& mask) const override; - virtual float getMass() const override; + float getMass() const override; friend class AvatarManager; friend class Avatar; @@ -85,9 +85,6 @@ protected: // ever called by the Avatar class dtor. ~AvatarMotionState(); - virtual bool isReadyToComputeShape() const override { return true; } - virtual const btCollisionShape* computeNewShape() override; - OtherAvatarPointer _avatar; float _diameter { 0.0f }; int32_t _collisionGroup; diff --git a/interface/src/avatar/DetailedMotionState.cpp b/interface/src/avatar/DetailedMotionState.cpp index cec27108ca..02a2b9d425 100644 --- a/interface/src/avatar/DetailedMotionState.cpp +++ b/interface/src/avatar/DetailedMotionState.cpp @@ -17,7 +17,7 @@ #include "MyAvatar.h" -DetailedMotionState::DetailedMotionState(AvatarPointer avatar, const btCollisionShape* shape, int jointIndex) : +DetailedMotionState::DetailedMotionState(AvatarPointer avatar, const btCollisionShape* shape, int32_t jointIndex) : ObjectMotionState(shape), _avatar(avatar), _jointIndex(jointIndex) { assert(_avatar); if (!_avatar->isMyAvatar()) { @@ -33,47 +33,26 @@ void DetailedMotionState::handleEasyChanges(uint32_t& flags) { } } -bool DetailedMotionState::handleHardAndEasyChanges(uint32_t& flags, PhysicsEngine* engine) { - return ObjectMotionState::handleHardAndEasyChanges(flags, engine); -} - DetailedMotionState::~DetailedMotionState() { assert(_avatar); _avatar = nullptr; } // virtual -uint32_t DetailedMotionState::getIncomingDirtyFlags() { +uint32_t DetailedMotionState::getIncomingDirtyFlags() const { return _body ? _dirtyFlags : 0; } -void DetailedMotionState::clearIncomingDirtyFlags() { +void DetailedMotionState::clearIncomingDirtyFlags(uint32_t mask) { if (_body) { - _dirtyFlags = 0; + _dirtyFlags &= ~mask; } } PhysicsMotionType DetailedMotionState::computePhysicsMotionType() const { - // TODO?: support non-DYNAMIC motion for avatars? (e.g. when sitting) return MOTION_TYPE_KINEMATIC; } -// virtual and protected -const btCollisionShape* DetailedMotionState::computeNewShape() { - btCollisionShape* shape = nullptr; - if (!_avatar->isMyAvatar()) { - if (_otherAvatar != nullptr) { - shape = _otherAvatar->createCollisionShape(_jointIndex, _isBound, _boundJoints); - } - } else { - std::shared_ptr myAvatar = std::static_pointer_cast(_avatar); - if (myAvatar) { - shape = myAvatar->getCharacterController()->createDetailedCollisionShapeForJoint(_jointIndex); - } - } - return shape; -} - // virtual bool DetailedMotionState::isMoving() const { return false; @@ -178,11 +157,23 @@ void DetailedMotionState::setRigidBody(btRigidBody* body) { } void DetailedMotionState::setShape(const btCollisionShape* shape) { - ObjectMotionState::setShape(shape); + if (_shape != shape) { + if (_shape) { + getShapeManager()->releaseShape(_shape); + } + _shape = shape; + if (_body) { + assert(_shape); + _body->setCollisionShape(const_cast(_shape)); + } + } else if (shape) { + // we need to release unused reference to shape + getShapeManager()->releaseShape(shape); + } } void DetailedMotionState::forceActive() { if (_body && !_body->isActive()) { _body->setActivationState(ACTIVE_TAG); } -} \ No newline at end of file +} diff --git a/interface/src/avatar/DetailedMotionState.h b/interface/src/avatar/DetailedMotionState.h index a9b4b4bb64..de59f41310 100644 --- a/interface/src/avatar/DetailedMotionState.h +++ b/interface/src/avatar/DetailedMotionState.h @@ -23,55 +23,55 @@ class DetailedMotionState : public ObjectMotionState { public: DetailedMotionState(AvatarPointer avatar, const btCollisionShape* shape, int jointIndex); - virtual void handleEasyChanges(uint32_t& flags) override; - virtual bool handleHardAndEasyChanges(uint32_t& flags, PhysicsEngine* engine) override; + void handleEasyChanges(uint32_t& flags) override; - virtual PhysicsMotionType getMotionType() const override { return _motionType; } + PhysicsMotionType getMotionType() const override { return _motionType; } - virtual uint32_t getIncomingDirtyFlags() override; - virtual void clearIncomingDirtyFlags() override; + uint32_t getIncomingDirtyFlags() const override; + void clearIncomingDirtyFlags(uint32_t mask = DIRTY_PHYSICS_FLAGS) override; - virtual PhysicsMotionType computePhysicsMotionType() const override; + PhysicsMotionType computePhysicsMotionType() const override; - virtual bool isMoving() const override; + bool isMoving() const override; // this relays incoming position/rotation to the RigidBody - virtual void getWorldTransform(btTransform& worldTrans) const override; + void getWorldTransform(btTransform& worldTrans) const override; // this relays outgoing position/rotation to the EntityItem - virtual void setWorldTransform(const btTransform& worldTrans) override; + void setWorldTransform(const btTransform& worldTrans) override; // These pure virtual methods must be implemented for each MotionState type // and make it possible to implement more complicated methods in this base class. // pure virtual overrides from ObjectMotionState - virtual float getObjectRestitution() const override; - virtual float getObjectFriction() const override; - virtual float getObjectLinearDamping() const override; - virtual float getObjectAngularDamping() const override; + float getObjectRestitution() const override; + float getObjectFriction() const override; + float getObjectLinearDamping() const override; + float getObjectAngularDamping() const override; - virtual glm::vec3 getObjectPosition() const override; - virtual glm::quat getObjectRotation() const override; - virtual glm::vec3 getObjectLinearVelocity() const override; - virtual glm::vec3 getObjectAngularVelocity() const override; - virtual glm::vec3 getObjectGravity() const override; + glm::vec3 getObjectPosition() const override; + glm::quat getObjectRotation() const override; + glm::vec3 getObjectLinearVelocity() const override; + glm::vec3 getObjectAngularVelocity() const override; + glm::vec3 getObjectGravity() const override; - virtual const QUuid getObjectID() const override; + const QUuid getObjectID() const override; - virtual QString getName() const override; - virtual QUuid getSimulatorID() const override; + QString getName() const override; + ShapeType getShapeType() const override { return SHAPE_TYPE_HULL; } + QUuid getSimulatorID() const override; void addDirtyFlags(uint32_t flags) { _dirtyFlags |= flags; } - virtual void computeCollisionGroupAndMask(int32_t& group, int32_t& mask) const override; + void computeCollisionGroupAndMask(int32_t& group, int32_t& mask) const override; - virtual float getMass() const override; + float getMass() const override; void forceActive(); QUuid getAvatarID() const { return _avatar->getID(); } - int getJointIndex() const { return _jointIndex; } - void setIsBound(bool isBound, std::vector boundJoints) { _isBound = isBound; _boundJoints = boundJoints; } - bool getIsBound(std::vector& boundJoints) const { boundJoints = _boundJoints; return _isBound; } + int32_t getJointIndex() const { return _jointIndex; } + void setIsBound(bool isBound, const std::vector& boundJoints) { _isBound = isBound; _boundJoints = boundJoints; } + bool getIsBound(std::vector& boundJoints) const { boundJoints = _boundJoints; return _isBound; } friend class AvatarManager; friend class Avatar; @@ -84,17 +84,14 @@ protected: // ever called by the Avatar class dtor. ~DetailedMotionState(); - virtual bool isReadyToComputeShape() const override { return true; } - virtual const btCollisionShape* computeNewShape() override; - AvatarPointer _avatar; float _diameter { 0.0f }; uint32_t _dirtyFlags; - int _jointIndex { -1 }; + int32_t _jointIndex { -1 }; OtherAvatarPointer _otherAvatar { nullptr }; bool _isBound { false }; - std::vector _boundJoints; + std::vector _boundJoints; }; #endif // hifi_DetailedMotionState_h diff --git a/interface/src/avatar/MyAvatar.cpp b/interface/src/avatar/MyAvatar.cpp index e3fbbe12ad..39f2d9f332 100644 --- a/interface/src/avatar/MyAvatar.cpp +++ b/interface/src/avatar/MyAvatar.cpp @@ -3755,6 +3755,7 @@ void MyAvatar::restrictScaleFromDomainSettings(const QJsonObject& domainSettings void MyAvatar::leaveDomain() { clearScaleRestriction(); saveAvatarScale(); + prepareResetTraitInstances(); } void MyAvatar::saveAvatarScale() { diff --git a/interface/src/avatar/MyCharacterController.cpp b/interface/src/avatar/MyCharacterController.cpp index b0123abe8d..aef1bcd668 100755 --- a/interface/src/avatar/MyCharacterController.cpp +++ b/interface/src/avatar/MyCharacterController.cpp @@ -377,21 +377,18 @@ void MyCharacterController::updateMassProperties() { _rigidBody->setMassProps(mass, inertia); } -btCollisionShape* MyCharacterController::createDetailedCollisionShapeForJoint(int jointIndex) { +const btCollisionShape* MyCharacterController::createDetailedCollisionShapeForJoint(int32_t jointIndex) { ShapeInfo shapeInfo; _avatar->computeDetailedShapeInfo(shapeInfo, jointIndex); if (shapeInfo.getType() != SHAPE_TYPE_NONE) { - btCollisionShape* shape = const_cast(ObjectMotionState::getShapeManager()->getShape(shapeInfo)); - if (shape) { - shape->setMargin(0.001f); - } + const btCollisionShape* shape = ObjectMotionState::getShapeManager()->getShape(shapeInfo); return shape; } return nullptr; } -DetailedMotionState* MyCharacterController::createDetailedMotionStateForJoint(int jointIndex) { - auto shape = createDetailedCollisionShapeForJoint(jointIndex); +DetailedMotionState* MyCharacterController::createDetailedMotionStateForJoint(int32_t jointIndex) { + const btCollisionShape* shape = createDetailedCollisionShapeForJoint(jointIndex); if (shape) { DetailedMotionState* motionState = new DetailedMotionState(_avatar, shape, jointIndex); motionState->setMass(_avatar->computeMass()); @@ -423,25 +420,16 @@ void MyCharacterController::buildPhysicsTransaction(PhysicsEngine::Transaction& } if (_pendingFlags & PENDING_FLAG_ADD_DETAILED_TO_SIMULATION) { _pendingFlags &= ~PENDING_FLAG_ADD_DETAILED_TO_SIMULATION; - for (int i = 0; i < _avatar->getJointCount(); i++) { + for (int32_t i = 0; i < _avatar->getJointCount(); i++) { auto dMotionState = createDetailedMotionStateForJoint(i); if (dMotionState) { _detailedMotionStates.push_back(dMotionState); transaction.objectsToAdd.push_back(dMotionState); } } - } -} - -void MyCharacterController::handleProcessedPhysicsTransaction(PhysicsEngine::Transaction& transaction) { - // things on objectsToRemove are ready for delete - for (auto object : transaction.objectsToRemove) { - delete object; } - transaction.clear(); } - class DetailedRayResultCallback : public btCollisionWorld::AllHitsRayResultCallback { public: DetailedRayResultCallback() @@ -467,7 +455,7 @@ std::vector MyCharacterController::rayTe _dynamicsWorld->rayTest(origin, end, rayCallback); if (rayCallback.m_hitFractions.size() > 0) { foundAvatars.reserve(rayCallback.m_hitFractions.size()); - for (int i = 0; i < rayCallback.m_hitFractions.size(); i++) { + for (int32_t i = 0; i < rayCallback.m_hitFractions.size(); i++) { auto object = rayCallback.m_collisionObjects[i]; ObjectMotionState* motionState = static_cast(object->getUserPointer()); if (motionState && motionState->getType() == MOTIONSTATE_TYPE_DETAILED) { @@ -493,4 +481,4 @@ std::vector MyCharacterController::rayTe } } return foundAvatars; -} \ No newline at end of file +} diff --git a/interface/src/avatar/MyCharacterController.h b/interface/src/avatar/MyCharacterController.h index f861f82422..0b64f66850 100644 --- a/interface/src/avatar/MyCharacterController.h +++ b/interface/src/avatar/MyCharacterController.h @@ -44,27 +44,25 @@ public: void setDensity(btScalar density) { _density = density; } - btCollisionShape* createDetailedCollisionShapeForJoint(int jointIndex); - DetailedMotionState* createDetailedMotionStateForJoint(int jointIndex); + const btCollisionShape* createDetailedCollisionShapeForJoint(int32_t jointIndex); + DetailedMotionState* createDetailedMotionStateForJoint(int32_t jointIndex); std::vector& getDetailedMotionStates() { return _detailedMotionStates; } void clearDetailedMotionStates(); void resetDetailedMotionStates(); void buildPhysicsTransaction(PhysicsEngine::Transaction& transaction); - void handleProcessedPhysicsTransaction(PhysicsEngine::Transaction& transaction); - struct RayAvatarResult { bool _intersect { false }; bool _isBound { false }; QUuid _intersectWithAvatar; - int _intersectWithJoint { -1 }; + int32_t _intersectWithJoint { -1 }; float _distance { 0.0f }; float _maxDistance { 0.0f }; QVariantMap _extraInfo; glm::vec3 _intersectionPoint; glm::vec3 _intersectionNormal; - std::vector _boundJoints; + std::vector _boundJoints; }; std::vector rayTest(const btVector3& origin, const btVector3& direction, const btScalar& length, const QVector& jointsToExclude) const; diff --git a/interface/src/avatar/OtherAvatar.cpp b/interface/src/avatar/OtherAvatar.cpp index d8cfe8f107..107932d5ec 100755 --- a/interface/src/avatar/OtherAvatar.cpp +++ b/interface/src/avatar/OtherAvatar.cpp @@ -116,6 +116,8 @@ void OtherAvatar::updateSpaceProxy(workload::Transaction& transaction) const { int OtherAvatar::parseDataFromBuffer(const QByteArray& buffer) { int32_t bytesRead = Avatar::parseDataFromBuffer(buffer); for (size_t i = 0; i < _detailedMotionStates.size(); i++) { + // NOTE: we activate _detailedMotionStates is because they are KINEMATIC + // and Bullet will automagically call DetailedMotionState::getWorldTransform() when active. _detailedMotionStates[i]->forceActive(); } if (_moving && _motionState) { @@ -124,11 +126,11 @@ int OtherAvatar::parseDataFromBuffer(const QByteArray& buffer) { return bytesRead; } -btCollisionShape* OtherAvatar::createCollisionShape(int jointIndex, bool& isBound, std::vector& boundJoints) { +const btCollisionShape* OtherAvatar::createCollisionShape(int32_t jointIndex, bool& isBound, std::vector& boundJoints) { ShapeInfo shapeInfo; isBound = false; - QString jointName = ""; - if (jointIndex > -1 && jointIndex < (int)_multiSphereShapes.size()) { + QString jointName = ""; + if (jointIndex > -1 && jointIndex < (int32_t)_multiSphereShapes.size()) { jointName = _multiSphereShapes[jointIndex].getJointName(); } switch (_bodyLOD) { @@ -163,39 +165,21 @@ btCollisionShape* OtherAvatar::createCollisionShape(int jointIndex, bool& isBoun } break; } + // Note: MultiSphereLow case really means: "skip fingers and use spheres for hands, + // else fall through to MultiSphereHigh case" case BodyLOD::MultiSphereHigh: computeDetailedShapeInfo(shapeInfo, jointIndex); break; default: + assert(false); // should never reach here break; } - if (shapeInfo.getType() != SHAPE_TYPE_NONE) { - auto shape = const_cast(ObjectMotionState::getShapeManager()->getShape(shapeInfo)); - if (shape) { - shape->setMargin(0.001f); - } - return shape; - } - return nullptr; -} - -DetailedMotionState* OtherAvatar::createMotionState(std::shared_ptr avatar, int jointIndex) { - bool isBound = false; - std::vector boundJoints; - btCollisionShape* shape = createCollisionShape(jointIndex, isBound, boundJoints); - if (shape) { - DetailedMotionState* motionState = new DetailedMotionState(avatar, shape, jointIndex); - motionState->setMass(computeMass()); - motionState->setIsBound(isBound, boundJoints); - return motionState; - } - return nullptr; + return ObjectMotionState::getShapeManager()->getShape(shapeInfo); } void OtherAvatar::resetDetailedMotionStates() { - for (size_t i = 0; i < _detailedMotionStates.size(); i++) { - _detailedMotionStates[i] = nullptr; - } + // NOTE: the DetailedMotionStates are deleted after being added to PhysicsEngine::Transaction::_objectsToRemove + // See AvatarManager::handleProcessedPhysicsTransaction() _detailedMotionStates.clear(); } @@ -231,11 +215,11 @@ void OtherAvatar::computeShapeLOD() { } bool OtherAvatar::isInPhysicsSimulation() const { - return _motionState != nullptr && _detailedMotionStates.size() > 0; + return _motionState && _motionState->getRigidBody(); } bool OtherAvatar::shouldBeInPhysicsSimulation() const { - return !isDead() && !(isInPhysicsSimulation() && _needsReinsertion); + return !isDead() && _workloadRegion < workload::Region::R3; } bool OtherAvatar::needsPhysicsUpdate() const { @@ -245,12 +229,9 @@ bool OtherAvatar::needsPhysicsUpdate() const { void OtherAvatar::rebuildCollisionShape() { if (_motionState) { + // do not actually rebuild here, instead flag for later _motionState->addDirtyFlags(Simulation::DIRTY_SHAPE | Simulation::DIRTY_MASS); - } - for (size_t i = 0; i < _detailedMotionStates.size(); i++) { - if (_detailedMotionStates[i]) { - _detailedMotionStates[i]->addDirtyFlags(Simulation::DIRTY_SHAPE | Simulation::DIRTY_MASS); - } + _needsReinsertion = true; } } @@ -260,25 +241,6 @@ void OtherAvatar::setCollisionWithOtherAvatarsFlags() { } } -void OtherAvatar::createDetailedMotionStates(const std::shared_ptr& avatar) { - auto& detailedMotionStates = getDetailedMotionStates(); - assert(detailedMotionStates.empty()); - if (_bodyLOD == BodyLOD::Sphere) { - auto dMotionState = createMotionState(avatar, -1); - if (dMotionState) { - detailedMotionStates.push_back(dMotionState); - } - } else { - for (int i = 0; i < getJointCount(); i++) { - auto dMotionState = createMotionState(avatar, i); - if (dMotionState) { - detailedMotionStates.push_back(dMotionState); - } - } - } - _needsReinsertion = false; -} - void OtherAvatar::simulate(float deltaTime, bool inView) { PROFILE_RANGE(simulation, "simulate"); diff --git a/interface/src/avatar/OtherAvatar.h b/interface/src/avatar/OtherAvatar.h index 43bfd2a9ae..498971d6ee 100644 --- a/interface/src/avatar/OtherAvatar.h +++ b/interface/src/avatar/OtherAvatar.h @@ -52,9 +52,7 @@ public: bool shouldBeInPhysicsSimulation() const; bool needsPhysicsUpdate() const; - btCollisionShape* createCollisionShape(int jointIndex, bool& isBound, std::vector& boundJoints); - DetailedMotionState* createMotionState(std::shared_ptr avatar, int jointIndex); - void createDetailedMotionStates(const std::shared_ptr& avatar); + const btCollisionShape* createCollisionShape(int32_t jointIndex, bool& isBound, std::vector& boundJoints); std::vector& getDetailedMotionStates() { return _detailedMotionStates; } void resetDetailedMotionStates(); BodyLOD getBodyLOD() { return _bodyLOD; } diff --git a/interface/src/graphics/GraphicsEngine.cpp b/interface/src/graphics/GraphicsEngine.cpp index 267822baf2..4f8b86cc0c 100644 --- a/interface/src/graphics/GraphicsEngine.cpp +++ b/interface/src/graphics/GraphicsEngine.cpp @@ -65,15 +65,15 @@ void GraphicsEngine::initializeGPU(GLWidget* glwidget) { DependencyManager::get()->setGPUContext(_gpuContext); } -void GraphicsEngine::initializeRender(bool disableDeferred) { +void GraphicsEngine::initializeRender() { // Set up the render engine render::CullFunctor cullFunctor = LODManager::shouldRender; _renderEngine->addJob("UpdateScene"); #ifndef Q_OS_ANDROID - _renderEngine->addJob("SecondaryCameraJob", cullFunctor, !disableDeferred); + _renderEngine->addJob("SecondaryCameraJob", cullFunctor); #endif - _renderEngine->addJob("RenderMainView", cullFunctor, !disableDeferred, render::ItemKey::TAG_BITS_0, render::ItemKey::TAG_BITS_0); + _renderEngine->addJob("RenderMainView", cullFunctor, render::ItemKey::TAG_BITS_0, render::ItemKey::TAG_BITS_0); _renderEngine->load(); _renderEngine->registerScene(_renderScene); diff --git a/interface/src/graphics/GraphicsEngine.h b/interface/src/graphics/GraphicsEngine.h index f0b88d2459..dccb098d5e 100644 --- a/interface/src/graphics/GraphicsEngine.h +++ b/interface/src/graphics/GraphicsEngine.h @@ -44,7 +44,7 @@ public: ~GraphicsEngine(); void initializeGPU(GLWidget*); - void initializeRender(bool disableDeferred); + void initializeRender(); void startup(); void shutdown(); diff --git a/interface/src/graphics/WorldBox.cpp b/interface/src/graphics/WorldBox.cpp index 908055e9c6..a28850207f 100644 --- a/interface/src/graphics/WorldBox.cpp +++ b/interface/src/graphics/WorldBox.cpp @@ -22,7 +22,7 @@ namespace render { PerformanceTimer perfTimer("worldBox"); auto& batch = *args->_batch; - DependencyManager::get()->bindSimpleProgram(batch); + DependencyManager::get()->bindSimpleProgram(batch, false, false, true, false, false, true, args->_renderMethod == Args::RenderMethod::FORWARD); WorldBoxRenderData::renderWorldBox(args, batch); } } diff --git a/interface/src/main.cpp b/interface/src/main.cpp index b2be010544..11054d25d0 100644 --- a/interface/src/main.cpp +++ b/interface/src/main.cpp @@ -53,6 +53,15 @@ int main(int argc, const char* argv[]) { // https://i.kym-cdn.com/entries/icons/original/000/008/342/ihave.jpg QSurfaceFormat::setDefaultFormat(format); #endif + +#if defined(Q_OS_WIN) + // Check the minimum version of + if (gl::getAvailableVersion() < gl::getRequiredVersion()) { + MessageBoxA(nullptr, "Interface requires OpenGL 4.1 or higher", "Unsupported", MB_OK); + return -1; + } +#endif + setupHifiApplication(BuildInfo::INTERFACE_NAME); QStringList arguments; diff --git a/interface/src/octree/SafeLanding.cpp b/interface/src/octree/SafeLanding.cpp index e56ca984e0..479c2a5860 100644 --- a/interface/src/octree/SafeLanding.cpp +++ b/interface/src/octree/SafeLanding.cpp @@ -168,7 +168,7 @@ bool isEntityPhysicsReady(const EntityItemPointer& entity) { bool hasAABox; entity->getAABox(hasAABox); if (hasAABox && downloadedCollisionTypes.count(modelEntity->getShapeType()) != 0) { - return (!entity->shouldBePhysical() || entity->isReadyToComputeShape() || modelEntity->computeShapeFailedToLoad()); + return (!entity->shouldBePhysical() || entity->isInPhysicsSimulation() || modelEntity->computeShapeFailedToLoad()); } } } diff --git a/interface/src/raypick/CollisionPick.cpp b/interface/src/raypick/CollisionPick.cpp index 82d75257df..83ed61030e 100644 --- a/interface/src/raypick/CollisionPick.cpp +++ b/interface/src/raypick/CollisionPick.cpp @@ -57,6 +57,37 @@ void buildObjectIntersectionsMap(IntersectionType intersectionType, const std::v } } +/**jsdoc + * An intersection result for a collision pick. + * + * @typedef {object} CollisionPickResult + * @property {boolean} intersects - true if there is at least one intersection, false if there isn't. + * @property {IntersectingObject[]} intersectingObjects - All objects which intersect with the collisionRegion. + * @property {CollisionRegion} collisionRegion - The collision region that was used. Valid even if there was no intersection. + */ + +/**jsdoc + * Information about a {@link CollisionPick}'s intersection with an object. + * + * @typedef {object} IntersectingObject + * @property {Uuid} id - The ID of the object. + * @property {IntersectionType} type - The type of the object, either 1 for INTERSECTED_ENTITY or 3 + * for INTERSECTED_AVATAR. + * @property {CollisionContact[]} collisionContacts - Information on the penetration between the pick and the object. + */ + +/**jsdoc + * A pair of points that represents part of an overlap between a {@link CollisionPick} and an object in the physics engine. + * Points which are further apart represent deeper overlap. + * + * @typedef {object} CollisionContact + * @property {Vec3} pointOnPick - A point representing a penetration of the object's surface into the volume of the pick, in + * world coordinates. + * @property {Vec3} pointOnObject - A point representing a penetration of the pick's surface into the volume of the object, in + * world coordinates. + * @property {Vec3} normalOnPick - The normal vector pointing away from the pick, representing the direction of collision. + */ + QVariantMap CollisionPickResult::toVariantMap() const { QVariantMap variantMap; diff --git a/interface/src/raypick/ParabolaPick.h b/interface/src/raypick/ParabolaPick.h index 0adbb01954..1175b2b246 100644 --- a/interface/src/raypick/ParabolaPick.h +++ b/interface/src/raypick/ParabolaPick.h @@ -42,6 +42,23 @@ public: float parabolicDistance { FLT_MAX }; bool intersects { false }; + /**jsdoc + * An intersection result for a parabola pick. + * + * @typedef {object} ParabolaPickResult + * @property {number} type - The intersection type. + * @property {boolean} intersects - true if there's a valid intersection, false if there isn't. + * @property {Uuid} objectID - The ID of the intersected object. null for HUD or invalid intersections. + * @property {number} distance - The distance from the parabola origin to the intersection point in a straight line. + * @property {number} parabolicDistance - The distance from the parabola origin to the intersection point along the arc of + * the parabola. + * @property {Vec3} intersection - The intersection point in world coordinates. + * @property {Vec3} surfaceNormal - The surface normal at the intersected point. All NaNs if type == + * Picks.INTERSECTED_HUD. + * @property {SubmeshIntersection} extraInfo - Additional intersection details for model objects, otherwise + * { }. + * @property {PickParabola} parabola - The pick parabola that was used. Valid even if there is no intersection. + */ virtual QVariantMap toVariantMap() const override { QVariantMap toReturn; toReturn["type"] = type; diff --git a/interface/src/raypick/ParabolaPointer.cpp b/interface/src/raypick/ParabolaPointer.cpp index 389f6ed286..23fc1cb4bd 100644 --- a/interface/src/raypick/ParabolaPointer.cpp +++ b/interface/src/raypick/ParabolaPointer.cpp @@ -20,8 +20,7 @@ const float ParabolaPointer::RenderState::ParabolaRenderItem::DEFAULT_PARABOLA_W const bool ParabolaPointer::RenderState::ParabolaRenderItem::DEFAULT_PARABOLA_ISVISIBLEINSECONDARYCAMERA { false }; const bool ParabolaPointer::RenderState::ParabolaRenderItem::DEFAULT_PARABOLA_DRAWINFRONT { false }; -gpu::PipelinePointer ParabolaPointer::RenderState::ParabolaRenderItem::_parabolaPipeline { nullptr }; -gpu::PipelinePointer ParabolaPointer::RenderState::ParabolaRenderItem::_transparentParabolaPipeline { nullptr }; +std::map, gpu::PipelinePointer> ParabolaPointer::RenderState::ParabolaRenderItem::_parabolaPipelines; ParabolaPointer::ParabolaPointer(const QVariant& rayProps, const RenderStateMap& renderStates, const DefaultRenderStateMap& defaultRenderStates, bool hover, const PointerTriggers& triggers, bool faceAvatar, bool followNormal, float followNormalStrength, bool centerEndY, bool lockEnd, bool distanceScaleEnd, @@ -401,33 +400,34 @@ void ParabolaPointer::RenderState::ParabolaRenderItem::updateBounds() { _bound = AABox(min, max - min); } -const gpu::PipelinePointer ParabolaPointer::RenderState::ParabolaRenderItem::getParabolaPipeline() { - if (!_parabolaPipeline || !_transparentParabolaPipeline) { - { - gpu::ShaderPointer program = gpu::Shader::createProgram(shader::render_utils::program::parabola); - auto state = std::make_shared(); +gpu::PipelinePointer ParabolaPointer::RenderState::ParabolaRenderItem::getParabolaPipeline(bool forward) const { + if (_parabolaPipelines.empty()) { + using namespace shader::render_utils::program; + + static const std::vector> keys = { + std::make_tuple(false, false, parabola), std::make_tuple(false, true, forward_parabola), std::make_tuple(true, false, parabola_translucent)/*, std::make_tuple(true, true, forward_parabola_translucent)*/ + }; + + for (auto& key : keys) { + gpu::StatePointer state = gpu::StatePointer(new gpu::State()); state->setDepthTest(true, true, gpu::LESS_EQUAL); - state->setBlendFunction(false, + if (std::get<0>(key)) { + PrepareStencil::testMask(*state); + } else { + PrepareStencil::testMaskDrawShape(*state); + } + state->setBlendFunction(std::get<0>(key), gpu::State::SRC_ALPHA, gpu::State::BLEND_OP_ADD, gpu::State::INV_SRC_ALPHA, gpu::State::FACTOR_ALPHA, gpu::State::BLEND_OP_ADD, gpu::State::ONE); - PrepareStencil::testMaskDrawShape(*state); state->setCullMode(gpu::State::CULL_NONE); - _parabolaPipeline = gpu::Pipeline::create(program, state); + + _parabolaPipelines[{std::get<0>(key), std::get<1>(key)}] = gpu::Pipeline::create(gpu::Shader::createProgram(std::get<2>(key)), state); } - { - gpu::ShaderPointer program = gpu::Shader::createProgram(shader::render_utils::program::parabola_translucent); - auto state = std::make_shared(); - state->setDepthTest(true, true, gpu::LESS_EQUAL); - state->setBlendFunction(true, - gpu::State::SRC_ALPHA, gpu::State::BLEND_OP_ADD, gpu::State::INV_SRC_ALPHA, - gpu::State::FACTOR_ALPHA, gpu::State::BLEND_OP_ADD, gpu::State::ONE); - PrepareStencil::testMask(*state); - state->setCullMode(gpu::State::CULL_NONE); - _transparentParabolaPipeline = gpu::Pipeline::create(program, state); - } + // The forward opaque/translucent pipelines are the same for now + _parabolaPipelines[{ true, true }] = _parabolaPipelines[{ false, true}]; } - return (_parabolaData.color.a < 1.0f ? _transparentParabolaPipeline : _parabolaPipeline); + return _parabolaPipelines[{ _parabolaData.color.a < 1.0f, forward }]; } void ParabolaPointer::RenderState::ParabolaRenderItem::render(RenderArgs* args) { @@ -441,7 +441,7 @@ void ParabolaPointer::RenderState::ParabolaRenderItem::render(RenderArgs* args) transform.setTranslation(_origin); batch.setModelTransform(transform); - batch.setPipeline(getParabolaPipeline()); + batch.setPipeline(getParabolaPipeline(args->_renderMethod == render::Args::RenderMethod::FORWARD)); const int MAX_SECTIONS = 100; if (glm::length2(_parabolaData.acceleration) < EPSILON) { diff --git a/interface/src/raypick/ParabolaPointer.h b/interface/src/raypick/ParabolaPointer.h index d4b705a7d2..94470971e6 100644 --- a/interface/src/raypick/ParabolaPointer.h +++ b/interface/src/raypick/ParabolaPointer.h @@ -26,9 +26,8 @@ public: bool isVisibleInSecondaryCamera, bool drawInFront, bool enabled); ~ParabolaRenderItem() {} - static gpu::PipelinePointer _parabolaPipeline; - static gpu::PipelinePointer _transparentParabolaPipeline; - const gpu::PipelinePointer getParabolaPipeline(); + static std::map, gpu::PipelinePointer> _parabolaPipelines; + gpu::PipelinePointer getParabolaPipeline(bool forward) const; void render(RenderArgs* args); render::Item::Bound& editBound() { return _bound; } diff --git a/interface/src/raypick/PickScriptingInterface.cpp b/interface/src/raypick/PickScriptingInterface.cpp index 09f4b68cb9..82d00d803f 100644 --- a/interface/src/raypick/PickScriptingInterface.cpp +++ b/interface/src/raypick/PickScriptingInterface.cpp @@ -55,23 +55,37 @@ PickFilter getPickFilter(unsigned int filter) { } /**jsdoc - * A set of properties that can be passed to {@link Picks.createPick} to create a new Ray Pick. + * A set of properties that can be passed to {@link Picks.createPick} when creating a new ray pick. + * * @typedef {object} Picks.RayPickProperties - * @property {boolean} [enabled=false] If this Pick should start enabled or not. Disabled Picks do not updated their pick results. - * @property {number} [filter=0] The filter for this Pick to use, constructed using filter flags combined using bitwise OR. - * @property {number} [maxDistance=0.0] The max distance at which this Pick will intersect. 0.0 = no max. < 0.0 is invalid. - * @property {Uuid} parentID - The ID of the parent, either an avatar, an entity, or a pick. - * @property {number} [parentJointIndex=0] - The joint of the parent to parent to, for example, the joints on the model of an avatar. (default = 0, no joint) - * @property {string} joint - If "Mouse," parents the pick to the mouse. If "Avatar," parents the pick to MyAvatar's head. Otherwise, parents to the joint of the given name on MyAvatar. - * @property {Vec3} [posOffset=Vec3.ZERO] Only for Joint Ray Picks. A local joint position offset, in meters. x = upward, y = forward, z = lateral - * @property {Vec3} [dirOffset=Vec3.UP] Only for Joint Ray Picks. A local joint direction offset. x = upward, y = forward, z = lateral - * @property {Vec3} [position] Only for Static Ray Picks. The world-space origin of the ray. - * @property {Vec3} [direction=-Vec3.UP] Only for Static Ray Picks. The world-space direction of the ray. + * @property {boolean} [enabled=false] - true if this pick should start enabled, false if it should + * start disabled. Disabled picks do not update their pick results. + * @property {FilterFlags} [filter=0] - The filter for this pick to use. Construct using {@link Picks} FilterFlags property + * values (e.g., Picks.PICK_DOMAIN_ENTTITIES) combined with | (bitwise OR) operators. + * @property {number} [maxDistance=0.0] - The maximum distance at which this pick will intersect. A value of 0.0 + * means no maximum. + * @property {Uuid} [parentID] - The ID of the parent: an avatar, an entity, or another pick. + * @property {number} [parentJointIndex=0] - The joint of the parent to parent to, for example, an avatar joint. + * A value of 0 means no joint.
+ * Used only if parentID is specified. + * @property {string} [joint] - "Mouse" parents the pick to the mouse; "Avatar" parents the pick to + * the user's avatar head; a joint name parents to the joint in the user's avatar; otherwise, the pick is "static", not + * parented to anything.
+ * Used only if parentID is not specified. + * @property {Vec3} [position=Vec3.ZERO] - The offset of the ray origin from its parent if parented, otherwise the ray origin + * in world coordinates. + * @property {Vec3} [posOffset] - Synonym for position. + * @property {Vec3} [direction] - The offset of the ray direction from its parent's y-axis if parented, otherwise the ray + * direction in world coordinates. + *

Default Value: Vec3.UP direction if joint is specified, otherwise + * -Vec3.UP.

+ * @property {Vec3} [dirOffset] - Synonym for direction. + * @property {Quat} [orientation] - Alternative property for specifying direction. The value is applied to the + * default direction value. */ unsigned int PickScriptingInterface::createRayPick(const QVariant& properties) { QVariantMap propMap = properties.toMap(); - #if defined (Q_OS_ANDROID) QString jointName { "" }; if (propMap["joint"].isValid()) { @@ -124,12 +138,20 @@ unsigned int PickScriptingInterface::createRayPick(const QVariant& properties) { } /**jsdoc - * A set of properties that can be passed to {@link Picks.createPick} to create a new Stylus Pick. + * A set of properties that can be passed to {@link Picks.createPick} when creating a new stylus pick. + * * @typedef {object} Picks.StylusPickProperties - * @property {number} [hand=-1] An integer. 0 == left, 1 == right. Invalid otherwise. - * @property {boolean} [enabled=false] If this Pick should start enabled or not. Disabled Picks do not updated their pick results. - * @property {number} [filter=0] The filter for this Pick to use, constructed using filter flags combined using bitwise OR. - * @property {number} [maxDistance=0.0] The max distance at which this Pick will intersect. 0.0 = no max. < 0.0 is invalid. + * @property {number} [hand=-1] 0 for the left hand, 1 for the right hand, invalid (-1) + * otherwise. + * @property {boolean} [enabled=false] - true if this pick should start enabled, false if it should + * start disabled. Disabled picks do not update their pick results. + * @property {number} [filter=0] - The filter for this pick to use. Construct using {@link Picks} FilterFlags property + * values (e.g., Picks.PICK_DOMAIN_ENTTITIES) combined with | (bitwise OR) operators. + *

Note: Stylus picks do not intersect avatars or the HUD.

+ * @property {number} [maxDistance=0.0] - The maximum distance at which this pick will intersect. A value of 0.0 + * means no maximum. + * @property {Vec3} [tipOffset=0,0.095,0] - The position of the stylus tip relative to the hand position at default avatar + * scale. */ unsigned int PickScriptingInterface::createStylusPick(const QVariant& properties) { QVariantMap propMap = properties.toMap(); @@ -167,23 +189,45 @@ unsigned int PickScriptingInterface::createStylusPick(const QVariant& properties // NOTE: Laser pointer still uses scaleWithAvatar. Until scaleWithAvatar is also deprecated for pointers, scaleWithAvatar should not be removed from the pick API. /**jsdoc - * A set of properties that can be passed to {@link Picks.createPick} to create a new Parabola Pick. + * A set of properties that can be passed to {@link Picks.createPick} when creating a new parabola pick. + * * @typedef {object} Picks.ParabolaPickProperties - * @property {boolean} [enabled=false] If this Pick should start enabled or not. Disabled Picks do not updated their pick results. - * @property {number} [filter=0] The filter for this Pick to use, constructed using filter flags combined using bitwise OR. - * @property {number} [maxDistance=0.0] The max distance at which this Pick will intersect. 0.0 = no max. < 0.0 is invalid. - * @property {Uuid} parentID - The ID of the parent, either an avatar, an entity, or a pick. - * @property {number} [parentJointIndex=0] - The joint of the parent to parent to, for example, the joints on the model of an avatar. (default = 0, no joint) - * @property {string} joint - If "Mouse," parents the pick to the mouse. If "Avatar," parents the pick to MyAvatar's head. Otherwise, parents to the joint of the given name on MyAvatar. - * @property {Vec3} [posOffset=Vec3.ZERO] Only for Joint Parabola Picks. A local joint position offset, in meters. x = upward, y = forward, z = lateral - * @property {Vec3} [dirOffset=Vec3.UP] Only for Joint Parabola Picks. A local joint direction offset. x = upward, y = forward, z = lateral - * @property {Vec3} [position] Only for Static Parabola Picks. The world-space origin of the parabola segment. - * @property {Vec3} [direction=-Vec3.FRONT] Only for Static Parabola Picks. The world-space direction of the parabola segment. - * @property {number} [speed=1] The initial speed of the parabola, i.e. the initial speed of the projectile whose trajectory defines the parabola. - * @property {Vec3} [accelerationAxis=-Vec3.UP] The acceleration of the parabola, i.e. the acceleration of the projectile whose trajectory defines the parabola, both magnitude and direction. - * @property {boolean} [rotateAccelerationWithAvatar=true] Whether or not the acceleration axis should rotate with the avatar's local Y axis. - * @property {boolean} [rotateAccelerationWithParent=false] Whether or not the acceleration axis should rotate with the parent's local Y axis, if available. - * @property {boolean} [scaleWithParent=true] If true, the velocity and acceleration of the Pick will scale linearly with the parent, if available. scaleWithAvatar is an alias but is deprecated. + * @property {boolean} [enabled=false] - true if this pick should start enabled, false if it should + * start disabled. Disabled picks do not update their pick results. + * @property {number} [filter=0] - The filter for this pick to use. Construct using {@link Picks} FilterFlags property + * values (e.g., Picks.PICK_DOMAIN_ENTTITIES) combined with | (bitwise OR) operators. + * @property {number} [maxDistance=0.0] - The maximum distance at which this pick will intersect. A value of 0.0 + * means no maximum. + * @property {Uuid} [parentID] - The ID of the parent: an avatar, an entity, or another pick. + * @property {number} [parentJointIndex=0] - The joint of the parent to parent to, for example, an avatar joint. + * A value of 0 means no joint.
+ * Used only if parentID is specified. + * @property {string} [joint] - "Mouse" parents the pick to the mouse; "Avatar" parents the pick to + * the user's avatar head; a joint name parents to the joint in the user's avatar; otherwise, the pick is "static", not + * parented to anything. + * Used only if parentID is not specified. + * @property {Vec3} [position=Vec3.ZERO] - The offset of the parabola origin from its parent if parented, otherwise the + * parabola origin in world coordinates. + * @property {Vec3} [posOffset] - Synonym for position. + * @property {Vec3} [direction] - The offset of the parabola direction from its parent's y-axis if parented, otherwise the + * parabola direction in world coordinates. + *

Default Value: Vec3.UP direction if joint is specified, otherwise + * Vec3.FRONT.

+ * @property {Vec3} [dirOffset] - Synonym for direction. + * @property {Quat} [orientation] - Alternative property for specifying direction. The value is applied to the + * default direction value. + * @property {number} [speed=1] - The initial speed of the parabola in m/s, i.e., the initial speed of a virtual projectile + * whose trajectory defines the parabola. + * @property {Vec3} [accelerationAxis=-Vec3.UP] - The acceleration of the parabola in m/s2, i.e., the acceleration + * of a virtual projectile whose trajectory defines the parabola, both magnitude and direction. + * @property {boolean} [rotateAccelerationWithAvatar=true] - true if the acceleration axis should rotate with the + * avatar about the avatar's y-axis, false if it shouldn't. + * @property {boolean} [rotateAccelerationWithParent=false] - true if the acceleration axis should rotate with the + * parent about the parent's y-axis, if available. + * @property {boolean} [scaleWithParent=true] - true if the velocity and acceleration of the pick should scale + * with the avatar or other parent. + * @property {boolean} [scaleWithAvatar=true] - Synonym for scalewithParent. + *

Deprecated: This property is deprecated and will be removed.

*/ unsigned int PickScriptingInterface::createParabolaPick(const QVariant& properties) { QVariantMap propMap = properties.toMap(); @@ -251,35 +295,38 @@ unsigned int PickScriptingInterface::createParabolaPick(const QVariant& properti return DependencyManager::get()->addPick(PickQuery::Parabola, parabolaPick); } -/**jsdoc -* A Shape defines a physical volume. -* -* @typedef {object} Shape -* @property {string} shapeType The type of shape to use. Can be one of the following: "box", "sphere", "capsule-x", "capsule-y", "capsule-z", "cylinder-x", "cylinder-y", "cylinder-z" -* @property {Vec3} dimensions - The size to scale the shape to. -*/ - -// TODO: Add this property to the Shape jsdoc above once model picks work properly -// * @property {string} modelURL - If shapeType is one of: "compound", "simple-hull", "simple-compound", or "static-mesh", this defines the model to load to generate the collision volume. /**jsdoc -* A set of properties that can be passed to {@link Picks.createPick} to create a new Collision Pick. - -* @typedef {object} Picks.CollisionPickProperties -* @property {boolean} [enabled=false] If this Pick should start enabled or not. Disabled Picks do not updated their pick results. -* @property {number} [filter=0] The filter for this Pick to use, constructed using filter flags combined using bitwise OR. -* @property {Shape} shape - The information about the collision region's size and shape. Dimensions are in world space, but will scale with the parent if defined. -* @property {Vec3} position - The position of the collision region, relative to a parent if defined. -* @property {Quat} orientation - The orientation of the collision region, relative to a parent if defined. -* @property {float} threshold - The approximate minimum penetration depth for a test object to be considered in contact with the collision region. -* The depth is measured in world space, but will scale with the parent if defined. -* @property {CollisionMask} [collisionGroup=8] - The type of object this collision pick collides as. Objects whose collision masks overlap with the pick's collision group -* will be considered colliding with the pick. -* @property {Uuid} parentID - The ID of the parent, either an avatar, an entity, or a pick. -* @property {number} [parentJointIndex=0] - The joint of the parent to parent to, for example, the joints on the model of an avatar. (default = 0, no joint) -* @property {string} joint - If "Mouse," parents the pick to the mouse. If "Avatar," parents the pick to MyAvatar's head. Otherwise, parents to the joint of the given name on MyAvatar. -* @property {boolean} [scaleWithParent=true] If true, the collision pick's dimensions and threshold will adjust according to the scale of the parent. -*/ + * A set of properties that can be passed to {@link Picks.createPick} when creating a new collision pick. + * + * @typedef {object} Picks.CollisionPickProperties + * @property {boolean} [enabled=false] - true if this pick should start enabled, false if it should + * start disabled. Disabled picks do not update their pick results. + * @property {FilterFlags} [filter=0] - The filter for this pick to use. Construct using {@link Picks} FilterFlags property + * values (e.g., Picks.PICK_DOMAIN_ENTTITIES) combined with | (bitwise OR) operators. + *

Note: Collision picks do not intersect the HUD.

+ * @property {number} [maxDistance=0.0] - The maximum distance at which this pick will intersect. A value of 0.0 + * means no maximum. + * @property {Uuid} [parentID] - The ID of the parent: an avatar, an entity, or another pick. + * @property {number} [parentJointIndex=0] - The joint of the parent to parent to, for example, an avatar joint. + * A value of 0 means no joint.
+ * Used only if parentID is specified. + * @property {string} [joint] - "Mouse" parents the pick to the mouse; "Avatar" parents the pick to + * the user's avatar head; a joint name parents to the joint in the user's avatar; otherwise, the pick is "static", not + * parented to anything.
+ * Used only if parentID is not specified. + * @property {boolean} [scaleWithParent=true] - true to scale the pick's dimensions and threshold according to the + * scale of the parent. + * + * @property {Shape} shape - The collision region's shape and size. Dimensions are in world coordinates but scale with the + * parent if defined. + * @property {Vec3} position - The position of the collision region, relative to the parent if defined. + * @property {Quat} orientation - The orientation of the collision region, relative to the parent if defined. + * @property {number} threshold - The approximate minimum penetration depth for a test object to be considered in contact with + * the collision region. The depth is in world coordinates but scales with the parent if defined. + * @property {CollisionMask} [collisionGroup=8] - The type of objects the collision region collides as. Objects whose collision + * masks overlap with the region's collision group are considered to be colliding with the region. + */ unsigned int PickScriptingInterface::createCollisionPick(const QVariant& properties) { QVariantMap propMap = properties.toMap(); diff --git a/interface/src/raypick/PickScriptingInterface.h b/interface/src/raypick/PickScriptingInterface.h index 6264a3e258..1cbdaa92f7 100644 --- a/interface/src/raypick/PickScriptingInterface.h +++ b/interface/src/raypick/PickScriptingInterface.h @@ -17,7 +17,7 @@ #include /**jsdoc - * The Picks API lets you create and manage objects for repeatedly calculating intersections in different ways. + * The Picks API lets you create and manage objects for repeatedly calculating intersections. * * @namespace Picks * @@ -25,33 +25,45 @@ * @hifi-client-entity * @hifi-avatar * - * @property {number} PICK_ENTITIES A filter flag. Include domain and avatar entities when intersecting. Read-only.. Deprecated. - * @property {number} PICK_OVERLAYS A filter flag. Include local entities when intersecting. Read-only.. Deprecated. + * @property {FilterFlags} PICK_DOMAIN_ENTITIES - Include domain entities when intersecting. Read-only. + * @property {FilterFlags} PICK_AVATAR_ENTITIES - Include avatar entities when intersecting. Read-only. + * @property {FilterFlags} PICK_LOCAL_ENTITIES - Include local entities when intersecting. Read-only. + * @property {FilterFlags} PICK_AVATARS - Include avatars when intersecting. Read-only. + * @property {FilterFlags} PICK_HUD - Include the HUD sphere when intersecting in HMD mode. Read-only. * - * @property {number} PICK_DOMAIN_ENTITIES A filter flag. Include domain entities when intersecting. Read-only.. - * @property {number} PICK_AVATAR_ENTITIES A filter flag. Include avatar entities when intersecting. Read-only.. - * @property {number} PICK_LOCAL_ENTITIES A filter flag. Include local entities when intersecting. Read-only.. - * @property {number} PICK_AVATARS A filter flag. Include avatars when intersecting. Read-only.. - * @property {number} PICK_HUD A filter flag. Include the HUD sphere when intersecting in HMD mode. Read-only.. + * @property {FilterFlags} PICK_ENTITIES - Include domain and avatar entities when intersecting. Read-only. + *

Deprecated: This property is deprecated and will be removed. Use PICK_DOMAIN_ENTITIES | + * PICK_AVATAR_ENTITIES instead.

+ * @property {FilterFlags} PICK_OVERLAYS - Include local entities when intersecting. Read-only. + *

Deprecated: This property is deprecated and will be removed. Use PICK_LOCAL_ENTITIES + * instead.

* - * @property {number} PICK_INCLUDE_VISIBLE A filter flag. Include visible objects when intersecting. Read-only.. - * @property {number} PICK_INCLUDE_INVISIBLE A filter flag. Include invisible objects when intersecting. Read-only.. + * @property {FilterFlags} PICK_INCLUDE_VISIBLE - Include visible objects when intersecting. Read-only. + *

Warning: Is currently always enabled by default but may not be in the future.

+ * @property {FilterFlags} PICK_INCLUDE_INVISIBLE - Include invisible objects when intersecting. Read-only. * - * @property {number} PICK_INCLUDE_COLLIDABLE A filter flag. Include collidable objects when intersecting. Read-only.. - * @property {number} PICK_INCLUDE_NONCOLLIDABLE A filter flag. Include non-collidable objects when intersecting. Read-only.. + * @property {FilterFlags} PICK_INCLUDE_COLLIDABLE - Include collidable objects when intersecting. Read-only. + *

Warning: Is currently always enabled by default but may not be in the future.

+ * @property {FilterFlags} PICK_INCLUDE_NONCOLLIDABLE - Include non-collidable objects when intersecting. Read-only. * - * @property {number} PICK_PRECISE A filter flag. Pick against exact meshes. Read-only.. - * @property {number} PICK_COARSE A filter flag. Pick against coarse meshes. Read-only.. + * @property {FilterFlags} PICK_PRECISE - Pick against exact meshes. Read-only. + * @property {FilterFlags} PICK_COARSE - Pick against coarse meshes. Read-only. * - * @property {number} PICK_ALL_INTERSECTIONS Read-only.. + * @property {FilterFlags} PICK_ALL_INTERSECTIONS - If set, returns all intersections instead of just the closest. + * Read-only. + *

Warning: Not yet implemented.

* - * @property {number} INTERSECTED_NONE An intersection type. Intersected nothing with the given filter flags. Read-only. - * @property {number} INTERSECTED_ENTITY An intersection type. Intersected an entity. Read-only. - * @property {number} INTERSECTED_LOCAL_ENTITY An intersection type. Intersected a local entity. - * @property {number} INTERSECTED_OVERLAY An intersection type. Intersected an entity (3D Overlays no longer exist). Read-only. - * @property {number} INTERSECTED_AVATAR An intersection type. Intersected an avatar. Read-only. - * @property {number} INTERSECTED_HUD An intersection type. Intersected the HUD sphere. Read-only. - * @property {number} perFrameTimeBudget - The max number of usec to spend per frame updating Pick results. + * @property {IntersectionType} INTERSECTED_NONE - Intersected nothing. Read-only. + * @property {IntersectionType} INTERSECTED_ENTITY - Intersected an entity. Read-only. + * @property {IntersectionType} INTERSECTED_LOCAL_ENTITY - Intersected a local entity. Read-only. + * @property {IntersectionType} INTERSECTED_OVERLAY - Intersected a local entity. (3D overlays no longer exist.) + * Read-only. + *

Deprecated: This property is deprecated and will be removed. Use + * INTERSECTED_LOCAL_ENTITY instead.

+ * @property {IntersectionType} INTERSECTED_AVATAR - Intersected an avatar. Read-only. + * @property {IntersectionType} INTERSECTED_HUD - Intersected the HUD sphere. Read-only. + * + * @property {number} perFrameTimeBudget - The maximum time, in microseconds, to spend per frame updating pick results. */ class PickScriptingInterface : public QObject, public Dependency { @@ -94,163 +106,145 @@ public: void registerMetaTypes(QScriptEngine* engine); /**jsdoc - * Adds a new Pick. - * Different {@link PickType}s use different properties, and within one PickType, the properties you choose can lead to a wide range of behaviors. For example, - * with PickType.Ray, depending on which optional parameters you pass, you could create a Static Ray Pick, a Mouse Ray Pick, or a Joint Ray Pick. - * Picks created with this method always intersect at least visible and collidable things + * Creates a new pick. Different {@link PickType}s use different properties, and within one PickType the properties you + * choose can lead to a wide range of behaviors. For example, with PickType.Ray, the properties could + * configure a mouse ray pick, an avatar head ray pick, or a joint ray pick. + *

Warning: Picks created using this method currently always intersect at least visible and collidable + * things but this may not always be the case.

* @function Picks.createPick - * @param {PickType} type A PickType that specifies the method of picking to use - * @param {Picks.RayPickProperties|Picks.StylusPickProperties|Picks.ParabolaPickProperties|Picks.CollisionPickProperties} properties A PickProperties object, containing all the properties for initializing this Pick - * @returns {number} The ID of the created Pick. Used for managing the Pick. 0 if invalid. + * @param {PickType} type - The type of picking to use. + * @param {Picks.RayPickProperties|Picks.ParabolaPickProperties|Picks.StylusPickProperties|Picks.CollisionPickProperties} + * properties - Properties of the pick, per the pick type. + * @returns {number} The ID of the pick created. 0 if invalid. */ // TODO: expand Pointers to be able to be fully configurable with PickFilters Q_INVOKABLE unsigned int createPick(const PickQuery::PickType type, const QVariant& properties); /**jsdoc - * Enables a Pick. + * Enables a pick. Enabled picks update their pick results. * @function Picks.enablePick - * @param {number} uid The ID of the Pick, as returned by {@link Picks.createPick}. + * @param {number} id - The ID of the pick. */ Q_INVOKABLE void enablePick(unsigned int uid); /**jsdoc - * Disables a Pick. + * Disables a pick. Disabled picks do not update their pick results. * @function Picks.disablePick - * @param {number} uid The ID of the Pick, as returned by {@link Picks.createPick}. + * @param {number} id - The ID of the pick. */ Q_INVOKABLE void disablePick(unsigned int uid); /**jsdoc - * Removes a Pick. + * Removes (deletes) a pick. * @function Picks.removePick - * @param {number} uid The ID of the Pick, as returned by {@link Picks.createPick}. + * @param {number} id - The ID of the pick. */ Q_INVOKABLE void removePick(unsigned int uid); /**jsdoc - * An intersection result for a Ray Pick. - * - * @typedef {object} RayPickResult - * @property {number} type The intersection type. - * @property {boolean} intersects If there was a valid intersection (type != INTERSECTED_NONE) - * @property {Uuid} objectID The ID of the intersected object. Uuid.NULL for the HUD or invalid intersections. - * @property {number} distance The distance to the intersection point from the origin of the ray. - * @property {Vec3} intersection The intersection point in world-space. - * @property {Vec3} surfaceNormal The surface normal at the intersected point. All NANs if type == INTERSECTED_HUD. - * @property {Variant} extraInfo Additional intersection details when available for Model objects. - * @property {PickRay} searchRay The PickRay that was used. Valid even if there was no intersection. - */ - - /**jsdoc - * An intersection result for a Stylus Pick. - * - * @typedef {object} StylusPickResult - * @property {number} type The intersection type. - * @property {boolean} intersects If there was a valid intersection (type != INTERSECTED_NONE) - * @property {Uuid} objectID The ID of the intersected object. Uuid.NULL for the HUD or invalid intersections. - * @property {number} distance The distance to the intersection point from the origin of the ray. - * @property {Vec3} intersection The intersection point in world-space. - * @property {Vec3} surfaceNormal The surface normal at the intersected point. All NANs if type == INTERSECTED_HUD. - * @property {Variant} extraInfo Additional intersection details when available for Model objects. - * @property {StylusTip} stylusTip The StylusTip that was used. Valid even if there was no intersection. - */ - - /**jsdoc - * An intersection result for a Parabola Pick. - * - * @typedef {object} ParabolaPickResult - * @property {number} type The intersection type. - * @property {boolean} intersects If there was a valid intersection (type != INTERSECTED_NONE) - * @property {Uuid} objectID The ID of the intersected object. Uuid.NULL for the HUD or invalid intersections. - * @property {number} distance The distance to the intersection point from the origin of the parabola, not along the parabola. - * @property {number} parabolicDistance The distance to the intersection point from the origin of the parabola, along the parabola. - * @property {Vec3} intersection The intersection point in world-space. - * @property {Vec3} surfaceNormal The surface normal at the intersected point. All NANs if type == INTERSECTED_HUD. - * @property {Variant} extraInfo Additional intersection details when available for Model objects. - * @property {PickParabola} parabola The PickParabola that was used. Valid even if there was no intersection. - */ - - /**jsdoc - * An intersection result for a Collision Pick. - * - * @typedef {object} CollisionPickResult - * @property {boolean} intersects If there was at least one valid intersection (intersectingObjects.length > 0) - * @property {IntersectingObject[]} intersectingObjects The collision information of each object which intersect with the CollisionRegion. - * @property {CollisionRegion} collisionRegion The CollisionRegion that was used. Valid even if there was no intersection. - */ - - /**jsdoc - * Information about the Collision Pick's intersection with an object - * - * @typedef {object} IntersectingObject - * @property {QUuid} id The ID of the object. - * @property {number} type The type of the object, either Picks.INTERSECTED_ENTITY() or Picks.INTERSECTED_AVATAR() - * @property {CollisionContact[]} collisionContacts Pairs of points representing penetration information between the pick and the object - */ - - /**jsdoc - * A pair of points that represents part of an overlap between a Collision Pick and an object in the physics engine. Points which are further apart represent deeper overlap - * - * @typedef {object} CollisionContact - * @property {Vec3} pointOnPick A point representing a penetration of the object's surface into the volume of the pick, in world space. - * @property {Vec3} pointOnObject A point representing a penetration of the pick's surface into the volume of the found object, in world space. - * @property {Vec3} normalOnPick The normalized vector pointing away from the pick, representing the direction of collision. - */ - - /**jsdoc - * Get the most recent pick result from this Pick. This will be updated as long as the Pick is enabled. + * Gets the most recent result from a pick. A pick continues to be updated ready to return a result, as long as it is + * enabled. + *

Note: Stylus picks only intersect with objects in their include list, set using + * {@link Picks.setIncludeItems|setIncludeItems}.

* @function Picks.getPrevPickResult - * @param {number} uid The ID of the Pick, as returned by {@link Picks.createPick}. - * @returns {RayPickResult|StylusPickResult|ParabolaPickResult|CollisionPickResult} The most recent intersection result. This will be different for different PickTypes. + * @param {number} id - The ID of the pick. + * @returns {RayPickResult|ParabolaPickResult|StylusPickResult|CollisionPickResult} The most recent intersection result. + * @example Highlight entities under your mouse in desktop mode or that you're looking at in HMD mode. + * // Highlight. + * var HIGHLIGHT_LIST_NAME = "highlightEntitiesExampleList"; + * var HIGHLIGHT_LIST_TYPE = "entity"; + * Selection.enableListHighlight(HIGHLIGHT_LIST_NAME, {}); + * + * // Ray pick. + * var PICK_FILTER = Picks.PICK_DOMAIN_ENTITIES | Picks.PICK_AVATAR_ENTITIES + * | Picks.PICK_INCLUDE_COLLIDABLE | Picks.PICK_INCLUDE_NONCOLLIDABLE; + * var rayPick = Picks.createPick(PickType.Ray, { + * enabled: true, + * filter: PICK_FILTER, + * joint: HMD.active ? "Avatar" : "Mouse" + * }); + * + * // Highlight intersected entity. + * var highlightedEntityID = null; + * Script.update.connect(function () { + * var rayPickResult = Picks.getPrevPickResult(rayPick); + * if (rayPickResult.intersects) { + * if (rayPickResult.objectID !== highlightedEntityID) { + * if (highlightedEntityID) { + * Selection.removeFromSelectedItemsList(HIGHLIGHT_LIST_NAME, HIGHLIGHT_LIST_TYPE, highlightedEntityID); + * } + * highlightedEntityID = rayPickResult.objectID; + * Selection.addToSelectedItemsList(HIGHLIGHT_LIST_NAME, HIGHLIGHT_LIST_TYPE, highlightedEntityID); + * } + * } else { + * if (highlightedEntityID) { + * Selection.removeFromSelectedItemsList(HIGHLIGHT_LIST_NAME, HIGHLIGHT_LIST_TYPE, highlightedEntityID); + * highlightedEntityID = null; + * } + * } + * }); + * + * // Clean up. + * Script.scriptEnding.connect(function () { + * if (highlightedEntityID) { + * Selection.removeFromSelectedItemsList(HIGHLIGHT_LIST_NAME, HIGHLIGHT_LIST_TYPE, highlightedEntityID); + * } + * }); */ Q_INVOKABLE QVariantMap getPrevPickResult(unsigned int uid); /**jsdoc - * Sets whether or not to use precision picking. + * Sets whether or not to use precision picking, i.e., whether to pick against precise meshes or coarse meshes. + * This has the same effect as using the PICK_PRECISE or PICK_COARSE filter flags. * @function Picks.setPrecisionPicking - * @param {number} uid The ID of the Pick, as returned by {@link Picks.createPick}. - * @param {boolean} precisionPicking Whether or not to use precision picking + * @param {number} id - The ID of the pick. + * @param {boolean} precisionPicking - true to use precision picking, false to use coarse picking. */ Q_INVOKABLE void setPrecisionPicking(unsigned int uid, bool precisionPicking); /**jsdoc - * Sets a list of Entity IDs and/or Avatar IDs to ignore during intersection. Not used by Stylus Picks. + * Sets a list of entity and avatar IDs to ignore during intersection. + *

Note: Not used by stylus picks.

* @function Picks.setIgnoreItems - * @param {number} uid The ID of the Pick, as returned by {@link Picks.createPick}. - * @param {Uuid[]} ignoreItems A list of IDs to ignore. + * @param {number} id - The ID of the pick. + * @param {Uuid[]} ignoreItems - The list of IDs to ignore. */ Q_INVOKABLE void setIgnoreItems(unsigned int uid, const QScriptValue& ignoreItems); /**jsdoc - * Sets a list of Entity IDs and/or Avatar IDs to include during intersection, instead of intersecting with everything. Stylus - * Picks only intersect with objects in their include list. + * Sets a list of entity IDs and/or avatar IDs to include during intersection, instead of intersecting with everything. + *

Note: Stylus picks only intersect with objects in their include list.

* @function Picks.setIncludeItems - * @param {number} uid The ID of the Pick, as returned by {@link Picks.createPick}. - * @param {Uuid[]} includeItems A list of IDs to include. + * @param {number} id - The ID of the pick. + * @param {Uuid[]} includeItems - The list of IDs to include. */ Q_INVOKABLE void setIncludeItems(unsigned int uid, const QScriptValue& includeItems); /**jsdoc - * Check if a Pick is associated with the left hand. + * Checks if a pick is associated with the left hand: a ray or parabola pick with joint set to + * "_CONTROLLER_LEFTHAND" or "_CAMERA_RELATIVE_CONTROLLER_LEFTHAND", or a stylus pick with hand + * set to 0. * @function Picks.isLeftHand - * @param {number} uid The ID of the Pick, as returned by {@link Picks.createPick}. - * @returns {boolean} True if the Pick is a Joint Ray or Parabola Pick with joint == "_CONTROLLER_LEFTHAND" or "_CAMERA_RELATIVE_CONTROLLER_LEFTHAND", or a Stylus Pick with hand == 0. + * @param {number} id - The ID of the pick. + * @returns {boolean} true if the pick is associated with the left hand, false if it isn't. */ Q_INVOKABLE bool isLeftHand(unsigned int uid); /**jsdoc - * Check if a Pick is associated with the right hand. + * Checks if a pick is associated with the right hand: a ray or parabola pick with joint set to + * "_CONTROLLER_RIGHTHAND" or "_CAMERA_RELATIVE_CONTROLLER_RIGHTHAND", or a stylus pick with hand + * set to 1. * @function Picks.isRightHand - * @param {number} uid The ID of the Pick, as returned by {@link Picks.createPick}. - * @returns {boolean} True if the Pick is a Joint Ray or Parabola Pick with joint == "_CONTROLLER_RIGHTHAND" or "_CAMERA_RELATIVE_CONTROLLER_RIGHTHAND", or a Stylus Pick with hand == 1. + * @param {number} id - The ID of the pick. + * @returns {boolean} true if the pick is associated with the right hand, false if it isn't. */ Q_INVOKABLE bool isRightHand(unsigned int uid); /**jsdoc - * Check if a Pick is associated with the system mouse. + * Checks if a pick is associated with the system mouse: a ray or parabola pick with joint set to "Mouse". * @function Picks.isMouse - * @param {number} uid The ID of the Pick, as returned by {@link Picks.createPick}. - * @returns {boolean} True if the Pick is a Mouse Ray or Parabola Pick, false otherwise. + * @param {number} id - The ID of the pick. + * @returns {boolean} true if the pick is associated with the system mouse, false if it isn't. */ Q_INVOKABLE bool isMouse(unsigned int uid); @@ -261,112 +255,162 @@ public slots: /**jsdoc * @function Picks.PICK_ENTITIES + * @deprecated This function is deprecated and will be removed. Use the Picks.PICK_DOMAIN_ENTITIES | + * Picks.PICK_AVATAR_ENTITIES properties expression instead. * @returns {number} */ static constexpr unsigned int PICK_ENTITIES() { return PickFilter::getBitMask(PickFilter::FlagBit::DOMAIN_ENTITIES) | PickFilter::getBitMask(PickFilter::FlagBit::AVATAR_ENTITIES); } + /**jsdoc * @function Picks.PICK_OVERLAYS + * @deprecated This function is deprecated and will be removed. Use the Picks.PICK_LOCAL_ENTITIES property + * instead. * @returns {number} */ static constexpr unsigned int PICK_OVERLAYS() { return PickFilter::getBitMask(PickFilter::FlagBit::LOCAL_ENTITIES); } + /**jsdoc * @function Picks.PICK_DOMAIN_ENTITIES + * @deprecated This function is deprecated and will be removed. Use the Picks.PICK_DOMAIN_ENTITIES property + * instead. * @returns {number} */ static constexpr unsigned int PICK_DOMAIN_ENTITIES() { return PickFilter::getBitMask(PickFilter::FlagBit::DOMAIN_ENTITIES); } + /**jsdoc * @function Picks.PICK_AVATAR_ENTITIES + * @deprecated This function is deprecated and will be removed. Use the Picks.PICK_AVATAR_ENTITIES property + * instead. * @returns {number} */ static constexpr unsigned int PICK_AVATAR_ENTITIES() { return PickFilter::getBitMask(PickFilter::FlagBit::AVATAR_ENTITIES); } + /**jsdoc * @function Picks.PICK_LOCAL_ENTITIES + * @deprecated This function is deprecated and will be removed. Use the Picks.PICK_LOCAL_ENTITIES property + * instead. * @returns {number} */ static constexpr unsigned int PICK_LOCAL_ENTITIES() { return PickFilter::getBitMask(PickFilter::FlagBit::LOCAL_ENTITIES); } + /**jsdoc * @function Picks.PICK_AVATARS + * @deprecated This function is deprecated and will be removed. Use the Picks.PICK_AVATARS property + * instead. * @returns {number} */ static constexpr unsigned int PICK_AVATARS() { return PickFilter::getBitMask(PickFilter::FlagBit::AVATARS); } + /**jsdoc * @function Picks.PICK_HUD + * @deprecated This function is deprecated and will be removed. Use the Picks.PICK_HUD property instead. * @returns {number} */ static constexpr unsigned int PICK_HUD() { return PickFilter::getBitMask(PickFilter::FlagBit::HUD); } + /**jsdoc * @function Picks.PICK_INCLUDE_VISIBLE + * @deprecated This function is deprecated and will be removed. Use the Picks.PICK_INCLUDE_VISIBLE property + * instead. * @returns {number} */ static constexpr unsigned int PICK_INCLUDE_VISIBLE() { return PickFilter::getBitMask(PickFilter::FlagBit::VISIBLE); } + /**jsdoc * @function Picks.PICK_INCLUDE_INVISIBLE + * @deprecated This function is deprecated and will be removed. Use the Picks.PICK_INCLUDE_INVISIBLE property + * instead. * @returns {number} */ static constexpr unsigned int PICK_INCLUDE_INVISIBLE() { return PickFilter::getBitMask(PickFilter::FlagBit::INVISIBLE); } + /**jsdoc * @function Picks.PICK_INCLUDE_COLLIDABLE + * @deprecated This function is deprecated and will be removed. Use the Picks.PICK_INCLUDE_COLLIDABLE property + * instead. * @returns {number} */ static constexpr unsigned int PICK_INCLUDE_COLLIDABLE() { return PickFilter::getBitMask(PickFilter::FlagBit::COLLIDABLE); } + /**jsdoc * @function Picks.PICK_INCLUDE_NONCOLLIDABLE + * @deprecated This function is deprecated and will be removed. Use the Picks.PICK_INCLUDE_NONCOLLIDABLE + * property instead. * @returns {number} */ static constexpr unsigned int PICK_INCLUDE_NONCOLLIDABLE() { return PickFilter::getBitMask(PickFilter::FlagBit::NONCOLLIDABLE); } + /**jsdoc * @function Picks.PICK_PRECISE + * @deprecated This function is deprecated and will be removed. Use the Picks.PICK_PRECISE property instead. * @returns {number} */ static constexpr unsigned int PICK_PRECISE() { return PickFilter::getBitMask(PickFilter::FlagBit::PRECISE); } + /**jsdoc * @function Picks.PICK_COARSE + * @deprecated This function is deprecated and will be removed. Use the Picks.PICK_COARSE property instead. * @returns {number} */ static constexpr unsigned int PICK_COARSE() { return PickFilter::getBitMask(PickFilter::FlagBit::COARSE); } + /**jsdoc * @function Picks.PICK_ALL_INTERSECTIONS + * @deprecated This function is deprecated and will be removed. Use the Picks.PICK_ALL_INTERSECTIONS property + * instead. * @returns {number} */ static constexpr unsigned int PICK_ALL_INTERSECTIONS() { return PickFilter::getBitMask(PickFilter::FlagBit::PICK_ALL_INTERSECTIONS); } /**jsdoc * @function Picks.INTERSECTED_NONE + * @deprecated This function is deprecated and will be removed. Use the Picks.INTERSECTED_NONE property + * instead. * @returns {number} */ static constexpr unsigned int INTERSECTED_NONE() { return IntersectionType::NONE; } /**jsdoc * @function Picks.INTERSECTED_ENTITY + * @deprecated This function is deprecated and will be removed. Use the Picks.INTERSECTED_ENTITY property + * instead. * @returns {number} */ static constexpr unsigned int INTERSECTED_ENTITY() { return IntersectionType::ENTITY; } /**jsdoc - * @function Picks.INTERSECTED_OVERLAY + * @function Picks.INTERSECTED_LOCAL_ENTITY + * @deprecated This function is deprecated and will be removed. Use the Picks.INTERSECTED_LOCAL_ENTITY + * property instead. * @returns {number} */ static constexpr unsigned int INTERSECTED_LOCAL_ENTITY() { return IntersectionType::LOCAL_ENTITY; } /**jsdoc * @function Picks.INTERSECTED_OVERLAY + * @deprecated This function is deprecated and will be removed. Use the Picks.INTERSECTED_LOCAL_ENTITY + * property instead. * @returns {number} */ static constexpr unsigned int INTERSECTED_OVERLAY() { return INTERSECTED_LOCAL_ENTITY(); } /**jsdoc * @function Picks.INTERSECTED_AVATAR + * @deprecated This function is deprecated and will be removed. Use the Picks.INTERSECTED_AVATAR property + * instead. * @returns {number} */ static constexpr unsigned int INTERSECTED_AVATAR() { return IntersectionType::AVATAR; } /**jsdoc * @function Picks.INTERSECTED_HUD + * @deprecated This function is deprecated and will be removed. Use the Picks.INTERSECTED_HUD property + * instead. * @returns {number} */ static constexpr unsigned int INTERSECTED_HUD() { return IntersectionType::HUD; } diff --git a/interface/src/raypick/PointerScriptingInterface.h b/interface/src/raypick/PointerScriptingInterface.h index b04d15d888..268b178fb6 100644 --- a/interface/src/raypick/PointerScriptingInterface.h +++ b/interface/src/raypick/PointerScriptingInterface.h @@ -49,7 +49,7 @@ public: * with PickType.Ray, depending on which optional parameters you pass, you could create a Static Ray Pointer, a Mouse Ray Pointer, or a Joint Ray Pointer. * Pointers created with this method always intersect at least visible and collidable things * @function Pointers.createPointer - * @param {PickType} type A PickType that specifies the method of picking to use + * @param {PickType} type A PickType that specifies the method of picking to use. Cannot be {@link PickType|PickType.Collision}. * @param {Pointers.LaserPointerProperties|Pointers.StylusPointerProperties|Pointers.ParabolaPointerProperties} properties A PointerProperties object, containing all the properties for initializing this Pointer and the {@link Picks.PickProperties} for the Pick that * this Pointer will use to do its picking. * @returns {number} The ID of the created Pointer. Used for managing the Pointer. 0 if invalid. diff --git a/interface/src/raypick/RayPick.h b/interface/src/raypick/RayPick.h index 161c930fef..170a0489da 100644 --- a/interface/src/raypick/RayPick.h +++ b/interface/src/raypick/RayPick.h @@ -39,6 +39,21 @@ public: float distance { FLT_MAX }; bool intersects { false }; + /**jsdoc + * An intersection result for a ray pick. + * + * @typedef {object} RayPickResult + * @property {IntersectionType} type - The intersection type. + * @property {boolean} intersects - true if there's a valid intersection, false if there isn't. + * @property {Uuid} objectID - The ID of the intersected object. null for HUD or invalid intersections. + * @property {number} distance - The distance from the ray origin to the intersection point. + * @property {Vec3} intersection - The intersection point in world coordinates. + * @property {Vec3} surfaceNormal - The surface normal at the intersected point. All NaNs if type == + * Picks.INTERSECTED_HUD. + * @property {SubmeshIntersection} extraInfo - Additional intersection details for model objects, otherwise + * { }. + * @property {PickRay} searchRay - The pick ray that was used. Valid even if there is no intersection. + */ virtual QVariantMap toVariantMap() const override { QVariantMap toReturn; toReturn["type"] = type; diff --git a/interface/src/raypick/RayPickScriptingInterface.h b/interface/src/raypick/RayPickScriptingInterface.h index 64b21ea055..32a2ec4a5d 100644 --- a/interface/src/raypick/RayPickScriptingInterface.h +++ b/interface/src/raypick/RayPickScriptingInterface.h @@ -19,29 +19,32 @@ #include "PickScriptingInterface.h" /**jsdoc - * Synonym for {@link Picks} as used for ray picks. Deprecated. + * The RayPick API is a subset of the {@link Picks} API, as used for ray picks. * * @namespace RayPick * + * @deprecated This API is deprecated and will be removed. Use the {@link Picks} API instead. + * * @hifi-interface * @hifi-client-entity * @hifi-avatar * - * @property {number} PICK_ENTITIES Read-only. - * @property {number} PICK_OVERLAYS Read-only. - * @property {number} PICK_AVATARS Read-only. - * @property {number} PICK_HUD Read-only. - * @property {number} PICK_COARSE Read-only. - * @property {number} PICK_INCLUDE_INVISIBLE Read-only. - * @property {number} PICK_INCLUDE_NONCOLLIDABLE Read-only. - * @property {number} PICK_ALL_INTERSECTIONS Read-only. - * @property {number} INTERSECTED_NONE Read-only. - * @property {number} INTERSECTED_ENTITY Read-only. - * @property {number} INTERSECTED_OVERLAY Read-only. - * @property {number} INTERSECTED_AVATAR Read-only. - * @property {number} INTERSECTED_HUD Read-only. + * @property {FilterFlags} PICK_ENTITIES - Include domain and avatar entities when intersecting. + * Read-only. + * @property {FilterFlags} PICK_OVERLAYS - Include local entities when intersecting. Read-only. + * @property {FilterFlags} PICK_AVATARS - Include avatars when intersecting. Read-only. + * @property {FilterFlags} PICK_HUD - Include the HUD sphere when intersecting in HMD mode. Read-only. + * @property {FilterFlags} PICK_PRECISE - Pick against exact meshes. Read-only. + * @property {FilterFlags} PICK_INCLUDE_INVISIBLE - Include invisible objects when intersecting. Read-only. + * @property {FilterFlags} PICK_INCLUDE_NONCOLLIDABLE - Include non-collidable objects when intersecting. Read-only. + * @property {FilterFlags} PICK_ALL_INTERSECTIONS - Return all intersections instead of just the closest. Read-only. + * @property {IntersectionType} INTERSECTED_NONE - Intersected nothing with the given filter flags. Read-only. + * @property {IntersectionType} INTERSECTED_ENTITY - Intersected an entity. Read-only. + * @property {IntersectionType} INTERSECTED_LOCAL_ENTITY - Intersected a local entity. Read-only. + * @property {IntersectionType} INTERSECTED_OVERLAY - Intersected an entity (3D Overlays no longer exist). Read-only. + * @property {IntersectionType} INTERSECTED_AVATAR - Intersected an avatar. Read-only. + * @property {IntersectionType} INTERSECTED_HUD - Intersected the HUD sphere. Read-only. */ - class RayPickScriptingInterface : public QObject, public Dependency { Q_OBJECT Q_PROPERTY(unsigned int PICK_ENTITIES READ PICK_ENTITIES CONSTANT) @@ -63,78 +66,96 @@ class RayPickScriptingInterface : public QObject, public Dependency { public: /**jsdoc + * Creates a new ray pick. + *

Warning: Picks created using this method currently always intersect at least visible and collidable + * things but this may not always be the case.

* @function RayPick.createRayPick - * @param {Picks.RayPickProperties} - * @returns {number} + * @param {Picks.RayPickProperties} properties - Properties of the pick. + * @returns {number} The ID of the pick created. 0 if invalid. */ Q_INVOKABLE unsigned int createRayPick(const QVariant& properties); /**jsdoc + * Enables a ray pick. * @function RayPick.enableRayPick - * @param {number} id + * @param {number} id - The ID of the ray pick. */ Q_INVOKABLE void enableRayPick(unsigned int uid); /**jsdoc + * Disables a ray pick. * @function RayPick.disableRayPick - * @param {number} id + * @param {number} id - The ID of the ray pick. */ Q_INVOKABLE void disableRayPick(unsigned int uid); /**jsdoc + * Removes (deletes) a ray pick. * @function RayPick.removeRayPick - * @param {number} id + * @param {number} id - The ID of the ray pick. */ Q_INVOKABLE void removeRayPick(unsigned int uid); /**jsdoc + * Gets the most recent pick result from a ray pick. A ray pick continues to be updated ready to return a result, as long + * as it is enabled. * @function RayPick.getPrevRayPickResult - * @param {number} id + * @param {number} id - The ID of the ray pick. * @returns {RayPickResult} */ Q_INVOKABLE QVariantMap getPrevRayPickResult(unsigned int uid); /**jsdoc + * Sets whether or not to use precision picking, i.e., whether to pick against precise meshes or coarse meshes. * @function RayPick.setPrecisionPicking - * @param {number} id - * @param {boolean} precisionPicking + * @param {number} id - The ID of the ray pick. + * @param {boolean} precisionPicking - true to use precision picking, false to use coarse picking. */ Q_INVOKABLE void setPrecisionPicking(unsigned int uid, bool precisionPicking); /**jsdoc + * Sets a list of entity and avatar IDs to ignore during intersection. * @function RayPick.setIgnoreItems - * @param {number} id - * @param {Uuid[]) ignoreEntities + * @param {number} id - The ID of the ray pick. + * @param {Uuid[]} ignoreItems - The list of IDs to ignore. */ Q_INVOKABLE void setIgnoreItems(unsigned int uid, const QScriptValue& ignoreEntities); /**jsdoc + * Sets a list of entity IDs and/or avatar IDs to include during intersection, instead of intersecting with everything. * @function RayPick.setIncludeItems - * @param {number} id - * @param {Uuid[]) includeEntities + * @param {number} id - The ID of the ray pick. + * @param {Uuid[]} includeItems - The list of IDs to include. */ Q_INVOKABLE void setIncludeItems(unsigned int uid, const QScriptValue& includeEntities); /**jsdoc + * Checks if a pick is associated with the left hand: a ray or parabola pick with joint set to + * "_CONTROLLER_LEFTHAND" or "_CAMERA_RELATIVE_CONTROLLER_LEFTHAND", or a stylus pick with hand + * set to 0. * @function RayPick.isLeftHand - * @param {number} id - * @returns {boolean} + * @param {number} id - The ID of the ray pick. + * @returns {boolean} true if the pick is associated with the left hand, false if it isn't. */ Q_INVOKABLE bool isLeftHand(unsigned int uid); /**jsdoc + * Checks if a pick is associated with the right hand: a ray or parabola pick with joint set to + * "_CONTROLLER_RIGHTHAND" or "_CAMERA_RELATIVE_CONTROLLER_RIGHTHAND", or a stylus pick with hand + * set to 1. * @function RayPick.isRightHand - * @param {number} id - * @returns {boolean} + * @param {number} id - The ID of the ray pick. + * @returns {boolean} true if the pick is associated with the right hand, false if it isn't. */ Q_INVOKABLE bool isRightHand(unsigned int uid); /**jsdoc + * Checks if a pick is associated with the system mouse: a ray or parabola pick with joint set to "Mouse". * @function RayPick.isMouse - * @param {number} id - * @returns {boolean} + * @param {number} id - The ID of the ray pick. + * @returns {boolean} true if the pick is associated with the system mouse, false if it isn't. */ Q_INVOKABLE bool isMouse(unsigned int uid); @@ -142,84 +163,107 @@ public slots: /**jsdoc * @function RayPick.PICK_ENTITIES + * @deprecated This function is deprecated and will be removed. Use the Raypick.PICK_ENTITIES property instead. * @returns {number} */ static unsigned int PICK_ENTITIES() { return PickScriptingInterface::PICK_ENTITIES(); } /**jsdoc * @function RayPick.PICK_OVERLAYS + * @deprecated This function is deprecated and will be removed. Use the RayPick.PICK_OVERLAYS property instead. * @returns {number} */ static unsigned int PICK_OVERLAYS() { return PickScriptingInterface::PICK_OVERLAYS(); } /**jsdoc * @function RayPick.PICK_AVATARS + * @deprecated This function is deprecated and will be removed. Use the RayPick.PICK_AVATARS property instead. * @returns {number} */ static unsigned int PICK_AVATARS() { return PickScriptingInterface::PICK_AVATARS(); } /**jsdoc * @function RayPick.PICK_HUD + * @deprecated This function is deprecated and will be removed. Use the RayPick.PICK_HUD property instead. * @returns {number} */ static unsigned int PICK_HUD() { return PickScriptingInterface::PICK_HUD(); } /**jsdoc * @function RayPick.PICK_COARSE + * @deprecated This function is deprecated and will be removed. Use the RayPick.PICK_COARSE property instead. * @returns {number} */ static unsigned int PICK_COARSE() { return PickScriptingInterface::PICK_COARSE(); } /**jsdoc * @function RayPick.PICK_INCLUDE_INVISIBLE + * @deprecated This function is deprecated and will be removed. Use the RayPick.PICK_INCLUDE_INVISIBLE + * property instead. * @returns {number} */ static unsigned int PICK_INCLUDE_INVISIBLE() { return PickScriptingInterface::PICK_INCLUDE_INVISIBLE(); } /**jsdoc * @function RayPick.PICK_INCLUDE_NONCOLLIDABLE + * @deprecated This function is deprecated and will be removed. Use the RayPick.PICK_INCLUDE_NONCOLLIDABLE + * property instead. * @returns {number} */ static unsigned int PICK_INCLUDE_NONCOLLIDABLE() { return PickScriptingInterface::PICK_INCLUDE_NONCOLLIDABLE(); } /**jsdoc * @function RayPick.PICK_ALL_INTERSECTIONS + * @deprecated This function is deprecated and will be removed. Use the RayPick.PICK_ALL_INTERSECTIONS + * property instead. * @returns {number} */ static unsigned int PICK_ALL_INTERSECTIONS() { return PickScriptingInterface::PICK_ALL_INTERSECTIONS(); } /**jsdoc * @function RayPick.INTERSECTED_NONE + * @deprecated This function is deprecated and will be removed. Use the RayPick.INTERSECTED_NONE property + * instead. * @returns {number} */ static unsigned int INTERSECTED_NONE() { return PickScriptingInterface::INTERSECTED_NONE(); } /**jsdoc * @function RayPick.INTERSECTED_ENTITY + * @deprecated This function is deprecated and will be removed. Use the RayPick.INTERSECTED_ENTITY property + * instead. * @returns {number} */ static unsigned int INTERSECTED_ENTITY() { return PickScriptingInterface::INTERSECTED_ENTITY(); } /**jsdoc * @function RayPick.INTERSECTED_OVERLAY + * @deprecated This function is deprecated and will be removed. Use the RayPick.INTERSECTED_LOCAL_ENTITY + * property instead. * @returns {number} */ static unsigned int INTERSECTED_LOCAL_ENTITY() { return PickScriptingInterface::INTERSECTED_LOCAL_ENTITY(); } /**jsdoc * @function RayPick.INTERSECTED_OVERLAY + * @deprecated This function is deprecated and will be removed. Use the RayPick.INTERSECTED_OVERLAY property + * instead. * @returns {number} */ static unsigned int INTERSECTED_OVERLAY() { return PickScriptingInterface::INTERSECTED_LOCAL_ENTITY(); } /**jsdoc * @function RayPick.INTERSECTED_AVATAR + * @deprecated This function is deprecated and will be removed. Use the RayPick.INTERSECTED_AVATAR property + * instead. * @returns {number} */ static unsigned int INTERSECTED_AVATAR() { return PickScriptingInterface::INTERSECTED_AVATAR(); } /**jsdoc * @function RayPick.INTERSECTED_HUD + * @deprecated This function is deprecated and will be removed. Use the RayPick.INTERSECTED_HUD property + * instead. * @returns {number} */ static unsigned int INTERSECTED_HUD() { return PickScriptingInterface::INTERSECTED_HUD(); } diff --git a/interface/src/raypick/StylusPick.h b/interface/src/raypick/StylusPick.h index 9d5dc10b67..e443fb1c6d 100644 --- a/interface/src/raypick/StylusPick.h +++ b/interface/src/raypick/StylusPick.h @@ -38,6 +38,18 @@ public: glm::vec3 intersection { NAN }; glm::vec3 surfaceNormal { NAN }; + /**jsdoc + * An intersection result for a stylus pick. + * + * @typedef {object} StylusPickResult + * @property {number} type - The intersection type. + * @property {boolean} intersects - true if there's a valid intersection, false if there isn't. + * @property {Uuid} objectID - The ID of the intersected object. null for invalid intersections. + * @property {number} distance - The distance to the intersection point from the stylus tip. + * @property {Vec3} intersection - The intersection point in world coordinates. + * @property {Vec3} surfaceNormal - The surface normal at the intersected point. + * @property {StylusTip} stylusTip - The stylus tip at the time of the result. Valid even if there is no intersection. + */ virtual QVariantMap toVariantMap() const override { QVariantMap toReturn; toReturn["type"] = type; diff --git a/interface/src/scripting/Audio.cpp b/interface/src/scripting/Audio.cpp index b406c097e7..cb8b211352 100644 --- a/interface/src/scripting/Audio.cpp +++ b/interface/src/scripting/Audio.cpp @@ -366,8 +366,10 @@ void Audio::onContextChanged() { void Audio::handlePushedToTalk(bool enabled) { if (getPTT()) { if (enabled) { + DependencyManager::get()->setOutputGain(0.1f); // duck the output by 20dB setMuted(false); } else { + DependencyManager::get()->setOutputGain(1.0f); setMuted(true); } } diff --git a/interface/src/scripting/HMDScriptingInterface.cpp b/interface/src/scripting/HMDScriptingInterface.cpp index a365b84a15..baca6250d2 100644 --- a/interface/src/scripting/HMDScriptingInterface.cpp +++ b/interface/src/scripting/HMDScriptingInterface.cpp @@ -30,6 +30,9 @@ HMDScriptingInterface::HMDScriptingInterface() { connect(qApp, &Application::miniTabletEnabledChanged, [this](bool enabled) { emit miniTabletEnabledChanged(enabled); }); + connect(qApp, &Application::awayStateWhenFocusLostInVRChanged, [this](bool enabled) { + emit awayStateWhenFocusLostInVRChanged(enabled); + }); } glm::vec3 HMDScriptingInterface::calculateRayUICollisionPoint(const glm::vec3& position, const glm::vec3& direction) const { @@ -137,6 +140,14 @@ bool HMDScriptingInterface::getMiniTabletEnabled() { return qApp->getMiniTabletEnabled(); } +void HMDScriptingInterface::setAwayStateWhenFocusLostInVREnabled(bool enabled) { + qApp->setAwayStateWhenFocusLostInVREnabled(enabled); +} + +bool HMDScriptingInterface::getAwayStateWhenFocusLostInVREnabled() { + return qApp->getAwayStateWhenFocusLostInVREnabled(); +} + QScriptValue HMDScriptingInterface::getHUDLookAtPosition2D(QScriptContext* context, QScriptEngine* engine) { glm::vec3 hudIntersection; diff --git a/interface/src/scripting/HMDScriptingInterface.h b/interface/src/scripting/HMDScriptingInterface.h index c6202d4105..335816bf7c 100644 --- a/interface/src/scripting/HMDScriptingInterface.h +++ b/interface/src/scripting/HMDScriptingInterface.h @@ -375,6 +375,14 @@ signals: */ bool miniTabletEnabledChanged(bool enabled); + /**jsdoc + * Triggered when the altering the mode for going into an away state when the interface focus is lost in VR. + * @function HMD.awayStateWhenFocusLostInVRChanged + * @param {boolean} enabled - true if the setting to go into an away state in VR when the interface focus is lost is enabled, otherwise false. + * @returns {Signal} + */ + bool awayStateWhenFocusLostInVRChanged(bool enabled); + public: HMDScriptingInterface(); @@ -423,6 +431,9 @@ public: void setMiniTabletEnabled(bool enabled); bool getMiniTabletEnabled(); + void setAwayStateWhenFocusLostInVREnabled(bool enabled); + bool getAwayStateWhenFocusLostInVREnabled(); + QVariant getPlayAreaRect(); QVector getSensorPositions(); diff --git a/interface/src/ui/InteractiveWindow.cpp b/interface/src/ui/InteractiveWindow.cpp index 72714ea8e8..4e454798ef 100644 --- a/interface/src/ui/InteractiveWindow.cpp +++ b/interface/src/ui/InteractiveWindow.cpp @@ -109,6 +109,8 @@ InteractiveWindow::InteractiveWindow(const QString& sourceUrl, const QVariantMap auto mainWindow = qApp->getWindow(); _dockWidget = std::shared_ptr(new DockWidget(title, mainWindow), dockWidgetDeleter); + auto quickView = _dockWidget->getQuickView(); + Application::setupQmlSurface(quickView->rootContext(), true); /**jsdoc * Configures how a NATIVE window is displayed. @@ -141,7 +143,6 @@ InteractiveWindow::InteractiveWindow(const QString& sourceUrl, const QVariantMap } } - auto quickView = _dockWidget->getQuickView(); QObject::connect(quickView.get(), &QQuickView::statusChanged, [&, this] (QQuickView::Status status) { if (status == QQuickView::Ready) { QQuickItem* rootItem = _dockWidget->getRootItem(); diff --git a/interface/src/ui/PreferencesDialog.cpp b/interface/src/ui/PreferencesDialog.cpp index 6a2516115d..fb7b0ef993 100644 --- a/interface/src/ui/PreferencesDialog.cpp +++ b/interface/src/ui/PreferencesDialog.cpp @@ -111,6 +111,12 @@ void setupPreferences() { auto setter = [](bool value) { qApp->setSettingConstrainToolbarPosition(value); }; preferences->addPreference(new CheckPreference(UI_CATEGORY, "Constrain Toolbar Position to Horizontal Center", getter, setter)); } + + { + auto getter = []()->bool { return qApp->getAwayStateWhenFocusLostInVREnabled(); }; + auto setter = [](bool value) { qApp->setAwayStateWhenFocusLostInVREnabled(value); }; + preferences->addPreference(new CheckPreference(UI_CATEGORY, "Go into away state when interface window loses focus in VR", getter, setter)); + } { auto getter = []()->float { return qApp->getDesktopTabletScale(); }; diff --git a/interface/src/workload/GameWorkloadRenderer.cpp b/interface/src/workload/GameWorkloadRenderer.cpp index a2fb32d396..2bb73999f1 100644 --- a/interface/src/workload/GameWorkloadRenderer.cpp +++ b/interface/src/workload/GameWorkloadRenderer.cpp @@ -145,6 +145,7 @@ void GameWorkloadRenderItem::setAllViews(const workload::Views& views) { } const gpu::PipelinePointer GameWorkloadRenderItem::getProxiesPipeline() { + // FIXME: this needs a forward pipeline, or to only write to one output if (!_drawAllProxiesPipeline) { gpu::ShaderPointer program = gpu::Shader::createProgram(shader::render_utils::program::drawWorkloadProxy); auto state = std::make_shared(); @@ -162,6 +163,7 @@ const gpu::PipelinePointer GameWorkloadRenderItem::getProxiesPipeline() { const gpu::PipelinePointer GameWorkloadRenderItem::getViewsPipeline() { + // FIXME: this needs a forward pipeline, or to only write to one output if (!_drawAllViewsPipeline) { gpu::ShaderPointer program = gpu::Shader::createProgram(shader::render_utils::program::drawWorkloadView); auto state = std::make_shared(); diff --git a/libraries/audio-client/src/AudioClient.cpp b/libraries/audio-client/src/AudioClient.cpp index 4d3311b065..cef6adcab0 100644 --- a/libraries/audio-client/src/AudioClient.cpp +++ b/libraries/audio-client/src/AudioClient.cpp @@ -221,6 +221,35 @@ static float computeLoudness(int16_t* samples, int numSamples, int numChannels, return (float)loudness * scale; } +template +static void applyGainSmoothing(float* buffer, int numFrames, float gain0, float gain1) { + + // fast path for unity gain + if (gain0 == 1.0f && gain1 == 1.0f) { + return; + } + + // cubic poly from gain0 to gain1 + float c3 = -2.0f * (gain1 - gain0); + float c2 = 3.0f * (gain1 - gain0); + float c0 = gain0; + + float t = 0.0f; + float tStep = 1.0f / numFrames; + + for (int i = 0; i < numFrames; i++) { + + // evaluate poly over t=[0,1) + float gain = (c3 * t + c2) * t * t + c0; + t += tStep; + + // apply gain to all channels + for (int ch = 0; ch < NUM_CHANNELS; ch++) { + buffer[NUM_CHANNELS*i + ch] *= gain; + } + } +} + static inline float convertToFloat(int16_t sample) { return (float)sample * (1 / 32768.0f); } @@ -2109,6 +2138,14 @@ qint64 AudioClient::AudioOutputIODevice::readData(char * data, qint64 maxSize) { int framesPopped = samplesPopped / AudioConstants::STEREO; int bytesWritten; if (samplesPopped > 0) { + + // apply output gain + float newGain = _audio->_outputGain.load(std::memory_order_acquire); + float oldGain = _audio->_lastOutputGain; + _audio->_lastOutputGain = newGain; + + applyGainSmoothing(mixBuffer, framesPopped, oldGain, newGain); + if (deviceChannelCount == OUTPUT_CHANNEL_COUNT) { // limit the audio _audio->_audioLimiter.render(mixBuffer, (int16_t*)data, framesPopped); diff --git a/libraries/audio-client/src/AudioClient.h b/libraries/audio-client/src/AudioClient.h index 7608bf5cdb..db70e2f7b3 100644 --- a/libraries/audio-client/src/AudioClient.h +++ b/libraries/audio-client/src/AudioClient.h @@ -241,8 +241,10 @@ public slots: void setInputVolume(float volume, bool emitSignal = true); void setReverb(bool reverb); void setReverbOptions(const AudioEffectOptions* options); + void setLocalInjectorGain(float gain) { _localInjectorGain = gain; }; void setSystemInjectorGain(float gain) { _systemInjectorGain = gain; }; + void setOutputGain(float gain) { _outputGain = gain; }; void outputNotify(); @@ -395,6 +397,8 @@ private: int _outputPeriod { 0 }; float* _outputMixBuffer { NULL }; int16_t* _outputScratchBuffer { NULL }; + std::atomic _outputGain { 1.0f }; + float _lastOutputGain { 1.0f }; // for local audio (used by audio injectors thread) std::atomic _localInjectorGain { 1.0f }; diff --git a/libraries/audio/src/InboundAudioStream.cpp b/libraries/audio/src/InboundAudioStream.cpp index 8c5388e222..5ac3996029 100644 --- a/libraries/audio/src/InboundAudioStream.cpp +++ b/libraries/audio/src/InboundAudioStream.cpp @@ -10,6 +10,7 @@ // #include "InboundAudioStream.h" +#include "TryLocker.h" #include @@ -215,7 +216,7 @@ int InboundAudioStream::parseData(ReceivedMessage& message) { if (framesAvailable > _desiredJitterBufferFrames + MAX_FRAMES_OVER_DESIRED) { int framesToDrop = framesAvailable - (_desiredJitterBufferFrames + DESIRED_JITTER_BUFFER_FRAMES_PADDING); _ringBuffer.shiftReadPosition(framesToDrop * _ringBuffer.getNumFrameSamples()); - + _framesAvailableStat.reset(); _currentJitterBufferFrames = 0; @@ -247,10 +248,18 @@ int InboundAudioStream::lostAudioData(int numPackets) { QByteArray decodedBuffer; while (numPackets--) { + MutexTryLocker lock(_decoderMutex); + if (!lock.isLocked()) { + // an incoming packet is being processed, + // and will likely be on the ring buffer shortly, + // so don't bother generating more data + qCInfo(audiostream, "Packet currently being unpacked or lost frame already being generated. Not generating lost frame."); + return 0; + } if (_decoder) { _decoder->lostFrame(decodedBuffer); } else { - decodedBuffer.resize(AudioConstants::NETWORK_FRAME_BYTES_STEREO); + decodedBuffer.resize(AudioConstants::NETWORK_FRAME_BYTES_PER_CHANNEL * _numChannels); memset(decodedBuffer.data(), 0, decodedBuffer.size()); } _ringBuffer.writeData(decodedBuffer.data(), decodedBuffer.size()); @@ -260,6 +269,12 @@ int InboundAudioStream::lostAudioData(int numPackets) { int InboundAudioStream::parseAudioData(PacketType type, const QByteArray& packetAfterStreamProperties) { QByteArray decodedBuffer; + + // may block on the real-time thread, which is acceptible as + // parseAudioData is only called by the packet processing + // thread which, while high performance, is not as sensitive to + // delays as the real-time thread. + QMutexLocker lock(&_decoderMutex); if (_decoder) { _decoder->decode(packetAfterStreamProperties, decodedBuffer); } else { @@ -278,16 +293,23 @@ int InboundAudioStream::writeDroppableSilentFrames(int silentFrames) { // case we will call the decoder's lostFrame() method, which indicates // that it should interpolate from its last known state down toward // silence. - if (_decoder) { - // FIXME - We could potentially use the output from the codec, in which - // case we might get a cleaner fade toward silence. NOTE: The below logic - // attempts to catch up in the event that the jitter buffers have grown. - // The better long term fix is to use the output from the decode, detect - // when it actually reaches silence, and then delete the silent portions - // of the jitter buffers. Or petentially do a cross fade from the decode - // output to silence. - QByteArray decodedBuffer; - _decoder->lostFrame(decodedBuffer); + { + // may block on the real-time thread, which is acceptible as + // writeDroppableSilentFrames is only called by the packet processing + // thread which, while high performance, is not as sensitive to + // delays as the real-time thread. + QMutexLocker lock(&_decoderMutex); + if (_decoder) { + // FIXME - We could potentially use the output from the codec, in which + // case we might get a cleaner fade toward silence. NOTE: The below logic + // attempts to catch up in the event that the jitter buffers have grown. + // The better long term fix is to use the output from the decode, detect + // when it actually reaches silence, and then delete the silent portions + // of the jitter buffers. Or petentially do a cross fade from the decode + // output to silence. + QByteArray decodedBuffer; + _decoder->lostFrame(decodedBuffer); + } } // calculate how many silent frames we should drop. @@ -338,10 +360,23 @@ int InboundAudioStream::popSamples(int maxSamples, bool allOrNothing) { popSamplesNoCheck(samplesAvailable); samplesPopped = samplesAvailable; } else { - // we can't pop any samples, set this stream to starved + // we can't pop any samples, set this stream to starved for jitter + // buffer calculations. setToStarved(); _consecutiveNotMixedCount++; - _lastPopSucceeded = false; + //Kick PLC to generate a filler frame, reducing 'click' + lostAudioData(allOrNothing ? (maxSamples - samplesAvailable) / _ringBuffer.getNumFrameSamples() : 1); + samplesPopped = _ringBuffer.samplesAvailable(); + if (samplesPopped) { + popSamplesNoCheck(samplesPopped); + } else { + // No samples available means a packet is currently being + // processed, so we don't generate lost audio data, and instead + // just wait for the packet to come in. This prevents locking + // the real-time audio thread at the cost of a potential (but rare) + // 'click' + _lastPopSucceeded = false; + } } } return samplesPopped; @@ -528,6 +563,7 @@ void InboundAudioStream::setupCodec(CodecPluginPointer codec, const QString& cod _codec = codec; _selectedCodecName = codecName; if (_codec) { + QMutexLocker lock(&_decoderMutex); _decoder = codec->createDecoder(AudioConstants::SAMPLE_RATE, numChannels); } } @@ -535,6 +571,7 @@ void InboundAudioStream::setupCodec(CodecPluginPointer codec, const QString& cod void InboundAudioStream::cleanupCodec() { // release any old codec encoder/decoder first... if (_codec) { + QMutexLocker lock(&_decoderMutex); if (_decoder) { _codec->releaseDecoder(_decoder); _decoder = nullptr; diff --git a/libraries/audio/src/InboundAudioStream.h b/libraries/audio/src/InboundAudioStream.h index 5ff9e2c84c..c10a86cb69 100644 --- a/libraries/audio/src/InboundAudioStream.h +++ b/libraries/audio/src/InboundAudioStream.h @@ -187,6 +187,7 @@ protected: CodecPluginPointer _codec; QString _selectedCodecName; + QMutex _decoderMutex; Decoder* _decoder { nullptr }; int _mismatchedAudioCodecCount { 0 }; }; diff --git a/libraries/audio/src/MixedProcessedAudioStream.cpp b/libraries/audio/src/MixedProcessedAudioStream.cpp index 082977246b..6510f0bfc9 100644 --- a/libraries/audio/src/MixedProcessedAudioStream.cpp +++ b/libraries/audio/src/MixedProcessedAudioStream.cpp @@ -11,6 +11,7 @@ #include "MixedProcessedAudioStream.h" #include "AudioLogging.h" +#include "TryLocker.h" MixedProcessedAudioStream::MixedProcessedAudioStream(int numFramesCapacity, int numStaticJitterFrames) : InboundAudioStream(AudioConstants::STEREO, AudioConstants::NETWORK_FRAME_SAMPLES_PER_CHANNEL, @@ -36,13 +37,20 @@ int MixedProcessedAudioStream::lostAudioData(int numPackets) { QByteArray outputBuffer; while (numPackets--) { + MutexTryLocker lock(_decoderMutex); + if (!lock.isLocked()) { + // an incoming packet is being processed, + // and will likely be on the ring buffer shortly, + // so don't bother generating more data + qCInfo(audiostream, "Packet currently being unpacked or lost frame already being generated. Not generating lost frame."); + return 0; + } if (_decoder) { _decoder->lostFrame(decodedBuffer); } else { decodedBuffer.resize(AudioConstants::NETWORK_FRAME_BYTES_STEREO); memset(decodedBuffer.data(), 0, decodedBuffer.size()); } - emit addedStereoSamples(decodedBuffer); emit processSamples(decodedBuffer, outputBuffer); @@ -55,6 +63,12 @@ int MixedProcessedAudioStream::lostAudioData(int numPackets) { int MixedProcessedAudioStream::parseAudioData(PacketType type, const QByteArray& packetAfterStreamProperties) { QByteArray decodedBuffer; + + // may block on the real-time thread, which is acceptible as + // parseAudioData is only called by the packet processing + // thread which, while high performance, is not as sensitive to + // delays as the real-time thread. + QMutexLocker lock(&_decoderMutex); if (_decoder) { _decoder->decode(packetAfterStreamProperties, decodedBuffer); } else { diff --git a/libraries/avatars-renderer/src/avatars-renderer/Avatar.cpp b/libraries/avatars-renderer/src/avatars-renderer/Avatar.cpp index cb0acd68cb..e836ecf7eb 100644 --- a/libraries/avatars-renderer/src/avatars-renderer/Avatar.cpp +++ b/libraries/avatars-renderer/src/avatars-renderer/Avatar.cpp @@ -690,6 +690,11 @@ void Avatar::fade(render::Transaction& transaction, render::Transition::Type typ transaction.addTransitionToItem(itemId, type, _renderItemID); } } + _lastFadeRequested = type; +} + +render::Transition::Type Avatar::getLastFadeRequested() const { + return _lastFadeRequested; } void Avatar::removeFromScene(AvatarSharedPointer self, const render::ScenePointer& scene, render::Transaction& transaction) { @@ -779,7 +784,7 @@ void Avatar::render(RenderArgs* renderArgs) { pointerTransform.setTranslation(position); pointerTransform.setRotation(rotation); batch.setModelTransform(pointerTransform); - geometryCache->bindSimpleProgram(batch); + geometryCache->bindSimpleProgram(batch, false, false, true, false, false, true, renderArgs->_renderMethod == render::Args::FORWARD); geometryCache->renderLine(batch, glm::vec3(0.0f, 0.0f, 0.0f), glm::vec3(0.0f, laserLength, 0.0f), laserColor, _leftPointerGeometryID); } } @@ -803,7 +808,7 @@ void Avatar::render(RenderArgs* renderArgs) { pointerTransform.setTranslation(position); pointerTransform.setRotation(rotation); batch.setModelTransform(pointerTransform); - geometryCache->bindSimpleProgram(batch); + geometryCache->bindSimpleProgram(batch, false, false, true, false, false, true, renderArgs->_renderMethod == render::Args::FORWARD); geometryCache->renderLine(batch, glm::vec3(0.0f, 0.0f, 0.0f), glm::vec3(0.0f, laserLength, 0.0f), laserColor, _rightPointerGeometryID); } } @@ -829,7 +834,7 @@ void Avatar::render(RenderArgs* renderArgs) { auto& frustum = renderArgs->getViewFrustum(); auto textPosition = getDisplayNamePosition(); if (frustum.pointIntersectsFrustum(textPosition)) { - renderDisplayName(batch, frustum, textPosition); + renderDisplayName(batch, frustum, textPosition, renderArgs->_renderMethod == render::Args::FORWARD); } } } @@ -1034,7 +1039,7 @@ Transform Avatar::calculateDisplayNameTransform(const ViewFrustum& view, const g return result; } -void Avatar::renderDisplayName(gpu::Batch& batch, const ViewFrustum& view, const glm::vec3& textPosition) const { +void Avatar::renderDisplayName(gpu::Batch& batch, const ViewFrustum& view, const glm::vec3& textPosition, bool forward) const { PROFILE_RANGE_BATCH(batch, __FUNCTION__); bool shouldShowReceiveStats = showReceiveStats && !isMyAvatar(); @@ -1090,7 +1095,7 @@ void Avatar::renderDisplayName(gpu::Batch& batch, const ViewFrustum& view, const { PROFILE_RANGE_BATCH(batch, __FUNCTION__":renderBevelCornersRect"); - DependencyManager::get()->bindSimpleProgram(batch, false, false, true, true, true); + DependencyManager::get()->bindSimpleProgram(batch, false, false, true, true, true, true, forward); DependencyManager::get()->renderBevelCornersRect(batch, left, bottom, width, height, bevelDistance, backgroundColor, _nameRectGeometryID); } @@ -1103,7 +1108,7 @@ void Avatar::renderDisplayName(gpu::Batch& batch, const ViewFrustum& view, const batch.setModelTransform(textTransform); { PROFILE_RANGE_BATCH(batch, __FUNCTION__":renderText"); - renderer->draw(batch, text_x, -text_y, nameUTF8.data(), textColor); + renderer->draw(batch, text_x, -text_y, nameUTF8.data(), textColor, glm::vec2(-1.0f), forward); } } } diff --git a/libraries/avatars-renderer/src/avatars-renderer/Avatar.h b/libraries/avatars-renderer/src/avatars-renderer/Avatar.h index a196c018d2..61901d662a 100644 --- a/libraries/avatars-renderer/src/avatars-renderer/Avatar.h +++ b/libraries/avatars-renderer/src/avatars-renderer/Avatar.h @@ -523,6 +523,7 @@ public: void fadeIn(render::ScenePointer scene); void fadeOut(render::Transaction& transaction, KillAvatarReason reason); + render::Transition::Type getLastFadeRequested() const; // JSDoc is in AvatarData.h. Q_INVOKABLE virtual float getEyeHeight() const override; @@ -694,13 +695,14 @@ protected: glm::vec3 getDisplayNamePosition() const; Transform calculateDisplayNameTransform(const ViewFrustum& view, const glm::vec3& textPosition) const; - void renderDisplayName(gpu::Batch& batch, const ViewFrustum& view, const glm::vec3& textPosition) const; + void renderDisplayName(gpu::Batch& batch, const ViewFrustum& view, const glm::vec3& textPosition, bool forward) const; virtual bool shouldRenderHead(const RenderArgs* renderArgs) const; virtual void fixupModelsInScene(const render::ScenePointer& scene); virtual void updatePalms(); render::ItemID _renderItemID{ render::Item::INVALID_ITEM_ID }; + render::Transition::Type _lastFadeRequested { render::Transition::Type::NONE }; // Used for sanity checking ThreadSafeValueCache _leftPalmPositionCache { glm::vec3() }; ThreadSafeValueCache _leftPalmRotationCache { glm::quat() }; diff --git a/libraries/entities-renderer/src/EntityTreeRenderer.cpp b/libraries/entities-renderer/src/EntityTreeRenderer.cpp index 7d130125b3..ae8473e544 100644 --- a/libraries/entities-renderer/src/EntityTreeRenderer.cpp +++ b/libraries/entities-renderer/src/EntityTreeRenderer.cpp @@ -220,6 +220,7 @@ void EntityTreeRenderer::stopDomainAndNonOwnedEntities() { void EntityTreeRenderer::clearDomainAndNonOwnedEntities() { stopDomainAndNonOwnedEntities(); + auto sessionUUID = getTree()->getMyAvatarSessionUUID(); std::unordered_map savedEntities; // remove all entities from the scene auto scene = _viewState->getMain3DScene(); @@ -227,7 +228,7 @@ void EntityTreeRenderer::clearDomainAndNonOwnedEntities() { for (const auto& entry : _entitiesInScene) { const auto& renderer = entry.second; const EntityItemPointer& entityItem = renderer->getEntity(); - if (!(entityItem->isLocalEntity() || (entityItem->isAvatarEntity() && entityItem->getOwningAvatarID() == getTree()->getMyAvatarSessionUUID()))) { + if (!(entityItem->isLocalEntity() || (entityItem->isAvatarEntity() && entityItem->getOwningAvatarID() == sessionUUID))) { fadeOutRenderable(renderer); } else { savedEntities[entry.first] = entry.second; @@ -238,7 +239,9 @@ void EntityTreeRenderer::clearDomainAndNonOwnedEntities() { _renderablesToUpdate = savedEntities; _entitiesInScene = savedEntities; - _layeredZones.clearNonLocalLayeredZones(); + if (_layeredZones.clearDomainAndNonOwnedZones(sessionUUID)) { + applyLayeredZones(); + } OctreeProcessor::clearDomainAndNonOwnedEntities(); } @@ -271,6 +274,9 @@ void EntityTreeRenderer::clear() { // reset the zone to the default (while we load the next scene) _layeredZones.clear(); + if (!_shuttingDown) { + applyLayeredZones(); + } OctreeProcessor::clear(); } @@ -363,6 +369,7 @@ void EntityTreeRenderer::addPendingEntities(const render::ScenePointer& scene, r for (const auto& processedId : processedIds) { _entitiesToAdd.erase(processedId); } + forceRecheckEntities(); } } } @@ -474,6 +481,12 @@ void EntityTreeRenderer::updateChangedEntities(const render::ScenePointer& scene } } +void EntityTreeRenderer::preUpdate() { + if (_tree && !_shuttingDown) { + _tree->preUpdate(); + } +} + void EntityTreeRenderer::update(bool simulate) { PROFILE_RANGE(simulation_physics, "ETR::update"); PerformanceTimer perfTimer("ETRupdate"); @@ -537,8 +550,7 @@ void EntityTreeRenderer::handleSpaceUpdate(std::pair proxyUp _spaceUpdates.emplace_back(proxyUpdate.first, proxyUpdate.second); } -bool EntityTreeRenderer::findBestZoneAndMaybeContainingEntities(QSet& entitiesContainingAvatar) { - bool didUpdate = false; +void EntityTreeRenderer::findBestZoneAndMaybeContainingEntities(QSet& entitiesContainingAvatar) { float radius = 0.01f; // for now, assume 0.01 meter radius, because we actually check the point inside later QVector entityIDs; @@ -550,7 +562,7 @@ bool EntityTreeRenderer::findBestZoneAndMaybeContainingEntities(QSetevalEntitiesInSphere(_avatarPosition, radius, PickFilter(), entityIDs); - LayeredZones oldLayeredZones(std::move(_layeredZones)); + LayeredZones oldLayeredZones(_layeredZones); _layeredZones.clear(); // create a list of entities that actually contain the avatar's position @@ -578,8 +590,8 @@ bool EntityTreeRenderer::findBestZoneAndMaybeContainingEntities(QSetgetVisible() && renderableForEntity(entity)) { - _layeredZones.insert(std::dynamic_pointer_cast(entity)); + if (isZone && entity->getVisible() && renderableIdForEntity(entity) != render::Item::INVALID_ITEM_ID) { + _layeredZones.emplace_back(std::dynamic_pointer_cast(entity)); } if ((!hasScript && isZone) || scriptHasLoaded) { @@ -588,24 +600,17 @@ bool EntityTreeRenderer::findBestZoneAndMaybeContainingEntities(QSetgetAvatarPosition(); @@ -623,7 +628,7 @@ bool EntityTreeRenderer::checkEnterLeaveEntities() { _forceRecheckEntities = false; QSet entitiesContainingAvatar; - didUpdate = findBestZoneAndMaybeContainingEntities(entitiesContainingAvatar); + findBestZoneAndMaybeContainingEntities(entitiesContainingAvatar); // Note: at this point we don't need to worry about the tree being locked, because we only deal with // EntityItemIDs from here. The callEntityScriptMethod() method is robust against attempting to call scripts @@ -649,7 +654,6 @@ bool EntityTreeRenderer::checkEnterLeaveEntities() { } } } - return didUpdate; } void EntityTreeRenderer::leaveDomainAndNonOwnedEntities() { @@ -696,18 +700,12 @@ bool EntityTreeRenderer::applyLayeredZones() { // in the expected layered order and update the scene with it auto scene = _viewState->getMain3DScene(); if (scene) { - render::Transaction transaction; render::ItemIDs list; - for (auto& zone : _layeredZones) { - auto id = renderableIdForEntity(zone.zone); - // The zone may not have been rendered yet. - if (id != render::Item::INVALID_ITEM_ID) { - list.push_back(id); - } - } - render::Selection selection("RankedZones", list); - transaction.resetSelection(selection); + _layeredZones.appendRenderIDs(list, this); + render::Selection selection("RankedZones", list); + render::Transaction transaction; + transaction.resetSelection(selection); scene->enqueueTransaction(transaction); } else { qCWarning(entitiesrenderer) << "EntityTreeRenderer::applyLayeredZones(), Unexpected null scene, possibly during application shutdown"; @@ -1018,7 +1016,6 @@ void EntityTreeRenderer::deletingEntity(const EntityItemID& entityID) { } void EntityTreeRenderer::addingEntity(const EntityItemID& entityID) { - forceRecheckEntities(); // reset our state to force checking our inside/outsideness of entities checkAndCallPreload(entityID); auto entity = std::static_pointer_cast(_tree)->findEntityByID(entityID); if (entity) { @@ -1190,107 +1187,103 @@ void EntityTreeRenderer::updateEntityRenderStatus(bool shouldRenderEntities) { } void EntityTreeRenderer::updateZone(const EntityItemID& id) { - // Get in the zone! - auto zone = std::dynamic_pointer_cast(getTree()->findEntityByEntityItemID(id)); - if (zone && zone->contains(_avatarPosition)) { - _layeredZones.update(zone); + if (auto zone = std::dynamic_pointer_cast(getTree()->findEntityByEntityItemID(id))) { + if (_layeredZones.update(zone, _avatarPosition, this)) { + applyLayeredZones(); + } } } -EntityTreeRenderer::LayeredZones::LayeredZones(LayeredZones&& other) { - // In a swap: - // > All iterators and references remain valid. The past-the-end iterator is invalidated. - bool isSkyboxLayerValid = (other._skyboxLayer != other.end()); +bool EntityTreeRenderer::LayeredZones::clearDomainAndNonOwnedZones(const QUuid& sessionUUID) { + bool zonesChanged = false; - swap(other); - _map.swap(other._map); - _skyboxLayer = other._skyboxLayer; - - if (!isSkyboxLayerValid) { - _skyboxLayer = end(); + auto it = begin(); + while (it != end()) { + auto zone = it->zone.lock(); + if (!zone || !(zone->isLocalEntity() || (zone->isAvatarEntity() && zone->getOwningAvatarID() == sessionUUID))) { + zonesChanged = true; + it = erase(it); + } else { + it++; + } } + + if (zonesChanged) { + sort(); + } + return zonesChanged; } -void EntityTreeRenderer::LayeredZones::clearNonLocalLayeredZones() { - std::set localLayeredZones; - std::map newMap; +std::pair EntityTreeRenderer::LayeredZones::getZoneInteractionProperties() const { + for (auto it = cbegin(); it != cend(); it++) { + auto zone = it->zone.lock(); + if (zone && zone->isDomainEntity()) { + return { zone->getFlyingAllowed(), zone->getGhostingAllowed() }; + } + } + return { true, true }; +} - for (auto iter = begin(); iter != end(); iter++) { - LayeredZone layeredZone = *iter; +bool EntityTreeRenderer::LayeredZones::update(std::shared_ptr zone, const glm::vec3& position, EntityTreeRenderer* entityTreeRenderer) { + // When a zone's position or visibility changes, we call this method + // In order to resort our zones, we first remove the changed zone, and then re-insert it if necessary - if (layeredZone.zone->isLocalEntity()) { - bool success; - iterator it; - std::tie(it, success) = localLayeredZones.insert(layeredZone); + bool needsResort = false; - if (success) { - newMap.emplace(layeredZone.id, it); + { + auto it = begin(); + while (it != end()) { + if (it->zone.lock() == zone) { + break; + } + it++; + } + if (it != end()) { + erase(it); + needsResort = true; + } + } + + // Only call contains if the zone is rendering + if (zone->isVisible() && entityTreeRenderer->renderableIdForEntity(zone) != render::Item::INVALID_ITEM_ID && zone->contains(position)) { + emplace_back(zone); + needsResort = true; + } + + if (needsResort) { + sort(); + } + + return needsResort; +} + +bool EntityTreeRenderer::LayeredZones::equals(const LayeredZones& other) const { + if (size() != other.size()) { + return false; + } + + auto it = cbegin(); + auto otherIt = other.cbegin(); + while (it != cend()) { + if (*it != *otherIt) { + return false; + } + it++; + otherIt++; + } + + return true; +} + +void EntityTreeRenderer::LayeredZones::appendRenderIDs(render::ItemIDs& list, EntityTreeRenderer* entityTreeRenderer) const { + for (auto it = cbegin(); it != cend(); it++) { + if (it->zone.lock()) { + auto id = entityTreeRenderer->renderableIdForEntityId(it->id); + if (id != render::Item::INVALID_ITEM_ID) { + list.push_back(id); } } } - - std::set::operator=(localLayeredZones); - _map = newMap; - _skyboxLayer = empty() ? end() : begin(); -} - -void EntityTreeRenderer::LayeredZones::clear() { - std::set::clear(); - _map.clear(); - _skyboxLayer = end(); -} - -std::pair EntityTreeRenderer::LayeredZones::insert(const LayeredZone& layer) { - iterator it; - bool success; - std::tie(it, success) = std::set::insert(layer); - - if (success) { - _map.emplace(it->id, it); - } - - return { it, success }; -} - -void EntityTreeRenderer::LayeredZones::update(std::shared_ptr zone) { - bool isVisible = zone->isVisible(); - - if (empty() && isVisible) { - // there are no zones: set this one - insert(zone); - return; - } else { - LayeredZone zoneLayer(zone); - - // find this zone's layer, if it exists - iterator layer = end(); - auto it = _map.find(zoneLayer.id); - if (it != _map.end()) { - layer = it->second; - // if the volume changed, we need to resort the layer (reinsertion) - // if the visibility changed, we need to erase the layer - if (zoneLayer.volume != layer->volume || !isVisible) { - erase(layer); - _map.erase(it); - layer = end(); - } - } - - // (re)insert this zone's layer if necessary - if (layer == end() && isVisible) { - std::tie(layer, std::ignore) = insert(zoneLayer); - _map.emplace(layer->id, layer); - } - } -} - -bool EntityTreeRenderer::LayeredZones::contains(const LayeredZones& other) { - bool result = std::equal(other.begin(), other._skyboxLayer, begin()); - if (result) { - // if valid, set the _skyboxLayer from the other LayeredZones - _skyboxLayer = std::next(begin(), std::distance(other.begin(), other._skyboxLayer)); - } - return result; } CalculateEntityLoadingPriority EntityTreeRenderer::_calculateEntityLoadingPriorityFunc = [](const EntityItem& item) -> float { @@ -1298,14 +1291,7 @@ CalculateEntityLoadingPriority EntityTreeRenderer::_calculateEntityLoadingPriori }; std::pair EntityTreeRenderer::getZoneInteractionProperties() { - for (auto& zone : _layeredZones) { - // Only domain entities control flying allowed and ghosting allowed - if (zone.zone && zone.zone->isDomainEntity()) { - return { zone.zone->getFlyingAllowed(), zone.zone->getGhostingAllowed() }; - } - } - - return { true, true }; + return _layeredZones.getZoneInteractionProperties(); } bool EntityTreeRenderer::wantsKeyboardFocus(const EntityItemID& id) const { diff --git a/libraries/entities-renderer/src/EntityTreeRenderer.h b/libraries/entities-renderer/src/EntityTreeRenderer.h index 05105a2c7f..f794d947ed 100644 --- a/libraries/entities-renderer/src/EntityTreeRenderer.h +++ b/libraries/entities-renderer/src/EntityTreeRenderer.h @@ -78,6 +78,7 @@ public: void setSetPrecisionPickingOperator(std::function setPrecisionPickingOperator) { _setPrecisionPickingOperator = setPrecisionPickingOperator; } void shutdown(); + void preUpdate(); void update(bool simulate); EntityTreePointer getTree() { return std::static_pointer_cast(_tree); } @@ -169,7 +170,7 @@ private: void resetEntitiesScriptEngine(); - bool findBestZoneAndMaybeContainingEntities(QSet& entitiesContainingAvatar); + void findBestZoneAndMaybeContainingEntities(QSet& entitiesContainingAvatar); bool applyLayeredZones(); void stopDomainAndNonOwnedEntities(); @@ -180,7 +181,7 @@ private: EntityItemID _currentClickingOnEntityID; QScriptValueList createEntityArgs(const EntityItemID& entityID); - bool checkEnterLeaveEntities(); + void checkEnterLeaveEntities(); void leaveDomainAndNonOwnedEntities(); void leaveAllEntities(); void forceRecheckEntities(); @@ -210,48 +211,38 @@ private: class LayeredZone { public: - LayeredZone(std::shared_ptr zone, QUuid id, float volume) : zone(zone), id(id), volume(volume) {} - LayeredZone(std::shared_ptr zone) : LayeredZone(zone, zone->getID(), zone->getVolumeEstimate()) {} + LayeredZone(std::shared_ptr zone) : zone(zone), id(zone->getID()), volume(zone->getVolumeEstimate()) {} - bool operator<(const LayeredZone& r) const { return std::tie(volume, id) < std::tie(r.volume, r.id); } - bool operator==(const LayeredZone& r) const { return id == r.id; } + // We need to sort on volume AND id so that different clients sort zones with identical volumes the same way + bool operator<(const LayeredZone& r) const { return volume < r.volume || (volume == r.volume && id < r.id); } + bool operator==(const LayeredZone& r) const { return zone.lock() && zone.lock() == r.zone.lock(); } + bool operator!=(const LayeredZone& r) const { return !(*this == r); } bool operator<=(const LayeredZone& r) const { return (*this < r) || (*this == r); } - std::shared_ptr zone; + std::weak_ptr zone; QUuid id; float volume; }; - class LayeredZones : public std::set { + class LayeredZones : public std::vector { public: - LayeredZones() {}; - LayeredZones(LayeredZones&& other); + bool clearDomainAndNonOwnedZones(const QUuid& sessionUUID); - // avoid accidental misconstruction - LayeredZones(const LayeredZones&) = delete; - LayeredZones& operator=(const LayeredZones&) = delete; - LayeredZones& operator=(LayeredZones&&) = delete; + void sort() { std::sort(begin(), end(), std::less()); } + bool equals(const LayeredZones& other) const; + bool update(std::shared_ptr zone, const glm::vec3& position, EntityTreeRenderer* entityTreeRenderer); - void clear(); - void clearNonLocalLayeredZones(); - std::pair insert(const LayeredZone& layer); - void update(std::shared_ptr zone); - bool contains(const LayeredZones& other); - - std::shared_ptr getZone() { return empty() ? nullptr : begin()->zone; } - - private: - std::map _map; - iterator _skyboxLayer { end() }; + void appendRenderIDs(render::ItemIDs& list, EntityTreeRenderer* entityTreeRenderer) const; + std::pair getZoneInteractionProperties() const; }; LayeredZones _layeredZones; - float _avgRenderableUpdateCost { 0.0f }; - uint64_t _lastZoneCheck { 0 }; const uint64_t ZONE_CHECK_INTERVAL = USECS_PER_MSEC * 100; // ~10hz const float ZONE_CHECK_DISTANCE = 0.001f; + float _avgRenderableUpdateCost { 0.0f }; + ReadWriteLockable _changedEntitiesGuard; std::unordered_set _changedEntities; diff --git a/libraries/entities-renderer/src/RenderableGizmoEntityItem.cpp b/libraries/entities-renderer/src/RenderableGizmoEntityItem.cpp index 1a188ca163..9468fdf3ef 100644 --- a/libraries/entities-renderer/src/RenderableGizmoEntityItem.cpp +++ b/libraries/entities-renderer/src/RenderableGizmoEntityItem.cpp @@ -261,15 +261,17 @@ void GizmoEntityRenderer::doRender(RenderArgs* args) { Transform transform; bool hasTickMarks; glm::vec4 tickProperties; + bool forward; withReadLock([&] { transform = _renderTransform; hasTickMarks = _ringProperties.getHasTickMarks(); tickProperties = glm::vec4(_ringProperties.getMajorTickMarksAngle(), _ringProperties.getMajorTickMarksLength(), _ringProperties.getMinorTickMarksAngle(), _ringProperties.getMinorTickMarksLength()); + forward = _renderLayer != RenderLayer::WORLD || args->_renderMethod == Args::RenderMethod::FORWARD; }); bool wireframe = render::ShapeKey(args->_globalShapeKey).isWireframe() || _primitiveMode == PrimitiveMode::LINES; - geometryCache->bindSimpleProgram(batch, false, isTransparent(), false, wireframe, true, true, _renderLayer != RenderLayer::WORLD); + geometryCache->bindSimpleProgram(batch, false, isTransparent(), false, wireframe, true, true, forward); batch.setModelTransform(transform); diff --git a/libraries/entities-renderer/src/RenderableGridEntityItem.cpp b/libraries/entities-renderer/src/RenderableGridEntityItem.cpp index f05ba35c79..31969e36fc 100644 --- a/libraries/entities-renderer/src/RenderableGridEntityItem.cpp +++ b/libraries/entities-renderer/src/RenderableGridEntityItem.cpp @@ -113,11 +113,13 @@ void GridEntityRenderer::doRender(RenderArgs* args) { glm::vec4 color; glm::vec3 dimensions; Transform renderTransform; + bool forward; withReadLock([&] { color = glm::vec4(toGlm(_color), _alpha); color = EntityRenderer::calculatePulseColor(color, _pulseProperties, _created); dimensions = _dimensions; renderTransform = _renderTransform; + forward = _renderLayer != RenderLayer::WORLD || args->_renderMethod == Args::RenderMethod::FORWARD; }); if (!_visible) { @@ -153,5 +155,5 @@ void GridEntityRenderer::doRender(RenderArgs* args) { DependencyManager::get()->renderGrid(*batch, minCorner, maxCorner, minorGridRowDivisions, minorGridColDivisions, MINOR_GRID_EDGE, majorGridRowDivisions, majorGridColDivisions, MAJOR_GRID_EDGE, - color, _geometryId); + color, forward, _geometryId); } \ No newline at end of file diff --git a/libraries/entities-renderer/src/RenderableLineEntityItem.cpp b/libraries/entities-renderer/src/RenderableLineEntityItem.cpp index 9c5424950a..cbe2a98166 100644 --- a/libraries/entities-renderer/src/RenderableLineEntityItem.cpp +++ b/libraries/entities-renderer/src/RenderableLineEntityItem.cpp @@ -55,7 +55,8 @@ void LineEntityRenderer::doRender(RenderArgs* args) { transform.setRotation(modelTransform.getRotation()); batch.setModelTransform(transform); if (_linePoints.size() > 1) { - DependencyManager::get()->bindSimpleProgram(batch); + DependencyManager::get()->bindSimpleProgram(batch, false, false, true, false, false, true, + _renderLayer != RenderLayer::WORLD || args->_renderMethod == Args::RenderMethod::FORWARD); DependencyManager::get()->renderVertices(batch, gpu::LINE_STRIP, _lineVerticesID); } } diff --git a/libraries/entities-renderer/src/RenderableModelEntityItem.cpp b/libraries/entities-renderer/src/RenderableModelEntityItem.cpp index bfbbe12ea6..0a9a076efb 100644 --- a/libraries/entities-renderer/src/RenderableModelEntityItem.cpp +++ b/libraries/entities-renderer/src/RenderableModelEntityItem.cpp @@ -735,13 +735,15 @@ bool RenderableModelEntityItem::shouldBePhysical() const { auto model = getModel(); // If we have a model, make sure it hasn't failed to download. // If it has, we'll report back that we shouldn't be physical so that physics aren't held waiting for us to be ready. - if (model && (getShapeType() == SHAPE_TYPE_COMPOUND || getShapeType() == SHAPE_TYPE_SIMPLE_COMPOUND) && model->didCollisionGeometryRequestFail()) { - return false; - } else if (model && getShapeType() != SHAPE_TYPE_NONE && model->didVisualGeometryRequestFail()) { - return false; - } else { - return ModelEntityItem::shouldBePhysical(); + ShapeType shapeType = getShapeType(); + if (model) { + if ((shapeType == SHAPE_TYPE_COMPOUND || shapeType == SHAPE_TYPE_SIMPLE_COMPOUND) && model->didCollisionGeometryRequestFail()) { + return false; + } else if (shapeType != SHAPE_TYPE_NONE && model->didVisualGeometryRequestFail()) { + return false; + } } + return !isDead() && shapeType != SHAPE_TYPE_NONE && QUrl(_modelURL).isValid(); } int RenderableModelEntityItem::getJointParent(int index) const { @@ -1520,7 +1522,7 @@ void ModelEntityRenderer::doRender(RenderArgs* args) { model = _model; }); if (model) { - model->renderDebugMeshBoxes(batch); + model->renderDebugMeshBoxes(batch, args->_renderMethod == Args::RenderMethod::FORWARD); } #endif } diff --git a/libraries/entities-renderer/src/RenderablePolyLineEntityItem.cpp b/libraries/entities-renderer/src/RenderablePolyLineEntityItem.cpp index 2430643ce2..d7246f9ba5 100644 --- a/libraries/entities-renderer/src/RenderablePolyLineEntityItem.cpp +++ b/libraries/entities-renderer/src/RenderablePolyLineEntityItem.cpp @@ -19,15 +19,12 @@ #include #include -#include - #include "paintStroke_Shared.slh" using namespace render; using namespace render::entities; -gpu::PipelinePointer PolyLineEntityRenderer::_pipeline = nullptr; -gpu::PipelinePointer PolyLineEntityRenderer::_glowPipeline = nullptr; +std::map, gpu::PipelinePointer> PolyLineEntityRenderer::_pipelines; static const QUrl DEFAULT_POLYLINE_TEXTURE = PathUtils::resourcesUrl("images/paintStroke.png"); @@ -44,29 +41,24 @@ PolyLineEntityRenderer::PolyLineEntityRenderer(const EntityItemPointer& entity) } } -void PolyLineEntityRenderer::buildPipeline() { - // FIXME: opaque pipeline - gpu::ShaderPointer program = gpu::Shader::createProgram(DISABLE_DEFERRED ? shader::entities_renderer::program::paintStroke_forward : shader::entities_renderer::program::paintStroke); +void PolyLineEntityRenderer::buildPipelines() { + // FIXME: opaque pipelines + + static const std::vector> keys = { + { render::Args::DEFERRED, false }, { render::Args::DEFERRED, true }, { render::Args::FORWARD, false }, { render::Args::FORWARD, true }, + }; + + for (auto& key : keys) { + gpu::ShaderPointer program = gpu::Shader::createProgram(key.first == render::Args::DEFERRED ? shader::entities_renderer::program::paintStroke : shader::entities_renderer::program::paintStroke_forward); - { gpu::StatePointer state = gpu::StatePointer(new gpu::State()); state->setCullMode(gpu::State::CullMode::CULL_NONE); - state->setDepthTest(true, true, gpu::LESS_EQUAL); + state->setDepthTest(true, !key.second, gpu::LESS_EQUAL); PrepareStencil::testMask(*state); state->setBlendFunction(true, gpu::State::SRC_ALPHA, gpu::State::BLEND_OP_ADD, gpu::State::INV_SRC_ALPHA, gpu::State::FACTOR_ALPHA, gpu::State::BLEND_OP_ADD, gpu::State::ONE); - _pipeline = gpu::Pipeline::create(program, state); - } - { - gpu::StatePointer state = gpu::StatePointer(new gpu::State()); - state->setCullMode(gpu::State::CullMode::CULL_NONE); - state->setDepthTest(true, false, gpu::LESS_EQUAL); - PrepareStencil::testMask(*state); - state->setBlendFunction(true, - gpu::State::SRC_ALPHA, gpu::State::BLEND_OP_ADD, gpu::State::INV_SRC_ALPHA, - gpu::State::FACTOR_ALPHA, gpu::State::BLEND_OP_ADD, gpu::State::ONE); - _glowPipeline = gpu::Pipeline::create(program, state); + _pipelines[key] = gpu::Pipeline::create(program, state); } } @@ -299,11 +291,11 @@ void PolyLineEntityRenderer::doRender(RenderArgs* args) { return; } - if (!_pipeline) { - buildPipeline(); + if (_pipelines.empty()) { + buildPipelines(); } - batch.setPipeline(_glow ? _glowPipeline : _pipeline); + batch.setPipeline(_pipelines[{args->_renderMethod, _glow}]); batch.setModelTransform(transform); batch.setResourceTexture(0, texture); batch.draw(gpu::TRIANGLE_STRIP, (gpu::uint32)(2 * numVertices), 0); diff --git a/libraries/entities-renderer/src/RenderablePolyLineEntityItem.h b/libraries/entities-renderer/src/RenderablePolyLineEntityItem.h index 3815b57671..adb30362da 100644 --- a/libraries/entities-renderer/src/RenderablePolyLineEntityItem.h +++ b/libraries/entities-renderer/src/RenderablePolyLineEntityItem.h @@ -37,7 +37,7 @@ protected: virtual ShapeKey getShapeKey() override; virtual void doRender(RenderArgs* args) override; - void buildPipeline(); + static void buildPipelines(); void updateGeometry(); void updateData(); @@ -58,8 +58,7 @@ protected: size_t _numVertices; gpu::BufferPointer _polylineDataBuffer; gpu::BufferPointer _polylineGeometryBuffer; - static gpu::PipelinePointer _pipeline; - static gpu::PipelinePointer _glowPipeline; + static std::map, gpu::PipelinePointer> _pipelines; }; } } // namespace diff --git a/libraries/entities-renderer/src/RenderablePolyVoxEntityItem.h b/libraries/entities-renderer/src/RenderablePolyVoxEntityItem.h index 7aea87535e..cca34767a4 100644 --- a/libraries/entities-renderer/src/RenderablePolyVoxEntityItem.h +++ b/libraries/entities-renderer/src/RenderablePolyVoxEntityItem.h @@ -72,7 +72,6 @@ public: glm::mat4 localToVoxelMatrix() const; virtual ShapeType getShapeType() const override; - virtual bool shouldBePhysical() const override { return !isDead(); } virtual bool isReadyToComputeShape() const override; virtual void computeShapeInfo(ShapeInfo& info) override; diff --git a/libraries/entities-renderer/src/RenderableShapeEntityItem.cpp b/libraries/entities-renderer/src/RenderableShapeEntityItem.cpp index 2548ae5914..6a0d7b001c 100644 --- a/libraries/entities-renderer/src/RenderableShapeEntityItem.cpp +++ b/libraries/entities-renderer/src/RenderableShapeEntityItem.cpp @@ -280,7 +280,7 @@ void ShapeEntityRenderer::doRender(RenderArgs* args) { // FIXME, support instanced multi-shape rendering using multidraw indirect outColor.a *= _isFading ? Interpolate::calculateFadeRatio(_fadeStartTime) : 1.0f; render::ShapePipelinePointer pipeline; - if (renderLayer == RenderLayer::WORLD) { + if (renderLayer == RenderLayer::WORLD && args->_renderMethod != Args::RenderMethod::FORWARD) { pipeline = outColor.a < 1.0f ? geometryCache->getTransparentShapePipeline() : geometryCache->getOpaqueShapePipeline(); } else { pipeline = outColor.a < 1.0f ? geometryCache->getForwardTransparentShapePipeline() : geometryCache->getForwardOpaqueShapePipeline(); diff --git a/libraries/entities-renderer/src/RenderableTextEntityItem.cpp b/libraries/entities-renderer/src/RenderableTextEntityItem.cpp index 81f367a956..a281c1d097 100644 --- a/libraries/entities-renderer/src/RenderableTextEntityItem.cpp +++ b/libraries/entities-renderer/src/RenderableTextEntityItem.cpp @@ -163,7 +163,7 @@ void TextEntityRenderer::doRender(RenderArgs* args) { Transform modelTransform; glm::vec3 dimensions; BillboardMode billboardMode; - bool layered; + bool forward; withReadLock([&] { modelTransform = _renderTransform; dimensions = _dimensions; @@ -174,7 +174,7 @@ void TextEntityRenderer::doRender(RenderArgs* args) { textColor = EntityRenderer::calculatePulseColor(textColor, _pulseProperties, _created); backgroundColor = glm::vec4(_backgroundColor, fadeRatio * _backgroundAlpha); backgroundColor = EntityRenderer::calculatePulseColor(backgroundColor, _pulseProperties, _created); - layered = _renderLayer != RenderLayer::WORLD; + forward = _renderLayer != RenderLayer::WORLD || args->_renderMethod == render::Args::FORWARD; }); // Render background @@ -187,7 +187,7 @@ void TextEntityRenderer::doRender(RenderArgs* args) { gpu::Batch& batch = *args->_batch; // FIXME: we need to find a better way of rendering text so we don't have to do this - if (layered) { + if (forward) { DependencyManager::get()->setupKeyLightBatch(args, batch); } @@ -199,7 +199,7 @@ void TextEntityRenderer::doRender(RenderArgs* args) { if (backgroundColor.a > 0.0f) { batch.setModelTransform(transformToTopLeft); auto geometryCache = DependencyManager::get(); - geometryCache->bindSimpleProgram(batch, false, backgroundColor.a < 1.0f, false, false, false, true, layered); + geometryCache->bindSimpleProgram(batch, false, backgroundColor.a < 1.0f, false, false, false, true, forward); geometryCache->renderQuad(batch, minCorner, maxCorner, backgroundColor, _geometryID); } @@ -210,7 +210,7 @@ void TextEntityRenderer::doRender(RenderArgs* args) { batch.setModelTransform(transformToTopLeft); glm::vec2 bounds = glm::vec2(dimensions.x - (_leftMargin + _rightMargin), dimensions.y - (_topMargin + _bottomMargin)); - _textRenderer->draw(batch, _leftMargin / scale, -_topMargin / scale, _text, textColor, bounds / scale, layered); + _textRenderer->draw(batch, _leftMargin / scale, -_topMargin / scale, _text, textColor, bounds / scale, forward); } } diff --git a/libraries/entities-renderer/src/RenderableZoneEntityItem.cpp b/libraries/entities-renderer/src/RenderableZoneEntityItem.cpp index 64cca404cb..e4300cca76 100644 --- a/libraries/entities-renderer/src/RenderableZoneEntityItem.cpp +++ b/libraries/entities-renderer/src/RenderableZoneEntityItem.cpp @@ -92,9 +92,7 @@ void ZoneEntityRenderer::doRender(RenderArgs* args) { } { // Sun - // Need an update ? if (_needSunUpdate) { - // Do we need to allocate the light in the stage ? if (LightStage::isIndexInvalid(_sunIndex)) { _sunIndex = _stage->addLight(_sunLight); } else { @@ -107,9 +105,7 @@ void ZoneEntityRenderer::doRender(RenderArgs* args) { { // Ambient updateAmbientMap(); - // Need an update ? if (_needAmbientUpdate) { - // Do we need to allocate the light in the stage ? if (LightStage::isIndexInvalid(_ambientIndex)) { _ambientIndex = _stage->addLight(_ambientLight); } else { @@ -123,7 +119,7 @@ void ZoneEntityRenderer::doRender(RenderArgs* args) { updateSkyboxMap(); if (_needBackgroundUpdate) { - if (_skyboxMode == COMPONENT_MODE_ENABLED && BackgroundStage::isIndexInvalid(_backgroundIndex)) { + if (BackgroundStage::isIndexInvalid(_backgroundIndex)) { _backgroundIndex = _backgroundStage->addBackground(_background); } _needBackgroundUpdate = false; @@ -186,24 +182,19 @@ void ZoneEntityRenderer::doRender(RenderArgs* args) { } } -void ZoneEntityRenderer::removeFromScene(const ScenePointer& scene, Transaction& transaction) { -#if 0 - if (_model) { - _model->removeFromScene(scene, transaction); - } -#endif - Parent::removeFromScene(scene, transaction); -} - void ZoneEntityRenderer::doRenderUpdateSynchronousTyped(const ScenePointer& scene, Transaction& transaction, const TypedEntityPointer& entity) { - DependencyManager::get()->updateZone(entity->getID()); - auto position = entity->getWorldPosition(); auto rotation = entity->getWorldOrientation(); auto dimensions = entity->getScaledDimensions(); bool rotationChanged = rotation != _lastRotation; bool transformChanged = rotationChanged || position != _lastPosition || dimensions != _lastDimensions; + auto visible = entity->getVisible(); + if (transformChanged || visible != _lastVisible) { + _lastVisible = visible; + DependencyManager::get()->updateZone(entity->getID()); + } + auto proceduralUserData = entity->getUserData(); bool proceduralUserDataChanged = _proceduralUserData != proceduralUserData; @@ -226,25 +217,6 @@ void ZoneEntityRenderer::doRenderUpdateSynchronousTyped(const ScenePointer& scen _proceduralUserData = entity->getUserData(); } -#if 0 - if (_lastShapeURL != _typedEntity->getCompoundShapeURL()) { - _lastShapeURL = _typedEntity->getCompoundShapeURL(); - _model.reset(); - _model = std::make_shared(); - _model->setIsWireframe(true); - _model->init(); - _model->setURL(_lastShapeURL); - } - - if (_model && _model->isActive()) { - _model->setScaleToFit(true, _lastDimensions); - _model->setSnapModelToRegistrationPoint(true, _entity->getRegistrationPoint()); - _model->setRotation(_lastRotation); - _model->setTranslation(_lastPosition); - _model->simulate(0.0f); - } -#endif - updateKeyZoneItemFromEntity(entity); if (keyLightChanged) { @@ -296,6 +268,10 @@ ItemKey ZoneEntityRenderer::getKey() { } bool ZoneEntityRenderer::needsRenderUpdateFromTypedEntity(const TypedEntityPointer& entity) const { + if (entity->getVisible() != _lastVisible) { + return true; + } + if (entity->keyLightPropertiesChanged() || entity->ambientLightPropertiesChanged() || entity->hazePropertiesChanged() || @@ -323,25 +299,7 @@ bool ZoneEntityRenderer::needsRenderUpdateFromTypedEntity(const TypedEntityPoint return true; } -#if 0 - if (_typedEntity->getCompoundShapeURL() != _lastShapeURL) { - return true; - } - - if (_model) { - if (!_model->needsFixupInScene() && (!ZoneEntityItem::getDrawZoneBoundaries() || _entity->getShapeType() != SHAPE_TYPE_COMPOUND)) { - return true; - } - - if (_model->needsFixupInScene() && (ZoneEntityItem::getDrawZoneBoundaries() || _entity->getShapeType() == SHAPE_TYPE_COMPOUND)) { - return true; - } - - if (_lastModelActive != _model->isActive()) { - return true; - } - } -#endif + // FIXME: do we need to trigger an update when shapeType changes? see doRenderUpdateAsynchronousTyped return false; } @@ -450,7 +408,6 @@ void ZoneEntityRenderer::updateKeyZoneItemFromEntity(const TypedEntityPointer& e } void ZoneEntityRenderer::setAmbientURL(const QString& ambientUrl) { - // nothing change if nothing change if (_ambientTextureURL == ambientUrl) { return; } @@ -466,8 +423,6 @@ void ZoneEntityRenderer::setAmbientURL(const QString& ambientUrl) { _pendingAmbientTexture = true; auto textureCache = DependencyManager::get(); _ambientTexture = textureCache->getTexture(_ambientTextureURL, image::TextureUsage::AMBIENT_TEXTURE); - - // keep whatever is assigned on the ambient map/sphere until texture is loaded } } @@ -492,7 +447,6 @@ void ZoneEntityRenderer::updateAmbientMap() { } void ZoneEntityRenderer::setSkyboxURL(const QString& skyboxUrl) { - // nothing change if nothing change if (_skyboxTextureURL == skyboxUrl) { return; } diff --git a/libraries/entities-renderer/src/RenderableZoneEntityItem.h b/libraries/entities-renderer/src/RenderableZoneEntityItem.h index 2fa55f1540..5fd9b87408 100644 --- a/libraries/entities-renderer/src/RenderableZoneEntityItem.h +++ b/libraries/entities-renderer/src/RenderableZoneEntityItem.h @@ -24,9 +24,6 @@ #include "RenderableEntityItem.h" #include -#if 0 -#include -#endif namespace render { namespace entities { class ZoneEntityRenderer : public TypedEntityRenderer { @@ -40,7 +37,6 @@ protected: virtual void onRemoveFromSceneTyped(const TypedEntityPointer& entity) override; virtual ItemKey getKey() override; virtual void doRender(RenderArgs* args) override; - virtual void removeFromScene(const ScenePointer& scene, Transaction& transaction) override; virtual bool needsRenderUpdateFromTypedEntity(const TypedEntityPointer& entity) const override; virtual void doRenderUpdateSynchronousTyped(const ScenePointer& scene, Transaction& transaction, const TypedEntityPointer& entity) override; virtual void doRenderUpdateAsynchronousTyped(const TypedEntityPointer& entity) override; @@ -76,14 +72,7 @@ private: glm::vec3 _lastPosition; glm::vec3 _lastDimensions; glm::quat _lastRotation; - - // FIXME compount shapes are currently broken - // FIXME draw zone boundaries are currently broken (also broken in master) -#if 0 - ModelPointer _model; - bool _lastModelActive { false }; - QString _lastShapeURL; -#endif + bool _lastVisible; LightStagePointer _stage; const graphics::LightPointer _sunLight { std::make_shared() }; @@ -137,25 +126,4 @@ private: } } // namespace -#if 0 - -class NetworkGeometry; -class KeyLightPayload; - -class RenderableZoneEntityItemMeta; - -class RenderableZoneEntityItem : public ZoneEntityItem, public RenderableEntityInterface { -public: - virtual bool contains(const glm::vec3& point) const override; - virtual bool addToScene(const EntityItemPointer& self, const render::ScenePointer& scene, render::Transaction& transaction) override; - virtual void removeFromScene(const EntityItemPointer& self, const render::ScenePointer& scene, render::Transaction& transaction) override; -private: - virtual void locationChanged(bool tellPhysics = true, bool tellChildren = true) override { EntityItem::locationChanged(tellPhysics, tellChildren); notifyBoundChanged(); } - virtual void dimensionsChanged() override { EntityItem::dimensionsChanged(); notifyBoundChanged(); } - void notifyBoundChanged(); - void notifyChangedRenderItem(); - void sceneUpdateRenderItemFromEntity(render::Transaction& transaction); -}; -#endif - #endif // hifi_RenderableZoneEntityItem_h diff --git a/libraries/entities/src/EntityEditPacketSender.cpp b/libraries/entities/src/EntityEditPacketSender.cpp index 0491bdedae..dbb3ab076e 100644 --- a/libraries/entities/src/EntityEditPacketSender.cpp +++ b/libraries/entities/src/EntityEditPacketSender.cpp @@ -110,6 +110,10 @@ void EntityEditPacketSender::queueEditEntityMessage(PacketType type, EntityPropertyFlags requestedProperties = propertiesCopy.getChangedProperties(); + if (!nodeList->getThisNodeCanGetAndSetPrivateUserData() && requestedProperties.getHasProperty(PROP_PRIVATE_USER_DATA)) { + requestedProperties -= PROP_PRIVATE_USER_DATA; + } + while (encodeResult == OctreeElement::PARTIAL) { encodeResult = EntityItemProperties::encodeEntityEditPacket(type, entityItemID, propertiesCopy, bufferOut, requestedProperties, didntFitProperties); diff --git a/libraries/entities/src/EntityItem.cpp b/libraries/entities/src/EntityItem.cpp index 7cc35f8be0..d39924dcd3 100644 --- a/libraries/entities/src/EntityItem.cpp +++ b/libraries/entities/src/EntityItem.cpp @@ -86,6 +86,7 @@ EntityPropertyFlags EntityItem::getEntityProperties(EncodeBitstreamParams& param requestedProperties += PROP_NAME; requestedProperties += PROP_LOCKED; requestedProperties += PROP_USER_DATA; + requestedProperties += PROP_PRIVATE_USER_DATA; requestedProperties += PROP_HREF; requestedProperties += PROP_DESCRIPTION; requestedProperties += PROP_POSITION; @@ -154,7 +155,8 @@ EntityPropertyFlags EntityItem::getEntityProperties(EncodeBitstreamParams& param } OctreeElement::AppendState EntityItem::appendEntityData(OctreePacketData* packetData, EncodeBitstreamParams& params, - EntityTreeElementExtraEncodeDataPointer entityTreeElementExtraEncodeData) const { + EntityTreeElementExtraEncodeDataPointer entityTreeElementExtraEncodeData, + const bool destinationNodeCanGetAndSetPrivateUserData) const { // ALL this fits... // object ID [16 bytes] @@ -198,6 +200,11 @@ OctreeElement::AppendState EntityItem::appendEntityData(OctreePacketData* packet requestedProperties = entityTreeElementExtraEncodeData->entities.value(getEntityItemID()); } + QString privateUserData = ""; + if (destinationNodeCanGetAndSetPrivateUserData) { + privateUserData = getPrivateUserData(); + } + EntityPropertyFlags propertiesDidntFit = requestedProperties; LevelDetails entityLevel = packetData->startLevel(); @@ -266,8 +273,8 @@ OctreeElement::AppendState EntityItem::appendEntityData(OctreePacketData* packet APPEND_ENTITY_PROPERTY(PROP_SIMULATION_OWNER, _simulationOwner.toByteArray()); // convert AVATAR_SELF_ID to actual sessionUUID. QUuid actualParentID = getParentID(); + auto nodeList = DependencyManager::get(); if (actualParentID == AVATAR_SELF_ID) { - auto nodeList = DependencyManager::get(); actualParentID = nodeList->getSessionUUID(); } APPEND_ENTITY_PROPERTY(PROP_PARENT_ID, actualParentID); @@ -276,6 +283,7 @@ OctreeElement::AppendState EntityItem::appendEntityData(OctreePacketData* packet APPEND_ENTITY_PROPERTY(PROP_NAME, getName()); APPEND_ENTITY_PROPERTY(PROP_LOCKED, getLocked()); APPEND_ENTITY_PROPERTY(PROP_USER_DATA, getUserData()); + APPEND_ENTITY_PROPERTY(PROP_PRIVATE_USER_DATA, privateUserData); APPEND_ENTITY_PROPERTY(PROP_HREF, getHref()); APPEND_ENTITY_PROPERTY(PROP_DESCRIPTION, getDescription()); APPEND_ENTITY_PROPERTY(PROP_POSITION, getLocalPosition()); @@ -812,6 +820,7 @@ int EntityItem::readEntityDataFromBuffer(const unsigned char* data, int bytesLef READ_ENTITY_PROPERTY(PROP_NAME, QString, setName); READ_ENTITY_PROPERTY(PROP_LOCKED, bool, setLocked); READ_ENTITY_PROPERTY(PROP_USER_DATA, QString, setUserData); + READ_ENTITY_PROPERTY(PROP_PRIVATE_USER_DATA, QString, setPrivateUserData); READ_ENTITY_PROPERTY(PROP_HREF, QString, setHref); READ_ENTITY_PROPERTY(PROP_DESCRIPTION, QString, setDescription); { // When we own the simulation we don't accept updates to the entity's transform/velocities @@ -1331,6 +1340,7 @@ EntityItemProperties EntityItem::getProperties(const EntityPropertyFlags& desire COPY_ENTITY_PROPERTY_TO_PROPERTIES(name, getName); COPY_ENTITY_PROPERTY_TO_PROPERTIES(locked, getLocked); COPY_ENTITY_PROPERTY_TO_PROPERTIES(userData, getUserData); + COPY_ENTITY_PROPERTY_TO_PROPERTIES(privateUserData, getPrivateUserData); COPY_ENTITY_PROPERTY_TO_PROPERTIES(href, getHref); COPY_ENTITY_PROPERTY_TO_PROPERTIES(description, getDescription); COPY_ENTITY_PROPERTY_TO_PROPERTIES(position, getLocalPosition); @@ -1479,6 +1489,7 @@ bool EntityItem::setProperties(const EntityItemProperties& properties) { SET_ENTITY_PROPERTY_FROM_PROPERTIES(name, setName); SET_ENTITY_PROPERTY_FROM_PROPERTIES(locked, setLocked); SET_ENTITY_PROPERTY_FROM_PROPERTIES(userData, setUserData); + SET_ENTITY_PROPERTY_FROM_PROPERTIES(privateUserData, setPrivateUserData); SET_ENTITY_PROPERTY_FROM_PROPERTIES(href, setHref); SET_ENTITY_PROPERTY_FROM_PROPERTIES(description, setDescription); SET_ENTITY_PROPERTY_FROM_PROPERTIES(position, setPosition); @@ -1828,42 +1839,42 @@ void EntityItem::setParentID(const QUuid& value) { if (!value.isNull() && tree) { EntityItemPointer entity = tree->findEntityByEntityItemID(value); if (entity) { - newParentNoBootstrapping = entity->getSpecialFlags() & Simulation::SPECIAL_FLAGS_NO_BOOTSTRAPPING; + newParentNoBootstrapping = entity->getSpecialFlags() & Simulation::SPECIAL_FLAG_NO_BOOTSTRAPPING; } } if (!oldParentID.isNull() && tree) { EntityItemPointer entity = tree->findEntityByEntityItemID(oldParentID); if (entity) { - oldParentNoBootstrapping = entity->getDirtyFlags() & Simulation::SPECIAL_FLAGS_NO_BOOTSTRAPPING; + oldParentNoBootstrapping = entity->getDirtyFlags() & Simulation::SPECIAL_FLAG_NO_BOOTSTRAPPING; } } if (!value.isNull() && (value == Physics::getSessionUUID() || value == AVATAR_SELF_ID)) { - newParentNoBootstrapping |= Simulation::SPECIAL_FLAGS_NO_BOOTSTRAPPING; + newParentNoBootstrapping |= Simulation::SPECIAL_FLAG_NO_BOOTSTRAPPING; } if (!oldParentID.isNull() && (oldParentID == Physics::getSessionUUID() || oldParentID == AVATAR_SELF_ID)) { - oldParentNoBootstrapping |= Simulation::SPECIAL_FLAGS_NO_BOOTSTRAPPING; + oldParentNoBootstrapping |= Simulation::SPECIAL_FLAG_NO_BOOTSTRAPPING; } if ((bool)(oldParentNoBootstrapping ^ newParentNoBootstrapping)) { - if ((bool)(newParentNoBootstrapping & Simulation::SPECIAL_FLAGS_NO_BOOTSTRAPPING)) { - markSpecialFlags(Simulation::SPECIAL_FLAGS_NO_BOOTSTRAPPING); + if ((bool)(newParentNoBootstrapping & Simulation::SPECIAL_FLAG_NO_BOOTSTRAPPING)) { + markSpecialFlags(Simulation::SPECIAL_FLAG_NO_BOOTSTRAPPING); forEachDescendant([&](SpatiallyNestablePointer object) { if (object->getNestableType() == NestableType::Entity) { EntityItemPointer entity = std::static_pointer_cast(object); entity->markDirtyFlags(Simulation::DIRTY_COLLISION_GROUP); - entity->markSpecialFlags(Simulation::SPECIAL_FLAGS_NO_BOOTSTRAPPING); + entity->markSpecialFlags(Simulation::SPECIAL_FLAG_NO_BOOTSTRAPPING); } }); } else { - clearSpecialFlags(Simulation::SPECIAL_FLAGS_NO_BOOTSTRAPPING); + clearSpecialFlags(Simulation::SPECIAL_FLAG_NO_BOOTSTRAPPING); forEachDescendant([&](SpatiallyNestablePointer object) { if (object->getNestableType() == NestableType::Entity) { EntityItemPointer entity = std::static_pointer_cast(object); entity->markDirtyFlags(Simulation::DIRTY_COLLISION_GROUP); - entity->clearSpecialFlags(Simulation::SPECIAL_FLAGS_NO_BOOTSTRAPPING); + entity->clearSpecialFlags(Simulation::SPECIAL_FLAG_NO_BOOTSTRAPPING); } }); } @@ -2102,7 +2113,7 @@ void EntityItem::computeCollisionGroupAndFinalMask(int32_t& group, int32_t& mask } } - if ((bool)(_flags & Simulation::SPECIAL_FLAGS_NO_BOOTSTRAPPING)) { + if ((bool)(_flags & Simulation::SPECIAL_FLAG_NO_BOOTSTRAPPING)) { userMask &= ~USER_COLLISION_GROUP_MY_AVATAR; } mask = Physics::getDefaultCollisionMask(group) & (int32_t)(userMask); @@ -2173,8 +2184,8 @@ bool EntityItem::addAction(EntitySimulationPointer simulation, EntityDynamicPoin } void EntityItem::enableNoBootstrap() { - if (!(bool)(_flags & Simulation::SPECIAL_FLAGS_NO_BOOTSTRAPPING)) { - _flags |= Simulation::SPECIAL_FLAGS_NO_BOOTSTRAPPING; + if (!(bool)(_flags & Simulation::SPECIAL_FLAG_NO_BOOTSTRAPPING)) { + _flags |= Simulation::SPECIAL_FLAG_NO_BOOTSTRAPPING; _flags |= Simulation::DIRTY_COLLISION_GROUP; // may need to not collide with own avatar // NOTE: unlike disableNoBootstrap() below, we do not call simulation->changeEntity() here @@ -2186,7 +2197,7 @@ void EntityItem::enableNoBootstrap() { if (child->getNestableType() == NestableType::Entity) { EntityItemPointer entity = std::static_pointer_cast(child); entity->markDirtyFlags(Simulation::DIRTY_COLLISION_GROUP); - entity->markSpecialFlags(Simulation::SPECIAL_FLAGS_NO_BOOTSTRAPPING); + entity->markSpecialFlags(Simulation::SPECIAL_FLAG_NO_BOOTSTRAPPING); } }); } @@ -2194,7 +2205,7 @@ void EntityItem::enableNoBootstrap() { void EntityItem::disableNoBootstrap() { if (!stillHasMyGrabAction()) { - _flags &= ~Simulation::SPECIAL_FLAGS_NO_BOOTSTRAPPING; + _flags &= ~Simulation::SPECIAL_FLAG_NO_BOOTSTRAPPING; _flags |= Simulation::DIRTY_COLLISION_GROUP; // may need to not collide with own avatar EntityTreePointer entityTree = getTree(); @@ -2207,7 +2218,7 @@ void EntityItem::disableNoBootstrap() { if (child->getNestableType() == NestableType::Entity) { EntityItemPointer entity = std::static_pointer_cast(child); entity->markDirtyFlags(Simulation::DIRTY_COLLISION_GROUP); - entity->clearSpecialFlags(Simulation::SPECIAL_FLAGS_NO_BOOTSTRAPPING); + entity->clearSpecialFlags(Simulation::SPECIAL_FLAG_NO_BOOTSTRAPPING); simulation->changeEntity(entity); } }); @@ -2326,7 +2337,7 @@ bool EntityItem::removeActionInternal(const QUuid& actionID, EntitySimulationPoi if (removedActionType == DYNAMIC_TYPE_HOLD || removedActionType == DYNAMIC_TYPE_FAR_GRAB) { disableNoBootstrap(); } else { - // NO-OP: we assume SPECIAL_FLAGS_NO_BOOTSTRAPPING bits and collision group are correct + // NO-OP: we assume SPECIAL_FLAG_NO_BOOTSTRAPPING bits and collision group are correct // because they should have been set correctly when the action was added // and/or when children were linked } @@ -3121,6 +3132,20 @@ void EntityItem::setUserData(const QString& value) { }); } +QString EntityItem::getPrivateUserData() const { + QString result; + withReadLock([&] { + result = _privateUserData; + }); + return result; +} + +void EntityItem::setPrivateUserData(const QString& value) { + withWriteLock([&] { + _privateUserData = value; + }); +} + // Certifiable Properties #define DEFINE_PROPERTY_GETTER(type, accessor, var) \ type EntityItem::get##accessor() const { \ @@ -3154,21 +3179,21 @@ DEFINE_PROPERTY_ACCESSOR(quint32, StaticCertificateVersion, staticCertificateVer uint32_t EntityItem::getDirtyFlags() const { uint32_t result; withReadLock([&] { - result = _flags & Simulation::DIRTY_FLAGS; + result = _flags & Simulation::DIRTY_FLAGS_MASK; }); return result; } void EntityItem::markDirtyFlags(uint32_t mask) { withWriteLock([&] { - mask &= Simulation::DIRTY_FLAGS; + mask &= Simulation::DIRTY_FLAGS_MASK; _flags |= mask; }); } void EntityItem::clearDirtyFlags(uint32_t mask) { withWriteLock([&] { - mask &= Simulation::DIRTY_FLAGS; + mask &= Simulation::DIRTY_FLAGS_MASK; _flags &= ~mask; }); } @@ -3176,21 +3201,21 @@ void EntityItem::clearDirtyFlags(uint32_t mask) { uint32_t EntityItem::getSpecialFlags() const { uint32_t result; withReadLock([&] { - result = _flags & Simulation::SPECIAL_FLAGS; + result = _flags & Simulation::SPECIAL_FLAGS_MASK; }); return result; } void EntityItem::markSpecialFlags(uint32_t mask) { withWriteLock([&] { - mask &= Simulation::SPECIAL_FLAGS; + mask &= Simulation::SPECIAL_FLAGS_MASK; _flags |= mask; }); } void EntityItem::clearSpecialFlags(uint32_t mask) { withWriteLock([&] { - mask &= Simulation::SPECIAL_FLAGS; + mask &= Simulation::SPECIAL_FLAGS_MASK; _flags &= ~mask; }); } @@ -3431,6 +3456,10 @@ bool EntityItem::isWearable() const { (getParentID() == DependencyManager::get()->getSessionUUID() || getParentID() == AVATAR_SELF_ID); } +bool EntityItem::isMyAvatarEntity() const { + return _hostType == entity::HostType::AVATAR && Physics::getSessionUUID() == _owningAvatarID; +}; + void EntityItem::addGrab(GrabPointer grab) { enableNoBootstrap(); SpatiallyNestable::addGrab(grab); diff --git a/libraries/entities/src/EntityItem.h b/libraries/entities/src/EntityItem.h index 29a1a8d73c..424454f528 100644 --- a/libraries/entities/src/EntityItem.h +++ b/libraries/entities/src/EntityItem.h @@ -23,6 +23,7 @@ #include // for OctreeElement::AppendState #include #include +#include #include #include #include @@ -33,11 +34,11 @@ #include "EntityPropertyFlags.h" #include "EntityTypes.h" #include "SimulationOwner.h" -#include "SimulationFlags.h" #include "EntityDynamicInterface.h" #include "GrabPropertyGroup.h" class EntitySimulation; +using EntitySimulationPointer = std::shared_ptr; class EntityTreeElement; class EntityTreeElementExtraEncodeData; class EntityDynamicInterface; @@ -133,7 +134,8 @@ public: virtual EntityPropertyFlags getEntityProperties(EncodeBitstreamParams& params) const; virtual OctreeElement::AppendState appendEntityData(OctreePacketData* packetData, EncodeBitstreamParams& params, - EntityTreeElementExtraEncodeDataPointer entityTreeElementExtraEncodeData) const; + EntityTreeElementExtraEncodeDataPointer entityTreeElementExtraEncodeData, + const bool destinationNodeCanGetAndSetPrivateUserData = false) const; virtual void appendSubclassData(OctreePacketData* packetData, EncodeBitstreamParams& params, EntityTreeElementExtraEncodeDataPointer entityTreeElementExtraEncodeData, @@ -322,7 +324,7 @@ public: bool getDynamic() const; void setDynamic(bool value); - virtual bool shouldBePhysical() const { return false; } + virtual bool shouldBePhysical() const { return !isDead() && getShapeType() != SHAPE_TYPE_NONE; } bool isVisuallyReady() const { return _visuallyReady; } bool getLocked() const; @@ -331,6 +333,9 @@ public: QString getUserData() const; virtual void setUserData(const QString& value); // FIXME: This is suspicious + QString getPrivateUserData() const; + void setPrivateUserData(const QString& value); + // FIXME not thread safe? const SimulationOwner& getSimulationOwner() const { return _simulationOwner; } void setSimulationOwner(const QUuid& id, uint8_t priority); @@ -423,8 +428,9 @@ public: bool isSimulated() const { return _simulated; } - void* getPhysicsInfo() const { return _physicsInfo; } + bool isInPhysicsSimulation() const { return (bool)(_flags & Simulation::SPECIAL_FLAG_IN_PHYSICS_SIMULATION); } + void* getPhysicsInfo() const { return _physicsInfo; } void setPhysicsInfo(void* data) { _physicsInfo = data; } EntityTreeElementPointer getElement() const { return _element; } @@ -501,6 +507,7 @@ public: virtual bool isWearable() const; bool isDomainEntity() const { return _hostType == entity::HostType::DOMAIN; } bool isAvatarEntity() const { return _hostType == entity::HostType::AVATAR; } + bool isMyAvatarEntity() const; bool isLocalEntity() const { return _hostType == entity::HostType::LOCAL; } entity::HostType getEntityHostType() const { return _hostType; } virtual void setEntityHostType(entity::HostType hostType) { _hostType = hostType; } @@ -641,6 +648,7 @@ protected: bool _dynamic { ENTITY_ITEM_DEFAULT_DYNAMIC }; bool _locked { ENTITY_ITEM_DEFAULT_LOCKED }; QString _userData { ENTITY_ITEM_DEFAULT_USER_DATA }; + QString _privateUserData{ ENTITY_ITEM_DEFAULT_PRIVATE_USER_DATA }; SimulationOwner _simulationOwner; bool _shouldHighlight { false }; QString _name { ENTITY_ITEM_DEFAULT_NAME }; diff --git a/libraries/entities/src/EntityItemProperties.cpp b/libraries/entities/src/EntityItemProperties.cpp index 2b738bc4e7..ce4387a006 100644 --- a/libraries/entities/src/EntityItemProperties.cpp +++ b/libraries/entities/src/EntityItemProperties.cpp @@ -487,6 +487,7 @@ EntityPropertyFlags EntityItemProperties::getChangedProperties() const { CHECK_PROPERTY_CHANGE(PROP_NAME, name); CHECK_PROPERTY_CHANGE(PROP_LOCKED, locked); CHECK_PROPERTY_CHANGE(PROP_USER_DATA, userData); + CHECK_PROPERTY_CHANGE(PROP_PRIVATE_USER_DATA, privateUserData); CHECK_PROPERTY_CHANGE(PROP_HREF, href); CHECK_PROPERTY_CHANGE(PROP_DESCRIPTION, description); CHECK_PROPERTY_CHANGE(PROP_POSITION, position); @@ -801,7 +802,7 @@ EntityPropertyFlags EntityItemProperties::getChangedProperties() const { * * @property {boolean} collisionless=false - Whether or not the entity should collide with items per its * collisionMask property. If true then the entity does not collide. A synonym is ignoreForCollisions. - * @property {Entities.CollisionMask} collisionMask=31 - What types of items the entity should collide with. + * @property {CollisionMask} collisionMask=31 - What types of items the entity should collide with. * @property {string} collidesWith="static,dynamic,kinematic,myAvatar,otherAvatar," - Synonym for collisionMask, * in text format. * @property {string} collisionSoundURL="" - The sound to play when the entity experiences a collision. Valid file formats are @@ -818,6 +819,9 @@ EntityPropertyFlags EntityItemProperties::getChangedProperties() const { * which you can manipulate the properties of, and use JSON.stringify() to convert the object into a string to * put in the property. * + * @property {string} privateUserData="" - Like userData, but only accessible by Entity Server Scripts, AC scripts, and users + * who are given "Can Get and Set Private User Data" permissions from the ACL matrix on the Domain Settings page. + * * @property {string} script="" - The URL of the client entity script, if any, that is attached to the entity. * @property {number} scriptTimestamp=0 - Intended to be used to indicate when the client entity script was loaded. Should be * an integer number of milliseconds since midnight GMT on January 1, 1970 (e.g., as supplied by Date.now(). @@ -1591,6 +1595,7 @@ QScriptValue EntityItemProperties::copyToScriptValue(QScriptEngine* engine, bool COPY_PROPERTY_TO_QSCRIPTVALUE(PROP_NAME, name); COPY_PROPERTY_TO_QSCRIPTVALUE(PROP_LOCKED, locked); COPY_PROPERTY_TO_QSCRIPTVALUE(PROP_USER_DATA, userData); + COPY_PROPERTY_TO_QSCRIPTVALUE(PROP_PRIVATE_USER_DATA, privateUserData); COPY_PROPERTY_TO_QSCRIPTVALUE(PROP_HREF, href); COPY_PROPERTY_TO_QSCRIPTVALUE(PROP_DESCRIPTION, description); COPY_PROPERTY_TO_QSCRIPTVALUE(PROP_POSITION, position); @@ -1999,6 +2004,7 @@ void EntityItemProperties::copyFromScriptValue(const QScriptValue& object, bool COPY_PROPERTY_FROM_QSCRIPTVALUE(name, QString, setName); COPY_PROPERTY_FROM_QSCRIPTVALUE(locked, bool, setLocked); COPY_PROPERTY_FROM_QSCRIPTVALUE(userData, QString, setUserData); + COPY_PROPERTY_FROM_QSCRIPTVALUE(privateUserData, QString, setPrivateUserData); COPY_PROPERTY_FROM_QSCRIPTVALUE(href, QString, setHref); COPY_PROPERTY_FROM_QSCRIPTVALUE(description, QString, setDescription); COPY_PROPERTY_FROM_QSCRIPTVALUE(position, vec3, setPosition); @@ -2288,6 +2294,7 @@ void EntityItemProperties::merge(const EntityItemProperties& other) { COPY_PROPERTY_IF_CHANGED(name); COPY_PROPERTY_IF_CHANGED(locked); COPY_PROPERTY_IF_CHANGED(userData); + COPY_PROPERTY_IF_CHANGED(privateUserData); COPY_PROPERTY_IF_CHANGED(href); COPY_PROPERTY_IF_CHANGED(description); COPY_PROPERTY_IF_CHANGED(position); @@ -2573,6 +2580,7 @@ bool EntityItemProperties::getPropertyInfo(const QString& propertyName, EntityPr ADD_PROPERTY_TO_MAP(PROP_NAME, Name, name, QString); ADD_PROPERTY_TO_MAP(PROP_LOCKED, Locked, locked, bool); ADD_PROPERTY_TO_MAP(PROP_USER_DATA, UserData, userData, QString); + ADD_PROPERTY_TO_MAP(PROP_PRIVATE_USER_DATA, PrivateUserData, privateUserData, QString); ADD_PROPERTY_TO_MAP(PROP_HREF, Href, href, QString); ADD_PROPERTY_TO_MAP(PROP_DESCRIPTION, Description, description, QString); ADD_PROPERTY_TO_MAP(PROP_POSITION, Position, position, vec3); @@ -3047,6 +3055,7 @@ OctreeElement::AppendState EntityItemProperties::encodeEntityEditPacket(PacketTy APPEND_ENTITY_PROPERTY(PROP_NAME, properties.getName()); APPEND_ENTITY_PROPERTY(PROP_LOCKED, properties.getLocked()); APPEND_ENTITY_PROPERTY(PROP_USER_DATA, properties.getUserData()); + APPEND_ENTITY_PROPERTY(PROP_PRIVATE_USER_DATA, properties.getPrivateUserData()); APPEND_ENTITY_PROPERTY(PROP_HREF, properties.getHref()); APPEND_ENTITY_PROPERTY(PROP_DESCRIPTION, properties.getDescription()); APPEND_ENTITY_PROPERTY(PROP_POSITION, properties.getPosition()); @@ -3530,6 +3539,7 @@ bool EntityItemProperties::decodeEntityEditPacket(const unsigned char* data, int READ_ENTITY_PROPERTY_TO_PROPERTIES(PROP_NAME, QString, setName); READ_ENTITY_PROPERTY_TO_PROPERTIES(PROP_LOCKED, bool, setLocked); READ_ENTITY_PROPERTY_TO_PROPERTIES(PROP_USER_DATA, QString, setUserData); + READ_ENTITY_PROPERTY_TO_PROPERTIES(PROP_PRIVATE_USER_DATA, QString, setPrivateUserData); READ_ENTITY_PROPERTY_TO_PROPERTIES(PROP_HREF, QString, setHref); READ_ENTITY_PROPERTY_TO_PROPERTIES(PROP_DESCRIPTION, QString, setDescription); READ_ENTITY_PROPERTY_TO_PROPERTIES(PROP_POSITION, vec3, setPosition); @@ -3941,6 +3951,7 @@ void EntityItemProperties::markAllChanged() { _nameChanged = true; _lockedChanged = true; _userDataChanged = true; + _privateUserDataChanged = true; _hrefChanged = true; _descriptionChanged = true; _positionChanged = true; @@ -4303,6 +4314,9 @@ QList EntityItemProperties::listChangedProperties() { if (userDataChanged()) { out += "userData"; } + if (privateUserDataChanged()) { + out += "privateUserData"; + } if (hrefChanged()) { out += "href"; } diff --git a/libraries/entities/src/EntityItemProperties.h b/libraries/entities/src/EntityItemProperties.h index 0142f42536..af945a89de 100644 --- a/libraries/entities/src/EntityItemProperties.h +++ b/libraries/entities/src/EntityItemProperties.h @@ -180,6 +180,7 @@ public: DEFINE_PROPERTY_REF(PROP_NAME, Name, name, QString, ENTITY_ITEM_DEFAULT_NAME); DEFINE_PROPERTY(PROP_LOCKED, Locked, locked, bool, ENTITY_ITEM_DEFAULT_LOCKED); DEFINE_PROPERTY_REF(PROP_USER_DATA, UserData, userData, QString, ENTITY_ITEM_DEFAULT_USER_DATA); + DEFINE_PROPERTY_REF(PROP_PRIVATE_USER_DATA, PrivateUserData, privateUserData, QString, ENTITY_ITEM_DEFAULT_PRIVATE_USER_DATA); DEFINE_PROPERTY_REF(PROP_HREF, Href, href, QString, ""); DEFINE_PROPERTY_REF(PROP_DESCRIPTION, Description, description, QString, ""); DEFINE_PROPERTY_REF_WITH_SETTER(PROP_POSITION, Position, position, glm::vec3, ENTITY_ITEM_ZERO_VEC3); @@ -607,6 +608,7 @@ inline QDebug operator<<(QDebug debug, const EntityItemProperties& properties) { DEBUG_PROPERTY_IF_CHANGED(debug, properties, Locked, locked, ""); DEBUG_PROPERTY_IF_CHANGED(debug, properties, Textures, textures, ""); DEBUG_PROPERTY_IF_CHANGED(debug, properties, UserData, userData, ""); + DEBUG_PROPERTY_IF_CHANGED(debug, properties, PrivateUserData, privateUserData, ""); DEBUG_PROPERTY_IF_CHANGED(debug, properties, SimulationOwner, simulationOwner, SimulationOwner()); DEBUG_PROPERTY_IF_CHANGED(debug, properties, Text, text, ""); DEBUG_PROPERTY_IF_CHANGED(debug, properties, LineHeight, lineHeight, ""); diff --git a/libraries/entities/src/EntityItemPropertiesDefaults.h b/libraries/entities/src/EntityItemPropertiesDefaults.h index be3c566724..cc12eb37b4 100644 --- a/libraries/entities/src/EntityItemPropertiesDefaults.h +++ b/libraries/entities/src/EntityItemPropertiesDefaults.h @@ -28,6 +28,7 @@ const QVector ENTITY_ITEM_DEFAULT_EMPTY_VEC3_QVEC = QVectorgetPacketReceiver(); packetReceiver.registerListener(PacketType::EntityScriptCallMethod, this, "handleEntityScriptCallMethodPacket"); @@ -107,6 +108,11 @@ bool EntityScriptingInterface::canReplaceContent() { return nodeList->getThisNodeCanReplaceContent(); } +bool EntityScriptingInterface::canGetAndSetPrivateUserData() { + auto nodeList = DependencyManager::get(); + return nodeList->getThisNodeCanGetAndSetPrivateUserData(); +} + void EntityScriptingInterface::setEntityTree(EntityTreePointer elementTree) { if (_entityTree) { disconnect(_entityTree.get(), &EntityTree::addingEntityPointer, this, &EntityScriptingInterface::onAddingEntity); diff --git a/libraries/entities/src/EntityScriptingInterface.h b/libraries/entities/src/EntityScriptingInterface.h index 38b73aaf45..c072dedaf9 100644 --- a/libraries/entities/src/EntityScriptingInterface.h +++ b/libraries/entities/src/EntityScriptingInterface.h @@ -236,6 +236,14 @@ public slots: */ Q_INVOKABLE bool canReplaceContent(); + /**jsdoc + * Check whether or not you can get and set private user data. + * @function Entities.canGetAndSetPrivateUserData + * @returns {boolean} true if the domain server will allow the user to get and set private user data, + * otherwise false. + */ + Q_INVOKABLE bool canGetAndSetPrivateUserData(); + /**jsdoc *

How an entity is sent over the wire.

* @@ -1861,6 +1869,15 @@ signals: */ void canWriteAssetsChanged(bool canWriteAssets); + /**jsdoc + * Triggered when your ability to get and set private user data changes. + * @function Entities.canGetAndSetPrivateUserDataChanged + * @param {boolean} canGetAndSetPrivateUserData - true if you can change the privateUserData property of an entity, + * otherwise false. + * @returns {Signal} + */ + void canGetAndSetPrivateUserDataChanged(bool canGetAndSetPrivateUserData); + /**jsdoc * Triggered when a mouse button is clicked while the mouse cursor is on an entity, or a controller trigger is fully diff --git a/libraries/entities/src/EntitySimulation.cpp b/libraries/entities/src/EntitySimulation.cpp index 05e71a8f06..b5e4fed0fd 100644 --- a/libraries/entities/src/EntitySimulation.cpp +++ b/libraries/entities/src/EntitySimulation.cpp @@ -176,47 +176,44 @@ void EntitySimulation::addEntity(EntityItemPointer entity) { void EntitySimulation::changeEntity(EntityItemPointer entity) { QMutexLocker lock(&_mutex); assert(entity); - if (!entity->isSimulated()) { - // This entity was either never added to the simulation or has been removed - // (probably for pending delete), so we don't want to keep a pointer to it - // on any internal lists. - return; - } + _changedEntities.insert(entity); +} - // Although it is not the responsibility of the EntitySimulation to sort the tree for EXTERNAL changes - // it IS responsibile for triggering deletes for entities that leave the bounds of the domain, hence - // we must check for that case here, however we rely on the change event to have set DIRTY_POSITION flag. +void EntitySimulation::processChangedEntities() { + QMutexLocker lock(&_mutex); + PROFILE_RANGE_EX(simulation_physics, "processChangedEntities", 0xffff00ff, (uint64_t)_changedEntities.size()); + for (auto& entity : _changedEntities) { + if (entity->isSimulated()) { + processChangedEntity(entity); + } + } + _changedEntities.clear(); +} + +void EntitySimulation::processChangedEntity(const EntityItemPointer& entity) { uint32_t dirtyFlags = entity->getDirtyFlags(); - if (dirtyFlags & Simulation::DIRTY_POSITION) { - AACube domainBounds(glm::vec3((float)-HALF_TREE_SCALE), (float)TREE_SCALE); - bool success; - AACube newCube = entity->getQueryAACube(success); - if (success && !domainBounds.touches(newCube)) { - qCDebug(entities) << "Entity " << entity->getEntityItemID() << " moved out of domain bounds."; - entity->die(); - prepareEntityForDelete(entity); - return; - } - } - if (dirtyFlags & Simulation::DIRTY_LIFETIME) { - if (entity->isMortal()) { - _mortalEntities.insert(entity); - uint64_t expiry = entity->getExpiry(); - if (expiry < _nextExpiry) { - _nextExpiry = expiry; + if (dirtyFlags & (Simulation::DIRTY_LIFETIME | Simulation::DIRTY_UPDATEABLE)) { + if (dirtyFlags & Simulation::DIRTY_LIFETIME) { + if (entity->isMortal()) { + _mortalEntities.insert(entity); + uint64_t expiry = entity->getExpiry(); + if (expiry < _nextExpiry) { + _nextExpiry = expiry; + } + } else { + _mortalEntities.remove(entity); } - } else { - _mortalEntities.remove(entity); } - entity->clearDirtyFlags(Simulation::DIRTY_LIFETIME); + if (dirtyFlags & Simulation::DIRTY_UPDATEABLE) { + if (entity->needsToCallUpdate()) { + _entitiesToUpdate.insert(entity); + } else { + _entitiesToUpdate.remove(entity); + } + } + entity->clearDirtyFlags(Simulation::DIRTY_LIFETIME | Simulation::DIRTY_UPDATEABLE); } - if (entity->needsToCallUpdate()) { - _entitiesToUpdate.insert(entity); - } else { - _entitiesToUpdate.remove(entity); - } - changeEntityInternal(entity); } void EntitySimulation::clearEntities() { diff --git a/libraries/entities/src/EntitySimulation.h b/libraries/entities/src/EntitySimulation.h index f107bcae6e..1dd0369561 100644 --- a/libraries/entities/src/EntitySimulation.h +++ b/libraries/entities/src/EntitySimulation.h @@ -13,6 +13,7 @@ #define hifi_EntitySimulation_h #include +#include #include #include @@ -82,13 +83,15 @@ public: /// \param entity pointer to EntityItem that needs to be put on the entitiesToDelete list and removed from others. virtual void prepareEntityForDelete(EntityItemPointer entity); + void processChangedEntities(); + protected: // These pure virtual methods are protected because they are not to be called will-nilly. The base class // calls them in the right places. virtual void updateEntitiesInternal(uint64_t now) = 0; virtual void addEntityInternal(EntityItemPointer entity) = 0; virtual void removeEntityInternal(EntityItemPointer entity); - virtual void changeEntityInternal(EntityItemPointer entity) = 0; + virtual void processChangedEntity(const EntityItemPointer& entity); virtual void clearEntitiesInternal() = 0; void expireMortalEntities(uint64_t now); @@ -114,11 +117,11 @@ private: // We maintain multiple lists, each for its distinct purpose. // An entity may be in more than one list. + std::unordered_set _changedEntities; // all changes this frame SetOfEntities _allEntities; // tracks all entities added the simulation SetOfEntities _mortalEntities; // entities that have an expiry uint64_t _nextExpiry; - SetOfEntities _entitiesToUpdate; // entities that need to call EntityItem::update() }; diff --git a/libraries/entities/src/EntityTree.cpp b/libraries/entities/src/EntityTree.cpp index b3dd78ae92..652266bd48 100644 --- a/libraries/entities/src/EntityTree.cpp +++ b/libraries/entities/src/EntityTree.cpp @@ -1286,6 +1286,14 @@ void EntityTree::fixupTerseEditLogging(EntityItemProperties& properties, QList= 0) { + QString changeHint = properties.getPrivateUserData(); + changedProperties[index] = QString("privateUserData:") + changeHint; + } + } + if (properties.parentJointIndexChanged()) { int index = changedProperties.indexOf("parentJointIndex"); if (index >= 0) { @@ -1772,6 +1780,7 @@ int EntityTree::processEditPacketData(ReceivedMessage& message, const unsigned c bool suppressDisallowedClientScript = false; bool suppressDisallowedServerScript = false; + bool suppressDisallowedPrivateUserData = false; bool isPhysics = message.getType() == PacketType::EntityPhysics; _totalEditMessages++; @@ -1860,7 +1869,22 @@ int EntityTree::processEditPacketData(ReceivedMessage& message, const unsigned c } } } + } + if (!properties.getPrivateUserData().isEmpty() && validEditPacket && !senderNode->getCanGetAndSetPrivateUserData()) { + if (wantEditLogging()) { + qCDebug(entities) << "User [" << senderNode->getUUID() + << "] is attempting to set private user data but user isn't allowed; edit rejected..."; + } + + // If this was an add, we also want to tell the client that sent this edit that the entity was not added. + if (isAdd) { + QWriteLocker locker(&_recentlyDeletedEntitiesLock); + _recentlyDeletedEntityItemIDs.insert(usecTimestampNow(), entityItemID); + validEditPacket = false; + } else { + suppressDisallowedPrivateUserData = true; + } } if (!isClone) { @@ -1915,6 +1939,11 @@ int EntityTree::processEditPacketData(ReceivedMessage& message, const unsigned c properties.setServerScripts(existingEntity->getServerScripts()); } + if (suppressDisallowedPrivateUserData) { + bumpTimestamp(properties); + properties.setPrivateUserData(existingEntity->getPrivateUserData()); + } + // if the EntityItem exists, then update it startLogging = usecTimestampNow(); if (wantEditLogging()) { @@ -2079,7 +2108,6 @@ void EntityTree::entityChanged(EntityItemPointer entity) { } void EntityTree::fixupNeedsParentFixups() { - PROFILE_RANGE(simulation_physics, "FixupParents"); MovingEntitiesOperator moveOperator; QVector entitiesToFixup; { @@ -2189,11 +2217,19 @@ void EntityTree::addToNeedsParentFixupList(EntityItemPointer entity) { _needsParentFixup.append(entity); } +void EntityTree::preUpdate() { + withWriteLock([&] { + fixupNeedsParentFixups(); + if (_simulation) { + _simulation->processChangedEntities(); + } + }); +} + void EntityTree::update(bool simulate) { PROFILE_RANGE(simulation_physics, "UpdateTree"); PerformanceTimer perfTimer("updateTree"); withWriteLock([&] { - fixupNeedsParentFixups(); if (simulate && _simulation) { _simulation->updateEntities(); { diff --git a/libraries/entities/src/EntityTree.h b/libraries/entities/src/EntityTree.h index c80517c82b..9108f8d8d2 100644 --- a/libraries/entities/src/EntityTree.h +++ b/libraries/entities/src/EntityTree.h @@ -109,9 +109,10 @@ public: virtual void releaseSceneEncodeData(OctreeElementExtraEncodeData* extraEncodeData) const override; - virtual void update() override { update(true); } - - void update(bool simulate); + // Why preUpdate() and update()? + // Because sometimes we need to do stuff between the two. + void preUpdate() override; + void update(bool simulate = true) override; // The newer API... void postAddEntity(EntityItemPointer entityItem); diff --git a/libraries/entities/src/ModelEntityItem.cpp b/libraries/entities/src/ModelEntityItem.cpp index 505ee26c0f..cb9637acd5 100644 --- a/libraries/entities/src/ModelEntityItem.cpp +++ b/libraries/entities/src/ModelEntityItem.cpp @@ -421,11 +421,6 @@ void ModelEntityItem::setAnimationFPS(float value) { }); } -// virtual -bool ModelEntityItem::shouldBePhysical() const { - return !isDead() && getShapeType() != SHAPE_TYPE_NONE && QUrl(_modelURL).isValid(); -} - void ModelEntityItem::resizeJointArrays(int newSize) { if (newSize < 0) { return; diff --git a/libraries/entities/src/ModelEntityItem.h b/libraries/entities/src/ModelEntityItem.h index d532fefe7e..75a695f1c0 100644 --- a/libraries/entities/src/ModelEntityItem.h +++ b/libraries/entities/src/ModelEntityItem.h @@ -118,8 +118,6 @@ public: const QString getTextures() const; void setTextures(const QString& textures); - virtual bool shouldBePhysical() const override; - virtual void setJointRotations(const QVector& rotations); virtual void setJointRotationsSet(const QVector& rotationsSet); virtual void setJointTranslations(const QVector& translations); diff --git a/libraries/entities/src/ParticleEffectEntityItem.h b/libraries/entities/src/ParticleEffectEntityItem.h index 52f229201e..b526298a4b 100644 --- a/libraries/entities/src/ParticleEffectEntityItem.h +++ b/libraries/entities/src/ParticleEffectEntityItem.h @@ -231,6 +231,8 @@ public: EntityPropertyFlags& propertyFlags, bool overwriteLocalData, bool& somethingChanged) override; + bool shouldBePhysical() const override { return false; } + void setColor(const glm::u8vec3& value); glm::u8vec3 getColor() const { return _particleProperties.color.gradient.target; } diff --git a/libraries/entities/src/PolyVoxEntityItem.h b/libraries/entities/src/PolyVoxEntityItem.h index dd05ce67b1..a6076dfda7 100644 --- a/libraries/entities/src/PolyVoxEntityItem.h +++ b/libraries/entities/src/PolyVoxEntityItem.h @@ -164,7 +164,6 @@ class PolyVoxEntityItem : public EntityItem { glm::vec3 getSurfacePositionAdjustment() const; virtual ShapeType getShapeType() const override; - virtual bool shouldBePhysical() const override { return !isDead(); } bool isEdged() const; diff --git a/libraries/entities/src/ShapeEntityItem.h b/libraries/entities/src/ShapeEntityItem.h index fc590e06a4..3622c74f50 100644 --- a/libraries/entities/src/ShapeEntityItem.h +++ b/libraries/entities/src/ShapeEntityItem.h @@ -84,8 +84,6 @@ public: void setUnscaledDimensions(const glm::vec3& value) override; - bool shouldBePhysical() const override { return !isDead(); } - bool supportsDetailedIntersection() const override; bool findDetailedRayIntersection(const glm::vec3& origin, const glm::vec3& direction, OctreeElementPointer& element, float& distance, diff --git a/libraries/entities/src/SimpleEntitySimulation.cpp b/libraries/entities/src/SimpleEntitySimulation.cpp index 28dc7b26c4..b8e3df2d03 100644 --- a/libraries/entities/src/SimpleEntitySimulation.cpp +++ b/libraries/entities/src/SimpleEntitySimulation.cpp @@ -85,7 +85,9 @@ void SimpleEntitySimulation::removeEntityInternal(EntityItemPointer entity) { _entitiesThatNeedSimulationOwner.remove(entity); } -void SimpleEntitySimulation::changeEntityInternal(EntityItemPointer entity) { +void SimpleEntitySimulation::processChangedEntity(const EntityItemPointer& entity) { + EntitySimulation::processChangedEntity(entity); + uint32_t flags = entity->getDirtyFlags(); if ((flags & Simulation::DIRTY_SIMULATOR_ID) || (flags & Simulation::DIRTY_VELOCITIES)) { if (entity->getSimulatorID().isNull()) { diff --git a/libraries/entities/src/SimpleEntitySimulation.h b/libraries/entities/src/SimpleEntitySimulation.h index 8ac9b69e93..1b240a8bf0 100644 --- a/libraries/entities/src/SimpleEntitySimulation.h +++ b/libraries/entities/src/SimpleEntitySimulation.h @@ -31,7 +31,7 @@ protected: void updateEntitiesInternal(uint64_t now) override; void addEntityInternal(EntityItemPointer entity) override; void removeEntityInternal(EntityItemPointer entity) override; - void changeEntityInternal(EntityItemPointer entity) override; + void processChangedEntity(const EntityItemPointer& entity) override; void clearEntitiesInternal() override; void sortEntitiesThatMoved() override; diff --git a/libraries/entities/src/SimulationOwner.h b/libraries/entities/src/SimulationOwner.h index f574234354..6f37066e47 100644 --- a/libraries/entities/src/SimulationOwner.h +++ b/libraries/entities/src/SimulationOwner.h @@ -89,6 +89,8 @@ // (14) When an entity's ownership priority drops to YIELD (=1, below VOLUNTEER) other participants may // bid for it immediately at VOLUNTEER. // +/* These declarations temporarily moved to SimulationFlags.h while we unravel some spaghetti dependencies. + * The intent is to move them back here once the dust settles. const uint8_t YIELD_SIMULATION_PRIORITY = 1; const uint8_t VOLUNTEER_SIMULATION_PRIORITY = YIELD_SIMULATION_PRIORITY + 1; const uint8_t RECRUIT_SIMULATION_PRIORITY = VOLUNTEER_SIMULATION_PRIORITY + 1; @@ -101,6 +103,7 @@ const uint8_t SCRIPT_POKE_SIMULATION_PRIORITY = SCRIPT_GRAB_SIMULATION_PRIORITY // which really just means: things that collide with it will be bid at a priority level one lower const uint8_t PERSONAL_SIMULATION_PRIORITY = SCRIPT_GRAB_SIMULATION_PRIORITY; const uint8_t AVATAR_ENTITY_SIMULATION_PRIORITY = PERSONAL_SIMULATION_PRIORITY; +*/ class SimulationOwner { diff --git a/libraries/entities/src/ZoneEntityItem.h b/libraries/entities/src/ZoneEntityItem.h index 69e3227135..34ad47f095 100644 --- a/libraries/entities/src/ZoneEntityItem.h +++ b/libraries/entities/src/ZoneEntityItem.h @@ -62,6 +62,7 @@ public: virtual bool isReadyToComputeShape() const override { return false; } virtual void setShapeType(ShapeType type) override; virtual ShapeType getShapeType() const override; + bool shouldBePhysical() const override { return false; } QString getCompoundShapeURL() const; virtual void setCompoundShapeURL(const QString& url); diff --git a/libraries/gl/src/gl/GLHelpers.cpp b/libraries/gl/src/gl/GLHelpers.cpp index 2c02fdca03..7b47736a3d 100644 --- a/libraries/gl/src/gl/GLHelpers.cpp +++ b/libraries/gl/src/gl/GLHelpers.cpp @@ -71,19 +71,159 @@ void gl::globalRelease(bool finish) {} #endif -void gl::getTargetVersion(int& major, int& minor) { +uint16_t gl::getTargetVersion() { + uint8_t major = 0, minor = 0; + #if defined(USE_GLES) major = 3; minor = 2; -#else -#if defined(Q_OS_MAC) +#elif defined(Q_OS_MAC) major = 4; minor = 1; #else major = 4; minor = disableGl45() ? 1 : 5; #endif + return GL_MAKE_VERSION(major, minor); +} + +uint16_t gl::getRequiredVersion() { + uint8_t major = 0, minor = 0; +#if defined(USE_GLES) + major = 3; + minor = 2; +#else + major = 4; + minor = 1; #endif + return GL_MAKE_VERSION(major, minor); +} + +#if defined(Q_OS_WIN) + +typedef BOOL(APIENTRYP PFNWGLCHOOSEPIXELFORMATARBPROC)(HDC hdc, const int *piAttribIList, const FLOAT *pfAttribFList, UINT nMaxFormats, int *piFormats, UINT *nNumFormats); +typedef HGLRC(APIENTRYP PFNWGLCREATECONTEXTATTRIBSARBPROC)(HDC hDC, HGLRC hShareContext, const int *attribList); +GLAPI PFNWGLCHOOSEPIXELFORMATARBPROC wglChoosePixelFormatARB; +GLAPI PFNWGLCREATECONTEXTATTRIBSARBPROC wglCreateContextAttribsARB; + +static bool setupPixelFormatSimple(HDC hdc) { + // FIXME build the PFD based on the + static const PIXELFORMATDESCRIPTOR pfd = // pfd Tells Windows How We Want Things To Be + { + sizeof(PIXELFORMATDESCRIPTOR), // Size Of This Pixel Format Descriptor + 1, // Version Number + PFD_DRAW_TO_WINDOW | // Format Must Support Window + PFD_SUPPORT_OPENGL | // Format Must Support OpenGL + PFD_DOUBLEBUFFER, // Must Support Double Buffering + PFD_TYPE_RGBA, // Request An RGBA Format + 24, // Select Our Color Depth + 0, 0, 0, 0, 0, 0, // Color Bits Ignored + 1, // Alpha Buffer + 0, // Shift Bit Ignored + 0, // No Accumulation Buffer + 0, 0, 0, 0, // Accumulation Bits Ignored + 24, // 24 Bit Z-Buffer (Depth Buffer) + 8, // 8 Bit Stencil Buffer + 0, // No Auxiliary Buffer + PFD_MAIN_PLANE, // Main Drawing Layer + 0, // Reserved + 0, 0, 0 // Layer Masks Ignored + }; + auto pixelFormat = ChoosePixelFormat(hdc, &pfd); + if (pixelFormat == 0) { + return false; + } + + if (SetPixelFormat(hdc, pixelFormat, &pfd) == FALSE) { + return false; + } + return true; +} + +#endif + +uint16_t gl::getAvailableVersion() { + static uint8_t major = 0, minor = 0; + static std::once_flag once; + std::call_once(once, [&] { +#if defined(USE_GLES) + // FIXME do runtime detection of the available GL version + major = 3; + minor = 2; +#elif defined(Q_OS_MAC) + // Damn it Apple. + major = 4; + minor = 1; +#elif defined(Q_OS_WIN) + // + HINSTANCE hInstance = GetModuleHandle(nullptr); + const auto windowClassName = "OpenGLVersionCheck"; + WNDCLASS wc = { }; + wc.lpfnWndProc = DefWindowProc; + wc.hInstance = hInstance; + wc.lpszClassName = windowClassName; + RegisterClass(&wc); + + using Handle = std::shared_ptr; + HWND rawHwnd = CreateWindowEx( + WS_EX_APPWINDOW, // extended style + windowClassName, // class name + windowClassName, // title + WS_CLIPSIBLINGS | WS_CLIPCHILDREN | CS_OWNDC | WS_POPUP, // style + 0, 0, 10, 10, // position and size + NULL, NULL, hInstance, NULL); + auto WindowDestroyer = [](void* handle) { + DestroyWindow((HWND)handle); + }; + Handle hWnd = Handle(rawHwnd, WindowDestroyer); + if (!hWnd) { + return; + } + HDC rawDC = GetDC(rawHwnd); + auto DCDestroyer = [=](void* handle) { + ReleaseDC(rawHwnd, (HDC)handle); + }; + if (!rawDC) { + return; + } + Handle hDC = Handle(rawDC, DCDestroyer); + if (!setupPixelFormatSimple(rawDC)) { + return; + } + auto GLRCDestroyer = [](void* handle) { + wglDeleteContext((HGLRC)handle); + }; + auto rawglrc = wglCreateContext(rawDC); + if (!rawglrc) { + return; + } + Handle hGLRC = Handle(rawglrc, GLRCDestroyer); + if (!wglMakeCurrent(rawDC, rawglrc)) { + return; + } + gl::initModuleGl(); + wglMakeCurrent(0, 0); + hGLRC.reset(); + if (!wglChoosePixelFormatARB || !wglCreateContextAttribsARB) { + return; + } + + // The only two versions we care about on Windows + // are 4.5 and 4.1 + if (GLAD_GL_VERSION_4_5) { + major = 4; + minor = disableGl45() ? 1 : 5; + } else if (GLAD_GL_VERSION_4_1) { + major = 4; + minor = 1; + } +#else + // FIXME do runtime detection of GL version on non-Mac/Windows/Mobile platforms + major = 4; + minor = disableGl45() ? 1 : 5; +#endif + }); + return GL_MAKE_VERSION(major, minor); } const QSurfaceFormat& getDefaultOpenGLSurfaceFormat() { @@ -105,10 +245,9 @@ const QSurfaceFormat& getDefaultOpenGLSurfaceFormat() { // Qt Quick may need a depth and stencil buffer. Always make sure these are available. format.setDepthBufferSize(DEFAULT_GL_DEPTH_BUFFER_BITS); format.setStencilBufferSize(DEFAULT_GL_STENCIL_BUFFER_BITS); - int major, minor; - ::gl::getTargetVersion(major, minor); - format.setMajorVersion(major); - format.setMinorVersion(minor); + auto glversion = ::gl::getTargetVersion(); + format.setMajorVersion(GL_GET_MAJOR_VERSION(glversion)); + format.setMinorVersion(GL_GET_MINOR_VERSION(glversion)); }); return format; } diff --git a/libraries/gl/src/gl/GLHelpers.h b/libraries/gl/src/gl/GLHelpers.h index 2a798e6e98..95c3b6a5c2 100644 --- a/libraries/gl/src/gl/GLHelpers.h +++ b/libraries/gl/src/gl/GLHelpers.h @@ -34,6 +34,10 @@ int glVersionToInteger(QString glVersion); bool isRenderThread(); +#define GL_MAKE_VERSION(major, minor) ((major << 8) | minor) +#define GL_GET_MINOR_VERSION(glversion) (glversion & 0x00FF) +#define GL_GET_MAJOR_VERSION(glversion) ((glversion & 0xFF00) >> 8) + namespace gl { void globalLock(); void globalRelease(bool finish = true); @@ -52,7 +56,11 @@ namespace gl { bool disableGl45(); - void getTargetVersion(int& major, int& minor); + uint16_t getTargetVersion(); + + uint16_t getAvailableVersion(); + + uint16_t getRequiredVersion(); } // namespace gl #define CHECK_GL_ERROR() ::gl::checkGLErrorDebug(__FUNCTION__) diff --git a/libraries/model-baker/src/model-baker/CalculateBlendshapeNormalsTask.cpp b/libraries/model-baker/src/model-baker/CalculateBlendshapeNormalsTask.cpp index b908fa9ced..e09bf7a419 100644 --- a/libraries/model-baker/src/model-baker/CalculateBlendshapeNormalsTask.cpp +++ b/libraries/model-baker/src/model-baker/CalculateBlendshapeNormalsTask.cpp @@ -61,7 +61,7 @@ void CalculateBlendshapeNormalsTask::run(const baker::BakeContextPointer& contex outVertex = blendshape.vertices[lookupIndex]; } else { // Index isn't in the blendshape, so return vertex from mesh - outVertex = mesh.vertices[lookupIndex]; + outVertex = baker::safeGet(mesh.vertices, lookupIndex); } }); } diff --git a/libraries/model-baker/src/model-baker/CalculateMeshNormalsTask.cpp b/libraries/model-baker/src/model-baker/CalculateMeshNormalsTask.cpp index a6884e104d..f07fb6fcd1 100644 --- a/libraries/model-baker/src/model-baker/CalculateMeshNormalsTask.cpp +++ b/libraries/model-baker/src/model-baker/CalculateMeshNormalsTask.cpp @@ -32,7 +32,7 @@ void CalculateMeshNormalsTask::run(const baker::BakeContextPointer& context, con return &normalsOut[normalIndex]; }, [&mesh](int vertexIndex, glm::vec3& outVertex) /* VertexSetter */ { - outVertex = mesh.vertices[vertexIndex]; + outVertex = baker::safeGet(mesh.vertices, vertexIndex); } ); } diff --git a/libraries/model-baker/src/model-baker/ModelMath.h b/libraries/model-baker/src/model-baker/ModelMath.h index 38bb3e1b3d..bbf42ffd9c 100644 --- a/libraries/model-baker/src/model-baker/ModelMath.h +++ b/libraries/model-baker/src/model-baker/ModelMath.h @@ -25,6 +25,17 @@ namespace baker { } } + template + const T& safeGet(const QVector& data, int i) { + static T t; + + if (i >= 0 && data.size() > i) { + return data[i]; + } else { + return t; + } + } + // Returns a reference to the normal at the specified index, or nullptr if it cannot be accessed using NormalAccessor = std::function; diff --git a/libraries/model-networking/src/model-networking/ModelCache.cpp b/libraries/model-networking/src/model-networking/ModelCache.cpp index 26bd20d967..1ed1c65358 100644 --- a/libraries/model-networking/src/model-networking/ModelCache.cpp +++ b/libraries/model-networking/src/model-networking/ModelCache.cpp @@ -542,5 +542,3 @@ void GeometryResourceWatcher::resourceRefreshed() { // FIXME: Model is not set up to handle a refresh // _instance.reset(); } - -#include "ModelCache.moc" diff --git a/libraries/networking/src/AddressManager.cpp b/libraries/networking/src/AddressManager.cpp index 517daf8ce5..7b21cb3460 100644 --- a/libraries/networking/src/AddressManager.cpp +++ b/libraries/networking/src/AddressManager.cpp @@ -482,7 +482,7 @@ void AddressManager::goToAddressFromObject(const QVariantMap& dataObject, const } else { QString iceServerAddress = domainObject[DOMAIN_ICE_SERVER_ADDRESS_KEY].toString(); - qCDebug(networking) << "Possible domain change required to connect to domain with ID" << domainID + qCDebug(networking_ice) << "Possible domain change required to connect to domain with ID" << domainID << "via ice-server at" << iceServerAddress; emit possibleDomainChangeRequiredViaICEForID(iceServerAddress, domainID); diff --git a/libraries/networking/src/DomainHandler.cpp b/libraries/networking/src/DomainHandler.cpp index 2513510b05..37e1b84eda 100644 --- a/libraries/networking/src/DomainHandler.cpp +++ b/libraries/networking/src/DomainHandler.cpp @@ -64,7 +64,7 @@ DomainHandler::DomainHandler(QObject* parent) : connect(this, &DomainHandler::redirectToErrorDomainURL, &_apiRefreshTimer, &QTimer::stop); } -void DomainHandler::disconnect() { +void DomainHandler::disconnect(QString reason) { // if we're currently connected to a domain, send a disconnect packet on our way out if (_isConnected) { sendDisconnectPacket(); @@ -81,6 +81,8 @@ void DomainHandler::disconnect() { _sockAddr.clear(); } + qCDebug(networking_ice) << "Disconnecting from domain server."; + qCDebug(networking_ice) << "REASON:" << reason; setIsConnected(false); } @@ -100,9 +102,9 @@ void DomainHandler::clearSettings() { _settingsObject = QJsonObject(); } -void DomainHandler::softReset() { +void DomainHandler::softReset(QString reason) { qCDebug(networking) << "Resetting current domain connection information."; - disconnect(); + disconnect(reason); clearSettings(); @@ -118,10 +120,10 @@ void DomainHandler::softReset() { } } -void DomainHandler::hardReset() { +void DomainHandler::hardReset(QString reason) { emit resetting(); - softReset(); + softReset(reason); _isInErrorState = false; emit redirectErrorStateChanged(_isInErrorState); @@ -166,7 +168,7 @@ void DomainHandler::setErrorDomainURL(const QUrl& url) { void DomainHandler::setSockAddr(const HifiSockAddr& sockAddr, const QString& hostname) { if (_sockAddr != sockAddr) { // we should reset on a sockAddr change - hardReset(); + hardReset("Changing domain sockAddr"); // change the sockAddr _sockAddr = sockAddr; } @@ -209,7 +211,7 @@ void DomainHandler::setURLAndID(QUrl domainURL, QUuid domainID) { // if it's in the error state, reset and try again. if ((_domainURL != domainURL || _sockAddr.getPort() != domainPort) || _isInErrorState) { // re-set the domain info so that auth information is reloaded - hardReset(); + hardReset("Changing domain URL"); QString previousHost = _domainURL.host(); _domainURL = domainURL; @@ -242,10 +244,24 @@ void DomainHandler::setURLAndID(QUrl domainURL, QUuid domainID) { void DomainHandler::setIceServerHostnameAndID(const QString& iceServerHostname, const QUuid& id) { + auto newIceServer = _iceServerSockAddr.getAddress().toString() != iceServerHostname; + auto newDomainID = id != _pendingDomainID; + // if it's in the error state, reset and try again. - if ((_iceServerSockAddr.getAddress().toString() != iceServerHostname || id != _pendingDomainID) || _isInErrorState) { + if (newIceServer || newDomainID || _isInErrorState) { + QString reason; + if (newIceServer) { + reason += "New ICE server;"; + } + if (newDomainID) { + reason += "New domain ID;"; + } + if (_isInErrorState) { + reason += "Domain in error state;"; + } + // re-set the domain info to connect to new domain - hardReset(); + hardReset(reason); // refresh our ICE client UUID to something new _iceClientID = QUuid::createUuid(); @@ -268,7 +284,7 @@ void DomainHandler::setIceServerHostnameAndID(const QString& iceServerHostname, completedIceServerHostnameLookup(); } - qCDebug(networking) << "ICE required to connect to domain via ice server at" << iceServerHostname; + qCDebug(networking_ice) << "ICE required to connect to domain via ice server at" << iceServerHostname; } } @@ -322,7 +338,7 @@ void DomainHandler::completedHostnameLookup(const QHostInfo& hostInfo) { } void DomainHandler::completedIceServerHostnameLookup() { - qCDebug(networking) << "ICE server socket is at" << _iceServerSockAddr; + qCDebug(networking_ice) << "ICE server socket is at" << _iceServerSockAddr; DependencyManager::get()->flagTimeForConnectionStep(LimitedNodeList::ConnectionStep::SetICEServerSocket); @@ -409,7 +425,7 @@ void DomainHandler::processSettingsPacketList(QSharedPointer pa void DomainHandler::processICEPingReplyPacket(QSharedPointer message) { const HifiSockAddr& senderSockAddr = message->getSenderSockAddr(); - qCDebug(networking) << "Received reply from domain-server on" << senderSockAddr; + qCDebug(networking_ice) << "Received reply from domain-server on" << senderSockAddr; if (getIP().isNull()) { // we're hearing back from this domain-server, no need to refresh API information @@ -417,13 +433,13 @@ void DomainHandler::processICEPingReplyPacket(QSharedPointer me // for now we're unsafely assuming this came back from the domain if (senderSockAddr == _icePeer.getLocalSocket()) { - qCDebug(networking) << "Connecting to domain using local socket"; + qCDebug(networking_ice) << "Connecting to domain using local socket"; activateICELocalSocket(); } else if (senderSockAddr == _icePeer.getPublicSocket()) { - qCDebug(networking) << "Conecting to domain using public socket"; + qCDebug(networking_ice) << "Conecting to domain using public socket"; activateICEPublicSocket(); } else { - qCDebug(networking) << "Reply does not match either local or public socket for domain. Will not connect."; + qCDebug(networking_ice) << "Reply does not match either local or public socket for domain. Will not connect."; } } } @@ -442,7 +458,7 @@ void DomainHandler::processDTLSRequirementPacket(QSharedPointer void DomainHandler::processICEResponsePacket(QSharedPointer message) { if (_icePeer.hasSockets()) { - qCDebug(networking) << "Received an ICE peer packet for domain-server but we already have sockets. Not processing."; + qCDebug(networking_ice) << "Received an ICE peer packet for domain-server but we already have sockets. Not processing."; // bail on processing this packet if our ice peer already has sockets return; } @@ -457,10 +473,10 @@ void DomainHandler::processICEResponsePacket(QSharedPointer mes DependencyManager::get()->flagTimeForConnectionStep(LimitedNodeList::ConnectionStep::ReceiveDSPeerInformation); if (_icePeer.getUUID() != _pendingDomainID) { - qCDebug(networking) << "Received a network peer with ID that does not match current domain. Will not attempt connection."; + qCDebug(networking_ice) << "Received a network peer with ID that does not match current domain. Will not attempt connection."; _icePeer.reset(); } else { - qCDebug(networking) << "Received network peer object for domain -" << _icePeer; + qCDebug(networking_ice) << "Received network peer object for domain -" << _icePeer; // ask the peer object to start its ping timer _icePeer.startPingTimer(); @@ -546,10 +562,14 @@ void DomainHandler::processDomainServerConnectionDeniedPacket(QSharedPointer 1) { + qCDebug(networking_ice) << "Silent domain checkins:" << _checkInPacketsSinceLastReply; + } + if (_checkInPacketsSinceLastReply > MAX_SILENT_DOMAIN_SERVER_CHECK_INS) { // we haven't heard back from DS in MAX_SILENT_DOMAIN_SERVER_CHECK_INS // so emit our signal that says that - qCDebug(networking) << "Limit of silent domain checkins reached"; + qCDebug(networking_ice) << "Limit of silent domain checkins reached"; emit limitOfSilentDomainCheckInsReached(); return true; } else { diff --git a/libraries/networking/src/DomainHandler.h b/libraries/networking/src/DomainHandler.h index 620ffb9641..fb18866001 100644 --- a/libraries/networking/src/DomainHandler.h +++ b/libraries/networking/src/DomainHandler.h @@ -42,7 +42,7 @@ class DomainHandler : public QObject { public: DomainHandler(QObject* parent = 0); - void disconnect(); + void disconnect(QString reason); void clearSettings(); const QUuid& getUUID() const { return _uuid; } @@ -105,7 +105,7 @@ public: bool isSocketKnown() const { return !_sockAddr.getAddress().isNull(); } - void softReset(); + void softReset(QString reason); int getCheckInPacketsSinceLastReply() const { return _checkInPacketsSinceLastReply; } bool checkInPacketTimeout(); @@ -210,7 +210,7 @@ signals: private: bool reasonSuggestsLogin(ConnectionRefusedReason reasonCode); void sendDisconnectPacket(); - void hardReset(); + void hardReset(QString reason); bool isHardRefusal(int reasonCode); diff --git a/libraries/networking/src/LimitedNodeList.cpp b/libraries/networking/src/LimitedNodeList.cpp index 82f3459c15..563d6e7ad1 100644 --- a/libraries/networking/src/LimitedNodeList.cpp +++ b/libraries/networking/src/LimitedNodeList.cpp @@ -197,6 +197,10 @@ void LimitedNodeList::setPermissions(const NodePermissions& newPermissions) { newPermissions.can(NodePermissions::Permission::canReplaceDomainContent)) { emit canReplaceContentChanged(_permissions.can(NodePermissions::Permission::canReplaceDomainContent)); } + if (originalPermissions.can(NodePermissions::Permission::canGetAndSetPrivateUserData) != + newPermissions.can(NodePermissions::Permission::canGetAndSetPrivateUserData)) { + emit canGetAndSetPrivateUserDataChanged(_permissions.can(NodePermissions::Permission::canGetAndSetPrivateUserData)); + } } void LimitedNodeList::setSocketLocalPort(quint16 socketLocalPort) { @@ -885,6 +889,7 @@ void LimitedNodeList::removeSilentNodes() { }); foreach(const SharedNodePointer& killedNode, killedNodes) { + qCDebug(networking_ice) << "Removing silent node" << killedNode; handleNodeKill(killedNode); } } @@ -1265,7 +1270,7 @@ void LimitedNodeList::sendPacketToIceServer(PacketType packetType, const HifiSoc iceDataStream << peerID; - qCDebug(networking) << "Sending packet to ICE server to request connection info for peer with ID" + qCDebug(networking_ice) << "Sending packet to ICE server to request connection info for peer with ID" << uuidStringWithoutCurlyBraces(peerID); } diff --git a/libraries/networking/src/LimitedNodeList.h b/libraries/networking/src/LimitedNodeList.h index 8593ad4b1b..60c91c8ff6 100644 --- a/libraries/networking/src/LimitedNodeList.h +++ b/libraries/networking/src/LimitedNodeList.h @@ -49,7 +49,7 @@ const int INVALID_PORT = -1; -const quint64 NODE_SILENCE_THRESHOLD_MSECS = 5 * 1000; +const quint64 NODE_SILENCE_THRESHOLD_MSECS = 20 * 1000; static const size_t DEFAULT_MAX_CONNECTION_RATE { std::numeric_limits::max() }; @@ -124,6 +124,7 @@ public: bool getThisNodeCanWriteAssets() const { return _permissions.can(NodePermissions::Permission::canWriteToAssetServer); } bool getThisNodeCanKick() const { return _permissions.can(NodePermissions::Permission::canKick); } bool getThisNodeCanReplaceContent() const { return _permissions.can(NodePermissions::Permission::canReplaceDomainContent); } + bool getThisNodeCanGetAndSetPrivateUserData() const { return _permissions.can(NodePermissions::Permission::canGetAndSetPrivateUserData); } quint16 getSocketLocalPort() const { return _nodeSocket.localPort(); } Q_INVOKABLE void setSocketLocalPort(quint16 socketLocalPort); @@ -368,6 +369,7 @@ signals: void canWriteAssetsChanged(bool canWriteAssets); void canKickChanged(bool canKick); void canReplaceContentChanged(bool canReplaceContent); + void canGetAndSetPrivateUserDataChanged(bool canGetAndSetPrivateUserData); protected slots: void connectedForLocalSocketTest(); diff --git a/libraries/networking/src/NetworkLogging.cpp b/libraries/networking/src/NetworkLogging.cpp index 834398694d..3d7c2fc5d5 100644 --- a/libraries/networking/src/NetworkLogging.cpp +++ b/libraries/networking/src/NetworkLogging.cpp @@ -12,6 +12,7 @@ #include "NetworkLogging.h" Q_LOGGING_CATEGORY(networking, "hifi.networking") +Q_LOGGING_CATEGORY(networking_ice, "hifi.networking.ice") Q_LOGGING_CATEGORY(resourceLog, "hifi.networking.resource") Q_LOGGING_CATEGORY(asset_client, "hifi.networking.asset_client") Q_LOGGING_CATEGORY(messages_client, "hifi.networking.messages_client") diff --git a/libraries/networking/src/NetworkLogging.h b/libraries/networking/src/NetworkLogging.h index 30116ff405..8247c60096 100644 --- a/libraries/networking/src/NetworkLogging.h +++ b/libraries/networking/src/NetworkLogging.h @@ -16,6 +16,7 @@ Q_DECLARE_LOGGING_CATEGORY(resourceLog) Q_DECLARE_LOGGING_CATEGORY(networking) +Q_DECLARE_LOGGING_CATEGORY(networking_ice) Q_DECLARE_LOGGING_CATEGORY(asset_client) Q_DECLARE_LOGGING_CATEGORY(messages_client) diff --git a/libraries/networking/src/NetworkPeer.h b/libraries/networking/src/NetworkPeer.h index 43fbc753eb..e2149d64af 100644 --- a/libraries/networking/src/NetworkPeer.h +++ b/libraries/networking/src/NetworkPeer.h @@ -23,7 +23,7 @@ const QString ICE_SERVER_HOSTNAME = "localhost"; const quint16 ICE_SERVER_DEFAULT_PORT = 7337; -const int ICE_HEARBEAT_INTERVAL_MSECS = 2 * 1000; +const int ICE_HEARBEAT_INTERVAL_MSECS = 1 * 1000; const int MAX_ICE_CONNECTION_ATTEMPTS = 5; const int UDP_PUNCH_PING_INTERVAL_MS = 250; diff --git a/libraries/networking/src/Node.h b/libraries/networking/src/Node.h index fe3177d785..07c599913b 100644 --- a/libraries/networking/src/Node.h +++ b/libraries/networking/src/Node.h @@ -83,6 +83,7 @@ public: bool getCanWriteToAssetServer() const { return _permissions.can(NodePermissions::Permission::canWriteToAssetServer); } bool getCanKick() const { return _permissions.can(NodePermissions::Permission::canKick); } bool getCanReplaceContent() const { return _permissions.can(NodePermissions::Permission::canReplaceDomainContent); } + bool getCanGetAndSetPrivateUserData() const { return _permissions.can(NodePermissions::Permission::canGetAndSetPrivateUserData); } using NodesIgnoredPair = std::pair, bool>; diff --git a/libraries/networking/src/NodeList.cpp b/libraries/networking/src/NodeList.cpp index 0a4c63d712..3a80745115 100644 --- a/libraries/networking/src/NodeList.cpp +++ b/libraries/networking/src/NodeList.cpp @@ -243,9 +243,11 @@ void NodeList::processICEPingPacket(QSharedPointer message) { sendPacket(std::move(replyPacket), message->getSenderSockAddr()); } -void NodeList::reset(bool skipDomainHandlerReset) { +void NodeList::reset(QString reason, bool skipDomainHandlerReset) { if (thread() != QThread::currentThread()) { - QMetaObject::invokeMethod(this, "reset", Q_ARG(bool, skipDomainHandlerReset)); + QMetaObject::invokeMethod(this, "reset", + Q_ARG(QString, reason), + Q_ARG(bool, skipDomainHandlerReset)); return; } @@ -267,7 +269,7 @@ void NodeList::reset(bool skipDomainHandlerReset) { if (!skipDomainHandlerReset) { // clear the domain connection information, unless they're the ones that asked us to reset - _domainHandler.softReset(); + _domainHandler.softReset(reason); } // refresh the owner UUID to the NULL UUID @@ -297,12 +299,12 @@ void NodeList::sendDomainServerCheckIn() { // may be called by multiple threads. if (!_sendDomainServerCheckInEnabled) { - qCDebug(networking) << "Refusing to send a domain-server check in while it is disabled."; + qCDebug(networking_ice) << "Refusing to send a domain-server check in while it is disabled."; return; } if (_isShuttingDown) { - qCDebug(networking) << "Refusing to send a domain-server check in while shutting down."; + qCDebug(networking_ice) << "Refusing to send a domain-server check in while shutting down."; return; } @@ -311,9 +313,9 @@ void NodeList::sendDomainServerCheckIn() { if (publicSockAddr.isNull()) { // we don't know our public socket and we need to send it to the domain server - qCDebug(networking) << "Waiting for inital public socket from STUN. Will not send domain-server check in."; + qCDebug(networking_ice) << "Waiting for inital public socket from STUN. Will not send domain-server check in."; } else if (domainHandlerIp.isNull() && _domainHandler.requiresICE()) { - qCDebug(networking) << "Waiting for ICE discovered domain-server socket. Will not send domain-server check in."; + qCDebug(networking_ice) << "Waiting for ICE discovered domain-server socket. Will not send domain-server check in."; handleICEConnectionToDomainServer(); // let the domain handler know we are due to send a checkin packet } else if (!domainHandlerIp.isNull() && !_domainHandler.checkInPacketTimeout()) { @@ -324,7 +326,7 @@ void NodeList::sendDomainServerCheckIn() { if (!domainIsConnected) { auto hostname = _domainHandler.getHostname(); - qCDebug(networking) << "Sending connect request to domain-server at" << hostname; + qCDebug(networking_ice) << "Sending connect request to domain-server at" << hostname; // is this our localhost domain-server? // if so we need to make sure we have an up-to-date local port in case it restarted @@ -334,7 +336,7 @@ void NodeList::sendDomainServerCheckIn() { quint16 domainPort = DEFAULT_DOMAIN_SERVER_PORT; getLocalServerPortFromSharedMemory(DOMAIN_SERVER_LOCAL_PORT_SMEM_KEY, domainPort); - qCDebug(networking) << "Local domain-server port read from shared memory (or default) is" << domainPort; + qCDebug(networking_ice) << "Local domain-server port read from shared memory (or default) is" << domainPort; _domainHandler.setPort(domainPort); } } @@ -346,7 +348,7 @@ void NodeList::sendDomainServerCheckIn() { bool requiresUsernameSignature = !domainIsConnected && !connectionToken.isNull(); if (requiresUsernameSignature && !accountManager->getAccountInfo().hasPrivateKey()) { - qWarning() << "A keypair is required to present a username signature to the domain-server" + qCWarning(networking_ice) << "A keypair is required to present a username signature to the domain-server" << "but no keypair is present. Waiting for keypair generation to complete."; accountManager->generateNewUserKeypair(); @@ -574,12 +576,12 @@ void NodeList::pingPunchForDomainServer() { const int NUM_DOMAIN_SERVER_PINGS_BEFORE_RESET = 2000 / UDP_PUNCH_PING_INTERVAL_MS; if (_domainHandler.getICEPeer().getConnectionAttempts() == 0) { - qCDebug(networking) << "Sending ping packets to establish connectivity with domain-server with ID" + qCDebug(networking_ice) << "Sending ping packets to establish connectivity with domain-server with ID" << uuidStringWithoutCurlyBraces(_domainHandler.getPendingDomainID()); } else { if (_domainHandler.getICEPeer().getConnectionAttempts() % NUM_DOMAIN_SERVER_PINGS_BEFORE_RESET == 0) { // if we have then nullify the domain handler's network peer and send a fresh ICE heartbeat - qCDebug(networking) << "No ping replies received from domain-server with ID" + qCDebug(networking_ice) << "No ping replies received from domain-server with ID" << uuidStringWithoutCurlyBraces(_domainHandler.getICEClientID()) << "-" << "re-sending ICE query."; _domainHandler.getICEPeer().softReset(); @@ -657,14 +659,14 @@ void NodeList::processDomainServerList(QSharedPointer message) if (_domainHandler.isConnected() && ((currentLocalID != Node::NULL_LOCAL_ID && newLocalID != currentLocalID) || (!currentSessionID.isNull() && newUUID != currentSessionID))) { - qCDebug(networking) << "Local ID or Session ID changed while connected to domain - forcing NodeList reset"; - // reset the nodelist, but don't do a domain handler reset since we're about to process a good domain list - reset(true); + reset("Local ID or Session ID changed while connected to domain - forcing NodeList reset", true); // tell the domain handler that we're no longer connected so that below // it can re-perform actions as if we just connected _domainHandler.setIsConnected(false); + // Clear any reliable connections using old ID. + _nodeSocket.clearConnections(); } setSessionLocalID(newLocalID); diff --git a/libraries/networking/src/NodeList.h b/libraries/networking/src/NodeList.h index f871560fba..c377ea89cb 100644 --- a/libraries/networking/src/NodeList.h +++ b/libraries/networking/src/NodeList.h @@ -103,8 +103,8 @@ public: virtual HifiSockAddr getDomainSockAddr() const override { return _domainHandler.getSockAddr(); } public slots: - void reset(bool skipDomainHandlerReset = false); - void resetFromDomainHandler() { reset(true); } + void reset(QString reason, bool skipDomainHandlerReset = false); + void resetFromDomainHandler() { reset("Reset from Domain Handler", true); } void sendDomainServerCheckIn(); void handleDSPathQuery(const QString& newPath); diff --git a/libraries/networking/src/NodePermissions.cpp b/libraries/networking/src/NodePermissions.cpp index 92ebf1d01e..e0de649c05 100644 --- a/libraries/networking/src/NodePermissions.cpp +++ b/libraries/networking/src/NodePermissions.cpp @@ -67,6 +67,7 @@ NodePermissions::NodePermissions(QMap perms) { Permission::canConnectPastMaxCapacity : Permission::none; permissions |= perms["id_can_kick"].toBool() ? Permission::canKick : Permission::none; permissions |= perms["id_can_replace_content"].toBool() ? Permission::canReplaceDomainContent : Permission::none; + permissions |= perms["id_can_get_and_set_private_user_data"].toBool() ? Permission::canGetAndSetPrivateUserData : Permission::none; } QVariant NodePermissions::toVariant(QHash groupRanks) { @@ -94,6 +95,7 @@ QVariant NodePermissions::toVariant(QHash groupRanks) { values["id_can_connect_past_max_capacity"] = can(Permission::canConnectPastMaxCapacity); values["id_can_kick"] = can(Permission::canKick); values["id_can_replace_content"] = can(Permission::canReplaceDomainContent); + values["id_can_get_and_set_private_user_data"] = can(Permission::canGetAndSetPrivateUserData); return QVariant(values); } @@ -166,6 +168,9 @@ QDebug operator<<(QDebug debug, const NodePermissions& perms) { if (perms.can(NodePermissions::Permission::canReplaceDomainContent)) { debug << " can_replace_content"; } + if (perms.can(NodePermissions::Permission::canGetAndSetPrivateUserData)) { + debug << " get-and-set-private-user-data"; + } debug.nospace() << "]"; return debug.nospace(); } diff --git a/libraries/networking/src/NodePermissions.h b/libraries/networking/src/NodePermissions.h index 1b0b9d220d..583c1b29ac 100644 --- a/libraries/networking/src/NodePermissions.h +++ b/libraries/networking/src/NodePermissions.h @@ -75,7 +75,8 @@ public: canKick = 64, canReplaceDomainContent = 128, canRezPermanentCertifiedEntities = 256, - canRezTemporaryCertifiedEntities = 512 + canRezTemporaryCertifiedEntities = 512, + canGetAndSetPrivateUserData = 1024 }; Q_DECLARE_FLAGS(Permissions, Permission) Permissions permissions; diff --git a/libraries/networking/src/ThreadedAssignment.cpp b/libraries/networking/src/ThreadedAssignment.cpp index 9b9a53b469..6a29613d25 100644 --- a/libraries/networking/src/ThreadedAssignment.cpp +++ b/libraries/networking/src/ThreadedAssignment.cpp @@ -58,7 +58,7 @@ void ThreadedAssignment::setFinished(bool isFinished) { packetReceiver.setShouldDropPackets(true); // send a disconnect packet to the domain - nodeList->getDomainHandler().disconnect(); + nodeList->getDomainHandler().disconnect("Finished"); // stop our owned timers _domainServerTimer.stop(); diff --git a/libraries/networking/src/udt/PacketHeaders.h b/libraries/networking/src/udt/PacketHeaders.h index ed81a6d9ca..5deadd8c43 100644 --- a/libraries/networking/src/udt/PacketHeaders.h +++ b/libraries/networking/src/udt/PacketHeaders.h @@ -270,6 +270,7 @@ enum class EntityVersion : PacketVersion { DisableWebMedia, ParticleShapeType, ParticleShapeTypeDeadlockFix, + PrivateUserData, // Add new versions above here NUM_PACKET_TYPE, diff --git a/libraries/octree/src/Octree.h b/libraries/octree/src/Octree.h index 82076f618b..4f994da60e 100644 --- a/libraries/octree/src/Octree.h +++ b/libraries/octree/src/Octree.h @@ -145,7 +145,10 @@ public: virtual bool rootElementHasData() const { return false; } virtual void releaseSceneEncodeData(OctreeElementExtraEncodeData* extraEncodeData) const { } - virtual void update() { } // nothing to do by default + // Why preUpdate() and update()? + // Because EntityTree needs them. + virtual void preUpdate() { } + virtual void update(bool simulate = true) { } OctreeElementPointer getRoot() { return _rootElement; } diff --git a/libraries/octree/src/OctreePersistThread.cpp b/libraries/octree/src/OctreePersistThread.cpp index 20ba3cde60..dd2cc12d50 100644 --- a/libraries/octree/src/OctreePersistThread.cpp +++ b/libraries/octree/src/OctreePersistThread.cpp @@ -242,6 +242,7 @@ bool OctreePersistThread::backupCurrentFile() { } void OctreePersistThread::process() { + _tree->preUpdate(); _tree->update(); auto now = std::chrono::steady_clock::now(); diff --git a/libraries/physics/src/EntityMotionState.cpp b/libraries/physics/src/EntityMotionState.cpp index 6abe5c3899..67aa7d2d7d 100644 --- a/libraries/physics/src/EntityMotionState.cpp +++ b/libraries/physics/src/EntityMotionState.cpp @@ -25,23 +25,6 @@ #include "PhysicsHelpers.h" #include "PhysicsLogging.h" -#ifdef WANT_DEBUG_ENTITY_TREE_LOCKS -#include "EntityTree.h" - -bool EntityMotionState::entityTreeIsLocked() const { - EntityTreeElementPointer element = _entity->getElement(); - EntityTreePointer tree = element ? element->getTree() : nullptr; - if (!tree) { - return true; - } - return true; -} -#else -bool entityTreeIsLocked() { - return true; -} -#endif - const uint8_t LOOPS_FOR_SIMULATION_ORPHAN = 50; const quint64 USECS_BETWEEN_OWNERSHIP_BIDS = USECS_PER_SECOND / 5; @@ -74,7 +57,6 @@ EntityMotionState::EntityMotionState(btCollisionShape* shape, EntityItemPointer _type = MOTIONSTATE_TYPE_ENTITY; assert(_entity); - assert(entityTreeIsLocked()); setMass(_entity->computeMass()); // we need the side-effects of EntityMotionState::setShape() so we call it explicitly here // rather than pass the legit shape pointer to the ObjectMotionState ctor above. @@ -143,7 +125,6 @@ void EntityMotionState::handleDeactivation() { // virtual void EntityMotionState::handleEasyChanges(uint32_t& flags) { - assert(entityTreeIsLocked()); updateServerPhysicsVariables(); ObjectMotionState::handleEasyChanges(flags); @@ -191,17 +172,10 @@ void EntityMotionState::handleEasyChanges(uint32_t& flags) { } -// virtual -bool EntityMotionState::handleHardAndEasyChanges(uint32_t& flags, PhysicsEngine* engine) { - updateServerPhysicsVariables(); - return ObjectMotionState::handleHardAndEasyChanges(flags, engine); -} - PhysicsMotionType EntityMotionState::computePhysicsMotionType() const { if (!_entity) { return MOTION_TYPE_STATIC; } - assert(entityTreeIsLocked()); if (_entity->getLocked()) { if (_entity->isMoving()) { @@ -226,7 +200,6 @@ PhysicsMotionType EntityMotionState::computePhysicsMotionType() const { } bool EntityMotionState::isMoving() const { - assert(entityTreeIsLocked()); return _entity && _entity->isMovingRelativeToParent(); } @@ -240,7 +213,6 @@ void EntityMotionState::getWorldTransform(btTransform& worldTrans) const { if (!_entity) { return; } - assert(entityTreeIsLocked()); if (_motionType == MOTION_TYPE_KINEMATIC) { BT_PROFILE("kinematicIntegration"); uint32_t thisStep = ObjectMotionState::getWorldSimulationStep(); @@ -271,7 +243,6 @@ void EntityMotionState::getWorldTransform(btTransform& worldTrans) const { // This callback is invoked by the physics simulation at the end of each simulation step... // iff the corresponding RigidBody is DYNAMIC and ACTIVE. void EntityMotionState::setWorldTransform(const btTransform& worldTrans) { - assert(entityTreeIsLocked()); measureBodyAcceleration(); // If transform or velocities are flagged as dirty it means a network or scripted change @@ -309,19 +280,6 @@ void EntityMotionState::setWorldTransform(const btTransform& worldTrans) { } -// virtual and protected -bool EntityMotionState::isReadyToComputeShape() const { - return _entity->isReadyToComputeShape(); -} - -// virtual and protected -const btCollisionShape* EntityMotionState::computeNewShape() { - ShapeInfo shapeInfo; - assert(entityTreeIsLocked()); - _entity->computeShapeInfo(shapeInfo); - return getShapeManager()->getShape(shapeInfo); -} - const uint8_t MAX_NUM_INACTIVE_UPDATES = 20; bool EntityMotionState::remoteSimulationOutOfSync(uint32_t simulationStep) { @@ -439,7 +397,6 @@ bool EntityMotionState::shouldSendUpdate(uint32_t simulationStep) { DETAILED_PROFILE_RANGE(simulation_physics, "ShouldSend"); // NOTE: we expect _entity and _body to be valid in this context, since shouldSendUpdate() is only called // after doesNotNeedToSendUpdate() returns false and that call should return 'true' if _entity or _body are NULL. - assert(entityTreeIsLocked()); // this case is prevented by setting _ownershipState to UNOWNABLE in EntityMotionState::ctor assert(!(_entity->isAvatarEntity() && _entity->getOwningAvatarID() != Physics::getSessionUUID())); @@ -505,7 +462,6 @@ void EntityMotionState::updateSendVelocities() { void EntityMotionState::sendBid(OctreeEditPacketSender* packetSender, uint32_t step) { DETAILED_PROFILE_RANGE(simulation_physics, "Bid"); - assert(entityTreeIsLocked()); updateSendVelocities(); @@ -546,7 +502,6 @@ void EntityMotionState::sendBid(OctreeEditPacketSender* packetSender, uint32_t s void EntityMotionState::sendUpdate(OctreeEditPacketSender* packetSender, uint32_t step) { DETAILED_PROFILE_RANGE(simulation_physics, "Send"); - assert(entityTreeIsLocked()); assert(isLocallyOwned()); updateSendVelocities(); @@ -645,8 +600,7 @@ void EntityMotionState::sendUpdate(OctreeEditPacketSender* packetSender, uint32_ _bumpedPriority = 0; } -uint32_t EntityMotionState::getIncomingDirtyFlags() { - assert(entityTreeIsLocked()); +uint32_t EntityMotionState::getIncomingDirtyFlags() const { uint32_t dirtyFlags = 0; if (_body && _entity) { dirtyFlags = _entity->getDirtyFlags(); @@ -676,10 +630,9 @@ uint32_t EntityMotionState::getIncomingDirtyFlags() { return dirtyFlags; } -void EntityMotionState::clearIncomingDirtyFlags() { - assert(entityTreeIsLocked()); +void EntityMotionState::clearIncomingDirtyFlags(uint32_t mask) { if (_body && _entity) { - _entity->clearDirtyFlags(DIRTY_PHYSICS_FLAGS); + _entity->clearDirtyFlags(mask); } } @@ -694,7 +647,6 @@ void EntityMotionState::slaveBidPriority() { // virtual QUuid EntityMotionState::getSimulatorID() const { - assert(entityTreeIsLocked()); return _entity->getSimulatorID(); } @@ -762,6 +714,10 @@ glm::vec3 EntityMotionState::getObjectLinearVelocityChange() const { return _measuredAcceleration * _measuredDeltaTime; } +bool EntityMotionState::shouldBeInPhysicsSimulation() const { + return _region < workload::Region::R3 && _entity->shouldBePhysical(); +} + // virtual void EntityMotionState::setMotionType(PhysicsMotionType motionType) { ObjectMotionState::setMotionType(motionType); @@ -770,7 +726,6 @@ void EntityMotionState::setMotionType(PhysicsMotionType motionType) { // virtual QString EntityMotionState::getName() const { - assert(entityTreeIsLocked()); return _entity->getName(); } @@ -788,6 +743,15 @@ bool EntityMotionState::shouldSendBid() const { && !_entity->getLocked(); } +void EntityMotionState::setRigidBody(btRigidBody* body) { + ObjectMotionState::setRigidBody(body); + if (_body) { + _entity->markSpecialFlags(Simulation::SPECIAL_FLAG_IN_PHYSICS_SIMULATION); + } else { + _entity->clearSpecialFlags(Simulation::SPECIAL_FLAG_IN_PHYSICS_SIMULATION); + } +} + uint8_t EntityMotionState::computeFinalBidPriority() const { return (_region == workload::Region::R1) ? glm::max(glm::max(VOLUNTEER_SIMULATION_PRIORITY, _bumpedPriority), _entity->getScriptSimulationPriority()) : 0; diff --git a/libraries/physics/src/EntityMotionState.h b/libraries/physics/src/EntityMotionState.h index ddf384dc77..7456837777 100644 --- a/libraries/physics/src/EntityMotionState.h +++ b/libraries/physics/src/EntityMotionState.h @@ -12,6 +12,7 @@ #ifndef hifi_EntityMotionState_h #define hifi_EntityMotionState_h +#include #include #include #include @@ -38,7 +39,6 @@ public: void handleDeactivation(); virtual void handleEasyChanges(uint32_t& flags) override; - virtual bool handleHardAndEasyChanges(uint32_t& flags, PhysicsEngine* engine) override; /// \return PhysicsMotionType based on params set in EntityItem virtual PhysicsMotionType computePhysicsMotionType() const override; @@ -55,8 +55,8 @@ public: void sendBid(OctreeEditPacketSender* packetSender, uint32_t step); void sendUpdate(OctreeEditPacketSender* packetSender, uint32_t step); - virtual uint32_t getIncomingDirtyFlags() override; - virtual void clearIncomingDirtyFlags() override; + virtual uint32_t getIncomingDirtyFlags() const override; + virtual void clearIncomingDirtyFlags(uint32_t mask = DIRTY_PHYSICS_FLAGS) override; virtual float getObjectRestitution() const override { return _entity->getRestitution(); } virtual float getObjectFriction() const override { return _entity->getFriction(); } @@ -84,6 +84,7 @@ public: void measureBodyAcceleration(); virtual QString getName() const override; + ShapeType getShapeType() const override { return _entity->getShapeType(); } virtual void computeCollisionGroupAndMask(int32_t& group, int32_t& mask) const override; @@ -99,6 +100,8 @@ public: void saveKinematicState(btScalar timeStep) override; protected: + void setRigidBody(btRigidBody* body) override; + uint8_t computeFinalBidPriority() const; void updateSendVelocities(); uint64_t getNextBidExpiry() const { return _nextBidExpiry; } @@ -112,12 +115,8 @@ protected: void clearObjectVelocities() const; - #ifdef WANT_DEBUG_ENTITY_TREE_LOCKS - bool entityTreeIsLocked() const; - #endif - - bool isReadyToComputeShape() const override; - const btCollisionShape* computeNewShape() override; + bool isInPhysicsSimulation() const { return _body != nullptr; } + bool shouldBeInPhysicsSimulation() const; void setMotionType(PhysicsMotionType motionType) override; // EntityMotionState keeps a SharedPointer to its EntityItem which is only set in the CTOR diff --git a/libraries/physics/src/ObjectActionTractor.cpp b/libraries/physics/src/ObjectActionTractor.cpp index c7681e217c..b53c2e137a 100644 --- a/libraries/physics/src/ObjectActionTractor.cpp +++ b/libraries/physics/src/ObjectActionTractor.cpp @@ -11,7 +11,8 @@ #include "ObjectActionTractor.h" -#include "QVariantGLM.h" +#include +#include #include "PhysicsLogging.h" diff --git a/libraries/physics/src/ObjectActionTravelOriented.cpp b/libraries/physics/src/ObjectActionTravelOriented.cpp index bd32ed13ff..b27ec40ae4 100644 --- a/libraries/physics/src/ObjectActionTravelOriented.cpp +++ b/libraries/physics/src/ObjectActionTravelOriented.cpp @@ -13,7 +13,9 @@ #include -#include "QVariantGLM.h" +#include +#include + #include "PhysicsLogging.h" const uint16_t ObjectActionTravelOriented::actionVersion = 1; diff --git a/libraries/physics/src/ObjectDynamic.h b/libraries/physics/src/ObjectDynamic.h index f41d6cd51d..49fa615b88 100644 --- a/libraries/physics/src/ObjectDynamic.h +++ b/libraries/physics/src/ObjectDynamic.h @@ -17,7 +17,9 @@ #include +#include #include +#include #include "ObjectMotionState.h" #include "BulletUtil.h" diff --git a/libraries/physics/src/ObjectMotionState.cpp b/libraries/physics/src/ObjectMotionState.cpp index 0ab051fa96..ad7332cb15 100644 --- a/libraries/physics/src/ObjectMotionState.cpp +++ b/libraries/physics/src/ObjectMotionState.cpp @@ -198,9 +198,14 @@ void ObjectMotionState::setShape(const btCollisionShape* shape) { getShapeManager()->releaseShape(_shape); } _shape = shape; - if (_body && _type != MOTIONSTATE_TYPE_DETAILED) { + if (_body) { + assert(_shape); + _body->setCollisionShape(const_cast(_shape)); updateCCDConfiguration(); } + } else if (shape) { + // we need to release unused reference to shape + getShapeManager()->releaseShape(shape); } } @@ -285,50 +290,6 @@ void ObjectMotionState::handleEasyChanges(uint32_t& flags) { } } -bool ObjectMotionState::handleHardAndEasyChanges(uint32_t& flags, PhysicsEngine* engine) { - assert(_body && _shape); - if (flags & Simulation::DIRTY_SHAPE) { - // make sure the new shape is valid - if (!isReadyToComputeShape()) { - return false; - } - const btCollisionShape* newShape = computeNewShape(); - if (!newShape) { - qCDebug(physics) << "Warning: failed to generate new shape!"; - // failed to generate new shape! --> keep old shape and remove shape-change flag - flags &= ~Simulation::DIRTY_SHAPE; - // TODO: force this object out of PhysicsEngine rather than just use the old shape - if ((flags & HARD_DIRTY_PHYSICS_FLAGS) == 0) { - // no HARD flags remain, so do any EASY changes - if (flags & EASY_DIRTY_PHYSICS_FLAGS) { - handleEasyChanges(flags); - } - return true; - } - } else { - if (_shape == newShape) { - // the shape didn't actually change, so we clear the DIRTY_SHAPE flag - flags &= ~Simulation::DIRTY_SHAPE; - // and clear the reference we just created - getShapeManager()->releaseShape(_shape); - } else { - _body->setCollisionShape(const_cast(newShape)); - setShape(newShape); - } - } - } - if (flags & EASY_DIRTY_PHYSICS_FLAGS) { - handleEasyChanges(flags); - } - // it is possible there are no HARD flags at this point (if DIRTY_SHAPE was removed) - // so we check again before we reinsert: - if (flags & HARD_DIRTY_PHYSICS_FLAGS) { - engine->reinsertObject(this); - } - - return true; -} - void ObjectMotionState::updateBodyMaterialProperties() { _body->setRestitution(getObjectRestitution()); _body->setFriction(getObjectFriction()); diff --git a/libraries/physics/src/ObjectMotionState.h b/libraries/physics/src/ObjectMotionState.h index fe175a2c7d..415b388e70 100644 --- a/libraries/physics/src/ObjectMotionState.h +++ b/libraries/physics/src/ObjectMotionState.h @@ -18,7 +18,7 @@ #include #include -#include +#include #include "ContactInfo.h" #include "ShapeManager.h" @@ -100,7 +100,6 @@ public: virtual ~ObjectMotionState(); virtual void handleEasyChanges(uint32_t& flags); - virtual bool handleHardAndEasyChanges(uint32_t& flags, PhysicsEngine* engine); void updateBodyMaterialProperties(); void updateBodyVelocities(); @@ -123,11 +122,12 @@ public: glm::vec3 getBodyAngularVelocity() const; virtual glm::vec3 getObjectLinearVelocityChange() const; - virtual uint32_t getIncomingDirtyFlags() = 0; - virtual void clearIncomingDirtyFlags() = 0; + virtual uint32_t getIncomingDirtyFlags() const = 0; + virtual void clearIncomingDirtyFlags(uint32_t mask = DIRTY_PHYSICS_FLAGS) = 0; virtual PhysicsMotionType computePhysicsMotionType() const = 0; + virtual bool needsNewShape() const { return _shape == nullptr || getIncomingDirtyFlags() & Simulation::DIRTY_SHAPE; } const btCollisionShape* getShape() const { return _shape; } btRigidBody* getRigidBody() const { return _body; } @@ -154,6 +154,7 @@ public: virtual void bump(uint8_t priority) {} virtual QString getName() const { return ""; } + virtual ShapeType getShapeType() const = 0; virtual void computeCollisionGroupAndMask(int32_t& group, int32_t& mask) const = 0; @@ -172,8 +173,6 @@ public: friend class PhysicsEngine; protected: - virtual bool isReadyToComputeShape() const = 0; - virtual const btCollisionShape* computeNewShape() = 0; virtual void setMotionType(PhysicsMotionType motionType); void updateCCDConfiguration(); @@ -187,7 +186,7 @@ protected: btRigidBody* _body { nullptr }; float _density { 1.0f }; - // ACTION_CAN_CONTROL_KINEMATIC_OBJECT_HACK: These date members allow an Action + // ACTION_CAN_CONTROL_KINEMATIC_OBJECT_HACK: These data members allow an Action // to operate on a kinematic object without screwing up our default kinematic integration // which is done in the MotionState::getWorldTransform(). mutable uint32_t _lastKinematicStep; diff --git a/libraries/physics/src/PhysicalEntitySimulation.cpp b/libraries/physics/src/PhysicalEntitySimulation.cpp index 8e5248f6a9..daa2b5d954 100644 --- a/libraries/physics/src/PhysicalEntitySimulation.cpp +++ b/libraries/physics/src/PhysicalEntitySimulation.cpp @@ -131,10 +131,10 @@ void PhysicalEntitySimulation::takeDeadAvatarEntities(SetOfEntities& deadEntitie _deadAvatarEntities.clear(); } -void PhysicalEntitySimulation::changeEntityInternal(EntityItemPointer entity) { +void PhysicalEntitySimulation::processChangedEntity(const EntityItemPointer& entity) { + EntitySimulation::processChangedEntity(entity); + // queue incoming changes: from external sources (script, EntityServer, etc) to physics engine - QMutexLocker lock(&_mutex); - assert(entity); EntityMotionState* motionState = static_cast(entity->getPhysicsInfo()); uint8_t region = _space->getRegion(entity->getSpaceIndex()); bool shouldBePhysical = region < workload::Region::R3 && entity->shouldBePhysical(); @@ -156,7 +156,6 @@ void PhysicalEntitySimulation::changeEntityInternal(EntityItemPointer entity) { // remove from the physical simulation _incomingChanges.remove(motionState); - _physicalObjects.remove(motionState); removeOwnershipData(motionState); _entitiesToRemoveFromPhysics.insert(entity); if (canBeKinematic && entity->isMovingRelativeToParent()) { @@ -227,44 +226,68 @@ void PhysicalEntitySimulation::prepareEntityForDelete(EntityItemPointer entity) } // end EntitySimulation overrides -const VectorOfMotionStates& PhysicalEntitySimulation::getObjectsToRemoveFromPhysics() { - QMutexLocker lock(&_mutex); - for (auto entity: _entitiesToRemoveFromPhysics) { - EntityMotionState* motionState = static_cast(entity->getPhysicsInfo()); - assert(motionState); - // TODO CLEan this, just a n extra check to avoid the crash that shouldn;t happen - if (motionState) { - _entitiesToAddToPhysics.remove(entity); - if (entity->isDead() && entity->getElement()) { - _deadEntities.insert(entity); +void PhysicalEntitySimulation::buildMotionStatesForEntitiesThatNeedThem() { + // this lambda for when we decide to actually build the motionState + auto buildMotionState = [&](btCollisionShape* shape, EntityItemPointer entity) { + EntityMotionState* motionState = new EntityMotionState(shape, entity); + entity->setPhysicsInfo(static_cast(motionState)); + motionState->setRegion(_space->getRegion(entity->getSpaceIndex())); + _physicalObjects.insert(motionState); + _incomingChanges.insert(motionState); + }; + + uint32_t deliveryCount = ObjectMotionState::getShapeManager()->getWorkDeliveryCount(); + if (deliveryCount != _lastWorkDeliveryCount) { + // new off-thread shapes have arrived --> find adds whose shapes have arrived + _lastWorkDeliveryCount = deliveryCount; + ShapeRequests::iterator requestItr = _shapeRequests.begin(); + while (requestItr != _shapeRequests.end()) { + EntityItemPointer entity = requestItr->entity; + EntityMotionState* motionState = static_cast(entity->getPhysicsInfo()); + if (!motionState) { + // this is an ADD because motionState doesn't exist yet + btCollisionShape* shape = const_cast(ObjectMotionState::getShapeManager()->getShapeByKey(requestItr->shapeHash)); + if (shape) { + // shape is ready at last! + // But the entity's desired shape might have changed since last requested + // --> rebuild the ShapeInfo to verify hash + // TODO? is there a better way to do this? + ShapeInfo shapeInfo; + entity->computeShapeInfo(shapeInfo); + if (shapeInfo.getHash() != requestItr->shapeHash) { + // bummer, the hashes are different and we no longer want the shape we've received + ObjectMotionState::getShapeManager()->releaseShape(shape); + // try again + shape = const_cast(ObjectMotionState::getShapeManager()->getShape(shapeInfo)); + if (shape) { + buildMotionState(shape, entity); + requestItr = _shapeRequests.erase(requestItr); + } else { + requestItr->shapeHash = shapeInfo.getHash(); + ++requestItr; + } + } else { + buildMotionState(shape, entity); + requestItr = _shapeRequests.erase(requestItr); + } + } else { + // shape not ready + ++requestItr; + } + } else { + // this is a CHANGE because motionState already exists + if (ObjectMotionState::getShapeManager()->hasShapeWithKey(requestItr->shapeHash)) { + entity->markDirtyFlags(Simulation::DIRTY_SHAPE); + _incomingChanges.insert(motionState); + requestItr = _shapeRequests.erase(requestItr); + } else { + // shape not ready + ++requestItr; + } } - - _incomingChanges.remove(motionState); - removeOwnershipData(motionState); - _physicalObjects.remove(motionState); - - // remember this motionState and delete it later (after removing its RigidBody from the PhysicsEngine) - _objectsToDelete.push_back(motionState); } } - _entitiesToRemoveFromPhysics.clear(); - return _objectsToDelete; -} -void PhysicalEntitySimulation::deleteObjectsRemovedFromPhysics() { - QMutexLocker lock(&_mutex); - for (auto motionState : _objectsToDelete) { - // someday when we invert the entities/physics lib dependencies we can let EntityItem delete its own PhysicsInfo - // until then we must do it here - // NOTE: a reference to the EntityItemPointer is released in the EntityMotionState::dtor - delete motionState; - } - _objectsToDelete.clear(); -} - -void PhysicalEntitySimulation::getObjectsToAddToPhysics(VectorOfMotionStates& result) { - result.clear(); - QMutexLocker lock(&_mutex); SetOfEntities::iterator entityItr = _entitiesToAddToPhysics.begin(); while (entityItr != _entitiesToAddToPhysics.end()) { EntityItemPointer entity = (*entityItr); @@ -273,7 +296,7 @@ void PhysicalEntitySimulation::getObjectsToAddToPhysics(VectorOfMotionStates& re prepareEntityForDelete(entity); entityItr = _entitiesToAddToPhysics.erase(entityItr); } else if (!entity->shouldBePhysical()) { - // this entity should no longer be on the internal _entitiesToAddToPhysics + // this entity should no longer be on _entitiesToAddToPhysics entityItr = _entitiesToAddToPhysics.erase(entityItr); if (entity->isMovingRelativeToParent()) { SetOfEntities::iterator itr = _simpleKinematicEntities.find(entity); @@ -282,53 +305,149 @@ void PhysicalEntitySimulation::getObjectsToAddToPhysics(VectorOfMotionStates& re } } } else if (entity->isReadyToComputeShape()) { - ShapeInfo shapeInfo; - entity->computeShapeInfo(shapeInfo); - int numPoints = shapeInfo.getLargestSubshapePointCount(); - if (shapeInfo.getType() == SHAPE_TYPE_COMPOUND) { - if (numPoints > MAX_HULL_POINTS) { - qWarning() << "convex hull with" << numPoints - << "points for entity" << entity->getName() - << "at" << entity->getWorldPosition() << " will be reduced"; + ShapeRequest shapeRequest(entity); + ShapeRequests::iterator requestItr = _shapeRequests.find(shapeRequest); + if (requestItr == _shapeRequests.end()) { + // not waiting for a shape (yet) + ShapeInfo shapeInfo; + entity->computeShapeInfo(shapeInfo); + uint32_t requestCount = ObjectMotionState::getShapeManager()->getWorkRequestCount(); + btCollisionShape* shape = const_cast(ObjectMotionState::getShapeManager()->getShape(shapeInfo)); + if (shape) { + EntityMotionState* motionState = static_cast(entity->getPhysicsInfo()); + if (!motionState) { + buildMotionState(shape, entity); + } else { + // Is it possible to fall in here? + // entity shouldn't be on _entitiesToAddToPhysics list if it already has a motionState. + // but just in case... + motionState->setShape(shape); + motionState->setRegion(_space->getRegion(entity->getSpaceIndex())); + _physicalObjects.insert(motionState); + _incomingChanges.insert(motionState); + } + } else if (requestCount != ObjectMotionState::getShapeManager()->getWorkRequestCount()) { + // shape doesn't exist but a new worker has been spawned to build it --> add to shapeRequests and wait + shapeRequest.shapeHash = shapeInfo.getHash(); + _shapeRequests.insert(shapeRequest); + } else { + // failed to build shape --> will not be added } } - btCollisionShape* shape = const_cast(ObjectMotionState::getShapeManager()->getShape(shapeInfo)); - if (shape) { - EntityMotionState* motionState = new EntityMotionState(shape, entity); - entity->setPhysicsInfo(static_cast(motionState)); - _physicalObjects.insert(motionState); - result.push_back(motionState); - entityItr = _entitiesToAddToPhysics.erase(entityItr); - - // make sure the motionState's region is up-to-date before it is actually added to physics - motionState->setRegion(_space->getRegion(entity->getSpaceIndex())); - } else { - //qWarning() << "Failed to generate new shape for entity." << entity->getName(); - ++entityItr; - } + entityItr = _entitiesToAddToPhysics.erase(entityItr); } else { ++entityItr; } } } -void PhysicalEntitySimulation::setObjectsToChange(const VectorOfMotionStates& objectsToChange) { +void PhysicalEntitySimulation::buildPhysicsTransaction(PhysicsEngine::Transaction& transaction) { QMutexLocker lock(&_mutex); - for (auto object : objectsToChange) { - _incomingChanges.insert(static_cast(object)); + // entities being removed + for (auto entity : _entitiesToRemoveFromPhysics) { + EntityMotionState* motionState = static_cast(entity->getPhysicsInfo()); + if (motionState) { + transaction.objectsToRemove.push_back(motionState); + _incomingChanges.remove(motionState); + } + if (_shapeRequests.size() > 0) { + ShapeRequest shapeRequest(entity); + ShapeRequests::iterator requestItr = _shapeRequests.find(shapeRequest); + if (requestItr != _shapeRequests.end()) { + _shapeRequests.erase(requestItr); + } + } } -} + _entitiesToRemoveFromPhysics.clear(); -void PhysicalEntitySimulation::getObjectsToChange(VectorOfMotionStates& result) { - result.clear(); - QMutexLocker lock(&_mutex); - for (auto stateItr : _incomingChanges) { - EntityMotionState* motionState = &(*stateItr); - result.push_back(motionState); + // entities to add + buildMotionStatesForEntitiesThatNeedThem(); + + // motionStates with changed entities: delete, add, or change + for (auto& object : _incomingChanges) { + uint32_t unhandledFlags = object->getIncomingDirtyFlags(); + + uint32_t handledFlags = EASY_DIRTY_PHYSICS_FLAGS; + bool isInPhysicsSimulation = object->isInPhysicsSimulation(); + bool shouldBeInPhysicsSimulation = object->shouldBeInPhysicsSimulation(); + if (!shouldBeInPhysicsSimulation && isInPhysicsSimulation) { + transaction.objectsToRemove.push_back(object); + continue; + } + + bool needsNewShape = object->needsNewShape(); + if (needsNewShape) { + ShapeType shapeType = object->getShapeType(); + if (shapeType == SHAPE_TYPE_STATIC_MESH) { + ShapeRequest shapeRequest(object->_entity); + ShapeRequests::iterator requestItr = _shapeRequests.find(shapeRequest); + if (requestItr == _shapeRequests.end()) { + ShapeInfo shapeInfo; + object->_entity->computeShapeInfo(shapeInfo); + uint32_t requestCount = ObjectMotionState::getShapeManager()->getWorkRequestCount(); + btCollisionShape* shape = const_cast(ObjectMotionState::getShapeManager()->getShape(shapeInfo)); + if (shape) { + object->setShape(shape); + handledFlags |= Simulation::DIRTY_SHAPE; + needsNewShape = false; + } else if (requestCount != ObjectMotionState::getShapeManager()->getWorkRequestCount()) { + // shape doesn't exist but a new worker has been spawned to build it --> add to shapeRequests and wait + shapeRequest.shapeHash = shapeInfo.getHash(); + _shapeRequests.insert(shapeRequest); + } else { + // failed to build shape --> will not be added/updated + handledFlags |= Simulation::DIRTY_SHAPE; + } + } else { + // continue waiting for shape request + } + } else { + ShapeInfo shapeInfo; + object->_entity->computeShapeInfo(shapeInfo); + btCollisionShape* shape = const_cast(ObjectMotionState::getShapeManager()->getShape(shapeInfo)); + if (shape) { + object->setShape(shape); + handledFlags |= Simulation::DIRTY_SHAPE; + needsNewShape = false; + } else { + // failed to build shape --> will not be added + } + } + } + if (!isInPhysicsSimulation) { + if (needsNewShape) { + // skip it + continue; + } else { + transaction.objectsToAdd.push_back(object); + handledFlags = DIRTY_PHYSICS_FLAGS; + unhandledFlags = 0; + } + } + + if (unhandledFlags & EASY_DIRTY_PHYSICS_FLAGS) { + object->handleEasyChanges(unhandledFlags); + } + if (unhandledFlags & (Simulation::DIRTY_MOTION_TYPE | Simulation::DIRTY_COLLISION_GROUP | (handledFlags & Simulation::DIRTY_SHAPE))) { + transaction.objectsToReinsert.push_back(object); + handledFlags |= HARD_DIRTY_PHYSICS_FLAGS; + } else if (unhandledFlags & Simulation::DIRTY_PHYSICS_ACTIVATION && object->getRigidBody()->isStaticObject()) { + transaction.activeStaticObjects.push_back(object); + } + object->clearIncomingDirtyFlags(handledFlags); } _incomingChanges.clear(); } +void PhysicalEntitySimulation::handleProcessedPhysicsTransaction(PhysicsEngine::Transaction& transaction) { + // things on objectsToRemove are ready for delete + for (auto object : transaction.objectsToRemove) { + _physicalObjects.remove(object); + delete object; + } + transaction.clear(); +} + void PhysicalEntitySimulation::handleDeactivatedMotionStates(const VectorOfMotionStates& motionStates) { bool serverlessMode = getEntityTree()->isServerlessMode(); for (auto stateItr : motionStates) { diff --git a/libraries/physics/src/PhysicalEntitySimulation.h b/libraries/physics/src/PhysicalEntitySimulation.h index 843069e247..817f92cb3c 100644 --- a/libraries/physics/src/PhysicalEntitySimulation.h +++ b/libraries/physics/src/PhysicalEntitySimulation.h @@ -13,6 +13,8 @@ #define hifi_PhysicalEntitySimulation_h #include +#include +#include #include #include @@ -70,7 +72,7 @@ protected: // only called by EntitySimulation virtual void updateEntitiesInternal(uint64_t now) override; virtual void addEntityInternal(EntityItemPointer entity) override; virtual void removeEntityInternal(EntityItemPointer entity) override; - virtual void changeEntityInternal(EntityItemPointer entity) override; + void processChangedEntity(const EntityItemPointer& entity) override; virtual void clearEntitiesInternal() override; void removeOwnershipData(EntityMotionState* motionState); @@ -79,12 +81,8 @@ protected: // only called by EntitySimulation public: virtual void prepareEntityForDelete(EntityItemPointer entity) override; - const VectorOfMotionStates& getObjectsToRemoveFromPhysics(); - void deleteObjectsRemovedFromPhysics(); - - void getObjectsToAddToPhysics(VectorOfMotionStates& result); - void setObjectsToChange(const VectorOfMotionStates& objectsToChange); - void getObjectsToChange(VectorOfMotionStates& result); + void buildPhysicsTransaction(PhysicsEngine::Transaction& transaction); + void handleProcessedPhysicsTransaction(PhysicsEngine::Transaction& transaction); void handleDeactivatedMotionStates(const VectorOfMotionStates& motionStates); void handleChangedMotionStates(const VectorOfMotionStates& motionStates); @@ -98,16 +96,25 @@ public: void sendOwnedUpdates(uint32_t numSubsteps); private: - SetOfEntities _entitiesToAddToPhysics; + void buildMotionStatesForEntitiesThatNeedThem(); + + class ShapeRequest { + public: + ShapeRequest() { } + ShapeRequest(const EntityItemPointer& e) : entity(e) { } + bool operator<(const ShapeRequest& other) const { return entity.get() < other.entity.get(); } + bool operator==(const ShapeRequest& other) const { return entity.get() == other.entity.get(); } + EntityItemPointer entity { nullptr }; + mutable uint64_t shapeHash { 0 }; + }; + SetOfEntities _entitiesToAddToPhysics; // we could also call this: _entitiesThatNeedMotionStates SetOfEntities _entitiesToRemoveFromPhysics; - - VectorOfMotionStates _objectsToDelete; - - SetOfEntityMotionStates _incomingChanges; // EntityMotionStates that have changed from external sources - // and need their RigidBodies updated - + SetOfEntityMotionStates _incomingChanges; // EntityMotionStates changed by external events SetOfMotionStates _physicalObjects; // MotionStates of entities in PhysicsEngine + using ShapeRequests = std::set; + ShapeRequests _shapeRequests; + PhysicsEnginePointer _physicsEngine = nullptr; EntityEditPacketSender* _entityPacketSender = nullptr; @@ -117,6 +124,7 @@ private: workload::SpacePointer _space; uint64_t _nextBidExpiry; uint32_t _lastStepSendPackets { 0 }; + uint32_t _lastWorkDeliveryCount { 0 }; }; diff --git a/libraries/physics/src/PhysicsEngine.cpp b/libraries/physics/src/PhysicsEngine.cpp index 4453a7d9f0..976c547c5e 100644 --- a/libraries/physics/src/PhysicsEngine.cpp +++ b/libraries/physics/src/PhysicsEngine.cpp @@ -178,8 +178,6 @@ void PhysicsEngine::addObjectToDynamicsWorld(ObjectMotionState* motionState) { int32_t group, mask; motionState->computeCollisionGroupAndMask(group, mask); _dynamicsWorld->addRigidBody(body, group, mask); - - motionState->clearIncomingDirtyFlags(); } QList PhysicsEngine::removeDynamicsForBody(btRigidBody* body) { @@ -252,6 +250,7 @@ void PhysicsEngine::removeSetOfObjects(const SetOfMotionStates& objects) { } object->clearIncomingDirtyFlags(); } + _activeStaticBodies.clear(); } void PhysicsEngine::addObjects(const VectorOfMotionStates& objects) { @@ -260,35 +259,6 @@ void PhysicsEngine::addObjects(const VectorOfMotionStates& objects) { } } -VectorOfMotionStates PhysicsEngine::changeObjects(const VectorOfMotionStates& objects) { - VectorOfMotionStates stillNeedChange; - for (auto object : objects) { - uint32_t flags = object->getIncomingDirtyFlags() & DIRTY_PHYSICS_FLAGS; - if (flags & HARD_DIRTY_PHYSICS_FLAGS) { - if (object->handleHardAndEasyChanges(flags, this)) { - object->clearIncomingDirtyFlags(); - } else { - stillNeedChange.push_back(object); - } - } else if (flags & EASY_DIRTY_PHYSICS_FLAGS) { - object->handleEasyChanges(flags); - object->clearIncomingDirtyFlags(); - } - if (object->getMotionType() == MOTION_TYPE_STATIC && object->isActive()) { - _activeStaticBodies.insert(object->getRigidBody()); - } - } - // active static bodies have changed (in an Easy way) and need their Aabbs updated - // but we've configured Bullet to NOT update them automatically (for improved performance) - // so we must do it ourselves - std::set::const_iterator itr = _activeStaticBodies.begin(); - while (itr != _activeStaticBodies.end()) { - _dynamicsWorld->updateSingleAabb(*itr); - ++itr; - } - return stillNeedChange; -} - void PhysicsEngine::reinsertObject(ObjectMotionState* object) { // remove object from DynamicsWorld bumpAndPruneContacts(object); @@ -320,7 +290,6 @@ void PhysicsEngine::processTransaction(PhysicsEngine::Transaction& transaction) body->setMotionState(nullptr); delete body; } - object->clearIncomingDirtyFlags(); } // adds @@ -328,34 +297,16 @@ void PhysicsEngine::processTransaction(PhysicsEngine::Transaction& transaction) addObjectToDynamicsWorld(object); } - // changes - std::vector failedChanges; - for (auto object : transaction.objectsToChange) { - uint32_t flags = object->getIncomingDirtyFlags() & DIRTY_PHYSICS_FLAGS; - if (flags & HARD_DIRTY_PHYSICS_FLAGS) { - if (object->handleHardAndEasyChanges(flags, this)) { - object->clearIncomingDirtyFlags(); - } else { - failedChanges.push_back(object); - } - } else if (flags & EASY_DIRTY_PHYSICS_FLAGS) { - object->handleEasyChanges(flags); - object->clearIncomingDirtyFlags(); - } - if (object->getMotionType() == MOTION_TYPE_STATIC && object->isActive()) { - _activeStaticBodies.insert(object->getRigidBody()); - } + // reinserts + for (auto object : transaction.objectsToReinsert) { + reinsertObject(object); } - // activeStaticBodies have changed (in an Easy way) and need their Aabbs updated - // but we've configured Bullet to NOT update them automatically (for improved performance) - // so we must do it ourselves - std::set::const_iterator itr = _activeStaticBodies.begin(); - while (itr != _activeStaticBodies.end()) { - _dynamicsWorld->updateSingleAabb(*itr); - ++itr; + + for (auto object : transaction.activeStaticObjects) { + btRigidBody* body = object->getRigidBody(); + _dynamicsWorld->updateSingleAabb(body); + _activeStaticBodies.insert(body); } - // we replace objectsToChange with any that failed - transaction.objectsToChange.swap(failedChanges); } void PhysicsEngine::removeContacts(ObjectMotionState* motionState) { diff --git a/libraries/physics/src/PhysicsEngine.h b/libraries/physics/src/PhysicsEngine.h index 43cc0d2176..d11b52f1af 100644 --- a/libraries/physics/src/PhysicsEngine.h +++ b/libraries/physics/src/PhysicsEngine.h @@ -79,11 +79,13 @@ public: void clear() { objectsToRemove.clear(); objectsToAdd.clear(); - objectsToChange.clear(); + objectsToReinsert.clear(); + activeStaticObjects.clear(); } std::vector objectsToRemove; std::vector objectsToAdd; - std::vector objectsToChange; + std::vector objectsToReinsert; + std::vector activeStaticObjects; }; PhysicsEngine(const glm::vec3& offset); @@ -97,7 +99,7 @@ public: void removeSetOfObjects(const SetOfMotionStates& objects); // only called during teardown void addObjects(const VectorOfMotionStates& objects); - VectorOfMotionStates changeObjects(const VectorOfMotionStates& objects); + void changeObjects(const VectorOfMotionStates& objects); void reinsertObject(ObjectMotionState* object); void processTransaction(Transaction& transaction); diff --git a/libraries/physics/src/ShapeFactory.cpp b/libraries/physics/src/ShapeFactory.cpp index 5808a539d6..ef5213df8f 100644 --- a/libraries/physics/src/ShapeFactory.cpp +++ b/libraries/physics/src/ShapeFactory.cpp @@ -293,6 +293,8 @@ const btCollisionShape* ShapeFactory::createShapeFromInfo(const ShapeInfo& info) radiuses.push_back(sphereData.w); } shape = new btMultiSphereShape(positions.data(), radiuses.data(), (int)positions.size()); + const float MULTI_SPHERE_MARGIN = 0.001f; + shape->setMargin(MULTI_SPHERE_MARGIN); } break; case SHAPE_TYPE_ELLIPSOID: { @@ -433,6 +435,8 @@ const btCollisionShape* ShapeFactory::createShapeFromInfo(const ShapeInfo& info) } } break; + default: + break; } if (shape) { if (glm::length2(info.getOffset()) > MIN_SHAPE_OFFSET * MIN_SHAPE_OFFSET) { @@ -457,6 +461,8 @@ const btCollisionShape* ShapeFactory::createShapeFromInfo(const ShapeInfo& info) shape = compound; } } + } else { + // TODO: warn about this case } return shape; } @@ -481,3 +487,8 @@ void ShapeFactory::deleteShape(const btCollisionShape* shape) { } delete nonConstShape; } + +void ShapeFactory::Worker::run() { + shape = ShapeFactory::createShapeFromInfo(shapeInfo); + emit submitWork(this); +} diff --git a/libraries/physics/src/ShapeFactory.h b/libraries/physics/src/ShapeFactory.h index 704a7804b3..d23785d513 100644 --- a/libraries/physics/src/ShapeFactory.h +++ b/libraries/physics/src/ShapeFactory.h @@ -14,6 +14,8 @@ #include #include +#include +#include #include @@ -22,6 +24,17 @@ namespace ShapeFactory { const btCollisionShape* createShapeFromInfo(const ShapeInfo& info); void deleteShape(const btCollisionShape* shape); + + class Worker : public QObject, public QRunnable { + Q_OBJECT + public: + Worker(const ShapeInfo& info) : shapeInfo(info), shape(nullptr) {} + void run() override; + ShapeInfo shapeInfo; + const btCollisionShape* shape; + signals: + void submitWork(Worker*); + }; }; #endif // hifi_ShapeFactory_h diff --git a/libraries/physics/src/ShapeManager.cpp b/libraries/physics/src/ShapeManager.cpp index 8acbe51540..c37f95b5f1 100644 --- a/libraries/physics/src/ShapeManager.cpp +++ b/libraries/physics/src/ShapeManager.cpp @@ -12,15 +12,15 @@ #include "ShapeManager.h" #include +#include -#include - -#include "ShapeFactory.h" +#include const int MAX_RING_SIZE = 256; ShapeManager::ShapeManager() { _garbageRing.reserve(MAX_RING_SIZE); + _nextOrphanExpiry = std::chrono::steady_clock::now(); } ShapeManager::~ShapeManager() { @@ -30,6 +30,10 @@ ShapeManager::~ShapeManager() { ShapeFactory::deleteShape(shapeRef->shape); } _shapeMap.clear(); + if (_deadWorker) { + delete _deadWorker; + _deadWorker = nullptr; + } } const btCollisionShape* ShapeManager::getShape(const ShapeInfo& info) { @@ -42,17 +46,84 @@ const btCollisionShape* ShapeManager::getShape(const ShapeInfo& info) { shapeRef->refCount++; return shapeRef->shape; } - const btCollisionShape* shape = ShapeFactory::createShapeFromInfo(info); - if (shape) { - ShapeReference newRef; - newRef.refCount = 1; - newRef.shape = shape; - newRef.key = info.getHash(); - _shapeMap.insert(hashKey, newRef); + const btCollisionShape* shape = nullptr; + if (info.getType() == SHAPE_TYPE_STATIC_MESH) { + uint64_t hash = info.getHash(); + const auto itr = std::find(_pendingMeshShapes.begin(), _pendingMeshShapes.end(), hash); + if (itr == _pendingMeshShapes.end()) { + // start a worker + _pendingMeshShapes.push_back(hash); + ++_workRequestCount; + // try to recycle old deadWorker + ShapeFactory::Worker* worker = _deadWorker; + if (!worker) { + worker = new ShapeFactory::Worker(info); + } else { + worker->shapeInfo = info; + _deadWorker = nullptr; + } + // we will delete worker manually later + worker->setAutoDelete(false); + QObject::connect(worker, &ShapeFactory::Worker::submitWork, this, &ShapeManager::acceptWork); + QThreadPool::globalInstance()->start(worker); + } + // else we're still waiting for the shape to be created on another thread + } else { + shape = ShapeFactory::createShapeFromInfo(info); + if (shape) { + ShapeReference newRef; + newRef.refCount = 1; + newRef.shape = shape; + newRef.key = info.getHash(); + _shapeMap.insert(hashKey, newRef); + } } return shape; } +const btCollisionShape* ShapeManager::getShapeByKey(uint64_t key) { + HashKey hashKey(key); + ShapeReference* shapeRef = _shapeMap.find(hashKey); + if (shapeRef) { + shapeRef->refCount++; + return shapeRef->shape; + } + return nullptr; +} + +bool ShapeManager::hasShapeWithKey(uint64_t key) const { + HashKey hashKey(key); + const ShapeReference* shapeRef = _shapeMap.find(hashKey); + return (bool)shapeRef; +} + +void ShapeManager::addToGarbage(uint64_t key) { + // look for existing entry in _garbageRing + int32_t ringSize = (int32_t)(_garbageRing.size()); + for (int32_t i = 0; i < ringSize; ++i) { + int32_t j = (_ringIndex + ringSize) % ringSize; + if (_garbageRing[j] == key) { + // already on the list, don't add it again + return; + } + } + if (ringSize == MAX_RING_SIZE) { + // remove one + HashKey hashKeyToRemove(_garbageRing[_ringIndex]); + ShapeReference* shapeRef = _shapeMap.find(hashKeyToRemove); + if (shapeRef && shapeRef->refCount == 0) { + ShapeFactory::deleteShape(shapeRef->shape); + _shapeMap.remove(hashKeyToRemove); + } + // replace at _ringIndex and advance + _garbageRing[_ringIndex] = key; + _ringIndex = (_ringIndex + 1) % ringSize; + } else { + // add one + _garbageRing.push_back(key); + } +} + // private helper method bool ShapeManager::releaseShapeByKey(uint64_t key) { HashKey hashKey(key); @@ -61,30 +132,7 @@ bool ShapeManager::releaseShapeByKey(uint64_t key) { if (shapeRef->refCount > 0) { shapeRef->refCount--; if (shapeRef->refCount == 0) { - // look for existing entry in _garbageRing - int32_t ringSize = (int32_t)(_garbageRing.size()); - for (int32_t i = 0; i < ringSize; ++i) { - int32_t j = (_ringIndex + ringSize) % ringSize; - if (_garbageRing[j] == key) { - // already on the list, don't add it again - return true; - } - } - if (ringSize == MAX_RING_SIZE) { - // remove one - HashKey hashKeyToRemove(_garbageRing[_ringIndex]); - ShapeReference* shapeRef = _shapeMap.find(hashKeyToRemove); - if (shapeRef && shapeRef->refCount == 0) { - ShapeFactory::deleteShape(shapeRef->shape); - _shapeMap.remove(hashKeyToRemove); - } - // replace at _ringIndex and advance - _garbageRing[_ringIndex] = key; - _ringIndex = (_ringIndex + 1) % ringSize; - } else { - // add one - _garbageRing.push_back(key); - } + addToGarbage(key); } return true; } else { @@ -153,3 +201,78 @@ bool ShapeManager::hasShape(const btCollisionShape* shape) const { } return false; } + +// slot: called when ShapeFactory::Worker is done building shape +void ShapeManager::acceptWork(ShapeFactory::Worker* worker) { + auto itr = std::find(_pendingMeshShapes.begin(), _pendingMeshShapes.end(), worker->shapeInfo.getHash()); + if (itr == _pendingMeshShapes.end()) { + // we've received a shape but don't remember asking for it + // (should not fall in here, but if we do: delete the unwanted shape) + if (worker->shape) { + ShapeFactory::deleteShape(worker->shape); + } + } else { + // clear pending status + *itr = _pendingMeshShapes.back(); + _pendingMeshShapes.pop_back(); + + // cache the new shape + if (worker->shape) { + ShapeReference newRef; + // refCount is zero because nothing is using the shape yet + newRef.refCount = 0; + newRef.shape = worker->shape; + newRef.key = worker->shapeInfo.getHash(); + HashKey hashKey(newRef.key); + _shapeMap.insert(hashKey, newRef); + + // This shape's refCount is zero because an object requested it but is not yet using it. We expect it to be + // used later but there is a possibility it will never be used (e.g. the object that wanted it was removed + // before the shape could be added, or has changed its mind and now wants a different shape). + // Normally zero refCount shapes belong on _garbageRing for possible cleanup but we don't want to add it there + // because it might get reaped too soon. So we add it to _orphans to check later. If it still has zero + // refCount on expiry we will move it to _garbageRing. + const int64_t SHAPE_EXPIRY = USECS_PER_SECOND; + auto now = std::chrono::steady_clock::now(); + auto newExpiry = now + std::chrono::microseconds(SHAPE_EXPIRY); + if (_nextOrphanExpiry < now) { + _nextOrphanExpiry = newExpiry; + // check for expired orphan shapes + size_t i = 0; + while (i < _orphans.size()) { + auto expiry = _orphans[i].expiry; + if (expiry < now) { + uint64_t key = _orphans[i].key; + HashKey hashKey(key); + ShapeReference* shapeRef = _shapeMap.find(hashKey); + if (shapeRef) { + if (shapeRef->refCount == 0) { + // shape unused after expiry + addToGarbage(key); + } + } + _orphans[i] = _orphans.back(); + _orphans.pop_back(); + } else { + if (expiry < _nextOrphanExpiry) { + _nextOrphanExpiry = expiry; + } + ++i; + } + } + } + _orphans.push_back(KeyExpiry(newRef.key, newExpiry)); + } + } + disconnect(worker, &ShapeFactory::Worker::submitWork, this, &ShapeManager::acceptWork); + + if (_deadWorker) { + // delete the previous deadWorker manually + delete _deadWorker; + } + // save this dead worker for later + worker->shapeInfo.clear(); + worker->shape = nullptr; + _deadWorker = worker; + ++_workDeliveryCount; +} diff --git a/libraries/physics/src/ShapeManager.h b/libraries/physics/src/ShapeManager.h index c1fb57e017..1f39fd56be 100644 --- a/libraries/physics/src/ShapeManager.h +++ b/libraries/physics/src/ShapeManager.h @@ -12,13 +12,17 @@ #ifndef hifi_ShapeManager_h #define hifi_ShapeManager_h +#include +#include #include +#include #include #include #include +#include "ShapeFactory.h" #include "HashKey.h" // The ShapeManager handles the ref-counting on shared shapes: @@ -44,7 +48,8 @@ // entries that still have zero ref-count. -class ShapeManager { +class ShapeManager : public QObject { + Q_OBJECT public: ShapeManager(); @@ -52,6 +57,8 @@ public: /// \return pointer to shape const btCollisionShape* getShape(const ShapeInfo& info); + const btCollisionShape* getShapeByKey(uint64_t key); + bool hasShapeWithKey(uint64_t key) const; /// \return true if shape was found and released bool releaseShape(const btCollisionShape* shape); @@ -64,8 +71,14 @@ public: int getNumReferences(const ShapeInfo& info) const; int getNumReferences(const btCollisionShape* shape) const; bool hasShape(const btCollisionShape* shape) const; + uint32_t getWorkRequestCount() const { return _workRequestCount; } + uint32_t getWorkDeliveryCount() const { return _workDeliveryCount; } + +protected slots: + void acceptWork(ShapeFactory::Worker* worker); private: + void addToGarbage(uint64_t key); bool releaseShapeByKey(uint64_t key); class ShapeReference { @@ -76,10 +89,24 @@ private: ShapeReference() : refCount(0), shape(nullptr) {} }; + using TimePoint = std::chrono::time_point; + class KeyExpiry { + public: + KeyExpiry(uint64_t k, std::chrono::time_point e) : expiry(e), key(k) {} + TimePoint expiry; + uint64_t key; + }; + // btHashMap is required because it supports memory alignment of the btCollisionShapes btHashMap _shapeMap; std::vector _garbageRing; + std::vector _pendingMeshShapes; + std::vector _orphans; + ShapeFactory::Worker* _deadWorker { nullptr }; + TimePoint _nextOrphanExpiry; uint32_t _ringIndex { 0 }; + std::atomic_uint _workRequestCount { 0 }; + std::atomic_uint _workDeliveryCount { 0 }; }; #endif // hifi_ShapeManager_h diff --git a/libraries/pointers/src/Pick.h b/libraries/pointers/src/Pick.h index dda35a53a2..1766736664 100644 --- a/libraries/pointers/src/Pick.h +++ b/libraries/pointers/src/Pick.h @@ -20,6 +20,22 @@ #include #include +/**jsdoc + *

The type of an intersection.

+ *
+ * + * + * + * + * + * + * + * + * + * + *
NameValueDescription
INTERSECTED_NONE0Intersected nothing.
INTERSECTED_ENTITY1Intersected an entity.
INTERSECTED_LOCAL_ENTITY2Intersected a local entity.
INTERSECTED_AVATAR3Intersected an avatar.
INTERSECTED_HUD4Intersected the HUD sphere.
+ * @typedef {number} IntersectionType + */ enum IntersectionType { NONE = 0, ENTITY, @@ -61,7 +77,7 @@ public: virtual ~PickQuery() = default; /**jsdoc - * Enum for different types of Picks and Pointers. + * The PickType API provides constant numeric values that represent different types of picks. * * @namespace PickType * @variation 0 @@ -70,22 +86,28 @@ public: * @hifi-client-entity * @hifi-avatar * - * @property {number} Ray Ray picks intersect a ray with the nearest object in front of them, along a given direction. - * @property {number} Stylus Stylus picks provide "tapping" functionality on/into flat surfaces. - * @property {number} Parabola Parabola picks intersect a parabola with the nearest object in front of them, with a given - * initial velocity and acceleration. - * @property {number} Collision Collision picks intersect a collision volume with avatars and entities that have collisions. + * @property {number} Ray - Ray picks intersect a ray with objects in front of them, along their direction. + * @property {number} Parabola - Parabola picks intersect a parabola with objects in front of them, along their arc. + * @property {number} Stylus - Stylus picks provide "tapping" functionality on or into flat surfaces. + * @property {number} Collision - Collision picks intersect a collision volume with avatars and entities that have + * collisions. */ - /**jsdoc + + /**jsdoc + *

A type of pick.

* * * * * - * - * - * - * + * + * + * + * * *
ValueDescription
{@link PickType(0)|PickType.Ray}
{@link PickType(0)|PickType.Stylus}
{@link PickType(0)|PickType.Parabola}
{@link PickType(0)|PickType.Collision}
{@link PickType(0)|PickType.Ray}Ray picks intersect a ray with objects in front of + * them, along their direction.
{@link PickType(0)|PickType.Parabola}Parabola picks intersect a parabola with objects + * in front of them, along their arc.
{@link PickType(0)|PickType.Stylus}Stylus picks provide "tapping" functionality on or + * into flat surfaces.
{@link PickType(0)|PickType.Collision}Collision picks intersect a collision volume + * with avatars and entities that have collisions.
* @typedef {number} PickType diff --git a/libraries/procedural/src/procedural/Procedural.cpp b/libraries/procedural/src/procedural/Procedural.cpp index 9940da0b9a..dbdf9cc7d1 100644 --- a/libraries/procedural/src/procedural/Procedural.cpp +++ b/libraries/procedural/src/procedural/Procedural.cpp @@ -288,6 +288,7 @@ void Procedural::prepare(gpu::Batch& batch, recompiledShader = true; } + // FIXME: need to handle forward rendering batch.setPipeline(recompiledShader ? _proceduralPipelines[key] : pipeline->second); if (_shaderDirty || _uniformsDirty) { diff --git a/libraries/render-utils/src/GeometryCache.cpp b/libraries/render-utils/src/GeometryCache.cpp index 2e762a0107..7bd6f88d71 100644 --- a/libraries/render-utils/src/GeometryCache.cpp +++ b/libraries/render-utils/src/GeometryCache.cpp @@ -37,8 +37,6 @@ #include "DeferredLightingEffect.h" -#include - namespace gr { using graphics::slot::texture::Texture; using graphics::slot::buffer::Buffer; @@ -115,6 +113,8 @@ static const uint SHAPE_NORMALS_OFFSET = offsetof(GeometryCache::ShapeVertex, no static const uint SHAPE_TEXCOORD0_OFFSET = offsetof(GeometryCache::ShapeVertex, uv); static const uint SHAPE_TANGENT_OFFSET = offsetof(GeometryCache::ShapeVertex, tangent); +std::map, gpu::PipelinePointer> GeometryCache::_gridPipelines; + void GeometryCache::computeSimpleHullPointListForShape(const int entityShape, const glm::vec3 &entityExtents, QVector &outPointList) { auto geometryCache = DependencyManager::get(); @@ -714,11 +714,13 @@ QHash GeometryCache::_simplePrograms; gpu::ShaderPointer GeometryCache::_simpleShader; gpu::ShaderPointer GeometryCache::_transparentShader; gpu::ShaderPointer GeometryCache::_unlitShader; +gpu::ShaderPointer GeometryCache::_simpleFadeShader; +gpu::ShaderPointer GeometryCache::_unlitFadeShader; gpu::ShaderPointer GeometryCache::_forwardSimpleShader; gpu::ShaderPointer GeometryCache::_forwardTransparentShader; gpu::ShaderPointer GeometryCache::_forwardUnlitShader; -gpu::ShaderPointer GeometryCache::_simpleFadeShader; -gpu::ShaderPointer GeometryCache::_unlitFadeShader; +gpu::ShaderPointer GeometryCache::_forwardSimpleFadeShader; +gpu::ShaderPointer GeometryCache::_forwardUnlitFadeShader; render::ShapePipelinePointer GeometryCache::_simpleOpaquePipeline; render::ShapePipelinePointer GeometryCache::_simpleTransparentPipeline; @@ -740,16 +742,13 @@ render::ShapePipelinePointer GeometryCache::shapePipelineFactory(const render::S if (key.isFaded()) { if (key.isTranslucent()) { return _simpleTransparentFadePipeline; - } - else { + } else { return _simpleOpaqueFadePipeline; } - } - else { + } else { if (key.isTranslucent()) { return _simpleTransparentPipeline; - } - else { + } else { return _simpleOpaquePipeline; } } @@ -805,6 +804,8 @@ void GeometryCache::initializeShapePipelines() { _simpleTransparentPipeline = getShapePipeline(false, true, true, false); _forwardSimpleOpaquePipeline = getShapePipeline(false, false, true, false, false, true); _forwardSimpleTransparentPipeline = getShapePipeline(false, true, true, false, false, true); + + // FIXME: these need forward pipelines _simpleOpaqueFadePipeline = getFadingShapePipeline(false, false, false, false, false); _simpleTransparentFadePipeline = getFadingShapePipeline(false, true, false, false, false); _simpleWirePipeline = getShapePipeline(false, false, true, true); @@ -823,11 +824,11 @@ render::ShapePipelinePointer GeometryCache::getShapePipeline(bool textured, bool } render::ShapePipelinePointer GeometryCache::getFadingShapePipeline(bool textured, bool transparent, bool culled, - bool unlit, bool depthBias) { + bool unlit, bool depthBias, bool forward) { auto fadeEffect = DependencyManager::get(); auto fadeBatchSetter = fadeEffect->getBatchSetter(); auto fadeItemSetter = fadeEffect->getItemUniformSetter(); - return std::make_shared(getSimplePipeline(textured, transparent, culled, unlit, depthBias, true), nullptr, + return std::make_shared(getSimplePipeline(textured, transparent, culled, unlit, depthBias, true, true, forward), nullptr, [fadeBatchSetter, fadeItemSetter](const render::ShapePipeline& shapePipeline, gpu::Batch& batch, render::Args* args) { batch.setResourceTexture(gr::Texture::MaterialAlbedo, DependencyManager::get()->getWhiteTexture()); fadeBatchSetter(shapePipeline, batch, args); @@ -937,7 +938,7 @@ void GeometryCache::renderWireSphere(gpu::Batch& batch, const glm::vec4& color) void GeometryCache::renderGrid(gpu::Batch& batch, const glm::vec2& minCorner, const glm::vec2& maxCorner, int majorRows, int majorCols, float majorEdge, int minorRows, int minorCols, float minorEdge, - const glm::vec4& color, int id) { + const glm::vec4& color, bool forward, int id) { Vec2FloatPair majorKey(glm::vec2(majorRows, majorCols), majorEdge); Vec2FloatPair minorKey(glm::vec2(minorRows, minorCols), minorEdge); Vec2FloatPairPair key(majorKey, minorKey); @@ -970,7 +971,7 @@ void GeometryCache::renderGrid(gpu::Batch& batch, const glm::vec2& minCorner, co } // Set the grid pipeline - useGridPipeline(batch, gridBuffer, color.a < 1.0f); + useGridPipeline(batch, gridBuffer, color.a < 1.0f, forward); static const glm::vec2 MIN_TEX_COORD(0.0f, 0.0f); static const glm::vec2 MAX_TEX_COORD(1.0f, 1.0f); @@ -2038,39 +2039,34 @@ void GeometryCache::useSimpleDrawPipeline(gpu::Batch& batch, bool noBlend) { } } -void GeometryCache::useGridPipeline(gpu::Batch& batch, GridBuffer gridBuffer, bool transparent) { - if (!_gridPipelineOpaque || !_gridPipelineTransparent) { +void GeometryCache::useGridPipeline(gpu::Batch& batch, GridBuffer gridBuffer, bool transparent, bool forward) { + if (_gridPipelines.empty()) { + using namespace shader::render_utils::program; const float DEPTH_BIAS = 0.001f; - // FIXME: need forward pipelines - { - auto program = gpu::Shader::createProgram(shader::render_utils::program::grid); - auto state = std::make_shared(); - state->setDepthTest(true, true, gpu::LESS_EQUAL); - state->setBlendFunction(false, - gpu::State::SRC_ALPHA, gpu::State::BLEND_OP_ADD, gpu::State::INV_SRC_ALPHA, - gpu::State::FACTOR_ALPHA, gpu::State::BLEND_OP_ADD, gpu::State::ONE); - PrepareStencil::testMaskDrawShape(*state); - state->setCullMode(gpu::State::CULL_NONE); - state->setDepthBias(DEPTH_BIAS); - _gridPipelineOpaque = gpu::Pipeline::create(program, state); - } + static const std::vector> keys = { + std::make_tuple(false, false, grid), std::make_tuple(false, true, forward_grid), std::make_tuple(true, false, grid_translucent), std::make_tuple(true, true, forward_grid_translucent) + }; - { - auto program = gpu::Shader::createProgram(shader::render_utils::program::grid_translucent); - auto state = std::make_shared(); + for (auto& key : keys) { + gpu::StatePointer state = gpu::StatePointer(new gpu::State()); state->setDepthTest(true, true, gpu::LESS_EQUAL); - state->setBlendFunction(true, + if (std::get<0>(key)) { + PrepareStencil::testMask(*state); + } else { + PrepareStencil::testMaskDrawShape(*state); + } + state->setBlendFunction(std::get<0>(key), gpu::State::SRC_ALPHA, gpu::State::BLEND_OP_ADD, gpu::State::INV_SRC_ALPHA, gpu::State::FACTOR_ALPHA, gpu::State::BLEND_OP_ADD, gpu::State::ONE); - PrepareStencil::testMask(*state); state->setCullMode(gpu::State::CULL_NONE); state->setDepthBias(DEPTH_BIAS); - _gridPipelineTransparent = gpu::Pipeline::create(program, state); + + _gridPipelines[{std::get<0>(key), std::get<1>(key)}] = gpu::Pipeline::create(gpu::Shader::createProgram(std::get<2>(key)), state); } } - batch.setPipeline(transparent ? _gridPipelineTransparent : _gridPipelineOpaque); + batch.setPipeline(_gridPipelines[{ transparent, forward }]); batch.setUniformBuffer(0, gridBuffer); } @@ -2162,6 +2158,7 @@ void GeometryCache::bindWebBrowserProgram(gpu::Batch& batch, bool transparent) { gpu::PipelinePointer GeometryCache::getWebBrowserProgram(bool transparent) { static std::once_flag once; std::call_once(once, [&]() { + // FIXME: need a forward pipeline for this buildWebShader(shader::render_utils::program::simple_opaque_web_browser, false, _simpleOpaqueWebBrowserShader, _simpleOpaqueWebBrowserPipeline); buildWebShader(shader::render_utils::program::simple_transparent_web_browser, true, _simpleTransparentWebBrowserShader, _simpleTransparentWebBrowserPipeline); }); @@ -2197,22 +2194,21 @@ gpu::PipelinePointer GeometryCache::getSimplePipeline(bool textured, bool transp _forwardSimpleShader = gpu::Shader::createProgram(forward_simple_textured); _forwardTransparentShader = gpu::Shader::createProgram(forward_simple_textured_transparent); _forwardUnlitShader = gpu::Shader::createProgram(forward_simple_textured_unlit); - if (DISABLE_DEFERRED) { - _simpleShader = _forwardSimpleShader; - _transparentShader = _forwardTransparentShader; - _unlitShader = _forwardUnlitShader; - } else { - _simpleShader = gpu::Shader::createProgram(simple_textured); - _transparentShader = gpu::Shader::createProgram(simple_transparent_textured); - _unlitShader = gpu::Shader::createProgram(simple_textured_unlit); - } + + _simpleShader = gpu::Shader::createProgram(simple_textured); + _transparentShader = gpu::Shader::createProgram(simple_transparent_textured); + _unlitShader = gpu::Shader::createProgram(simple_textured_unlit); }); } else { static std::once_flag once; std::call_once(once, [&]() { using namespace shader::render_utils::program; - _simpleFadeShader = gpu::Shader::createProgram(DISABLE_DEFERRED ? forward_simple_textured : simple_textured_fade); - _unlitFadeShader = gpu::Shader::createProgram(DISABLE_DEFERRED ? forward_simple_textured_unlit : simple_textured_unlit_fade); + // FIXME: these aren't right... + _forwardSimpleFadeShader = gpu::Shader::createProgram(forward_simple_textured); + _forwardUnlitFadeShader = gpu::Shader::createProgram(forward_simple_textured_unlit); + + _simpleFadeShader = gpu::Shader::createProgram(simple_textured_fade); + _unlitFadeShader = gpu::Shader::createProgram(simple_textured_unlit_fade); }); } @@ -2240,8 +2236,8 @@ gpu::PipelinePointer GeometryCache::getSimplePipeline(bool textured, bool transp gpu::ShaderPointer program; if (config.isForward()) { - program = (config.isUnlit()) ? (config.isFading() ? _unlitFadeShader : _forwardUnlitShader) : - (config.isFading() ? _simpleFadeShader : (config.isTransparent() ? _forwardTransparentShader : _forwardSimpleShader)); + program = (config.isUnlit()) ? (config.isFading() ? _forwardUnlitFadeShader : _forwardUnlitShader) : + (config.isFading() ? _forwardSimpleFadeShader : (config.isTransparent() ? _forwardTransparentShader : _forwardSimpleShader)); } else { program = (config.isUnlit()) ? (config.isFading() ? _unlitFadeShader : _unlitShader) : (config.isFading() ? _simpleFadeShader : (config.isTransparent() ? _transparentShader : _simpleShader)); diff --git a/libraries/render-utils/src/GeometryCache.h b/libraries/render-utils/src/GeometryCache.h index 4ff061786a..a42b059a8c 100644 --- a/libraries/render-utils/src/GeometryCache.h +++ b/libraries/render-utils/src/GeometryCache.h @@ -266,7 +266,7 @@ public: void renderGrid(gpu::Batch& batch, const glm::vec2& minCorner, const glm::vec2& maxCorner, int majorRows, int majorCols, float majorEdge, int minorRows, int minorCols, float minorEdge, - const glm::vec4& color, int id); + const glm::vec4& color, bool forward, int id); void renderBevelCornersRect(gpu::Batch& batch, int x, int y, int width, int height, int bevelDistance, const glm::vec4& color, int id); @@ -400,9 +400,8 @@ private: glm::vec4 edge; }; using GridBuffer = gpu::BufferView; - void useGridPipeline(gpu::Batch& batch, GridBuffer gridBuffer, bool isLayered); - gpu::PipelinePointer _gridPipelineOpaque; - gpu::PipelinePointer _gridPipelineTransparent; + void useGridPipeline(gpu::Batch& batch, GridBuffer gridBuffer, bool transparent, bool forward); + static std::map, gpu::PipelinePointer> _gridPipelines; class BatchItemDetails { public: @@ -460,11 +459,14 @@ private: static gpu::ShaderPointer _simpleShader; static gpu::ShaderPointer _transparentShader; static gpu::ShaderPointer _unlitShader; + static gpu::ShaderPointer _simpleFadeShader; + static gpu::ShaderPointer _unlitFadeShader; static gpu::ShaderPointer _forwardSimpleShader; static gpu::ShaderPointer _forwardTransparentShader; static gpu::ShaderPointer _forwardUnlitShader; - static gpu::ShaderPointer _simpleFadeShader; - static gpu::ShaderPointer _unlitFadeShader; + static gpu::ShaderPointer _forwardSimpleFadeShader; + static gpu::ShaderPointer _forwardUnlitFadeShader; + static render::ShapePipelinePointer _simpleOpaquePipeline; static render::ShapePipelinePointer _simpleTransparentPipeline; static render::ShapePipelinePointer _forwardSimpleOpaquePipeline; @@ -483,7 +485,7 @@ private: static render::ShapePipelinePointer getShapePipeline(bool textured = false, bool transparent = false, bool culled = true, bool unlit = false, bool depthBias = false, bool forward = false); static render::ShapePipelinePointer getFadingShapePipeline(bool textured = false, bool transparent = false, bool culled = true, - bool unlit = false, bool depthBias = false); + bool unlit = false, bool depthBias = false, bool forward = false); }; #endif // hifi_GeometryCache_h diff --git a/libraries/render-utils/src/Model.cpp b/libraries/render-utils/src/Model.cpp index 7d0119a0f2..96979a23a9 100644 --- a/libraries/render-utils/src/Model.cpp +++ b/libraries/render-utils/src/Model.cpp @@ -447,7 +447,7 @@ bool Model::findRayIntersectionAgainstSubMeshes(const glm::vec3& origin, const g } /**jsdoc - * Information about a submesh intersection point. + * A submesh intersection point. * @typedef {object} SubmeshIntersection * @property {Vec3} worldIntersectionPoint - The intersection point in world coordinates. * @property {Vec3} meshIntersectionPoint - The intersection point in model coordinates. @@ -1033,7 +1033,7 @@ void Model::removeFromScene(const render::ScenePointer& scene, render::Transacti _renderInfoHasTransparent = false; } -void Model::renderDebugMeshBoxes(gpu::Batch& batch) { +void Model::renderDebugMeshBoxes(gpu::Batch& batch, bool forward) { int colorNdx = 0; _mutex.lock(); @@ -1042,7 +1042,7 @@ void Model::renderDebugMeshBoxes(gpu::Batch& batch) { Transform meshToWorld(meshToWorldMatrix); batch.setModelTransform(meshToWorld); - DependencyManager::get()->bindSimpleProgram(batch, false, false, false, true, true); + DependencyManager::get()->bindSimpleProgram(batch, false, false, false, true, true, forward); for (auto& meshTriangleSets : _modelSpaceMeshTriangleSets) { for (auto &partTriangleSet : meshTriangleSets) { diff --git a/libraries/render-utils/src/Model.h b/libraries/render-utils/src/Model.h index 7844e9bc41..7c861a3bc1 100644 --- a/libraries/render-utils/src/Model.h +++ b/libraries/render-utils/src/Model.h @@ -347,7 +347,7 @@ public: const QMap& getRenderItems() const { return _modelMeshRenderItemsMap; } BlendShapeOperator getModelBlendshapeOperator() const { return _modelBlendshapeOperator; } - void renderDebugMeshBoxes(gpu::Batch& batch); + void renderDebugMeshBoxes(gpu::Batch& batch, bool forward); int getResourceDownloadAttempts() { return _renderWatcher.getResourceDownloadAttempts(); } int getResourceDownloadAttemptsRemaining() { return _renderWatcher.getResourceDownloadAttemptsRemaining(); } diff --git a/libraries/render-utils/src/RenderCommonTask.h b/libraries/render-utils/src/RenderCommonTask.h index b43a10aa7b..4f72600d34 100644 --- a/libraries/render-utils/src/RenderCommonTask.h +++ b/libraries/render-utils/src/RenderCommonTask.h @@ -137,4 +137,16 @@ public: void run(const render::RenderContextPointer& renderContext, const Inputs& inputs, Outputs& output); }; +class SetRenderMethod { +public: + using JobModel = render::Job::Model; + + SetRenderMethod(render::Args::RenderMethod method) : _method(method) {} + + void run(const render::RenderContextPointer& renderContext) { renderContext->args->_renderMethod = _method; } + +protected: + render::Args::RenderMethod _method; +}; + #endif // hifi_RenderDeferredTask_h diff --git a/libraries/render-utils/src/RenderForwardTask.cpp b/libraries/render-utils/src/RenderForwardTask.cpp index 5e30308a05..de55f3f4ff 100755 --- a/libraries/render-utils/src/RenderForwardTask.cpp +++ b/libraries/render-utils/src/RenderForwardTask.cpp @@ -48,6 +48,8 @@ using namespace render; extern void initForwardPipelines(ShapePlumber& plumber); void RenderForwardTask::build(JobModel& task, const render::Varying& input, render::Varying& output) { + task.addJob("SetRenderMethodTask", render::Args::FORWARD); + // Prepare the ShapePipelines auto fadeEffect = DependencyManager::get(); ShapePlumberPointer shapePlumber = std::make_shared(); diff --git a/libraries/render-utils/src/RenderPipelines.cpp b/libraries/render-utils/src/RenderPipelines.cpp index ac2eb8e475..2817abb4a1 100644 --- a/libraries/render-utils/src/RenderPipelines.cpp +++ b/libraries/render-utils/src/RenderPipelines.cpp @@ -228,9 +228,11 @@ void initForwardPipelines(ShapePlumber& plumber) { // Opaques addPipeline(Key::Builder().withMaterial(), program::forward_model); + addPipeline(Key::Builder().withMaterial().withLightmap(), program::forward_model_lightmap); addPipeline(Key::Builder().withMaterial().withUnlit(), program::forward_model_unlit); addPipeline(Key::Builder().withMaterial().withTangents(), program::forward_model_normal_map); - + addPipeline(Key::Builder().withMaterial().withTangents().withLightmap(), program::forward_model_normal_map_lightmap); + // Deformed Opaques addPipeline(Key::Builder().withMaterial().withDeformed(), program::forward_deformed_model); addPipeline(Key::Builder().withMaterial().withDeformed().withTangents(), program::forward_deformed_model_normal_map); diff --git a/libraries/render-utils/src/RenderViewTask.cpp b/libraries/render-utils/src/RenderViewTask.cpp index 7230635060..ffaecedb0b 100644 --- a/libraries/render-utils/src/RenderViewTask.cpp +++ b/libraries/render-utils/src/RenderViewTask.cpp @@ -10,14 +10,37 @@ // #include "RenderViewTask.h" -#include "AssembleLightingStageTask.h" #include "RenderShadowTask.h" +#include "RenderCommonTask.h" #include "RenderDeferredTask.h" #include "RenderForwardTask.h" -void RenderViewTask::build(JobModel& task, const render::Varying& input, render::Varying& output, render::CullFunctor cullFunctor, bool isDeferred, uint8_t tagBits, uint8_t tagMask) { +#include + +void RenderShadowsAndDeferredTask::build(JobModel& task, const render::Varying& input, render::Varying& output, render::CullFunctor cullFunctor, uint8_t tagBits, uint8_t tagMask) { + task.addJob("SetRenderMethodTask", render::Args::DEFERRED); + + const auto items = input.getN(0); + const auto lightingModel = input.getN(1); + const auto lightingStageFramesAndZones = input.getN(2); + + // Warning : the cull functor passed to the shadow pass should only be testing for LOD culling. If frustum culling + // is performed, then casters not in the view frustum will be removed, which is not what we wish. + const auto shadowTaskIn = RenderShadowTask::Input(lightingStageFramesAndZones.get().get0()[0], lightingModel).asVarying(); + const auto shadowTaskOut = task.addJob("RenderShadowTask", shadowTaskIn, cullFunctor, tagBits, tagMask); + + const auto renderDeferredInput = RenderDeferredTask::Input(items, lightingModel, lightingStageFramesAndZones, shadowTaskOut).asVarying(); + task.addJob("RenderDeferredTask", renderDeferredInput); +} + +void DeferredForwardSwitchJob::build(JobModel& task, const render::Varying& input, render::Varying& output, render::CullFunctor cullFunctor, uint8_t tagBits, uint8_t tagMask) { + task.addBranch("RenderShadowsAndDeferredTask", RENDER_FORWARD ? 1 : 0, input, cullFunctor, tagBits, tagMask); + + task.addBranch("RenderForwardTask", RENDER_FORWARD ? 0 : 1, input); +} + +void RenderViewTask::build(JobModel& task, const render::Varying& input, render::Varying& output, render::CullFunctor cullFunctor, uint8_t tagBits, uint8_t tagMask) { const auto items = task.addJob("FetchCullSort", cullFunctor, tagBits, tagMask); - assert(items.canCast()); // Issue the lighting model, aka the big global settings for the view const auto lightingModel = task.addJob("LightingModel"); @@ -25,17 +48,11 @@ void RenderViewTask::build(JobModel& task, const render::Varying& input, render: // Assemble the lighting stages current frames const auto lightingStageFramesAndZones = task.addJob("AssembleStages", items); - if (isDeferred) { - // Warning : the cull functor passed to the shadow pass should only be testing for LOD culling. If frustum culling - // is performed, then casters not in the view frustum will be removed, which is not what we wish. - const auto shadowTaskIn = RenderShadowTask::Input(lightingStageFramesAndZones.get().get0()[0], lightingModel).asVarying(); - const auto shadowTaskOut = task.addJob("RenderShadowTask", shadowTaskIn, cullFunctor, tagBits, tagMask); - - const auto renderInput = RenderDeferredTask::Input(items, lightingModel, lightingStageFramesAndZones, shadowTaskOut).asVarying(); - task.addJob("RenderDeferredTask", renderInput); - } else { +#ifndef Q_OS_ANDROID + const auto deferredForwardIn = DeferredForwardSwitchJob::Input(items, lightingModel, lightingStageFramesAndZones).asVarying(); + task.addJob("DeferredForwardSwitch", deferredForwardIn, cullFunctor, tagBits, tagMask); +#else const auto renderInput = RenderForwardTask::Input(items, lightingModel, lightingStageFramesAndZones).asVarying(); - task.addJob("Forward", renderInput); - } + task.addJob("RenderForwardTask", renderInput); +#endif } - diff --git a/libraries/render-utils/src/RenderViewTask.h b/libraries/render-utils/src/RenderViewTask.h index 5da3d18474..cdb56a2189 100644 --- a/libraries/render-utils/src/RenderViewTask.h +++ b/libraries/render-utils/src/RenderViewTask.h @@ -15,6 +15,30 @@ #include #include +#include "AssembleLightingStageTask.h" + +class RenderShadowsAndDeferredTask { +public: + using Input = render::VaryingSet3; + using JobModel = render::Task::ModelI; + + RenderShadowsAndDeferredTask() {} + + void build(JobModel& task, const render::Varying& inputs, render::Varying& outputs, render::CullFunctor cullFunctor, uint8_t tagBits, uint8_t tagMask); + +}; + +class DeferredForwardSwitchJob { +public: + using Input = render::VaryingSet3; + using JobModel = render::Switch::ModelI; + + DeferredForwardSwitchJob() {} + + void configure(const render::SwitchConfig& config) {} + void build(JobModel& task, const render::Varying& inputs, render::Varying& outputs, render::CullFunctor cullFunctor, uint8_t tagBits, uint8_t tagMask); + +}; class RenderViewTask { public: @@ -23,7 +47,7 @@ public: RenderViewTask() {} - void build(JobModel& task, const render::Varying& inputs, render::Varying& outputs, render::CullFunctor cullFunctor, bool isDeferred, uint8_t tagBits = 0x00, uint8_t tagMask = 0x00); + void build(JobModel& task, const render::Varying& inputs, render::Varying& outputs, render::CullFunctor cullFunctor, uint8_t tagBits = 0x00, uint8_t tagMask = 0x00); }; diff --git a/libraries/render-utils/src/TextRenderer3D.cpp b/libraries/render-utils/src/TextRenderer3D.cpp index 8ef0dc0d73..d3ea20273e 100644 --- a/libraries/render-utils/src/TextRenderer3D.cpp +++ b/libraries/render-utils/src/TextRenderer3D.cpp @@ -67,11 +67,11 @@ float TextRenderer3D::getFontSize() const { } void TextRenderer3D::draw(gpu::Batch& batch, float x, float y, const QString& str, const glm::vec4& color, - const glm::vec2& bounds, bool layered) { + const glm::vec2& bounds, bool forward) { // The font does all the OpenGL work if (_font) { _color = color; - _font->drawString(batch, _drawInfo, str, _color, _effectType, { x, y }, bounds, layered); + _font->drawString(batch, _drawInfo, str, _color, _effectType, { x, y }, bounds, forward); } } diff --git a/libraries/render-utils/src/TextRenderer3D.h b/libraries/render-utils/src/TextRenderer3D.h index 6c91411e1d..ce4dd9f9e5 100644 --- a/libraries/render-utils/src/TextRenderer3D.h +++ b/libraries/render-utils/src/TextRenderer3D.h @@ -38,8 +38,8 @@ public: glm::vec2 computeExtent(const QString& str) const; float getFontSize() const; // Pixel size - void draw(gpu::Batch& batch, float x, float y, const QString& str, const glm::vec4& color = glm::vec4(1.0f), - const glm::vec2& bounds = glm::vec2(-1.0f), bool layered = false); + void draw(gpu::Batch& batch, float x, float y, const QString& str, const glm::vec4& color, + const glm::vec2& bounds, bool forward); private: TextRenderer3D(const char* family, float pointSize, int weight = -1, bool italic = false, diff --git a/libraries/render-utils/src/ZoneRenderer.cpp b/libraries/render-utils/src/ZoneRenderer.cpp index 0e9672a7f2..e1606ba9f8 100644 --- a/libraries/render-utils/src/ZoneRenderer.cpp +++ b/libraries/render-utils/src/ZoneRenderer.cpp @@ -43,7 +43,9 @@ const Selection::Name ZoneRendererTask::ZONES_SELECTION { "RankedZones" }; void ZoneRendererTask::build(JobModel& task, const Varying& input, Varying& output) { // Filter out the sorted list of zones - const auto zoneItems = task.addJob("FilterZones", input, ZONES_SELECTION.c_str()); + // FIXME: the zones in the selection are already sorted, but we're doing another sort here to pick the selected items + // out of `input`, which means we're also looping over the inItems an extra time. + const auto zoneItems = task.addJob("FilterZones", input, ZONES_SELECTION); // just setup the current zone env task.addJob("SetupZones", zoneItems); diff --git a/libraries/render-utils/src/forward_grid.slf b/libraries/render-utils/src/forward_grid.slf new file mode 100644 index 0000000000..e34794bfed --- /dev/null +++ b/libraries/render-utils/src/forward_grid.slf @@ -0,0 +1,40 @@ +<@include gpu/Config.slh@> +<$VERSION_HEADER$> +// Generated on <$_SCRIBE_DATE$> +// +// Created by Sam Gondelman on 5/9/19 +// Copyright 2019 High Fidelity, Inc. +// +// Distributed under the Apache License, Version 2.0. +// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html +// + +<@include gpu/ShaderConstants.h@> +<@include gpu/Paint.slh@> + +struct Grid { + vec4 period; + vec4 offset; + vec4 edge; +}; + +LAYOUT(binding=0) uniform gridBuffer { + Grid grid; +}; + +layout(location=GPU_ATTR_TEXCOORD0) in vec2 varTexCoord0; +layout(location=GPU_ATTR_COLOR) in vec4 varColor; + +layout(location=0) out vec4 _fragColor0; + +void main(void) { + float alpha = mix(paintGridMajorMinor(varTexCoord0, grid.offset, grid.period, grid.edge), + paintGrid(varTexCoord0, grid.offset.xy, grid.period.xy, grid.edge.xy), + float(grid.edge.z == 0.0)); + + if (alpha < 0.0001) { + discard; + } + + _fragColor0 = vec4(varColor.xyz, 1.0); +} diff --git a/libraries/render-utils/src/forward_grid_translucent.slf b/libraries/render-utils/src/forward_grid_translucent.slf new file mode 100644 index 0000000000..df0494a22e --- /dev/null +++ b/libraries/render-utils/src/forward_grid_translucent.slf @@ -0,0 +1,41 @@ +<@include gpu/Config.slh@> +<$VERSION_HEADER$> +// Generated on <$_SCRIBE_DATE$> +// +// Created by Sam Gondelman on 5/9/19 +// Copyright 2019 High Fidelity, Inc. +// +// Distributed under the Apache License, Version 2.0. +// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html +// + +<@include gpu/ShaderConstants.h@> +<@include gpu/Paint.slh@> + +struct Grid { + vec4 period; + vec4 offset; + vec4 edge; +}; + +LAYOUT(binding=0) uniform gridBuffer { + Grid grid; +}; + +layout(location=GPU_ATTR_TEXCOORD0) in vec2 varTexCoord0; +layout(location=GPU_ATTR_COLOR) in vec4 varColor; + +layout(location=0) out vec4 _fragColor0; + +void main(void) { + float alpha = mix(paintGridMajorMinor(varTexCoord0, grid.offset, grid.period, grid.edge), + paintGrid(varTexCoord0, grid.offset.xy, grid.period.xy, grid.edge.xy), + float(grid.edge.z == 0.0)); + alpha *= varColor.w; + + if (alpha < 0.0001) { + discard; + } + + _fragColor0 = vec4(varColor.xyz, alpha); +} diff --git a/libraries/render-utils/src/forward_model_lightmap.slf b/libraries/render-utils/src/forward_model_lightmap.slf new file mode 100644 index 0000000000..aa1d6dc3b8 --- /dev/null +++ b/libraries/render-utils/src/forward_model_lightmap.slf @@ -0,0 +1,71 @@ +<@include gpu/Config.slh@> +<$VERSION_HEADER$> +// <$_SCRIBE_FILENAME$> +// Generated on <$_SCRIBE_DATE$> +// +// Created by Sam Gateau on 2/15/2016. +// Copyright 2014 High Fidelity, Inc. +// +// Distributed under the Apache License, Version 2.0. +// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html +// + +<@include DefaultMaterials.slh@> +<@include graphics/Material.slh@> +<@include graphics/MaterialTextures.slh@> +<@include render-utils/ShaderConstants.h@> + +<@include ForwardGlobalLight.slh@> + +<$declareEvalLightmappedColor()$> + +<@include gpu/Transform.slh@> +<$declareStandardCameraTransform()$> + +<$declareMaterialTextures(ALBEDO, ROUGHNESS, _SCRIBE_NULL, METALLIC)$> +<$declareMaterialLightmap()$> + +layout(location=RENDER_UTILS_ATTR_POSITION_ES) in vec4 _positionES; +layout(location=RENDER_UTILS_ATTR_TEXCOORD01) in vec4 _texCoord01; +#define _texCoord0 _texCoord01.xy +#define _texCoord1 _texCoord01.zw +layout(location=RENDER_UTILS_ATTR_NORMAL_WS) in vec3 _normalWS; +layout(location=RENDER_UTILS_ATTR_COLOR) in vec4 _color; + +layout(location=0) out vec4 _fragColor0; + +void main(void) { + Material mat = getMaterial(); + BITFIELD matKey = getMaterialKey(mat); + <$fetchMaterialTexturesCoord0(matKey, _texCoord0, albedoTex, roughnessTex, _SCRIBE_NULL, metallicTex)$> + <$fetchMaterialTexturesCoord1(matKey, _texCoord1, _SCRIBE_NULL, lightmap)$> + + float opacity = 1.0; + <$evalMaterialOpacity(albedoTex.a, opacity, matKey, opacity)$>; + <$discardTransparent(opacity)$>; + + vec3 albedo = getMaterialAlbedo(mat); + <$evalMaterialAlbedo(albedoTex, albedo, matKey, albedo)$>; + albedo *= _color.rgb; + + float roughness = getMaterialRoughness(mat); + <$evalMaterialRoughness(roughnessTex, roughness, matKey, roughness)$>; + + float metallic = getMaterialMetallic(mat); + <$evalMaterialMetallic(metallicTex, metallic, matKey, metallic)$>; + + vec3 fragNormal = normalize(_normalWS); + + TransformCamera cam = getTransformCamera(); + + vec4 color = vec4(evalLightmappedColor( + cam._viewInverse, + 1.0, + 1.0, + fragNormal, + albedo, + lightmap), + opacity); + + _fragColor0 = color; +} diff --git a/libraries/render-utils/src/forward_model_normal_map_lightmap.slf b/libraries/render-utils/src/forward_model_normal_map_lightmap.slf new file mode 100644 index 0000000000..c36f3d51c6 --- /dev/null +++ b/libraries/render-utils/src/forward_model_normal_map_lightmap.slf @@ -0,0 +1,74 @@ +<@include gpu/Config.slh@> +<$VERSION_HEADER$> +// <$_SCRIBE_FILENAME$> +// Generated on <$_SCRIBE_DATE$> +// +// Created by Sam Gateau on 2/15/2016. +// Copyright 2014 High Fidelity, Inc. +// +// Distributed under the Apache License, Version 2.0. +// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html +// + +<@include DefaultMaterials.slh@> +<@include graphics/Material.slh@> +<@include graphics/MaterialTextures.slh@> +<@include render-utils/ShaderConstants.h@> + +<@include ForwardGlobalLight.slh@> + +<$declareEvalLightmappedColor()$> + +<@include gpu/Transform.slh@> +<$declareStandardCameraTransform()$> + +<$declareMaterialTextures(ALBEDO, ROUGHNESS, NORMAL, METALLIC)$> +<$declareMaterialLightmap()$> + +layout(location=RENDER_UTILS_ATTR_POSITION_ES) in vec4 _positionES; +layout(location=RENDER_UTILS_ATTR_TEXCOORD01) in vec4 _texCoord01; +#define _texCoord0 _texCoord01.xy +#define _texCoord1 _texCoord01.zw +layout(location=RENDER_UTILS_ATTR_NORMAL_WS) in vec3 _normalWS; +layout(location=RENDER_UTILS_ATTR_TANGENT_WS) in vec3 _tangentWS; +layout(location=RENDER_UTILS_ATTR_COLOR) in vec4 _color; + +layout(location=0) out vec4 _fragColor0; + +void main(void) { + Material mat = getMaterial(); + BITFIELD matKey = getMaterialKey(mat); + <$fetchMaterialTexturesCoord0(matKey, _texCoord0, albedoTex, roughnessTex, normalTex, metallicTex)$> + <$fetchMaterialTexturesCoord1(matKey, _texCoord1, _SCRIBE_NULL, lightmap)$> + + float opacity = 1.0; + <$evalMaterialOpacity(albedoTex.a, opacity, matKey, opacity)$>; + <$discardTransparent(opacity)$>; + + vec3 albedo = getMaterialAlbedo(mat); + <$evalMaterialAlbedo(albedoTex, albedo, matKey, albedo)$>; + albedo *= _color.rgb; + + float roughness = getMaterialRoughness(mat); + <$evalMaterialRoughness(roughnessTex, roughness, matKey, roughness)$>; + + float metallic = getMaterialMetallic(mat); + <$evalMaterialMetallic(metallicTex, metallic, matKey, metallic)$>; + + vec3 fragPosition = _positionES.xyz; + vec3 fragNormal; + <$evalMaterialNormalLOD(fragPosition, normalTex, _normalWS, _tangentWS, fragNormal)$> + + TransformCamera cam = getTransformCamera(); + + vec4 color = vec4(evalLightmappedColor( + cam._viewInverse, + 1.0, + 1.0, + fragNormal, + albedo, + lightmap), + opacity); + + _fragColor0 = color; +} diff --git a/libraries/render-utils/src/forward_parabola.slf b/libraries/render-utils/src/forward_parabola.slf new file mode 100644 index 0000000000..b0def6db6b --- /dev/null +++ b/libraries/render-utils/src/forward_parabola.slf @@ -0,0 +1,18 @@ +<@include gpu/Config.slh@> +<$VERSION_HEADER$> +// Generated on <$_SCRIBE_DATE$> +// +// Created by Sam Gondelman on 5/9/19 +// Copyright 2019 High Fidelity, Inc. +// +// Distributed under the Apache License, Version 2.0. +// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html +// + +layout(location=0) in vec4 _color; + +layout(location=0) out vec4 _fragColor0; + +void main(void) { + _fragColor0 = _color; +} diff --git a/libraries/render-utils/src/parabola_forward.slv b/libraries/render-utils/src/parabola_forward.slv deleted file mode 100644 index 4eb1456666..0000000000 --- a/libraries/render-utils/src/parabola_forward.slv +++ /dev/null @@ -1,7 +0,0 @@ -layout(location=0) in vec4 _color; - -layout(location=0) out vec4 _fragColor0; - -void main(void) { - _fragColor0 = _color; -} \ No newline at end of file diff --git a/libraries/render-utils/src/render-utils/forward_grid.slp b/libraries/render-utils/src/render-utils/forward_grid.slp new file mode 100644 index 0000000000..c81b208f63 --- /dev/null +++ b/libraries/render-utils/src/render-utils/forward_grid.slp @@ -0,0 +1 @@ +VERTEX standardTransformPNTC diff --git a/libraries/render-utils/src/render-utils/forward_grid_translucent.slp b/libraries/render-utils/src/render-utils/forward_grid_translucent.slp new file mode 100644 index 0000000000..c81b208f63 --- /dev/null +++ b/libraries/render-utils/src/render-utils/forward_grid_translucent.slp @@ -0,0 +1 @@ +VERTEX standardTransformPNTC diff --git a/libraries/render-utils/src/render-utils/forward_model_lightmap.slp b/libraries/render-utils/src/render-utils/forward_model_lightmap.slp new file mode 100644 index 0000000000..81ac672062 --- /dev/null +++ b/libraries/render-utils/src/render-utils/forward_model_lightmap.slp @@ -0,0 +1 @@ +VERTEX model diff --git a/libraries/render-utils/src/render-utils/forward_model_normal_map_lightmap.slp b/libraries/render-utils/src/render-utils/forward_model_normal_map_lightmap.slp new file mode 100644 index 0000000000..c50be6285b --- /dev/null +++ b/libraries/render-utils/src/render-utils/forward_model_normal_map_lightmap.slp @@ -0,0 +1 @@ +VERTEX model_normal_map diff --git a/libraries/render-utils/src/render-utils/forward_parabola.slp b/libraries/render-utils/src/render-utils/forward_parabola.slp new file mode 100644 index 0000000000..ab3f1d4126 --- /dev/null +++ b/libraries/render-utils/src/render-utils/forward_parabola.slp @@ -0,0 +1 @@ +VERTEX parabola diff --git a/libraries/render-utils/src/text/Font.cpp b/libraries/render-utils/src/text/Font.cpp index 364e24c5ac..c69db5e055 100644 --- a/libraries/render-utils/src/text/Font.cpp +++ b/libraries/render-utils/src/text/Font.cpp @@ -13,10 +13,13 @@ #include "FontFamilies.h" #include "../StencilMaskPass.h" -#include "DisableDeferred.h" - static std::mutex fontMutex; +gpu::PipelinePointer Font::_deferredPipeline; +gpu::PipelinePointer Font::_forwardPipeline; +gpu::PipelinePointer Font::_transparentPipeline; +gpu::Stream::FormatPointer Font::_format; + struct TextureVertex { glm::vec2 pos; glm::vec2 tex; @@ -218,13 +221,10 @@ void Font::read(QIODevice& in) { } void Font::setupGPU() { - if (!_initialized) { - _initialized = true; - + if (!_deferredPipeline) { // Setup render pipeline { { - gpu::ShaderPointer program = gpu::Shader::createProgram(shader::render_utils::program::forward_sdf_text3D); auto state = std::make_shared(); state->setCullMode(gpu::State::CULL_BACK); state->setDepthTest(true, true, gpu::LESS_EQUAL); @@ -232,25 +232,11 @@ void Font::setupGPU() { gpu::State::SRC_ALPHA, gpu::State::BLEND_OP_ADD, gpu::State::INV_SRC_ALPHA, gpu::State::FACTOR_ALPHA, gpu::State::BLEND_OP_ADD, gpu::State::ONE); PrepareStencil::testMaskDrawShape(*state); - _layeredPipeline = gpu::Pipeline::create(program, state); - } - - if (DISABLE_DEFERRED) { - _pipeline = _layeredPipeline; - } else { - gpu::ShaderPointer program = gpu::Shader::createProgram(shader::render_utils::program::sdf_text3D); - auto state = std::make_shared(); - state->setCullMode(gpu::State::CULL_BACK); - state->setDepthTest(true, true, gpu::LESS_EQUAL); - state->setBlendFunction(false, - gpu::State::SRC_ALPHA, gpu::State::BLEND_OP_ADD, gpu::State::INV_SRC_ALPHA, - gpu::State::FACTOR_ALPHA, gpu::State::BLEND_OP_ADD, gpu::State::ONE); - PrepareStencil::testMaskDrawShape(*state); - _pipeline = gpu::Pipeline::create(program, state); + _deferredPipeline = gpu::Pipeline::create(gpu::Shader::createProgram(shader::render_utils::program::sdf_text3D), state); + _forwardPipeline = gpu::Pipeline::create(gpu::Shader::createProgram(shader::render_utils::program::forward_sdf_text3D), state); } { - gpu::ShaderPointer program = gpu::Shader::createProgram(shader::render_utils::program::sdf_text3D_transparent); auto state = std::make_shared(); state->setCullMode(gpu::State::CULL_BACK); state->setDepthTest(true, true, gpu::LESS_EQUAL); @@ -258,7 +244,7 @@ void Font::setupGPU() { gpu::State::SRC_ALPHA, gpu::State::BLEND_OP_ADD, gpu::State::INV_SRC_ALPHA, gpu::State::FACTOR_ALPHA, gpu::State::BLEND_OP_ADD, gpu::State::ONE); PrepareStencil::testMask(*state); - _transparentPipeline = gpu::Pipeline::create(program, state); + _transparentPipeline = gpu::Pipeline::create(gpu::Shader::createProgram(shader::render_utils::program::sdf_text3D_transparent), state); } } @@ -363,7 +349,7 @@ void Font::buildVertices(Font::DrawInfo& drawInfo, const QString& str, const glm } void Font::drawString(gpu::Batch& batch, Font::DrawInfo& drawInfo, const QString& str, const glm::vec4& color, - EffectType effectType, const glm::vec2& origin, const glm::vec2& bounds, bool layered) { + EffectType effectType, const glm::vec2& origin, const glm::vec2& bounds, bool forward) { if (str == "") { return; } @@ -390,7 +376,7 @@ void Font::drawString(gpu::Batch& batch, Font::DrawInfo& drawInfo, const QString } // need the gamma corrected color here - batch.setPipeline(color.a < 1.0f ? _transparentPipeline : (layered ? _layeredPipeline : _pipeline)); + batch.setPipeline(color.a < 1.0f ? _transparentPipeline : (forward ? _forwardPipeline : _deferredPipeline)); batch.setInputFormat(_format); batch.setInputBuffer(0, drawInfo.verticesBuffer, 0, _format->getChannels().at(0)._stride); batch.setResourceTexture(render_utils::slot::texture::TextFont, _texture); diff --git a/libraries/render-utils/src/text/Font.h b/libraries/render-utils/src/text/Font.h index 28af5bac43..893ab59981 100644 --- a/libraries/render-utils/src/text/Font.h +++ b/libraries/render-utils/src/text/Font.h @@ -46,7 +46,7 @@ public: // Render string to batch void drawString(gpu::Batch& batch, DrawInfo& drawInfo, const QString& str, const glm::vec4& color, EffectType effectType, - const glm::vec2& origin, const glm::vec2& bound, bool layered); + const glm::vec2& origin, const glm::vec2& bound, bool forward); static Pointer load(const QString& family); @@ -77,15 +77,13 @@ private: float _descent = 0.0f; float _spaceWidth = 0.0f; - bool _initialized = false; - - // gpu structures - gpu::PipelinePointer _pipeline; - gpu::PipelinePointer _layeredPipeline; - gpu::PipelinePointer _transparentPipeline; gpu::TexturePointer _texture; - gpu::Stream::FormatPointer _format; gpu::BufferStreamPointer _stream; + + static gpu::PipelinePointer _deferredPipeline; + static gpu::PipelinePointer _forwardPipeline; + static gpu::PipelinePointer _transparentPipeline; + static gpu::Stream::FormatPointer _format; }; #endif diff --git a/libraries/render/src/render/Args.h b/libraries/render/src/render/Args.h index 953a0b8223..7821692a60 100644 --- a/libraries/render/src/render/Args.h +++ b/libraries/render/src/render/Args.h @@ -64,6 +64,7 @@ namespace render { public: enum RenderMode { DEFAULT_RENDER_MODE, SHADOW_RENDER_MODE, MIRROR_RENDER_MODE, SECONDARY_CAMERA_RENDER_MODE }; enum DisplayMode { MONO, STEREO_MONITOR, STEREO_HMD }; + enum RenderMethod { DEFERRED, FORWARD }; enum DebugFlags { RENDER_DEBUG_NONE = 0, RENDER_DEBUG_HULLS = 1 @@ -77,6 +78,7 @@ namespace render { float lodAngleHalfTan = 0.1f, RenderMode renderMode = DEFAULT_RENDER_MODE, DisplayMode displayMode = MONO, + RenderMethod renderMethod = DEFERRED, DebugFlags debugFlags = RENDER_DEBUG_NONE, gpu::Batch* batch = nullptr) : _context(context), @@ -86,6 +88,7 @@ namespace render { _lodAngleHalfTanSq(lodAngleHalfTan * lodAngleHalfTan), _renderMode(renderMode), _displayMode(displayMode), + _renderMethod(renderMethod), _debugFlags(debugFlags), _batch(batch) { } @@ -117,6 +120,7 @@ namespace render { RenderMode _renderMode { DEFAULT_RENDER_MODE }; DisplayMode _displayMode { MONO }; + RenderMethod _renderMethod { DEFERRED }; DebugFlags _debugFlags { RENDER_DEBUG_NONE }; gpu::Batch* _batch = nullptr; diff --git a/libraries/render/src/render/Scene.cpp b/libraries/render/src/render/Scene.cpp index 4f6fe3e36a..3fd52d5fa2 100644 --- a/libraries/render/src/render/Scene.cpp +++ b/libraries/render/src/render/Scene.cpp @@ -287,12 +287,7 @@ void Scene::processTransactionFrame(const Transaction& transaction) { _numAllocatedItems.exchange(maxID); } - if (transaction.touchTransactions()) { - std::unique_lock lock(_selectionsMutex); - - // resets and potential NEW items - resetSelections(transaction._resetSelections); - } + resetSelections(transaction._resetSelections); resetHighlights(transaction._highlightResets); removeHighlights(transaction._highlightRemoves); @@ -581,35 +576,34 @@ void Scene::resetItemTransition(ItemID itemId) { } } -// This function is thread safe Selection Scene::getSelection(const Selection::Name& name) const { std::unique_lock lock(_selectionsMutex); auto found = _selections.find(name); if (found == _selections.end()) { return Selection(); } else { - return (*found).second; + return found->second; } } -// This function is thread safe bool Scene::isSelectionEmpty(const Selection::Name& name) const { std::unique_lock lock(_selectionsMutex); auto found = _selections.find(name); if (found == _selections.end()) { return true; } else { - return (*found).second.isEmpty(); + return found->second.isEmpty(); } } void Scene::resetSelections(const Transaction::SelectionResets& transactions) { + std::unique_lock lock(_selectionsMutex); for (auto selection : transactions) { auto found = _selections.find(selection.getName()); if (found == _selections.end()) { - _selections.insert(SelectionMap::value_type(selection.getName(), selection)); + _selections[selection.getName()] = selection; } else { - (*found).second = selection; + found->second = selection; } } } diff --git a/libraries/render/src/render/Scene.h b/libraries/render/src/render/Scene.h index 08fbf33bcd..5f4a209b66 100644 --- a/libraries/render/src/render/Scene.h +++ b/libraries/render/src/render/Scene.h @@ -78,9 +78,6 @@ public: void merge(Transaction&& transaction); void clear(); - // Checkers if there is work to do when processing the transaction - bool touchTransactions() const { return !_resetSelections.empty(); } - protected: using Reset = std::tuple; diff --git a/libraries/render/src/render/Selection.h b/libraries/render/src/render/Selection.h index 2c7ce710cd..05b2395b42 100644 --- a/libraries/render/src/render/Selection.h +++ b/libraries/render/src/render/Selection.h @@ -45,9 +45,8 @@ namespace render { Name _name; ItemIDs _items; }; - using Selections = std::vector; - using SelectionMap = std::map; + using SelectionMap = std::unordered_map; } diff --git a/libraries/script-engine/src/Quat.h b/libraries/script-engine/src/Quat.h index d24db786d0..0a5e58ac26 100644 --- a/libraries/script-engine/src/Quat.h +++ b/libraries/script-engine/src/Quat.h @@ -23,7 +23,7 @@ #include /**jsdoc - * A quaternion value. See also the {@link Quat(0)|Quat} object. + * A quaternion value. See also the {@link Quat(0)|Quat} API. * @typedef {object} Quat * @property {number} x - Imaginary component i. * @property {number} y - Imaginary component j. @@ -32,9 +32,10 @@ */ /**jsdoc - * The Quat API provides facilities for generating and manipulating quaternions. + * The Quat API provides facilities for generating and manipulating quaternions. * Quaternions should be used in preference to Euler angles wherever possible because quaternions don't suffer from the problem * of gimbal lock. + * * @namespace Quat * @variation 0 * @@ -59,7 +60,7 @@ class Quat : public QObject, protected QScriptable { public slots: /**jsdoc - * Multiply two quaternions. + * Multiplies two quaternions. * @function Quat(0).multiply * @param {Quat} q1 - The first quaternion. * @param {Quat} q2 - The second quaternion. @@ -90,8 +91,8 @@ public slots: glm::quat normalize(const glm::quat& q); /**jsdoc - * Calculate the conjugate of a quaternion. For a unit quaternion, its conjugate is the same as its - * {@link Quat(0).inverse|Quat.inverse}. + * Calculates the conjugate of a quaternion. For a unit quaternion, its conjugate is the same as its + * {@link Quat(0).inverse|Quat.inverse}. * @function Quat(0).conjugate * @param {Quat} q - The quaternion to conjugate. * @returns {Quat} The conjugate of q. @@ -106,8 +107,9 @@ public slots: glm::quat conjugate(const glm::quat& q); /**jsdoc - * Calculate a camera orientation given eye position, point of interest, and "up" direction. The camera's negative z-axis is - * the forward direction. The result has zero roll about its forward direction with respect to the given "up" direction. + * Calculates a camera orientation given an eye position, point of interest, and "up" direction. The camera's negative + * z-axis is the forward direction. The result has zero roll about its forward direction with respect to the given "up" + * direction. * @function Quat(0).lookAt * @param {Vec3} eye - The eye position. * @param {Vec3} target - The point to look at. @@ -121,7 +123,7 @@ public slots: glm::quat lookAt(const glm::vec3& eye, const glm::vec3& center, const glm::vec3& up); /**jsdoc - * Calculate a camera orientation given eye position and point of interest. The camera's negative z-axis is the forward + * Calculates a camera orientation given an eye position and point of interest. The camera's negative z-axis is the forward * direction. The result has zero roll about its forward direction. * @function Quat(0).lookAtSimple * @param {Vec3} eye - The eye position. @@ -137,7 +139,7 @@ public slots: glm::quat lookAtSimple(const glm::vec3& eye, const glm::vec3& center); /**jsdoc - * Calculate the shortest rotation from a first vector onto a second. + * Calculates the shortest rotation from a first vector onto a second. * @function Quat(0).rotationBetween * @param {Vec3} v1 - The first vector. * @param {Vec3} v2 - The second vector. @@ -154,7 +156,7 @@ public slots: glm::quat rotationBetween(const glm::vec3& v1, const glm::vec3& v2); /**jsdoc - * Generate a quaternion from a {@link Vec3} of Euler angles in degrees. + * Generates a quaternion from a {@link Vec3} of Euler angles in degrees. * @function Quat(0).fromVec3Degrees * @param {Vec3} vector - A vector of three Euler angles in degrees, the angles being the rotations about the x, y, and z * axes. @@ -168,7 +170,7 @@ public slots: glm::quat fromVec3Degrees(const glm::vec3& vec3); /**jsdoc - * Generate a quaternion from a {@link Vec3} of Euler angles in radians. + * Generates a quaternion from a {@link Vec3} of Euler angles in radians. * @function Quat(0).fromVec3Radians * @param {Vec3} vector - A vector of three Euler angles in radians, the angles being the rotations about the x, y, and z * axes. @@ -179,7 +181,7 @@ public slots: glm::quat fromVec3Radians(const glm::vec3& vec3); /**jsdoc - * Generate a quaternion from pitch, yaw, and roll values in degrees. + * Generates a quaternion from pitch, yaw, and roll values in degrees. * @function Quat(0).fromPitchYawRollDegrees * @param {number} pitch - The pitch angle in degrees. * @param {number} yaw - The yaw angle in degrees. @@ -191,7 +193,7 @@ public slots: glm::quat fromPitchYawRollDegrees(float pitch, float yaw, float roll); /**jsdoc - * Generate a quaternion from pitch, yaw, and roll values in radians. + * Generates a quaternion from pitch, yaw, and roll values in radians. * @function Quat(0).fromPitchYawRollRadians * @param {number} pitch - The pitch angle in radians. * @param {number} yaw - The yaw angle in radians. @@ -203,7 +205,7 @@ public slots: glm::quat fromPitchYawRollRadians(float pitch, float yaw, float roll); /**jsdoc - * Calculate the inverse of a quaternion. For a unit quaternion, its inverse is the same as its + * Calculates the inverse of a quaternion. For a unit quaternion, its inverse is the same as its * {@link Quat(0).conjugate|Quat.conjugate}. * @function Quat(0).inverse * @param {Quat} q - The quaternion. @@ -219,9 +221,9 @@ public slots: glm::quat inverse(const glm::quat& q); /**jsdoc - * Get the "front" direction that the camera would face if its orientation was set to the quaternion value. + * Gets the "front" direction that the camera would face if its orientation was set to the quaternion value. * This is a synonym for {@link Quat(0).getForward|Quat.getForward}. - * The High Fidelity camera has axes x = right, y = up, -z = forward. + * The High Fidelity camera has axes x = right, y = up, -z = forward. * @function Quat(0).getFront * @param {Quat} orientation - A quaternion representing an orientation. * @returns {Vec3} The negative z-axis rotated by orientation. @@ -229,9 +231,9 @@ public slots: glm::vec3 getFront(const glm::quat& orientation) { return getForward(orientation); } /**jsdoc - * Get the "forward" direction that the camera would face if its orientation was set to the quaternion value. + * Gets the "forward" direction that the camera would face if its orientation was set to the quaternion value. * This is a synonym for {@link Quat(0).getFront|Quat.getFront}. - * The High Fidelity camera has axes x = right, y = up, -z = forward. + * The High Fidelity camera has axes x = right, y = up, -z = forward. * @function Quat(0).getForward * @param {Quat} orientation - A quaternion representing an orientation. * @returns {Vec3} The negative z-axis rotated by orientation. @@ -242,8 +244,8 @@ public slots: glm::vec3 getForward(const glm::quat& orientation); /**jsdoc - * Get the "right" direction that the camera would have if its orientation was set to the quaternion value. - * The High Fidelity camera has axes x = right, y = up, -z = forward. + * Gets the "right" direction that the camera would have if its orientation was set to the quaternion value. + * The High Fidelity camera has axes x = right, y = up, -z = forward. * @function Quat(0).getRight * @param {Quat} orientation - A quaternion representing an orientation. * @returns {Vec3} The x-axis rotated by orientation. @@ -251,8 +253,8 @@ public slots: glm::vec3 getRight(const glm::quat& orientation); /**jsdoc - * Get the "up" direction that the camera would have if its orientation was set to the quaternion value. - * The High Fidelity camera has axes x = right, y = up, -z = forward. + * Gets the "up" direction that the camera would have if its orientation was set to the quaternion value. + * The High Fidelity camera has axes x = right, y = up, -z = forward. * @function Quat(0).getUp * @param {Quat} orientation - A quaternion representing an orientation. * @returns {Vec3} The y-axis rotated by orientation. @@ -260,8 +262,8 @@ public slots: glm::vec3 getUp(const glm::quat& orientation); /**jsdoc - * Calculate the Euler angles for the quaternion, in degrees. (The "safe" in the name signifies that the angle results will - * not be garbage even when the rotation is particularly difficult to decompose with pitches around +/-90 degrees.) + * Calculates the Euler angles for the quaternion, in degrees. (The "safe" in the name signifies that the angle results + * will not be garbage even when the rotation is particularly difficult to decompose with pitches around +/-90 degrees.) * @function Quat(0).safeEulerAngles * @param {Quat} orientation - A quaternion representing an orientation. * @returns {Vec3} A {@link Vec3} of Euler angles for the orientation, in degrees, the angles being the @@ -273,7 +275,7 @@ public slots: glm::vec3 safeEulerAngles(const glm::quat& orientation); /**jsdoc - * Generate a quaternion given an angle to rotate through and an axis to rotate about. + * Generates a quaternion given an angle to rotate through and an axis to rotate about. * @function Quat(0).angleAxis * @param {number} angle - The angle to rotate through, in degrees. * @param {Vec3} axis - The unit axis to rotate about. @@ -286,7 +288,7 @@ public slots: glm::quat angleAxis(float angle, const glm::vec3& v); /**jsdoc - * Get the rotation axis for a quaternion. + * Gets the rotation axis for a quaternion. * @function Quat(0).axis * @param {Quat} q - The quaternion. * @returns {Vec3} The normalized rotation axis for q. @@ -300,7 +302,7 @@ public slots: glm::vec3 axis(const glm::quat& orientation); /**jsdoc - * Get the rotation angle for a quaternion. + * Gets the rotation angle for a quaternion. * @function Quat(0).angle * @param {Quat} q - The quaternion. * @returns {number} The rotation angle for q, in radians. WARNING: This value is in radians @@ -316,7 +318,7 @@ public slots: // spherical linear interpolation // alpha: 0.0 to 1.0? /**jsdoc - * Compute a spherical linear interpolation between two rotations, safely handling two rotations that are very similar. + * Computes a spherical linear interpolation between two rotations, safely handling two rotations that are very similar. * See also, {@link Quat(0).slerp|Quat.slerp}. * @function Quat(0).mix * @param {Quat} q1 - The beginning rotation. @@ -336,7 +338,7 @@ public slots: glm::quat mix(const glm::quat& q1, const glm::quat& q2, float alpha); /**jsdoc - * Compute a spherical linear interpolation between two rotations, for rotations that are not very similar. + * Computes a spherical linear interpolation between two rotations, for rotations that are not very similar. * See also, {@link Quat(0).mix|Quat.mix}. * @function Quat(0).slerp * @param {Quat} q1 - The beginning rotation. @@ -349,7 +351,7 @@ public slots: glm::quat slerp(const glm::quat& q1, const glm::quat& q2, float alpha); /**jsdoc - * Compute a spherical quadrangle interpolation between two rotations along a path oriented toward two other rotations. + * Computes a spherical quadrangle interpolation between two rotations along a path oriented toward two other rotations. * Equivalent to: Quat.slerp(Quat.slerp(q1, q2, alpha), Quat.slerp(s1, s2, alpha), 2 * alpha * (1.0 - alpha)). * @function Quat(0).squad * @param {Quat} q1 - Initial rotation. @@ -364,8 +366,8 @@ public slots: glm::quat squad(const glm::quat& q1, const glm::quat& q2, const glm::quat& s1, const glm::quat& s2, float h); /**jsdoc - * Calculate the dot product of two quaternions. The closer the quaternions are to each other the more non-zero the value is - * (either positive or negative). Identical unit rotations have a dot product of +/- 1. + * Calculates the dot product of two quaternions. The closer the quaternions are to each other the more non-zero the value + * is (either positive or negative). Identical unit rotations have a dot product of +/-1. * @function Quat(0).dot * @param {Quat} q1 - The first quaternion. * @param {Quat} q2 - The second quaternion. @@ -385,7 +387,7 @@ public slots: float dot(const glm::quat& q1, const glm::quat& q2); /**jsdoc - * Print to the program log a text label followed by a quaternion's pitch, yaw, and roll Euler angles. + * Prints to the program log a text label followed by a quaternion's pitch, yaw, and roll Euler angles. * @function Quat(0).print * @param {string} label - The label to print. * @param {Quat} q - The quaternion to print. @@ -403,7 +405,7 @@ public slots: void print(const QString& label, const glm::quat& q, bool asDegrees = false); /**jsdoc - * Test whether two quaternions are equal. Note: The quaternions must be exactly equal in order for + * Tests whether two quaternions are equal. Note: The quaternions must be exactly equal in order for * true to be returned; it is often better to use {@link Quat(0).dot|Quat.dot} and test for closeness to +/-1. * @function Quat(0).equal * @param {Quat} q1 - The first quaternion. diff --git a/libraries/script-engine/src/SceneScriptingInterface.h b/libraries/script-engine/src/SceneScriptingInterface.h index a78fa44641..fa67666676 100644 --- a/libraries/script-engine/src/SceneScriptingInterface.h +++ b/libraries/script-engine/src/SceneScriptingInterface.h @@ -21,10 +21,11 @@ namespace SceneScripting { /**jsdoc - * @typedef {object} Scene.Stage.Location - * @property {number} longitude - * @property {number} latitude - * @property {number} altitude + * Stage location. + * @typedef {object} Stage.Location + * @property {number} longitude - Longitude. + * @property {number} latitude - Latitude. + * @property {number} altitude - Altitude. */ class Location : public QObject { Q_OBJECT @@ -49,9 +50,10 @@ namespace SceneScripting { using LocationPointer = std::unique_ptr; /**jsdoc - * @typedef {object} Scene.Stage.Time - * @property {number} hour - * @property {number} day + * Stage time. + * @typedef {object} Stage.Time + * @property {number} hour - Hour. + * @property {number} day - Day. */ class Time : public QObject { Q_OBJECT @@ -73,11 +75,12 @@ namespace SceneScripting { using TimePointer = std::unique_ptr