C#開發BIMFACE系列27 服務端API之獲取模型資料12：獲取構件分類樹

阿新 • • 發佈：2019-09-11

系列目錄【已更新最新開發文章，點選檢視詳細】

BIMFACE官方示例中，載入三維模型後，模型瀏覽器中左上角預設提供了“目錄樹”的功能，清晰地展示了模型的完整構成及上下級關係。

本篇介紹如何獲取單個模型的構件分類樹資訊。

請求地址：POST https://api.bimface.com/data/v2/files/{fileId}/tree

說明：單模型構件分類樹, treeType 接受兩個值：default 和 customized，預設為 default。

v引數用來區別 treeType 為 default 時返回樹的格式， customized總是返回格式2.0的構件樹。

引數：

v引數用來區別 treeType 為 default 時返回樹的格式， customized總是返回格式2.0的構件樹。

當 treeType 為"customized"時，desiredHierarchy 表示了篩選樹的層次,可選值有building,systemType,specialty,floor,category,family,familyType，如:desiredHierarchy=specialty,systemtype。

customizedNodeKeys：用來指定篩選樹每個維度用id或者是name作為唯一標識, 如"floor":"id"。

請求2.0的預設分類樹（floor, category, family, familyType）

請求 path(示例)：https://api.bimface.com/data/v2/files/1211223382064960/tree?v=2.0

請求 header(示例)："Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"

請求 body(示例)：可以為空，不傳遞。

HTTP響應示例(200)：

{
    "code": "success",
    "message": null,
    "data": [
        {
            "actualName": "1F",
            "data": null,
            "elementCount": 18,
            "id": "694",
            "items": [
                {
                    "actualName": "欄杆扶手",
                    "data": null,
                    "elementCount": 18,
                    "id": "-2000126",
                    "items": [
                        {
                            "actualName": "欄杆扶手",
                            "data": null,
                            "elementCount": 18,
                            "id": "",
                            "items": [
                                {
                                    "actualName": "欄杆",
                                    "data": null,
                                    "elementCount": 1,
                                    "id": null,
                                    "items": [],
                                    "name": "欄杆",
                                    "type": "familyType"
                                }
                            ],
                            "name": "欄杆扶手",
                            "type": "family"
                        }
                    ],
                    "name": "欄杆扶手",
                    "type": "category"
                }
            ],
            "name": "1F",
            "type": "floor"
        }
    ]
}

返回的結果結構比較複雜，封裝成對應的C#類如下：

/// <summary>
///  獲取單個模型的構件分類樹(2.0的預設分類樹 floor, category, family, familyType)返回的結果類（預設模式）
/// </summary>
[Serializable]
public class SingleModelTree : GeneralResponse<List<TreeItem>> 
{

}

呼叫的 TreeItem 類

[Serializable]
public class TreeItem
{
    /// <summary>
    ///  項的名稱
    /// </summary>
    [JsonProperty("actualName")]
    public string ActualName { get; set; }

    [JsonProperty("data")]
    public string Data { get; set; }

    [JsonProperty("elementCount")]
    public int? ElementCount { get; set; }

    [JsonProperty("id")]
    public string Id { get; set; }

    [JsonProperty("items")]
    public TreeItem[] Items { get; set; }

    [JsonProperty("name")]
    public string Name { get; set; }

    /// <summary>
    ///  例如：familyType、family、category
    /// </summary>
    [JsonProperty("type")]
    public string Type { get; set; }

    /// <summary>返回表示當前物件的字串。</summary>
    /// <returns>表示當前物件的字串。</returns>
    public override string ToString()
    {
        return String.Format("[actualName={0}, data={1}, elementCount={2}, id={3}, items={4}, name={5}, type={6}]",
                             ActualName, Data, ElementCount, Id, Items.ToStringLine(), Name, Type);
    }
}

請注意 TreeItem 類中的 public TreeItem[] Items { get; set; } 屬性，型別是該類本身。屬於遞迴引用。

Newtonsoft.Json.dll 預設支援遞迴引用類的序列化與反序列化。

