add JSON filter to OctreeQuery

libraries/networking/src/udt/PacketHeaders.cpp

@@ -49,6 +49,8 @@ PacketVersion versionForPacketType(PacketType packetType) {
         case PacketType::EntityEdit:
         case PacketType::EntityData:
             return VERSION_ENTITIES_SERVER_SCRIPTS;
+        case PacketType::EntityQuery:
+            return VERSION_ENTITIES_JSON_FILTER;
         case PacketType::AvatarIdentity:
         case PacketType::AvatarData:
         case PacketType::BulkAvatarData:

libraries/networking/src/udt/PacketHeaders.h

@@ -199,6 +199,7 @@ const PacketVersion VERSION_WEB_ENTITIES_SUPPORT_DPI = 63;
 const PacketVersion VERSION_ENTITIES_ARROW_ACTION = 64;
 const PacketVersion VERSION_ENTITIES_LAST_EDITED_BY = 65;
 const PacketVersion VERSION_ENTITIES_SERVER_SCRIPTS = 66;
+const PacketVersion VERSION_ENTITIES_JSON_FILTER = 67;
 
 enum class AssetServerPacketVersion: PacketVersion {
     VegasCongestionControl = 19

libraries/octree/src/OctreeQuery.cpp

@@ -9,6 +9,8 @@
 //  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
 //
 
+#include <QtCore/QJsonDocument>
+
 #include <GLMHelpers.h>
 #include <udt/PacketHeaders.h>
 
@@ -23,35 +25,27 @@ OctreeQuery::OctreeQuery() {
 int OctreeQuery::getBroadcastData(unsigned char* destinationBuffer) {
     unsigned char* bufferStart = destinationBuffer;
     
-    // TODO: DRY this up to a shared method
+    // back a boolean (cut to 1 byte) to designate if this query uses the sent view frustum
-    // that can pack any type given the number of bytes
+    memcpy(destinationBuffer, &_usesFrustum, sizeof(_usesFrustum));
-    // and return the number of bytes to push the pointer
+    destinationBuffer += sizeof(_usesFrustum);
+    
+    if (_usesFrustum) {
+        // TODO: DRY this up to a shared method
+        // that can pack any type given the number of bytes
+        // and return the number of bytes to push the pointer
+        
+        // camera details
+        memcpy(destinationBuffer, &_cameraPosition, sizeof(_cameraPosition));
+        destinationBuffer += sizeof(_cameraPosition);
+        destinationBuffer += packOrientationQuatToBytes(destinationBuffer, _cameraOrientation);
+        destinationBuffer += packFloatAngleToTwoByte(destinationBuffer, _cameraFov);
+        destinationBuffer += packFloatRatioToTwoByte(destinationBuffer, _cameraAspectRatio);
+        destinationBuffer += packClipValueToTwoByte(destinationBuffer, _cameraNearClip);
+        destinationBuffer += packClipValueToTwoByte(destinationBuffer, _cameraFarClip);
+        memcpy(destinationBuffer, &_cameraEyeOffsetPosition, sizeof(_cameraEyeOffsetPosition));
+        destinationBuffer += sizeof(_cameraEyeOffsetPosition);
+    }
     
-    // camera details
-    memcpy(destinationBuffer, &_cameraPosition, sizeof(_cameraPosition));
-    destinationBuffer += sizeof(_cameraPosition);
-    destinationBuffer += packOrientationQuatToBytes(destinationBuffer, _cameraOrientation);
-    destinationBuffer += packFloatAngleToTwoByte(destinationBuffer, _cameraFov);
-    destinationBuffer += packFloatRatioToTwoByte(destinationBuffer, _cameraAspectRatio);
-    destinationBuffer += packClipValueToTwoByte(destinationBuffer, _cameraNearClip);
-    destinationBuffer += packClipValueToTwoByte(destinationBuffer, _cameraFarClip);
-    memcpy(destinationBuffer, &_cameraEyeOffsetPosition, sizeof(_cameraEyeOffsetPosition));
-    destinationBuffer += sizeof(_cameraEyeOffsetPosition);
-
-    // bitMask of less than byte wide items
-    unsigned char bitItems = 0;
-
-    // NOTE: we need to keep these here for new clients to talk to old servers. After we know that the clients and
-    // servers and clients have all been updated we could remove these bits. New servers will always force these
-    // features on old clients even if they don't ask for them. (which old clients will properly handle). New clients
-    // will always ask for these so that old servers will use these features.
-    setAtBit(bitItems, WANT_LOW_RES_MOVING_BIT);
-    setAtBit(bitItems, WANT_COLOR_AT_BIT);
-    setAtBit(bitItems, WANT_DELTA_AT_BIT);
-    setAtBit(bitItems, WANT_COMPRESSION);
-
-    *destinationBuffer++ = bitItems;
-
     // desired Max Octree PPS
     memcpy(destinationBuffer, &_maxQueryPPS, sizeof(_maxQueryPPS));
     destinationBuffer += sizeof(_maxQueryPPS);
@@ -67,6 +61,25 @@ int OctreeQuery::getBroadcastData(unsigned char* destinationBuffer) {
     memcpy(destinationBuffer, &_cameraCenterRadius, sizeof(_cameraCenterRadius));
     destinationBuffer += sizeof(_cameraCenterRadius);
     
+    // create a QByteArray that holds the binary representation of the JSON parameters
+    QByteArray binaryParametersDocument;
+    
+    if (!_jsonParameters.isEmpty()) {
+        binaryParametersDocument = QJsonDocument(_jsonParameters).toBinaryData();
+    }
+    
+    // write the size of the JSON parameters
+    uint16_t binaryParametersBytes = binaryParametersDocument.size();
+    memcpy(destinationBuffer, &binaryParametersBytes, sizeof(binaryParametersBytes));
+    destinationBuffer += sizeof(binaryParametersBytes);
+    
+    // pack the binary JSON parameters
+    // NOTE: for now we assume that the filters that will be set are all small enough that we will not have a packet > MTU
+    if (binaryParametersDocument.size() > 0) {
+        memcpy(destinationBuffer, binaryParametersDocument.data(), binaryParametersBytes);
+        destinationBuffer += binaryParametersBytes;
+    }
+    
     return destinationBuffer - bufferStart;
 }
 
@@ -76,24 +89,22 @@ int OctreeQuery::parseData(ReceivedMessage& message) {
     const unsigned char* startPosition = reinterpret_cast<const unsigned char*>(message.getRawMessage());
     const unsigned char* sourceBuffer = startPosition;
     
-    // camera details
+    // check if this query uses a view frustum
-    memcpy(&_cameraPosition, sourceBuffer, sizeof(_cameraPosition));
+    memcpy(&_usesFrustum, sourceBuffer, sizeof(_usesFrustum));
-    sourceBuffer += sizeof(_cameraPosition);
+    sourceBuffer += _usesFrustum;
-    sourceBuffer += unpackOrientationQuatFromBytes(sourceBuffer, _cameraOrientation);
+    
-    sourceBuffer += unpackFloatAngleFromTwoByte((uint16_t*) sourceBuffer, &_cameraFov);
+    if (_usesFrustum) {
-    sourceBuffer += unpackFloatRatioFromTwoByte(sourceBuffer,_cameraAspectRatio);
+        // unpack camera details
-    sourceBuffer += unpackClipValueFromTwoByte(sourceBuffer,_cameraNearClip);
+        memcpy(&_cameraPosition, sourceBuffer, sizeof(_cameraPosition));
-    sourceBuffer += unpackClipValueFromTwoByte(sourceBuffer,_cameraFarClip);
+        sourceBuffer += sizeof(_cameraPosition);
-    memcpy(&_cameraEyeOffsetPosition, sourceBuffer, sizeof(_cameraEyeOffsetPosition));
+        sourceBuffer += unpackOrientationQuatFromBytes(sourceBuffer, _cameraOrientation);
-    sourceBuffer += sizeof(_cameraEyeOffsetPosition);
+        sourceBuffer += unpackFloatAngleFromTwoByte((uint16_t*) sourceBuffer, &_cameraFov);
-
+        sourceBuffer += unpackFloatRatioFromTwoByte(sourceBuffer,_cameraAspectRatio);
-    // optional feature flags
+        sourceBuffer += unpackClipValueFromTwoByte(sourceBuffer,_cameraNearClip);
-    unsigned char bitItems = 0;
+        sourceBuffer += unpackClipValueFromTwoByte(sourceBuffer,_cameraFarClip);
-    bitItems = (unsigned char)*sourceBuffer++;
+        memcpy(&_cameraEyeOffsetPosition, sourceBuffer, sizeof(_cameraEyeOffsetPosition));
-
+        sourceBuffer += sizeof(_cameraEyeOffsetPosition);
-    // NOTE: we used to use these bits to set feature request items if we need to extend the protocol with optional features
+    }
-    // do it here with... wantFeature= oneAtBit(bitItems, WANT_FEATURE_BIT);
-    Q_UNUSED(bitItems);
 
     // desired Max Octree PPS
     memcpy(&_maxQueryPPS, sourceBuffer, sizeof(_maxQueryPPS));
@@ -106,13 +117,25 @@ int OctreeQuery::parseData(ReceivedMessage& message) {
     // desired boundaryLevelAdjust
     memcpy(&_boundaryLevelAdjust, sourceBuffer, sizeof(_boundaryLevelAdjust));
     sourceBuffer += sizeof(_boundaryLevelAdjust);
-
+    
-    auto bytesRead = sourceBuffer - startPosition;
+    memcpy(&_cameraCenterRadius, sourceBuffer, sizeof(_cameraCenterRadius));
-    auto bytesLeft = message.getSize() - bytesRead;
+    sourceBuffer += sizeof(_cameraCenterRadius);
-    if (bytesLeft >= (int)sizeof(_cameraCenterRadius)) {
+    
-        memcpy(&_cameraCenterRadius, sourceBuffer, sizeof(_cameraCenterRadius));
+    // check if we have a packed JSON filter
-        sourceBuffer += sizeof(_cameraCenterRadius);
+    uint16_t binaryParametersBytes;
+    memcpy(&binaryParametersBytes, sourceBuffer, sizeof(binaryParametersBytes));
+    sourceBuffer += sizeof(binaryParametersBytes);
+    
+    if (binaryParametersBytes > 0) {
+        // unpack the binary JSON parameters
+        QByteArray binaryJSONParameters { binaryParametersBytes, 0 };
+        memcpy(binaryJSONParameters.data(), sourceBuffer, binaryParametersBytes);
+        sourceBuffer += binaryParametersBytes;
+        
+        // grab the parameter object from the packed binary representation of JSON
+        _jsonParameters = QJsonDocument::fromBinaryData(binaryJSONParameters).object();
     }
+    
     return sourceBuffer - startPosition;
 }
 

libraries/octree/src/OctreeQuery.h

@@ -31,14 +31,10 @@ typedef unsigned long long quint64;
 #include <glm/glm.hpp>
 #include <glm/gtc/quaternion.hpp>
 
+#include <QtCore/QJsonObject>
+
 #include <NodeData.h>
 
-// First bitset
-const int WANT_LOW_RES_MOVING_BIT = 0;
-const int WANT_COLOR_AT_BIT = 1;
-const int WANT_DELTA_AT_BIT = 2;
-const int UNUSED_BIT_3 = 3; // unused... available for new feature
-const int WANT_COMPRESSION = 4; // 5th bit
 
 class OctreeQuery : public NodeData {
     Q_OBJECT
@@ -71,11 +67,18 @@ public:
     void setCameraFarClip(float farClip) { _cameraFarClip = farClip; }
     void setCameraEyeOffsetPosition(const glm::vec3& eyeOffsetPosition) { _cameraEyeOffsetPosition = eyeOffsetPosition; }
     void setCameraCenterRadius(float radius) { _cameraCenterRadius = radius; }
-
+    
+    // getters/setters for JSON filter
+    QJsonObject getJSONParameters() { return _jsonParameters; }
+    void setJSONParameters(const QJsonObject& jsonParameters) { _jsonParameters = jsonParameters; }
+    
     // related to Octree Sending strategies
     int getMaxQueryPacketsPerSecond() const { return _maxQueryPPS; }
     float getOctreeSizeScale() const { return _octreeElementSizeScale; }
     int getBoundaryLevelAdjust() const { return _boundaryLevelAdjust; }
+    
+    bool getUsesFrustum() { return _usesFrustum; }
+    void setUsesFrustum(bool usesFrustum) { _usesFrustum = usesFrustum; }
 
 public slots:
     void setMaxQueryPacketsPerSecond(int maxQueryPPS) { _maxQueryPPS = maxQueryPPS; }
@@ -97,7 +100,11 @@ protected:
     int _maxQueryPPS = DEFAULT_MAX_OCTREE_PPS;
     float _octreeElementSizeScale = DEFAULT_OCTREE_SIZE_SCALE; /// used for LOD calculations
     int _boundaryLevelAdjust = 0; /// used for LOD calculations
-
+    
+    uint8_t _usesFrustum = true;
+    
+    QJsonObject _jsonParameters;
+    
 private:
     // privatize the copy constructor and assignment operator so they cannot be called
     OctreeQuery(const OctreeQuery&);