first cut at support for extra element data

assignment-client/src/octree/OctreeQueryNode.cpp

@@ -346,9 +346,10 @@ void OctreeQueryNode::dumpOutOfView() {
     int outOfView = 0;
     OctreeElementBag tempBag;
     while (!elementBag.isEmpty()) {
-        OctreeElement* node = elementBag.extract();
+        void* extraData;
+        OctreeElement* node = elementBag.extract(extraData);
         if (node->isInView(_currentViewFrustum)) {
-            tempBag.insert(node);
+            tempBag.insert(node, extraData);
             stillInView++;
         } else {
             outOfView++;
@@ -356,9 +357,10 @@ void OctreeQueryNode::dumpOutOfView() {
     }
     if (stillInView > 0) {
         while (!tempBag.isEmpty()) {
-            OctreeElement* node = tempBag.extract();
+            void* extraData;
+            OctreeElement* node = tempBag.extract(extraData);
             if (node->isInView(_currentViewFrustum)) {
-                elementBag.insert(node);
+                elementBag.insert(node, extraData);
             }
         }
     }

assignment-client/src/octree/OctreeSendThread.cpp

@@ -392,10 +392,10 @@ int OctreeSendThread::packetDistributor(OctreeQueryNode* nodeData, bool viewFrus
         bool dontRestartSceneOnMove = false; // this is experimental
         if (dontRestartSceneOnMove) {
             if (nodeData->elementBag.isEmpty()) {
-                nodeData->elementBag.insert(_myServer->getOctree()->getRoot()); // only in case of empty
+                nodeData->elementBag.insert(_myServer->getOctree()->getRoot(), NULL); // only in case of empty
             }
         } else {
-            nodeData->elementBag.insert(_myServer->getOctree()->getRoot()); // original behavior, reset on move or empty
+            nodeData->elementBag.insert(_myServer->getOctree()->getRoot(), NULL); // original behavior, reset on move or empty
         }
     }
 
@@ -423,7 +423,8 @@ int OctreeSendThread::packetDistributor(OctreeQueryNode* nodeData, bool viewFrus
 
             bool lastNodeDidntFit = false; // assume each node fits
             if (!nodeData->elementBag.isEmpty()) {
-                OctreeElement* subTree = nodeData->elementBag.extract();
+                void* subTreeExtraData;
+                OctreeElement* subTree = nodeData->elementBag.extract(subTreeExtraData);
                 
                 /* TODO: Looking for a way to prevent locking and encoding a tree that is not
                 // going to result in any packets being sent...
@@ -472,7 +473,7 @@ int OctreeSendThread::packetDistributor(OctreeQueryNode* nodeData, bool viewFrus
                 lockWaitElapsedUsec = (float)(lockWaitEnd - lockWaitStart);
 
                 quint64 encodeStart = usecTimestampNow();
-                bytesWritten = _myServer->getOctree()->encodeTreeBitstream(subTree, &_packetData, nodeData->elementBag, params);
+                bytesWritten = _myServer->getOctree()->encodeTreeBitstream(subTree, subTreeExtraData, &_packetData, nodeData->elementBag, params);
                 quint64 encodeEnd = usecTimestampNow();
                 encodeElapsedUsec = (float)(encodeEnd - encodeStart);
                 

libraries/octree/src/Octree.cpp

@@ -896,7 +896,7 @@ OctreeElement* Octree::getElementEnclosingPoint(const glm::vec3& point, Octree::
 
 
 
-int Octree::encodeTreeBitstream(OctreeElement* element,
+int Octree::encodeTreeBitstream(OctreeElement* element, void* elementExtraData,
                         OctreePacketData* packetData, OctreeElementBag& bag,
                         EncodeBitstreamParams& params) {
 
@@ -936,7 +936,9 @@ int Octree::encodeTreeBitstream(OctreeElement* element,
 
     // If the octalcode couldn't fit, then we can return, because no nodes below us will fit...
     if (!roomForOctalCode) {
-        bag.insert(element); // add the element back to the bag so it will eventually get included
+        // add the element back to the bag so it will eventually get included, passing NULL for extraData means entire element
+        // needs to be encoded
+        bag.insert(element, NULL);
         params.stopReason = EncodeBitstreamParams::DIDNT_FIT;
         return bytesWritten;
     }
@@ -953,7 +955,7 @@ int Octree::encodeTreeBitstream(OctreeElement* element,
 
     ViewFrustum::location parentLocationThisView = ViewFrustum::INTERSECT; // assume parent is in view, but not fully
 
-    int childBytesWritten = encodeTreeBitstreamRecursion(element, packetData, bag, params,
+    int childBytesWritten = encodeTreeBitstreamRecursion(element, elementExtraData, packetData, bag, params,
                                                             currentEncodeLevel, parentLocationThisView);
 
     // if childBytesWritten == 1 then something went wrong... that's not possible
@@ -984,7 +986,7 @@ int Octree::encodeTreeBitstream(OctreeElement* element,
     return bytesWritten;
 }
 
-int Octree::encodeTreeBitstreamRecursion(OctreeElement* element,
+int Octree::encodeTreeBitstreamRecursion(OctreeElement* element, void* elementExtraData,
                                             OctreePacketData* packetData, OctreeElementBag& bag,
                                             EncodeBitstreamParams& params, int& currentEncodeLevel,
                                             const ViewFrustum::location& parentLocationThisView) const {
@@ -1447,7 +1449,7 @@ int Octree::encodeTreeBitstreamRecursion(OctreeElement* element,
                 // called databits), then we wouldn't send the children. So those types of Octree's should tell us to keep
                 // recursing, by returning TRUE in recurseChildrenWithData().
                 if (recurseChildrenWithData() || !params.viewFrustum || !oneAtBit(childrenColoredBits, originalIndex)) {
-                    childTreeBytesOut = encodeTreeBitstreamRecursion(childElement, packetData, bag, params, 
+                    childTreeBytesOut = encodeTreeBitstreamRecursion(childElement, NULL, packetData, bag, params,
                                                                             thisLevel, nodeLocationThisView);
                 }
 
@@ -1555,8 +1557,11 @@ int Octree::encodeTreeBitstreamRecursion(OctreeElement* element,
         packetData->discardLevel(thisLevelKey);
     }
 
+    // This happens if the element could not be written at all. In the case of Octree's that support partial
+    // element data, continueThisLevel will be true. So this only happens if the full element needs to be
+    // added back to the element bag.
     if (!continueThisLevel) {
-        bag.insert(element);
+        bag.insert(element, NULL); // We only got here if none of the element could fit.
 
         // don't need to check element here, because we can't get here with no element
         if (params.stats) {
@@ -1652,9 +1657,9 @@ void Octree::writeToSVOFile(const char* fileName, OctreeElement* element) {
         OctreeElementBag elementBag;
         // If we were given a specific element, start from there, otherwise start from root
         if (element) {
-            elementBag.insert(element);
+            elementBag.insert(element, NULL); // NOTE: NULL for extraData means encode the entire element
         } else {
-            elementBag.insert(_rootElement);
+            elementBag.insert(_rootElement, NULL); // NOTE: NULL for extraData means encode the entire element
         }
 
         OctreePacketData packetData;
@@ -1662,10 +1667,11 @@ void Octree::writeToSVOFile(const char* fileName, OctreeElement* element) {
         bool lastPacketWritten = false;
 
         while (!elementBag.isEmpty()) {
-            OctreeElement* subTree = elementBag.extract();
+            void* elementExtraData;
+            OctreeElement* subTree = elementBag.extract(elementExtraData);
             lockForRead(); // do tree locking down here so that we have shorter slices and less thread contention
             EncodeBitstreamParams params(INT_MAX, IGNORE_VIEW_FRUSTUM, WANT_COLOR, NO_EXISTS_BITS);
-            bytesWritten = encodeTreeBitstream(subTree, &packetData, elementBag, params);
+            bytesWritten = encodeTreeBitstream(subTree, elementExtraData, &packetData, elementBag, params);
             unlock();
 
             // if the subTree couldn't fit, and so we should reset the packet and reinsert the element in our bag and try again
@@ -1675,7 +1681,7 @@ void Octree::writeToSVOFile(const char* fileName, OctreeElement* element) {
                     lastPacketWritten = true;
                 }
                 packetData.reset(); // is there a better way to do this? could we fit more?
-                elementBag.insert(subTree);
+                elementBag.insert(subTree, NULL);  // NOTE: NULL for extraData means encode the entire element
             } else {
                 lastPacketWritten = false;
             }
@@ -1701,7 +1707,7 @@ bool Octree::countOctreeElementsOperation(OctreeElement* element, void* extraDat
 
 void Octree::copySubTreeIntoNewTree(OctreeElement* startElement, Octree* destinationTree, bool rebaseToRoot) {
     OctreeElementBag elementBag;
-    elementBag.insert(startElement);
+    elementBag.insert(startElement, NULL); // NOTE: NULL for extraData means encode the entire element
     int chopLevels = 0;
     if (rebaseToRoot) {
         chopLevels = numberOfThreeBitSectionsInCode(startElement->getOctalCode());
@@ -1710,11 +1716,12 @@ void Octree::copySubTreeIntoNewTree(OctreeElement* startElement, Octree* destina
     static OctreePacketData packetData;
 
     while (!elementBag.isEmpty()) {
-        OctreeElement* subTree = elementBag.extract();
+        void* elementExtraData;
+        OctreeElement* subTree = elementBag.extract(elementExtraData);
         packetData.reset(); // reset the packet between usage
         // ask our tree to write a bitsteam
         EncodeBitstreamParams params(INT_MAX, IGNORE_VIEW_FRUSTUM, WANT_COLOR, NO_EXISTS_BITS, chopLevels);
-        encodeTreeBitstream(subTree, &packetData, elementBag, params);
+        encodeTreeBitstream(subTree, elementExtraData, &packetData, elementBag, params);
         // ask destination tree to read the bitstream
         ReadBitstreamToTreeParams args(WANT_COLOR, NO_EXISTS_BITS);
         destinationTree->readBitstreamToTree(packetData.getUncompressedData(), packetData.getUncompressedSize(), args);
@@ -1724,18 +1731,19 @@ void Octree::copySubTreeIntoNewTree(OctreeElement* startElement, Octree* destina
 void Octree::copyFromTreeIntoSubTree(Octree* sourceTree, OctreeElement* destinationElement) {
     OctreeElementBag elementBag;
     // If we were given a specific element, start from there, otherwise start from root
-    elementBag.insert(sourceTree->_rootElement);
+    elementBag.insert(sourceTree->_rootElement, NULL);  // NOTE: NULL for extraData means encode the entire element
 
     static OctreePacketData packetData;
 
     while (!elementBag.isEmpty()) {
-        OctreeElement* subTree = elementBag.extract();
+        void* elementExtraData;
+        OctreeElement* subTree = elementBag.extract(elementExtraData);
 
         packetData.reset(); // reset between usage
 
         // ask our tree to write a bitsteam
         EncodeBitstreamParams params(INT_MAX, IGNORE_VIEW_FRUSTUM, WANT_COLOR, NO_EXISTS_BITS);
-        sourceTree->encodeTreeBitstream(subTree, &packetData, elementBag, params);
+        sourceTree->encodeTreeBitstream(subTree, elementExtraData, &packetData, elementBag, params);
 
         // ask destination tree to read the bitstream
         bool wantImportProgress = true;

libraries/octree/src/Octree.h

@@ -246,7 +246,8 @@ public:
 
     void recurseTreeWithOperator(RecurseOctreeOperator* operatorObject);
 
-    int encodeTreeBitstream(OctreeElement* element, OctreePacketData* packetData, OctreeElementBag& bag,
+    int encodeTreeBitstream(OctreeElement* element, void* elementExtraData, 
+                            OctreePacketData* packetData, OctreeElementBag& bag,
                             EncodeBitstreamParams& params) ;
 
     bool isDirty() const { return _isDirty; }
@@ -326,7 +327,7 @@ public slots:
 protected:
     void deleteOctalCodeFromTreeRecursion(OctreeElement* element, void* extraData);
 
-    int encodeTreeBitstreamRecursion(OctreeElement* element,
+    int encodeTreeBitstreamRecursion(OctreeElement* element, void* elementExtraData,
                                      OctreePacketData* packetData, OctreeElementBag& bag,
                                      EncodeBitstreamParams& params, int& currentEncodeLevel,
                                      const ViewFrustum::location& parentLocationThisView) const;

libraries/octree/src/OctreeElementBag.cpp

@@ -41,11 +41,14 @@ void OctreeElementBag::deleteAll() {
 }
 
 
-void OctreeElementBag::insert(OctreeElement* element) {
+void OctreeElementBag::insert(OctreeElement* element, void* extraData) {
     _bagElements.insert(element);
+    
+    // TODO store the extra data too...
+    //_elementsExtraData[element] = extraData;
 }
 
-OctreeElement* OctreeElementBag::extract() {
+OctreeElement* OctreeElementBag::extract(void*& extraData) {
     OctreeElement* result = NULL;
 
     if (_bagElements.size() > 0) {
@@ -53,6 +56,12 @@ OctreeElement* OctreeElementBag::extract() {
         result = *front;
         _bagElements.erase(front);
     }
+    
+    if (result) {
+        // TODO retrieve the extra data too...
+        //extraData = _elementsExtraData[result];
+        //_elementsExtraData.clear(result);
+    }
     return result;
 }
 

libraries/octree/src/OctreeElementBag.h

@@ -24,8 +24,8 @@ public:
     OctreeElementBag();
     ~OctreeElementBag();
     
-    void insert(OctreeElement* element); // put a element into the bag
+    void insert(OctreeElement* element, void* extraData); // put a element into the bag
-    OctreeElement* extract(); // pull a element out of the bag (could come in any order)
+    OctreeElement* extract(void*& extraData); // pull a element out of the bag (could come in any order)
     bool contains(OctreeElement* element); // is this element in the bag?
     void remove(OctreeElement* element); // remove a specific element from the bag