C#實現方法：

 1 /// <summary>
 2 ///  獲取單個模型中構件的預設分類樹
 3 /// </summary>
 4 /// <param name="accessToken">【必填】令牌</param>
 5 /// <param name="fileId">【必填】代表該單模型的檔案ID</param>
 6 /// <param name="v">【非必填】用來區別treeType為default時返回樹的格式</param>
 7 /// <param name="request">【非必填】其他過濾引數類物件</param>
 8 /// <returns></returns>
 9 public virtual SingleModelTree GetSingleModelTreeByDefault(string accessToken, long fileId, string v = "2.0", FileTreeRequestBody request = null)
10 {
11     //return GetSingleModelTree(accessToken, fileId, TreeType.Default, v, request);
12     /* 單模型構件分類樹,
13       （1）treeType 接受兩個值：default 和 customized，預設為 default。
14       （2）v 引數用來區別 treeType 為 default 時返回樹的格式, customized 總是返回格式2.0的構件樹。 
15       （3）當 treeType 為"customized"時，FileTreeRequestBody 類的 desiredHierarchy 屬性 表示了篩選樹的層次,可選值有building,systemType,specialty,floor,category,family,familyType，
16           如:desiredHierarchy=specialty,systemtype。
17             customizedNodeKeys: 用來指定篩選樹每個維度用id或者是name作為唯一標識, 如"floor":"id"
18     */
19 
20     // POST https://api.bimface.com/data/v2/files/{fileId}/tree
21     string url = string.Format(BimfaceConstants.API_HOST + "/data/v2/files/{0}/tree?treeType=default", fileId);
22 
23     if (!string.IsNullOrWhiteSpace(v))
24     {
25         url = url + "&v=" + v;
26     }
27 
28     string data = string.Empty;
29     if (request != null)
30     {
31         data = request.SerializeToJson();
32     }
33 
34     BimFaceHttpHeaders headers = new BimFaceHttpHeaders();
35     headers.AddOAuth2Header(accessToken);
36 
37     try
38     {
39         SingleModelTree response;
40 
41         HttpManager httpManager = new HttpManager(headers);
42         HttpResult httpResult = httpManager.Post(url, data);
43         if (httpResult.Status == HttpResult.STATUS_SUCCESS)
44         {
45             response = httpResult.Text.DeserializeJsonToObject<SingleModelTree>();
46         }
47         else
48         {
49             response = new SingleModelTree
50             {
51                 Message = httpResult.RefText
52             };
53         }
54 
55         return response;
56     }
57     catch (Exception ex)
58     {
59         throw new Exception("[獲取單個模型中構件的預設分類樹]發生異常！", ex);
60     }
61 }

其中呼叫到的 httpManager.Post() 方法，請參考《C# HTTP系列》

測試：

在BIMFACE的控制檯中可以看到我們上傳的檔案列表，模型狀態均為轉換成功。

使用“A4.rvt”為例測試上述方法。

完整的分類樹為

success

[
  {
    "actualName": "標高 1",
    "data": null,
    "elementCount": 4,
    "id": "311",
    "items": [
      {
        "actualName": "牆",
        "data": null,
        "elementCount": 4,
        "id": "-2000011",
        "items": [
          {
            "actualName": "基本牆",
            "data": null,
            "elementCount": 4,
            "id": "",
            "items": [
              {
                "actualName": "常規 - 200mm",
                "data": null,
                "elementCount": 4,
                "id": "398",
                "items": [],
                "name": "常規 - 200mm",
                "type": "familyType"
              }
            ],
            "name": "基本牆",
            "type": "family"
          }
        ],
        "name": "牆",
        "type": "category"
      }
    ],
    "name": "標高 1",
    "type": "floor"
  }
]

測試程式碼如下：

// 獲取構件分類樹（預設）
protected void btnGetSingleModelTreeByDefault_Click(object sender, EventArgs e)
{
    long fileId = txtFileID.Text.Trim().ToLong();
    FileConvertApi api = new FileConvertApi();
    SingleModelTree response = api.GetSingleModelTreeByDefault(txtAccessToken.Text, fileId);

    txtResult.Text = response.Code.ToString2()
                   + Environment.NewLine
                   + response.Message.ToString2()
                   + Environment.NewLine
                   + response.Data.ToStringLine();
}

請求自定義樹（floor, category, family, familyType）

請求 path(示例)：https://api.bimface.com/data/v2/files/1211223382064960/tree?v=2.0&treeType=customized

請求 header(示例)："Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"

請求 body(示例)：

{
    "desiredHierarchy": [
        "category",
        "family"
    ],
    "customizedNodeKeys": {
        "category": "name"
    }
}

請求體不能為 NULL ，必須傳遞值。否則請求失敗，提示 system.error. customized tree request body is null

HTTP響應示例(200)：

{
    "code": "success",
    "message": null,
    "data": {
        "items": [
            {
                "actualName": "專用裝置",
                "data": null,
                "elementCount": 6,
                "id": "-2001350",
                "items": [
                    {
                        "actualName": "投影儀-基於天花板 3D",
                        "data": null,
                        "elementCount": 3,
                        "id": "",
                        "items": [

                        ],
                        "name": "投影儀-基於天花板 3D",
                        "type": "family"
                    },
                    {
                        "actualName": "投影螢幕-基於天花板 3D",
                        "data": null,
                        "elementCount": 3,
                        "id": "",
                        "items": [

                        ],
                        "name": "投影螢幕-基於天花板 3D",
                        "type": "family"
                    }
                ],
                "name": "衛浴裝置",
                "type": "category"
            }
        ],
        "root": "category"
    }
}

返回的結果結構比較複雜，封裝成對應的C#類如下：

/// <summary>
///  獲取單個模型的構件分類樹(自定義樹floor, category, family, familyType)返回的結果類
/// </summary>
[Serializable]
public class SingleModelTreeByCustomized : GeneralResponse<SingleModelTreeByCustomized>
{
    [JsonProperty("root")]
    public string Root { get; set; }

    [JsonProperty("items")]
    public TreeItem[] Items { get; set; }

    /// <summary>返回表示當前物件的字串。</summary>
    /// <returns>表示當前物件的字串。</returns>
    public override string ToString()
    {
        return String.Format("[root={0}, items={1}]",
                             Root, Items.ToStringLine());
    }
}

C#實現方法：

 1 /// <summary>
 2 ///  獲取單個模型中構件的自定義分類樹
 3 /// </summary>
 4 /// <param name="accessToken">【必填】令牌</param>
 5 /// <param name="fileId">【必填】代表該單模型的檔案ID</param>
 6 /// <param name="v">【非必填】用來區別treeType為default時返回樹的格式</param>
 7 /// <param name="request">【非必填】其他過濾引數類物件</param>
 8 /// <returns></returns>
 9 public virtual SingleModelTreeByCustomized GetSingleModelTreeByCustomized(string accessToken, long fileId, string v = "2.0", FileTreeRequestBody request = null)
