BH.oM.Geometry.ISolid

The interface for all three-dimensional geometrical objects

Interface structure

Implemented interfaces and base types

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

• BH.oM.Geometry.IGeometry
• BH.oM.Base.IObject

Classes implementing this interface

The following classes are implementing this interface:

• BH.oM.Geometry.BoundaryRepresentation
• BH.oM.Geometry.Cone
• BH.oM.Geometry.Cuboid
• BH.oM.Geometry.Cylinder
• BH.oM.Geometry.Sphere
• BH.oM.Geometry.Torus

Properties

Derived properties

The following properties are defined as extension methods in one of the BHoM_Engines

Name	Type	Description	Quantity	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
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
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
IsNull	bool	Checks if a Geometry is null and outputs relevant error message.	-	Geometry_Engine
ISubParts	IEnumerable<IGeometry>	-	-	Geometry_Engine
IsValid	bool	-	-	Geometry_Engine
IVolume	double	Gets the enclosed volume of a solid.	Volume [m³]	Geometry_Engine

Code and Schema

C# implementation

C#

public interface ISolid : BH.oM.Geometry.IGeometry, BH.oM.Base.IObject

Assembly: Geometry_oM.dll

The C# interface definition is available on github:

• ISolid.cs

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/ISolid.json"
}

The JSON Schema is available on github here:

• ISolid.json