Environment_Engine: Intuitive default environmental panel types

Environment_Engine/Create/Panel.cs

@@ -43,30 +43,42 @@
         /**** Public Methods                            ****/
         /***************************************************/
 
         [Description("Create a collection of Environment Panels which form a space from a BHoM Boundary Representation (Brep)")]
         [Input("brep", "A BHoM Boundary Representation to convert into a collection of Environment Panels")]
         [Input("connectedSpaceName", "A name for the space which these panels are connected to. If no name is provided, a randomised default will be generated")]
         [Input("angleTolerance", "The angle tolerance for collapsing to polylines used when generating the external edges of the surfaces")]
-        [Input("panelType", "The panel type to assign to the panels, if no input is added roof, floor and wall types are assigned by default")]
+        [Input("roofType", "The panel type to assign to the panels where the panels are identified as roof. If no input is added roof types are assigned by default.")]
+        [Input("ceilingType", "The panel type to assign to the panels where the panels are identified as ceiling. If no input is added ceiling types are assigned by default.")]
+        [Input("internalFloorType", "The panel type to assign to the panels where the panels are identified as internal flooring. If no input is added FloorInternal types are assigned by default.")]
+        [Input("externalGrounding", "The panel type to assign to the panels where the panels are identified as external grounding. If no input is added SlabOnGrade types are assigned by default.")]
+        [Input("externalWallType", "The panel type to assign to the panels where the panels are identified as external walls. If no input is added WallExternal types are assigned by default.")]
+        [Input("internalWallType", "The panel type to assign to the panels where the panels are identified as internal walls. If no input is added WallInternal types are assigned by default.")]
         [Output("panelsAsSpace", "A collection of Environment Panels representing a closed space generated from the provided Brep geometry")]
-        public static List<Panel> Panels(this BoundaryRepresentation brep, string connectedSpaceName = null, double angleTolerance = BH.oM.Geometry.Tolerance.Angle, PanelType panelType = PanelType.Undefined)
+        [PreviousVersion("6.3", "BH.Engine.Environment.Create.Panels(BH.oM.Geometry.BoundaryRepresentation, System.String, System.Double, BH.oM.Environment.Elements.PanelType)")]
+        public static List<Panel> Panels(this BoundaryRepresentation brep, string connectedSpaceName = null, double angleTolerance = BH.oM.Geometry.Tolerance.Angle, PanelType roofType = PanelType.Roof, PanelType ceilingType = PanelType.Ceiling, PanelType internalFloorType = PanelType.FloorInternal, PanelType externalGrounding = PanelType.SlabOnGrade, PanelType externalWallType = PanelType.WallExternal, PanelType internalWallType = PanelType.WallInternal)
         {
             if(brep == null)
             {
                 BH.Engine.Base.Compute.RecordError("Could not create panels from a null brep.");
                 return null;
             }
 
-            return brep.Surfaces.ToList().Panels(connectedSpaceName, angleTolerance, panelType);
+            return brep.Surfaces.ToList().Panels(connectedSpaceName, angleTolerance, roofType, ceilingType, internalFloorType, externalGrounding, externalWallType, internalWallType);
         }
 
         [Description("Create a collection of Environment Panels from a collection of BHoM Surfaces")]
         [Input("surfaces", "A collection of BHoM surfaces to convert into a Environment Panels. The surfaces should be grouped as a single space as all panels generated from the surfaces will have the same connectedSpaceName")]
         [Input("connectedSpaceName", "A name for the space which these panels are connected to. If no name is provided, a randomised default will be generated")]
         [Input("angleTolerance", "The angle tolerance for collapsing to polylines used when generating the external edges of the surfaces")]
-        [Input("panelType", "The panel type to assign to the panels, if no input is added roof, floor and wall types are assigned by default")]
+        [Input("roofType", "The panel type to assign to the panels where the panels are identified as roof. If no input is added roof types are assigned by default.")]
+        [Input("ceilingType", "The panel type to assign to the panels where the panels are identified as ceiling. If no input is added ceiling types are assigned by default.")]
+        [Input("internalFloorType", "The panel type to assign to the panels where the panels are identified as internal flooring. If no input is added FloorInternal types are assigned by default.")]
+        [Input("externalGrounding", "The panel type to assign to the panels where the panels are identified as external grounding. If no input is added SlabOnGrade types are assigned by default.")]
+        [Input("externalWallType", "The panel type to assign to the panels where the panels are identified as external walls. If no input is added WallExternal types are assigned by default.")]
+        [Input("internalWallType", "The panel type to assign to the panels where the panels are identified as internal walls. If no input is added WallInternal types are assigned by default.")]
         [Output("panel", "An Environment Panels representing a closed space generated from the provided surfaces")]
-        public static List<Panel> Panels(this List<ISurface> surfaces, string connectedSpaceName = null, double angleTolerance = BH.oM.Geometry.Tolerance.Angle, PanelType panelType = PanelType.Undefined)
+        [PreviousVersion("6.3", "BH.Engine.Environment.Create.Panels(System.Collections.Generic.List<BH.oM.Geometry.ISurface>, System.String, System.Double, BH.oM.Environment.Elements.PanelType)")]
+        public static List<Panel> Panels(this List<ISurface> surfaces, string connectedSpaceName = null, double angleTolerance = BH.oM.Geometry.Tolerance.Angle, PanelType roofType = PanelType.Roof, PanelType ceilingType = PanelType.Ceiling, PanelType internalFloorType = PanelType.FloorInternal, PanelType externalGrounding = PanelType.SlabOnGrade, PanelType externalWallType = PanelType.WallExternal, PanelType internalWallType = PanelType.WallInternal)
         {
             if(surfaces == null)
             {
@@ -77,24 +89,23 @@
             if (connectedSpaceName == null)
                 connectedSpaceName = "auto" + Guid.NewGuid().ToString();
 
-            List<Panel> panels = surfaces.Select(x => x.Panel(connectedSpaceName, angleTolerance, panelType)).Where(x => x != null).ToList();
+            List<Panel> panels = surfaces.Select(x => x.Panel(connectedSpaceName, angleTolerance)).Where(x => x != null).ToList();
+
+            panels = panels.SetRoofPanels(roofType, ceilingType, internalFloorType);
 
-            if (panelType == PanelType.Undefined)
-            {
-                panels = panels.SetRoofPanels();
-                panels = panels.SetFloorPanels();
-                panels = panels.SetWallPanels();
-            }
+            panels = panels.SetFloorPanels(externalGrounding);
 
+            panels = panels.SetWallPanels(externalWallType, internalWallType);
+
             return panels;
         }
 
         [Description("Create an Environments Panel from a BHoM Surface")]
         [Input("surface", "A BHoM surface to convert into an Environment Panel")]
         [Input("connectedSpaceName", "A name for the space which this panel is connected to. If no name is provided, a randomised default will be generated")]
         [Input("angleTolerance", "The angle tolerance for collapsing to polylines used when generating the external edges of the surfaces")]
         [Input("panelType", "The panel type to assign to the panel, default type is Undefined")]
         [Output("panel", "An Environment Panels representing a closed space generated from the provided Brep geometry")]
         public static Panel Panel(this ISurface surface, string connectedSpaceName = null, double angleTolerance = BH.oM.Geometry.Tolerance.Angle, PanelType panelType = PanelType.Undefined)
         {
             if(surface.GetType() == typeof(NurbsSurface))

Environment_Engine/Modify/SetFloorPanels.cs

@@ -40,10 +40,11 @@
         /**** Public Methods                            ****/
         /***************************************************/
 
-        [Description("Modifies a collection of Panels and sets their type to be slab on grade or internal floor if they are the lowest panel in the space. If the panel has one connected space then it is deemed to be a slab on grade panel, otherwise it is an internal floor panel")]
-        [Input("panelsAsSpace", "A collection of Environment Panels that represent a closed space")]
-        [Output("panelsAsSpace", "BHoM Environment panels representing a closed space where the slab on grade or internal floor panels have had their type set")]
-        public static List<Panel> SetFloorPanels(this List<Panel> panelsAsSpace)
+        [Description("Modifies a collection of Panels and sets their type to be slab on grade or internal floor if they are the lowest panel in the space. If the panel has one connected space then it is deemed to be a slab on grade panel, otherwise it is an internal floor panel.")]
+        [Input("panelsAsSpace", "A collection of Environment Panels that represent a closed space.")]
+        [Output("panelsAsSpace", "BHoM Environment panels representing a closed space where the slab on grade or internal floor panels have had their type set.")]
+        [PreviousVersion("6.3", "BH.Engine.Environment.Modify.SetFloorPanels(System.Collections.Generic.List<BH.oM.Environment.Elements.Panel>)")]
+        public static List<Panel> SetFloorPanels(this List<Panel> panelsAsSpace, PanelType internalFloorType = PanelType.FloorInternal, PanelType externalGrounding = PanelType.SlabOnGrade)
         {
             List<Panel> clones = new List<Panel>(panelsAsSpace.Select(x => x.DeepClone<Panel>()).ToList());
 
@@ -66,9 +67,9 @@
             foreach (Panel panel in floorPanels)
             {
                 if (panel.ConnectedSpaces.Where(x => x != "-1").ToList().Count == 1)
-                    panel.Type = PanelType.SlabOnGrade;
+                    panel.Type = externalGrounding;
                 else if (panel.ConnectedSpaces.Where(x => x != "-1").ToList().Count == 2)
-                    panel.Type = PanelType.FloorInternal;
+                    panel.Type = internalFloorType;
             }
 
 

Environment_Engine/Modify/SetRoofPanels.cs

@@ -40,10 +40,14 @@
         /**** Public Methods                            ****/
         /***************************************************/
 
-        [Description("Modifies a collection of Panels and sets their type to be roof or ceiling if they are the highest panel in the space. If the panel has one connected space then it is deemed to be a roof panel, otherwise it is a ceiling panel")]
-        [Input("panelsAsSpace", "A collection of Environment Panels that represent a closed space")]
-        [Output("panelsAsSpace", "BHoM Environment panels representing a closed space where the roof or ceiling panels have had their type set")]
-        public static List<Panel> SetRoofPanels(this List<Panel> panelsAsSpace)
+        [Description("Modifies a collection of Panels and sets their type to be roof or ceiling if they are the highest panel in the space. If the panel has one connected space then it is deemed to be a roof panel, otherwise it is a ceiling panel.")]
+        [Input("panelsAsSpace", "A collection of Environment Panels that represent a closed space.")]
+        [Input("roofType", "The panel type to define external roof panels. Defaults to 'roof'.")]
+        [Input("ceilingType", "The panel type to define internal ceiling panels, defined as panels on the horizontal tilt with 2 connected spaces. Defaults to 'ceiling'.")]
+        [Input("internalFloorType", "The panel type to define internal floors. Defaults to 'FloorInternal'.")]
+        [Output("panelsAsSpace", "BHoM Environment panels representing a closed space where the roof or ceiling panels have had their type set.")]
+        [PreviousVersion("6.3", "BH.Engine.Environment.Modify.SetRoofPanels(System.Collections.Generic.List<BH.oM.Environment.Elements.Panel>)")]
+        public static List<Panel> SetRoofPanels(this List<Panel> panelsAsSpace, PanelType roofType = PanelType.Roof, PanelType ceilingType = PanelType.Ceiling, PanelType internalFloorType = PanelType.FloorInternal)
         {
             List<Panel> clones = new List<Panel>(panelsAsSpace.Select(x => x.DeepClone<Panel>()).ToList());
 
@@ -64,15 +68,15 @@
             foreach (Panel panel in roofPanels)
             {
                 if (panel.ConnectedSpaces.Where(x => x != "-1").ToList().Count == 1)
-                    panel.Type = PanelType.Roof;
+                    panel.Type = roofType;
                 else if (panel.ConnectedSpaces.Where(x => x != "-1").ToList().Count == 2)
-                    panel.Type = PanelType.Ceiling;
+                    panel.Type = ceilingType;
             }
 
             foreach (Panel panel in roofPanels)
             {
                 if (panel.Type == PanelType.Ceiling && panel.MaximumLevel() != maxZ)
-                    panel.Type = PanelType.FloorInternal;
+                    panel.Type = internalFloorType;
             }
 
             return clones;

Environment_Engine/Modify/SetWallPanels.cs

@@ -40,10 +40,11 @@
         /**** Public Methods                            ****/
         /***************************************************/
 
-        [Description("Modifies a collection of Panels and sets their type to be interior or exterior wall if they have a tilt of 90 degrees. If the panel has one connected space then it is deemed to be an internal wall panel, otherwise it is an external wall panel")]
-        [Input("panelsAsSpace", "A collection of Environment Panels that represent a closed space")]
-        [Output("panelsAsSpace", "BHoM Environment panels representing a closed space where the internal or external wall panels have had their type set")]
-        public static List<Panel> SetWallPanels(this List<Panel> panelsAsSpace)
+        [Description("Modifies a collection of Panels and sets their type to be interior or exterior wall if they have a tilt of 90 degrees. If the panel has one connected space then it is deemed to be an internal wall panel, otherwise it is an external wall panel.")]
+        [Input("panelsAsSpace", "A collection of Environment Panels that represent a closed space.")]
+        [Output("panelsAsSpace", "BHoM Environment panels representing a closed space where the internal or external wall panels have had their type set.")]
+        [PreviousVersion("6.3", "BH.Engine.Environment.Modify.SetWallPanels(System.Collections.Generic.List<BH.oM.Environment.Elements.Panel>)")]
+        public static List<Panel> SetWallPanels(this List<Panel> panelsAsSpace, PanelType externalWallType = PanelType.WallExternal, PanelType internalWallType = PanelType.WallInternal)
         {
             List<Panel> clones = new List<Panel>(panelsAsSpace.Select(x => x.DeepClone<Panel>()).ToList());
 
@@ -66,9 +67,9 @@
             foreach (Panel panel in wallPanels)
             {
                 if (panel.ConnectedSpaces.Where(x => x != "-1").ToList().Count == 1)
-                    panel.Type = PanelType.WallExternal;
+                    panel.Type = externalWallType;
                 else if (panel.ConnectedSpaces.Where(x => x != "-1").ToList().Count == 2)
-                    panel.Type = PanelType.WallInternal;
+                    panel.Type = internalWallType;
             }
 
             return clones;