--Standardize HM3D object ID ( <name> _ <unique ID> ) (#1618)

Author: jturner65

src/esp/assets/GenericSemanticMeshData.cpp

@@ -158,7 +158,7 @@ GenericSemanticMeshData::buildSemanticMeshData(
             static_cast<scene::HM3DObjectInstance&>(*ssdObjs[i]);
         const Mn::Vector3ub ssdColor = ssdObj.getColor();
         const uint32_t colorInt = colorAsInt(ssdColor);
-        int semanticID = ssdObj.getSemanticID();
+        int semanticID = ssdObj.semanticID();
         int regionIDX =
             static_cast<scene::HM3DSemanticRegion&>(*ssdObj.region())
                 .getIndex();

src/esp/bindings/SceneBindings.cpp

@@ -172,6 +172,7 @@ void initSceneBindings(py::module& m) {
       .def_property_readonly("id", &SemanticObject::id,
                              "The ID of the object, of the form "
                              "``<level_id>_<region_id>_<object_id>``")
+      .def_property_readonly("semantic_id", &SemanticObject::semanticID)
       .def_property_readonly("region", &SemanticObject::region)
       .def_property_readonly("aabb", &SemanticObject::aabb)
       .def_property_readonly("obb", &SemanticObject::obb)

src/esp/scene/HM3DSemanticScene.cpp

@@ -43,16 +43,11 @@ namespace {
 
 struct TempHM3DObject {
   int objInstanceID;
+  int objCatID;
   std::string categoryName;
   std::string objInstanceName;
   Mn::Vector3ub color;
   std::shared_ptr<SemanticRegion> region;
-
-  void setObjInstanceAndName(int _objInstanceID) {
-    objInstanceID = _objInstanceID;
-    objInstanceName =
-        Cr::Utility::formatString("{}_{}", categoryName, objInstanceID);
-  }
 };
 
 struct TempHM3DRegion {
@@ -95,7 +90,7 @@ bool SemanticScene::buildHM3DHouse(std::ifstream& ifs,
     // Line :
     // Unique Instance ID (int), color (hex RGB), category name
     // (string), room/region ID (int)
-    // instance ID is first token
+    // unique instance ID is first token
     int instanceID = std::stoi(tokens[0]);
     // semantic color is 2nd token, as hex string
     auto colorVec = getVec3ub(tokens[1]);
@@ -107,7 +102,10 @@ bool SemanticScene::buildHM3DHouse(std::ifstream& ifs,
     // room/region
     int regionID = std::stoi(tokens[3]);
     // build initial temp object
-    TempHM3DObject obj{0, objCategoryName, "", colorVec};
+    TempHM3DObject obj{
+        instanceID, 0, objCategoryName,
+        Cr::Utility::formatString("{}_{}", objCategoryName, instanceID),
+        colorVec};
     objInstance[instanceID] = obj;
     // find category, build if dne
     TempHM3DCategory tmpCat{
@@ -126,7 +124,7 @@ bool SemanticScene::buildHM3DHouse(std::ifstream& ifs,
     std::vector<TempHM3DObject*>& objsWithCat = item.second.objInstances;
     int objCatIdx = 0;
     for (TempHM3DObject* objItem : objsWithCat) {
-      objItem->setObjInstanceAndName(objCatIdx++);
+      objItem->objCatID = objCatIdx++;
     }
     // build category item and place within temp map
     item.second.category_ = std::make_shared<HM3DObjectCategory>(
@@ -160,7 +158,7 @@ bool SemanticScene::buildHM3DHouse(std::ifstream& ifs,
   for (auto& item : objInstance) {
     TempHM3DObject obj = item.second;
     auto objPtr = std::make_shared<HM3DObjectInstance>(HM3DObjectInstance(
-        item.first, obj.objInstanceID, obj.objInstanceName, obj.color));
+        obj.objInstanceID, obj.objCatID, obj.objInstanceName, obj.color));
     objPtr->category_ = categories[obj.categoryName].category_;
     // set region
     objPtr->parentIndex_ = obj.region->index_;

src/esp/scene/HM3DSemanticScene.h

@@ -39,22 +39,20 @@ class HM3DSemanticRegion : public SemanticRegion {
 
 class HM3DObjectInstance : public SemanticObject {
  public:
-  HM3DObjectInstance(int id,
-                     int objInstanceId,
+  HM3DObjectInstance(int objInstanceID,
+                     int objCatID,
                      const std::string& name,
                      const Mn::Vector3ub& clr)
-      : id_(id), objInstanceId_(objInstanceId), name_(name), color_(clr) {}
+      : SemanticObject(), objCatID_(objCatID), name_(name), color_(clr) {
+    index_ = objInstanceID;
+  }
   Mn::Vector3ub getColor() const { return color_; }
 
   std::string id() const override { return name_; }
 
-  int getSemanticID() const { return id_; }
-
  protected:
-  // semantic ID of the object instance in the file
-  const int id_;
-  // instance ID of this particular instance within the category it belongs in
-  const int objInstanceId_;
+  // idx of this particular object instance within the category it belongs in
+  const int objCatID_;
   // unique name for this instance
   const std::string name_;
   // specified color for this object instance.

src/esp/scene/SemanticScene.h

@@ -335,6 +335,11 @@ class SemanticObject {
     }
   }
 
+  /**
+   * @brief Retrieve the unique semantic ID corresponding to this object
+   */
+  int semanticID() const { return index_; }
+
   SemanticRegion::ptr region() const { return region_; }
 
   box3f aabb() const { return obb_.toAABB(); }
@@ -344,7 +349,14 @@ class SemanticObject {
   SemanticCategory::ptr category() const { return category_; }
 
  protected:
+  /**
+   * @brief The unique semantic ID corresponding to this object
+   */
   int index_{};
+
+  /**
+   * @brief References the parent region for this object
+   */
   int parentIndex_{};
   std::shared_ptr<SemanticCategory> category_;
   geo::OBB obb_;