BH.oM.Environment.Elements.Opening¶
A cutout or hole in a building surface/panel (e.g. Window, Door, Rooflight)
Class structure¶
Implemented interfaces and base types¶
The Opening is inheriting from the following base type(s) and implements the following interfaces:
- BH.oM.Base.BHoMObject
- BH.oM.Base.IBHoMObject
- BH.oM.Base.IObject
- BH.oM.Environment.IEnvironmentObject
- BH.oM.Analytical.Elements.IOpening<BH.oM.Environment.Elements.Edge>
- BH.oM.Analytical.IAnalytical
- BH.oM.Dimensional.IElement2D
- BH.oM.Dimensional.IElement
- BH.oM.Dimensional.IElementM
Properties¶
Defining properties¶
The following properties are defined on the class
| Name | Type | Description | Quantity |
|---|---|---|---|
| Edges | List<Edge> | A collection of environment Edge objects which define the external boundary of the opening | - |
| FrameConstruction | IConstruction | A construction object providing construction information about the frame of the opening | - |
| FrameFactorValue | double | The percentage of the opening that is frame | - |
| InnerEdges | List<Edge> | A collection of environment Edge objects which define the internal boundary of the opening | - |
| OpeningConstruction | IConstruction | A construction object providing construction information about the opening - typically gazing construction | - |
| Type | OpeningType | The type of opening on a panel (e.g. Window, Door). Use OpeningType enum | - |
Inherited properties¶
The following properties are inherited from the base class of the object
| Name | Type | Description | Quantity |
|---|---|---|---|
| BHoM_Guid | Guid | - | - |
| Name | string | - | - |
| Fragments | FragmentSet | - | - |
| Tags | HashSet<string> | - | - |
| CustomData | Dictionary<string, object> | - | - |
Derived properties¶
The following properties are defined as extension methods in one of the BHoM_Engines
| Name | Type | Description | Quantity | Engine |
|---|---|---|---|---|
| Altitude | double | Returns the minimum altitude of an Environment Object as the minimum z value from the bounding box of the geometry | - | Environment_Engine |
| AltitudeRange | double | Returns the range of altitude of an Environment Object taken as the maximum z value minus minimum z value from the bounding box of the geometry | - | Environment_Engine |
| Area | double | Queries the IElement2Ds area defined as the area confined by the outline curves subtracting the area of the internal elements. | Area [m²] | Spatial_Engine |
| Bottom | ICurve | Returns the bottom of a given environment object. | - | Environment_Engine |
| Bounds | BoundingBox | Queries the IElement2Ds BoundingBox. Acts on the element curve definition of the IElement2D through the Geometry_Engine. | - | Spatial_Engine |
| Centroid | Point | Queries the centre of area for a IElement2Ds surface representation. For an IElement2D with homogeneous material and thickness this will also be the centre of weight. | - | Spatial_Engine |
| ControlPoints | List<Point> | Queries the control points of the element curve representation of the IElement2D. | - | Spatial_Engine |
| DominantVector | Vector | Gets the the dominant vector (orientation) of an Element2D based on its lines lengths. | - | Spatial_Engine |
| ElementCurves | List<ICurve> | Queries the geometricly defining curves of the IElement2Ds surface. | - | Spatial_Engine |
| ElementEmbodiedCarbon | List<IElementResult<MaterialResult>> | Evaluates the embodied carbon on the provided element based on IStructE methodology of evaluation. If you would like to evaluate other EPD metrics, please use one of the Query.EnvironmentalResults methods. TemplateMaterials can be provided helping with picking the correct EPD corresponding to each material on the element. Please note that this evaluation method only support mass-based EPDs. |
- | LifeCycleAssessment_Engine |
| ElementEnvironmentalMetrics | List<List<EnvironmentalMetric>> | Query the Environmental Product Declarations from any IElementM with a MaterialComposition composed of IEPD materials. | - | LifeCycleAssessment_Engine |
| ElementEpds | List<EnvironmentalProductDeclaration> | Query the Environmental Product Declarations from any IElementM with a MaterialComposition composed of IEPD materials. | - | LifeCycleAssessment_Engine |
| ElementMaterialNames | List<string> | Query the element's MaterialComposition to form a Material Hint to aid in EPD-Material Mapping. | - | LifeCycleAssessment_Engine |
| ElementScope | ScopeType | Returns the enumerable type of the scope found on an element. | - | LifeCycleAssessment_Engine |
| ElementVertices | List<Point> | Returns the discontinuity points from the defining ICurves of the IElement2D. | - | Spatial_Engine |
| EnvironmentalResults | List<IElementResult<MaterialResult>> | Evaluates the EnvironmentalMetrics for the provided element and returns an ElementResult for each evaluated metric type. Evaluation is done by extracting the material takeoff for the provided element, giving quantities and Materiality. Each Material in the takeoff is then evaluated by finding the EnvironmentalProductDeclaration (EPD), either stored on the material or from the list of template materials. Each metric, or filtered chosen metrics, on the EPD is then evaluated. Finally, an element result is returned per metric type. Each element result being the sum result of all metrics of the same type. |
- | LifeCycleAssessment_Engine |
| ExplodeToParts | Output<List<ICurve>, List<ICurve>, List<ICurve>> | Returns the sides, top and bottom of a given environment object. | - | Environment_Engine |
| ExternalElementCurves | List<ICurve> | Queries the geometricly defining external curves of the IElement2Ds surface. | - | Spatial_Engine |
| FrameFactor | double | Returns the Frame Factor of an opening as a decimal representing the percentage of the opening which is made up of frame. Result is between 0 (0% frame) to 1 (100% frame) | - | Environment_Engine |
| Height | double | Returns the height of an Environment Opening | - | Environment_Engine |
| Height | double | Returns the height of a generic Environment Object | - | Environment_Engine |
| IArea | double | Queries the area of the geometrical representation of an IElement. | Area [m²] | Spatial_Engine |
| IBounds | BoundingBox | Queries the IElements BoundingBox. Acts on the elements geometrical definition of the IElement through the Geometry_Engine. | - | Spatial_Engine |
| ICentroid | Point | Queries the centre of weight for the homogeneous geometrical representation of an IElement. | - | Spatial_Engine |
| IControlPoints | List<Point> | Queries the control points of the geometrical representation of an IElement. | - | Spatial_Engine |
| IElementCurves | List<ICurve> | Queries the geometricly defining curves of the IElements geometry. | - | Spatial_Engine |
| IElementVertices | List<Point> | Returns the discontinuity points from the defining ICurves of the IElement. | - | Spatial_Engine |
| IGeneralMaterialTakeoff | GeneralMaterialTakeoff | Gets the unique Materials along with their volumes defining an object's make-up. | - | Matter_Engine |
| IInternalElements2D | List<IElement2D> | Queries the IElement2Ds internal IElement2Ds. Returns a empty list for objects without definied internal elements | - | Spatial_Engine |
| IIsPlanar | bool | Checks whether all control points of an element lie in a single plane. | - | Spatial_Engine |
| IIsSelfIntersecting | bool | Checks if any of the curves defining an IElement is closer to itself than the tolerance at any two points (is self intersecting). In case of IElement2D, does not check for intersections between external and internal curves, or between different internal curves. | - | Spatial_Engine |
| IMaterialComposition | MaterialComposition | Gets the unique Materials along with their relative proportions defining an object's make-up. | - | Matter_Engine |
| Inclination | double | Returns the inclination of a generic Environment Object | - | Environment_Engine |
| INewInternalElement2D | IElement2D | Creates a IElement2D of a type which can be assigned to the IElement2D. | - | Spatial_Engine |
| InternalElementCurves | List<ICurve> | Queries the geometricly defining internal curves, such as Openings, of the IElement2Ds surface. | - | Spatial_Engine |
| InternalOutlineCurves | List<PolyCurve> | Queries the IElement2Ds internal IElement2Ds outline curves. | - | Spatial_Engine |
| IOutlineElements1D | List<IElement1D> | Returns every IElement1D which makes up the exterior perimeter of the IElement2D. | - | Spatial_Engine |
| IPrimaryPropertyName | string | Returns the name of an elements primary defining construction property | - | Facade_Engine |
| ISolidVolume | double | Returns an element's solid volume, i.e. the the volume of the element that had any materiality, excluding cavities, openings and voids. | Volume [m³] | Matter_Engine |
| IsPlanar | bool | Checks whether all control points of an element lie in a single plane. | - | Spatial_Engine |
| IsSelfIntersecting | bool | Checks if any of the element curves of the IElement2D is closer to itself than the tolerance at any two points. Does not check for intersections between external and internal curves, or between different internal curves. | - | Spatial_Engine |
| IVolumetricMaterialTakeoff | VolumetricMaterialTakeoff | Gets the unique Materials along with their volumes defining an object's make-up. | - | Matter_Engine |
| Mass | double | Evaluates the mass of an object based its VolumetricMaterialTakeoff and Density. | Mass [kg] | Matter_Engine |
| MaterialComposition | MaterialComposition | Gets all the Materials a Opening is composed of and in which ratios | - | Environment_Engine |
| MaximumLevel | double | Returns the maximum level of the given opening based on the z axis | - | Environment_Engine |
| MinimumLevel | double | Returns the minimum level of the given opening based on the z axis | - | Environment_Engine |
| Normal | Vector | Returns the normal to the IElement2D which is perpendicular to its plane and oriented according to the right hand rule in relation to the outline curve. | - | Spatial_Engine |
| Orientation | Nullable<double> | Returns the angle to north of a given environmental object on an xyPlane | - | Environment_Engine |
| OutlineCurve | PolyCurve | Returns a single polycurve outline created from the external elements. | - | Spatial_Engine |
| OutlineElements1D | List<IElement1D> | Returns the outline 1D elements of an Environment Opening | - | Environment_Engine |
| Polyline | Polyline | Returns the external boundary from an Environment Opening as a BHoM Geometry Polyline | - | Environment_Engine |
| Polyline | Polyline | Returns the external boundary from a generic Environment Object | - | Environment_Engine |
| QuantityTypes | List<QuantityType> | Query the QuantityType values from any IElementM object's MaterialComposition. | - | LifeCycleAssessment_Engine |
| Sides | List<ICurve> | Returns the sides of a given environment object. | - | Environment_Engine |
| SolidVolume | double | Returns an Openings solid volume based on its area, and construction thickness | Volume [m³] | Environment_Engine |
| Thickness | double | Returns the thickness of an Environment Opening based on its construction | - | Environment_Engine |
| Thickness | double | Returns the thickness of an Environment Opening based on its construction | - | Environment_Engine |
| Tilt | double | Returns the tilt of an Environment Object | - | Environment_Engine |
| ToLines | List<Line> | Returns the external boundary from an Environment Opening as a collection of BHoM Geometry Lines | - | Environment_Engine |
| ToLines | List<Line> | Returns the external boundary from a generic Environment Object | - | Environment_Engine |
| Top | ICurve | Returns the top of a given environment object. | - | Environment_Engine |
| Width | double | Returns the width of an Environment Opening | - | Environment_Engine |
| Width | double | Returns the width of a generic Environment Object | - | Environment_Engine |
Code and Schema¶
C# implementation¶
C#
public class Opening : BH.oM.Base.BHoMObject,
BH.oM.Base.IBHoMObject,
BH.oM.Base.IObject,
BH.oM.Environment.IEnvironmentObject,
BH.oM.Analytical.Elements.IOpening<BH.oM.Environment.Elements.Edge>,
BH.oM.Analytical.IAnalytical,
BH.oM.Dimensional.IElement2D,
BH.oM.Dimensional.IElement,
BH.oM.Dimensional.IElementM
Assembly: Environment_oM.dll
The C# class definition is available on github:
All history and changes of the class can be found by inspection the history.
JSON Schema implementation¶
The object is defined as a JSON schema. You can validate a JSON instance against this schema by reference. To do this, use the schema reference below in a validator like this one.
JSON Schema
{
"$ref" : "https://raw.githubusercontent.com/BHoM/BHoM_JSONSchema/develop/Environment_oM/Elements/Opening.json"
}
The JSON Schema is available on github here: