Skip to content

BH.oM.Geometry.Plane

Defines a flat infinite two-dimensional surface

Class structure

Implemented interfaces and base types

The Plane 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
Origin Point A point through which the plane passes -
Normal Vector Vector perpendicualar to the plane, defining the orientation in three-dimensional space -

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 BoundingBox of the Plane. If the Plane is parallel to any of the world axis, the returned BoundingBox will be an infinite flat box in the plane. If not, the rturned box will be infinite box in all coordinate directions. - 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
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
IsPlanar bool Checks if the Plane is planar, i.e. all of its parts fit in a single plane. For a Plane this is always the case, why this method always returns true. - Geometry_Engine
ISubParts IEnumerable<IGeometry> - - Geometry_Engine
IsValid bool - - Geometry_Engine

Code and Schema

C# implementation

C#
public class Plane : BH.oM.Geometry.IGeometry, BH.oM.Base.IObject

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

The JSON Schema is available on github here:

Example JSON instance

Example JSON instance of type Plane.

Example JSON
{
  "_t": "BH.oM.Geometry.Plane",
  "Origin": {
    "_t": "BH.oM.Geometry.Point",
    "X": 0.0,
    "Y": 0.0,
    "Z": 0.0
  },
  "Normal": {
    "_t": "BH.oM.Geometry.Vector",
    "X": 0.0,
    "Y": 0.0,
    "Z": 1.0
  },
  "_bhomVersion": "8.2"
}