BH.oM.Geometry.Pipe

A constant circular cross section surface, following a defined curve path.

Class structure

Implemented interfaces and base types

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

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

Properties

Defining properties

The following properties are defined on the class

Name	Type	Description	Quantity
Centreline	ICurve	Defines the central axis perpendicular to the circular cross sections, and thus the path along which the tubular surface follows.	-
Radius	double	The distance from the Curve Centreline to a point on the Pipe surface.	Length [m]
Capped	bool	Defines the Pipe as closed and therfore a solid volume.	-

Derived properties

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

Name	Type	Description	Quantity	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 Pipe. If the Pipe is capped, this returns a circle at each end of the centre curve. If the pipe is uncapped, this method returns an empty list.	-	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	Checks if the Pipe is planar, i.e. all of its parts fit in a single plane. This is true if the Centreline has a length lower than the tolerance, or if the radiues is smaller than the tolerance.	-	Geometry_Engine
ISubParts	IEnumerable<ISurface>	-	-	Geometry_Engine
ISubParts	IEnumerable<IGeometry>	-	-	Geometry_Engine
IsValid	bool	-	-	Geometry_Engine

Code and Schema

C# implementation

C#

public class Pipe : BH.oM.Geometry.ISurface, BH.oM.Geometry.IGeometry, BH.oM.Base.IObject

Assembly: Geometry_oM.dll

The C# class definition is available on github:

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

The JSON Schema is available on github here:

• Pipe.json

Example JSON instance

Example JSON instance of type Pipe.

Example JSON

{
  "_t": "BH.oM.Geometry.Pipe",
  "Centreline": {
    "_t": "BH.oM.Geometry.Line",
    "Start": {
      "_t": "BH.oM.Geometry.Point",
      "X": 0.0,
      "Y": 0.0,
      "Z": 0.0
    },
    "End": {
      "_t": "BH.oM.Geometry.Point",
      "X": 0.0,
      "Y": 0.0,
      "Z": 10.0
    },
    "Infinite": false
  },
  "Radius": 2.0,
  "Capped": true,
  "_bhomVersion": "8.2"
}