10 {
11     //return GetSingleModelTree(accessToken, fileId, TreeType.Default, v, request);
12     /* 單模型構件分類樹,
13       （1）treeType 接受兩個值：default 和 customized，預設為 default。
14       （2）v 引數用來區別 treeType 為 default 時返回樹的格式, customized 總是返回格式2.0的構件樹。 
15       （3）當 treeType 為"customized"時，FileTreeRequestBody 類的 desiredHierarchy 屬性 表示了篩選樹的層次,可選值有building,systemType,specialty,floor,category,family,familyType，
16           如:desiredHierarchy=specialty,systemtype。
17             customizedNodeKeys: 用來指定篩選樹每個維度用id或者是name作為唯一標識, 如"floor":"id"
18     */
19 
20     // POST https://api.bimface.com/data/v2/files/{fileId}/tree
21     string url = string.Format(BimfaceConstants.API_HOST + "/data/v2/files/{0}/tree?treeType=customized", fileId);
22 
23     if (!string.IsNullOrWhiteSpace(v))
24     {
25         url = url + "&v=" + v;
26     }
27 
28     string data = string.Empty;
29     if (request != null)
30     {
31         data = request.SerializeToJson();
32     }
33 
34     BimFaceHttpHeaders headers = new BimFaceHttpHeaders();
35     headers.AddOAuth2Header(accessToken);
36 
37     try
38     {
39         SingleModelTreeByCustomized response;
40 
41         HttpManager httpManager = new HttpManager(headers);
42         HttpResult httpResult = httpManager.Post(url, data);
43         if (httpResult.Status == HttpResult.STATUS_SUCCESS)
44         {
45             response = httpResult.Text.DeserializeJsonToObject<SingleModelTreeByCustomized>();
46         }
47         else
48         {
49             response = new SingleModelTreeByCustomized
50             {
51                 Message = httpResult.RefText
52             };
53         }
54 
55         return response;
56     }
57     catch (Exception ex)
58     {
59         throw new Exception("[獲取單個模型中構件的自定義分類樹]發生異常！", ex);
60     }
61 }

測試：

同樣使用“A4.rvt”為例測試上述方法。

完整的分類樹為

success

[root=單體, 
 items=[actualName=, 
        data=, 
        elementCount=4, 
        id=0, 
        items=[actualName=, 
               data=, 
               elementCount=4, 
               id=0, 
               items=[actualName=, 
                     data=, 
                     elementCount=4, 
                     id=0, 
                     items=[actualName=標高 1, 
                            data=, 
                            elementCount=4, 
                            id=311, 
                            items=[actualName=牆, 
                                   data=, 
                                   elementCount=4, 
                                   id=-2000011, 
                                   items=[actualName=基本牆, 
                                          data=, 
                                          elementCount=4, 
                                          id=, 
                                          items=[actualName=常規 - 200mm, 
                                                 data=, 
                                                 elementCount=4, 
                                                 id=398, 
                                                 items=, 
                                                 name=常規 - 200mm, 
                                                 type=familyType
                                                ], 
                                          name=基本牆, 
                                          type=family
                                         ],
                                   name=牆, 
                                   type=category
                                  ],
                            name=標高 1, 
                            type=floor
                           ],
                     name=未設專業, 
                     type=specialty
                    ],
                name=未設系統型別, 
                type=systemType
               ],
        name=未設單體, 
        type=building
       ]
]

介面上的篩選樹的層次是過濾條件，主要用於篩選 type 屬性。

測試程式碼如下：

// 獲取構件分類樹（自定義）
protected void btnGetSingleModelTreeByCustomized_Click(object sender, EventArgs e)
{
    long fileId = txtFileID.Text.Trim().ToLong();

    List<string> lstDesiredHierarchy = new List<string>();
    if (chkTreeBuilding.Checked)
    {
        lstDesiredHierarchy.Add("building");
    }
    if (chkTreeSystemType.Checked)
    {
        lstDesiredHierarchy.Add("systemType");
    }
    if (chkTreeSpecialty.Checked)
    {
        lstDesiredHierarchy.Add("specialty");
    }
    if (chkTreeFloor.Checked)
    {
        lstDesiredHierarchy.Add("floor");
    }
    if (chkTreeCategory.Checked)
    {
        lstDesiredHierarchy.Add("category");
    }
    if (chkTreeFamily.Checked)
    {
        lstDesiredHierarchy.Add("family");
    }
    if (chkTreeFamilyType.Checked)
    {
        lstDesiredHierarchy.Add("familyType");
    }

    FileTreeRequestBody request = new FileTreeRequestBody();
    request.DesiredHierarchy = lstDesiredHierarchy.ToArray();// new[] { "building", "systemType", "specialty", "floor", "category", "family", "familyType" };
    request.CustomizedNodeKeys = new Dictionary<string, string> { { "category", "name" } };

    FileConvertApi api = new FileConvertApi();
    SingleModelTreeByCustomized response = api.GetSingleModelTreeByCustomized(txtAccessToken.Text, fileId, "2.0", request);

    txtResult.Text = response.Code.ToString2()
                   + Environment.NewLine
                   + response.Message.ToString2()
                   + Environment.NewLine
                   + response.Data;
}

