BH.oM.Geometry.Point

Defines a dimensionless location in three-dimensional space.

Class structure

Implemented interfaces and base types

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

• BH.oM.Geometry.IGeometry
• BH.oM.Base.IObject
• IComparable<BH.oM.Geometry.Point>
• BH.oM.Dimensional.IElement0D
• BH.oM.Dimensional.IElement

Properties

Defining properties

The following properties are defined on the class

Name	Type	Description	Quantity
X	double	Position along global X coordinate axis.	-
Y	double	Position along global Y coordinate axis.	-
Z	double	Position along global Z coordinate axis.	-

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 Point. Will be a singluar BoundingBox with Min and Max value set to the Point.	-	Geometry_Engine
Bounds	BoundingBox	Queries the IElement0Ds BoundingBox. Acts on the Point definition of the IElement0D through the Geometry_Engine.	-	Spatial_Engine
Centroid	Point	Queries the centre of weight for the homogeneous geometrical representation of an IElement0D. Always returns the point location due to zero-dimensionality of an IElement0D.	-	Spatial_Engine
ControlPoints	List<Point>	Queries the control points of the geometrical representation of an IElement0D. Always returns the point location due to zero-dimensionality of an IElement0D.	-	Spatial_Engine
ElementCurves	List<ICurve>	Queries the defining curves of an IElement0D. Always returns empty collection due to zero-dimensionality of an IElement0D.	-	Spatial_Engine
ElementVertices	List<Point>	Returns the point from the IElement0D. Mainly to accomodate the interface method.	-	Spatial_Engine
Geometry	Point	-	-	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
IArea	double	Queries the area of the geometrical representation of an IElement.	Area [m²]	Spatial_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
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
IGeometry	Point	Queries the defining geometrical object which all spatial operations will act on.	-	Spatial_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 whether all control points of an element lie in a single plane.	-	Spatial_Engine
IIsPlanar	bool	Checks if the IGeometry is planar, i.e. all of its parts fit in a single plane.	-	Geometry_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
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 whether all control points of an element lie in a single plane.	-	Spatial_Engine
IsPlanar	bool	Checks if the Point is planar, i.e. all of its parts fit in a single plane. For a Point this is always the case, why this method always returns true.	-	Geometry_Engine
IsSelfIntersecting	bool	Checks if the one dimensional representation of the IElement0D is closer to itself than the tolerance at any two points. Always false because a zero-dimensional IElement0D does not consist of curves.	-	Spatial_Engine
ISubParts	IEnumerable<IGeometry>	-	-	Geometry_Engine
IsValid	bool	-	-	Geometry_Engine
IsValid	bool	-	-	Geometry_Engine

Code and Schema

C# implementation

C#

public class Point : BH.oM.Geometry.IGeometry,
BH.oM.Base.IObject,
System.IComparable<BH.oM.Geometry.Point>,
BH.oM.Dimensional.IElement0D,
BH.oM.Dimensional.IElement

Assembly: Geometry_oM.dll

The C# class definition is available on github:

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

The JSON Schema is available on github here:

• Point.json

Example JSON instance

Example JSON instance of type Point.

Example JSON

{
  "_t": "BH.oM.Geometry.Point",
  "X": 1.0,
  "Y": 2.0,
  "Z": 3.0,
  "_bhomVersion": "8.2"
}