Skip to content

Commit cb49d17

Browse files
albinberFraser Greenroyd
albinber
authored and
Fraser Greenroyd
committed
Changed documentation
1 parent 3faa62f commit cb49d17

File tree

4 files changed

+21
-11
lines changed

4 files changed

+21
-11
lines changed

‎Environment_Engine/Create/Panel.cs

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,12 @@ public static partial class Create
4747
[Input("brep", "A BHoM Boundary Representation to convert into a collection of Environment Panels")]
4848
[Input("connectedSpaceName", "A name for the space which these panels are connected to. If no name is provided, a randomised default will be generated")]
4949
[Input("angleTolerance", "The angle tolerance for collapsing to polylines used when generating the external edges of the surfaces")]
50-
[Input("panelType", "The panel type to assign to the panels, if no input is added roof, floor and wall types are assigned by default")]
50+
[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.")]
51+
[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.")]
52+
[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.")]
53+
[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.")]
54+
[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.")]
55+
[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.")]
5156
[Output("panelsAsSpace", "A collection of Environment Panels representing a closed space generated from the provided Brep geometry")]
5257
[PreviousVersion("6.3", "BH.Engine.Environment.Create.Panels(BH.oM.Geometry.BoundaryRepresentation, System.String, System.Double, BH.oM.Environment.Elements.PanelType)")]
5358
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)
@@ -65,7 +70,12 @@ public static List<Panel> Panels(this BoundaryRepresentation brep, string connec
6570
[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")]
6671
[Input("connectedSpaceName", "A name for the space which these panels are connected to. If no name is provided, a randomised default will be generated")]
6772
[Input("angleTolerance", "The angle tolerance for collapsing to polylines used when generating the external edges of the surfaces")]
68-
[Input("panelType", "The panel type to assign to the panels, if no input is added roof, floor and wall types are assigned by default")]
73+
[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.")]
74+
[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.")]
75+
[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.")]
76+
[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.")]
77+
[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.")]
78+
[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.")]
6979
[Output("panel", "An Environment Panels representing a closed space generated from the provided surfaces")]
7080
[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)")]
7181
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)

‎Environment_Engine/Modify/SetFloorPanels.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,9 @@ public static partial class Modify
4040
/**** Public Methods ****/
4141
/***************************************************/
4242

43-
[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")]
44-
[Input("panelsAsSpace", "A collection of Environment Panels that represent a closed space")]
45-
[Output("panelsAsSpace", "BHoM Environment panels representing a closed space where the slab on grade or internal floor panels have had their type set")]
43+
[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.")]
44+
[Input("panelsAsSpace", "A collection of Environment Panels that represent a closed space.")]
45+
[Output("panelsAsSpace", "BHoM Environment panels representing a closed space where the slab on grade or internal floor panels have had their type set.")]
4646
[PreviousVersion("6.3", "BH.Engine.Environment.Modify.SetFloorPanels(System.Collections.Generic.List<BH.oM.Environment.Elements.Panel>)")]
4747
public static List<Panel> SetFloorPanels(this List<Panel> panelsAsSpace, PanelType internalFloorType = PanelType.FloorInternal, PanelType externalGrounding = PanelType.SlabOnGrade)
4848
{

‎Environment_Engine/Modify/SetRoofPanels.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,12 +40,12 @@ public static partial class Modify
4040
/**** Public Methods ****/
4141
/***************************************************/
4242

43-
[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")]
44-
[Input("panelsAsSpace", "A collection of Environment Panels that represent a closed space")]
43+
[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.")]
44+
[Input("panelsAsSpace", "A collection of Environment Panels that represent a closed space.")]
4545
[Input("roofType", "The panel type to define external roof panels. Defaults to 'roof'.")]
4646
[Input("ceilingType", "The panel type to define internal ceiling panels, defined as panels on the horizontal tilt with 2 connected spaces. Defaults to 'ceiling'.")]
4747
[Input("internalFloorType", "The panel type to define internal floors. Defaults to 'FloorInternal'.")]
48-
[Output("panelsAsSpace", "BHoM Environment panels representing a closed space where the roof or ceiling panels have had their type set")]
48+
[Output("panelsAsSpace", "BHoM Environment panels representing a closed space where the roof or ceiling panels have had their type set.")]
4949
[PreviousVersion("6.3", "BH.Engine.Environment.Modify.SetRoofPanels(System.Collections.Generic.List<BH.oM.Environment.Elements.Panel>)")]
5050
public static List<Panel> SetRoofPanels(this List<Panel> panelsAsSpace, PanelType roofType = PanelType.Roof, PanelType ceilingType = PanelType.Ceiling, PanelType internalFloorType = PanelType.FloorInternal)
5151
{

‎Environment_Engine/Modify/SetWallPanels.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,9 @@ public static partial class Modify
4040
/**** Public Methods ****/
4141
/***************************************************/
4242

43-
[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")]
44-
[Input("panelsAsSpace", "A collection of Environment Panels that represent a closed space")]
45-
[Output("panelsAsSpace", "BHoM Environment panels representing a closed space where the internal or external wall panels have had their type set")]
43+
[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.")]
44+
[Input("panelsAsSpace", "A collection of Environment Panels that represent a closed space.")]
45+
[Output("panelsAsSpace", "BHoM Environment panels representing a closed space where the internal or external wall panels have had their type set.")]
4646
[PreviousVersion("6.3", "BH.Engine.Environment.Modify.SetWallPanels(System.Collections.Generic.List<BH.oM.Environment.Elements.Panel>)")]
4747
public static List<Panel> SetWallPanels(this List<Panel> panelsAsSpace, PanelType externalWallType = PanelType.WallExternal, PanelType internalWallType = PanelType.WallInternal)
4848
{

0 commit comments

Comments
 (0)