系列目錄【已更新最新開發文章，點選檢視詳細】 &nbs

C#開發BIMFACE系列27 服務端API之獲取模型資料12：獲取構件分類樹

系列目錄【已更新最新開發文章，點選檢視詳細】 BIMFACE官方示例中，載入三維模型後，模型瀏覽器中左上角預設提供了“目錄樹”的功能，清晰地展示了模型的完整構成及上下級關係。本篇介紹如何獲取單個模型的構件分類樹資訊

C#開發BIMFACE系列6 服務端API之獲取檔案資訊

在《C#開發BIMFACE系列4 服務端API之源上傳檔案》、《C#開發BIMFACE系列5 服務端API之檔案直傳》兩篇文章中詳細介紹瞭如何將本地檔案上傳到BIMFACE伺服器及BIMFACE後臺的分散式儲存系統中。檔案上傳成功後，BIMFACE的服務會返回與該檔案相關的資訊，如下圖：開

C#開發BIMFACE系列14 服務端API之批量獲取轉換狀態詳情

系列目錄【已更新最新開發文章，點選檢視詳細】上一篇《C#開發BIMFACE系列13 服務端API之獲取轉換狀態》中介紹了根據檔案ID查詢單個檔案的轉換狀態。本文介紹批量獲取轉換狀態詳情。請求地址：POST https://api.b

C#開發BIMFACE系列17 服務端API之獲取模型資料2：獲取構件材質列表

系列目錄【已更新最新開發文章，點選檢視詳細】在上一篇《C#開發BIMFACE系列16 服務端API之獲取模型資料1：查詢滿足條件的構件ID列表》中介紹了獲取單檔案(模型)的所有構建ID列表。每個構建由多種材質組成，本文介紹獲取單個構建ID的材質列表。請

C#開發BIMFACE系列18 服務端API之獲取模型資料3：獲取構件屬性

系列目錄【已更新最新開發文章，點選檢視詳細】本篇主要介紹如何獲取單檔案/模型下單個構建的屬性資訊。請求地址：GET https://api.bimface.com/data/v2/files/{fileId}/elements/{elementId}

C#開發BIMFACE系列19 服務端API之獲取模型資料4：獲取多個構件的共同屬性

系列目錄【已更新最新開發文章，點選檢視詳細】在前幾篇部落格中介紹了一個三維檔案/模型包含多個構建，每個構建又是由多種材質組成，每個構建都有很多屬性。不同的構建也有可能包含相同的屬性。上圖中可以看到構建1與構建2擁有相同的屬性2，構建2與構建n擁有相

C#開發BIMFACE系列21 服務端API之獲取模型資料6：獲取單模型的樓層資訊

系列目錄【已更新最新開發文章，點選檢視詳細】一個檔案/模型中可能包含多個樓層資訊，獲取樓層資訊對於前端頁面的動態展示非常有幫助。本篇介紹獲取一個檔案/模型中可能包含多個樓層資訊的詳細方法。請求地址：GET https://api.bimface.com

C#開發BIMFACE系列24 服務端API之獲取模型資料9：獲取單個房間資訊

系列目錄【已更新最新開發文章，點選檢視詳細】大廈建築模型中，基本上包含多個樓層，每個樓層包含多個房間等資訊。在《C#開發BIMFACE系列21 服務端API之獲取模型資料6：獲取單模型的樓層資訊》中介紹瞭如何獲取一個模型中包含的樓層資訊、面積分區、房間等資

C#開發BIMFACE系列30 服務端API之模型對比1：發起模型對比

