C#开发BIMFACE系列21 服务端API之获取模型数据6：获取单模型的楼层信息

2022-09-22 10:26:42

系列目录【已更新最新开发文章，点击查看详细】

一个文件/模型中可能包含多个楼层信息，获取楼层信息对于前端页面的动态展示非常有帮助。本篇介绍获取一个文件/模型中可能包含多个楼层信息的详细方法。

请求地址：GET https://api.bimface.com/data/v2/files/{fileId}/floors

说明：获取单个模型的所有楼层信息

参数：

请求 path(示例)：https://api.bimface.com/data/v2/files/1211223382064960/floors

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

HTTP响应示例(200)：

{
  "code" : "success",
  "data" : [ {
    "archElev" : 0.0,
    "areas" : [ {
      "boundary" : "",
      "id" : "313137",
      "levelId" : "11",
      "maxPt" : {
        "x" : -4938.068482562385,
        "y" : -3201.59397858169,
        "z" : 0.0
      },
      "minPt" : {
        "x" : -4938.068482562385,
        "y" : -3201.59397858169,
        "z" : 0.0
      },
      "name" : "dining room 4"
    } ],
    "elevation" : 0.0,
    "height" : 4000.0,
    "id" : "311",
    "miniMap" : "787e5907b0ca5cb35f5d10ba091a085b/resource/model/maps/elevation 1.png",
    "name" : "elevation 1",
    "rooms" : [ {
      "boundary" : "",
      "id" : "313137",
      "levelId" : "11",
      "maxPt" : {
        "x" : -4938.068482562385,
        "y" : -3201.59397858169,
        "z" : 0.0
      },
      "minPt" : {
        "x" : -4938.068482562385,
        "y" : -3201.59397858169,
        "z" : 0.0
      },
      "name" : "dining room 4"
    } ],
    "structElev" : 0.0
  } ],
  "message" : ""
}

返回的数据结构比较复杂，封装成对应的C#类如下：

/// <summary>
///  获取单个模型的楼层信息返回的结果类
/// </summary>
[Serializable]
public class SingleModelFloors : GeneralResponse<List<Floor>>
{

}

其中Floor类的结构如下：

/// <summary>
///  楼层信息
/// </summary>
[Serializable]
public class Floor
{
    /// <summary>
    ///  例如： 0.0
    /// </summary>
    [JsonProperty("archElev")]
    public double? ArchElev { get; set; }

    /// <summary>
    ///  例如： 0.0
    /// </summary>
    [JsonProperty("areas")]
    public ObjectOnFloor[] Areas { get; set; }

    /// <summary>
    ///  例如： 0.0
    /// </summary>
    [JsonProperty("elevation")]
    public double? Elevation { get; set; }

    /// <summary>
    ///  例如：4000.0
    /// </summary>
    [JsonProperty("height")]
    public double? Height { get; set; }

    /// <summary>
    ///  编号。例如："311"
    /// </summary>
    [JsonProperty("id")]
    public string Id { get; set; }

    /// <summary>
    ///  样例 : "787e5907b0ca5cb35f5d10ba091a085b/resource/model/maps/elevation 1.png"
    /// </summary>
    [JsonProperty("miniMap")]
    public string MiniMap { get; set; }

    /// <summary>
    ///  名称。例如："elevation 1"
    /// </summary>
    [JsonProperty("name")]
    public string Name { get; set; }

    /// <summary>
    /// 房间信息
    /// </summary>
    [JsonProperty("rooms")]
    public ObjectOnFloor[] Rooms { get; set; }

    /// <summary>
    ///  例如：0.0
    /// </summary>
    [JsonProperty("structElev")]
    public double? StructElev { get; set; }

    /// <summary>返回表示当前对象的字符串。</summary>
    /// <returns>表示当前对象的字符串。</returns>
    public override string ToString()
    {
        StringBuilder sbAreas = new StringBuilder();
        if (Areas != null && Areas.Length > 0)
        {
            foreach(var area in Areas)
            {
                sbAreas.AppendLine(area.ToString());
            }
        }

        StringBuilder sbRooms = new StringBuilder();
        if (Rooms != null && Rooms.Length > 0)
        {
            foreach (var room in Rooms)
            {
                sbAreas.AppendLine(room.ToString());
            }
        }

        return string.Format("[archElev={0}, Areas={1}, elevation={2}, height={3}, id={4}, miniMap={5}, name={6}, rooms={7}, structElev={8}]",
                             ArchElev, sbAreas, Elevation, Height, Id, MiniMap, Name, sbRooms, StructElev);
    }
}

/// <summary>
///  楼层上包含的对象
/// </summary>
[Serializable]
public class ObjectOnFloor
{
    /// <summary>
    ///  边界
    /// </summary>
    [JsonProperty("boundary")]
    public string Boundary { get; set; }

    /// <summary>
    ///  编号
    /// </summary>
    [JsonProperty("id")]
    public string Id { get; set; }

    /// <summary>
    ///  水平线编号
    /// </summary>
    [JsonProperty("levelId")]
    public string LevelId { get; set; }

    [JsonProperty("maxPt")]
    public Coordinate MaxPt { get; set; }

    [JsonProperty("minPt")]
    public Coordinate MinPt { get; set; }

    /// <summary>
    ///  对象名称。例如："dining room 4"
    /// </summary>
    [JsonProperty("name")]
    public string Name { get; set; }

    /// <summary>返回表示当前对象的字符串。</summary>
    /// <returns>表示当前对象的字符串。</returns>
    public override string ToString()
    {
        return string.Format("[boundary={0}, id={1}, levelId={2}, maxPt={3}, minPt={4}, name={5}]",
                             Boundary, Id, LevelId, MaxPt, MinPt, Name);
    }
}

[Serializable]
public class Coordinate : ThreeDimensionalCoordinates
{
    
}

其中 ThreeDimensionalCoordinates 类在《C#开发BIMFACE系列18 服务端API之获取模型数据3：获取构件属性》中有使用过，请查看其详细定义。

C#实现方法：

 1 /// <summary>
 2 ///  获取单个模型的楼层信息
 3 /// </summary>
 4 /// <param name="accessToken">【必填】令牌</param>
 5 /// <param name="fileId">【必填】代表该单模型的文件ID</param>
 6 /// <param name="includeArea">【非必填】是否将楼层中的面积分区ID、名称一起返回</param>
 7 /// <param name="includeRoom">【非必填】是否将楼层中的房间ID、名称一起返回</param>
 8 /// <returns></returns>
 9 public virtual SingleModelFloors GetSingleModelFloors(string accessToken, long fileId, bool? includeArea = null, bool? includeRoom = null)
10 {
11     // GET https://api.bimface.com/data/v2/files/{fileId}/floors
12     string url = string.Format(BimfaceConstants.API_HOST + "/data/v2/files/{0}/floors", fileId);
13     if (includeArea != null && includeRoom == null)
14     {
15         url = url + "?includeArea=" + includeArea;
16     }
17     else if (includeArea == null && includeRoom != null)
18     {
19         url = url + "?includeRoom=" + includeRoom;
20     }
21     else if (includeArea != null && includeRoom != null)
22     {
23         url = url + "?includeArea=" + includeArea + "&includeRoom=" + includeRoom;
24     }
25 
26     BimFaceHttpHeaders headers = new BimFaceHttpHeaders();
27     headers.AddOAuth2Header(accessToken);
28 
29     try
30     {
31         SingleModelFloors response;
32 
33         HttpManager httpManager = new HttpManager(headers);
34         HttpResult httpResult = httpManager.Get(url);
35         if (httpResult.Status == HttpResult.STATUS_SUCCESS)
36         {
37             response = httpResult.Text.DeserializeJsonToObject<SingleModelFloors>();
38         }
39         else
40         {
41             response = new SingleModelFloors
42             {
43                 Message = httpResult.RefText
44             };
45         }
46 
47         return response;
48     }
49     catch (Exception ex)
50     {
51         throw new Exception("[获取单模型的楼层信息]发生异常！", ex);
52     }
53 }

其中调用到的 httpManager.Get() 方法，请参考《C# HTTP系列》

测试

在BIMFACE的控制台中可以看到我们上传的文件列表，共计2个文件。模型状态均为转换成功。