Skip to content

BH.oM.Physical.Elements.Void

Class structure

Implemented interfaces and base types

The Void is inheriting from the following base type(s) and implements the following interfaces:

Properties

Defining properties

The following properties are defined on the class

Name Type Description Quantity
Location ISurface - -

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
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 curve of a given generic opening object. - Physical_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
ElementVertices List<Point> Returns the discontinuity points from the defining ICurves of the IElement2D. - Spatial_Engine
ExternalElementCurves List<ICurve> Queries the geometricly defining external curves of the IElement2Ds surface. - Spatial_Engine
ExternalPolyline List<Polyline> Returns the External Polyline representation of a physical object that represents an opening (e.g. window or door). - Physical_Engine
ExternalPolyline List<Polyline> Returns the External Polyline representation of a physical object (e.g. wall or window). - Physical_Engine
GeneralMaterialTakeoff GeneralMaterialTakeoff Gets the volumetric material takeoff from the Void object. This will always return an empty takeoff as a void represent an area of no materiality. - Physical_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 volumetric material takeoff from the IOpening. - Facade_Engine
IGeneralMaterialTakeoff GeneralMaterialTakeoff Gets the volumetric material takeoff from the IOpening. - Physical_Engine
IHeight double Returns the vertical orthogonal height of a generic opening based on global coordinates of its BoundingBox. Length [m] Physical_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
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
InternalPolyline List<Polyline> Returns the Internal Polyline representation of a physical object that represents an opening (e.g. window or door). - Physical_Engine
InternalPolyline List<Polyline> Returns the Internal Polyline representation of a physical object (e.g. wall or window). - Physical_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
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 volumetric material takeoff from the IOpening. - Physical_Engine
IWidth double Returns the horizontal orthogonal width of a generic opening based on global coordinates of its BoundingBox. Length [m] Physical_Engine
Mass double Evaluates the mass of an object based its Solid Volume and Density.
Requires a single consistent value of Density to be provided across all MaterialProperties of a given element.		 Mass [kg] Physical_Engine
MaterialComposition MaterialComposition Gets all the Materials an IOpening is composed of and in which ratios. - Physical_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
OutlineCurve PolyCurve Returns a single polycurve outline created from the external elements. - Spatial_Engine
OutlineElements1D List<IElement1D> Gets the external outline elements of an IOpening. - Physical_Engine
Polyline List<Polyline> Returns a Polyline representation of a physical object that represents an opening (e.g. window or door). - Physical_Engine
Polyline List<Polyline> Returns a Polyline representation of a physical object (e.g. wall or window). - Physical_Engine
SolidVolume double Returns an IOpening's solid volume based on thickness and area. Volume [m³] Physical_Engine
VolumetricMaterialTakeoff VolumetricMaterialTakeoff Gets the volumetric material takeoff from the Void object. This will always return an empty takeoff as a void represent an area of no materiality. - Physical_Engine

Code and Schema

C# implementation

C#
public class Void : BH.oM.Base.BHoMObject,
BH.oM.Base.IBHoMObject,
BH.oM.Base.IObject,
BH.oM.Physical.Elements.IOpening,
BH.oM.Physical.IPhysical,
BH.oM.Dimensional.IElement2D,
BH.oM.Dimensional.IElement

Assembly: Physical_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/Physical_oM/Elements/Void.json"
}

The JSON Schema is available on github here: