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

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

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

请求地址：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" : "",

      "levelId" : "",

      "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" : "",

    "miniMap" : "787e5907b0ca5cb35f5d10ba091a085b/resource/model/maps/elevation 1.png",

    "name" : "elevation 1",

    "rooms" : [ {

      "boundary" : "",

      "id" : "",

      "levelId" : "",

      "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 > )

        {

            foreach(var area in Areas)

            {

                sbAreas.AppendLine(area.ToString());

            }

        }

        StringBuilder sbRooms = new StringBuilder();

        if (Rooms != null && Rooms.Length > )

        {

            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#实现方法：

 /// <summary>

 ///  获取单个模型的楼层信息

 /// </summary>

 /// <param name="accessToken">【必填】令牌</param>

 /// <param name="fileId">【必填】代表该单模型的文件ID</param>

 /// <param name="includeArea">【非必填】是否将楼层中的面积分区ID、名称一起返回</param>

 /// <param name="includeRoom">【非必填】是否将楼层中的房间ID、名称一起返回</param>

 /// <returns></returns>

 public virtual SingleModelFloors GetSingleModelFloors(string accessToken, long fileId, bool? includeArea = null, bool? includeRoom = null)

 {

     // GET https://api.bimface.com/data/v2/files/{fileId}/floors

     string url = string.Format(BimfaceConstants.API_HOST + "/data/v2/files/{0}/floors", fileId);

     if (includeArea != null && includeRoom == null)

     {

         url = url + "?includeArea=" + includeArea;

     }

     else if (includeArea == null && includeRoom != null)

     {

         url = url + "?includeRoom=" + includeRoom;

     }

     else if (includeArea != null && includeRoom != null)

     {

         url = url + "?includeArea=" + includeArea + "&includeRoom=" + includeRoom;

     }

     BimFaceHttpHeaders headers = new BimFaceHttpHeaders();

     headers.AddOAuth2Header(accessToken);

     try

     {

         SingleModelFloors response;

         HttpManager httpManager = new HttpManager(headers);

         HttpResult httpResult = httpManager.Get(url);

         if (httpResult.Status == HttpResult.STATUS_SUCCESS)

         {

             response = httpResult.Text.DeserializeJsonToObject<SingleModelFloors>();

         }

         else

         {

             response = new SingleModelFloors

             {

                 Message = httpResult.RefText

             };

         }

         return response;

     }

     catch (Exception ex)

     {

         throw new Exception("[获取单模型的楼层信息]发生异常！", ex);

     }

 }

测试

在BIMFACE的控制台中可以看到以下文件列表。模型状态均为转换成功。