系列目錄【已更新最新開發文章，點選檢視詳細】　　在實際專案中，由於需求變更經常需要對模型檔案進行修改。為了便於使用者瞭解模型在修改前後發生的變化，BIMFACE提供了模型線上對比功能，可以利用線上的模型對比介面，通過簡單的四個步驟實現模型線上對比。模型對比可

C#開發BIMFACE系列36 服務端API之：回撥機制

系列目錄【已更新最新開發文章，點選檢視詳細】　　在《C# 開發 BIMFACE 系列文章》中介紹了模型轉換、模型對比介面。這2個功能介面比較特殊，發起請求後，邏輯處理是在BIMFACE雲端進行的，通常需要5~10分鐘。當邏輯處理完成後，BIMFACE通過回撥

C#開發BIMFACE系列12 服務端API之檔案轉換

系列目錄【已更新最新開發文章，點選檢視詳細】在代表模型的原始檔上傳到BIMFACE後，一般會進行三種API呼叫操作：發起模型轉換查詢轉換狀態如轉換成功，獲取模型轉換後的BIM資料在模型成功進行

C#開發BIMFACE系列39 網頁整合開發3：審圖系統中三維模型比對

系列目錄【已更新最新開發文章，點選檢視詳細】　　在建築施工圖審查系統中，設計單位提交設計完成的模型/圖紙，審查專家審查模型/圖紙。審查過程中如果發現不符合規範的地方，則流程退回到設計單位，設計單位人員根據審查意見重新調整設計，調整完成後再次提交到審查專家。此

C# 服務端篇之實現RestFul Service開發(簡單實用)

原文地址:http://www.cnblogs.com/xuliangxing/p/8735552.html 一、RestFul簡介　　REST（Representational State Transfer 通常被翻譯為“表述性狀態傳輸”或者“表述性狀態轉移”）是RoyFielding提

【HLSDK系列】服務端 UpdateClientData 函數

del 完全 dll viewmodel 代碼 lag ase mod water 首先說明下，這個函數是寫在 mp.dll 裏的。服務器會給每個客戶端發送一些數據，其中兩大數據種類就是 clientdata_t 和 entity_state_t 這裏要說的是 clien

【HLSDK系列】服務端 AddToFullPack 函數

客戶端 global 客戶 const start max pre 參數 glob 服務端會給客戶端發送一些數據，其中兩大種類數據是 clientdata_t 和 entity_state_t 這裏我們說說 entity_state_t 這個結構體。你在丟在地上的槍、C4

【HLSDK系列】服務端實體 edict_t 和控制類

武器 .cpp 成員常用 blog 生成指針但是 dll 我們來了解一下引擎是怎麽管理實體的吧！我們這裏就說說服務端的實體（edict_t）服務端用 edict_t 這個結構體來保存一個實體，可以說一個 edict_t 就是一個服務端實體，下文簡稱實體。我們在

api-gateway實踐（8）新服務網關 - 測試發布（服務端API）

isp logs rest span com 點擊功能 size json對象一、網關引擎網關引擎地址：http://10.110.20.191:8080/api-gateway-engine/ 二、服務提供者服務提供者地址：http://10.110.20.19

C# 開發ModBus Tcp的服務器程序實現ModBus Tcp數據總換

bus ont 區分發布命名空間 ppa 組件 pen 最大前言本文將使用一個Nuget公開的組件技術來實現一個ModBus TCP的服務器端數據引擎，方便的實現接收來自各種設備的數據。在visual studio 中的Nuget管理器中可以下載安裝，也可

C#編寫聊天軟件服務端

cte AD sel public 登錄客戶端發送消息監聽端口獲取 1 using System; 2 using System.Collections.Generic; 3 using System.Linq; 4 using System.Text

釘釘服務端api介面使用

第一步:註冊釘釘企業賬號開啟連結：https://oa.dingtalk.com/#/login，註冊賬號即可第二步：建立應用以建立e應用為例：還需要授權一個開發人員，並獲取CorpSecret，需要把corpId和CorpSecret作為引數請求api介面獲取

C#開發BIMFACE系列27 服務端API之獲取模型資料12：獲取構件分類樹

相關推薦