BH.oM.Geometry.PolySurface¶
A composite surface constructed by combining a collection of surfaces of any type. Whole PolySurface integrity, continuity and closure is not guaranteed at creation. Discontinuous and/or multi-region definitions are possible, although validity of some engine methods may vary depending on the PolySurface form.
Class structure¶
Implemented interfaces and base types¶
The PolySurface 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 |
|---|---|---|---|
| Surfaces | List<ISurface> | A collection of surfaces, of any or mixed type, which together define the composite shape. | - |
Derived properties¶
The following properties are defined as extension methods in one of the BHoM_Engines
| Name | Type | Description | Quantity | Engine |
|---|---|---|---|---|
| Area | double | Calculates the area of the provided geometry. | Area [m²] | Geometry_Engine |
| Bounds | BoundingBox | Returns the global world axis oriented enclosing BoundingBox for all points on the surface, i.e. the box with the smallest volume within which all the surface points lie. | - | Geometry_Engine |
| Edges | List<ICurve> | - | - | Geometry_Engine |
| ExternalEdges | List<ICurve> | Gets the external edge curves of the PolySurface the external edge curves of all of its parts. | - | Geometry_Engine |
| GeometryHash | string | Returns a signature of the input geometry, useful for diffing. The hash is computed as a serialised array representing the coordinate of significant points taken on the geometry. The number of points is reduced to the minimum essential to determine uniquely any geometry. Additionally, the resulting points are transformed based on the source geometry type, to remove or minimize collisions. (Any transformation so performed is translational only, in order to support geometrical tolerance, i.e. numerical distance, when comparing GeometryHashes downstream). |
- | Geometry_Engine |
| IArea | double | Calculates the area of the provided geometry. | Area [m²] | Geometry_Engine |
| IBounds | BoundingBox | Returns the global world axis oriented enclosing BoundingBox for all points of the geometry, i.e. the box with the smallest volume within which all the points on the geometry lie. | - | Geometry_Engine |
| IExternalEdges | List<ICurve> | Gets the external edge curves of the ISurface. | - | Geometry_Engine |
| IHashArray | double[] | Returns a signature of the input geometry, useful for distance-based comparisons and diffing. The hash is computed as an array representing the coordinate of significant points taken on the geometry. The number of points is reduced to the minimum essential to determine uniquely any geometry. Additionally, the resulting points are transformed based on the source geometry type, to remove or minimize collisions. (Any transformation so performed is translational only, in order to support geometrical tolerance, i.e. numerical distance, when comparing GeometryHashes downstream). |
- | Geometry_Engine |
| IInternalEdges | List<ICurve> | - | - | Geometry_Engine |
| IIsPlanar | bool | Checks if the IGeometry is planar, i.e. all of its parts fit in a single plane. | - | Geometry_Engine |
| IIsValid | bool | - | - | Geometry_Engine |
| INormals | List<Vector> | Interface method that returns the list of vectors normal to any IGeometry. | - | Geometry_Engine |
| InternalEdges | List<ICurve> | - | - | Geometry_Engine |
| IsNull | bool | Checks if a Geometry is null and outputs relevant error message. | - | Geometry_Engine |
| IsPlanar | bool | - | - | Geometry_Engine |
| ISubParts | IEnumerable<ISurface> | - | - | Geometry_Engine |
| ISubParts | IEnumerable<IGeometry> | - | - | Geometry_Engine |
| IsValid | bool | - | - | Geometry_Engine |
| SubParts | List<ISurface> | - | - | Geometry_Engine |
Code and Schema¶
C# implementation¶
Assembly: Geometry_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/Geometry_oM/PolySurface.json"
}
The JSON Schema is available on github here: