BH.oM.Analytical.Elements.IEdge¶
Interface structure¶
Implemented interfaces and base types¶
The IEdge is inheriting from the following base type(s) and implements the following interfaces:
- BH.oM.Base.IBHoMObject
- BH.oM.Base.IObject
- BH.oM.Analytical.IAnalytical
- BH.oM.Dimensional.IElement1D
- BH.oM.Dimensional.IElement
Classes implementing this interface¶
The following classes are implementing this interface:
Properties¶
Defining properties¶
The following properties are defined on the interface
| Name | Type | Description | Quantity |
|---|---|---|---|
| Curve | ICurve | - | - |
Derived properties¶
The following properties are defined as extension methods in one of the BHoM_Engines
| Name | Type | Description | Quantity | Engine |
|---|---|---|---|---|
| Bounds | BoundingBox | Queries the IElement1Ds BoundingBox. Acts on the ICurve definition of the IElement1D through the Geometry_Engine. | - | Spatial_Engine |
| Centroid | Point | Queries the centre of weight for a IElement1Ds ICurve representation. | - | Spatial_Engine |
| ControlPoints | List<Point> | Queries the control points of the one dimensional representation of the IElement1D. | - | Spatial_Engine |
| DominantVector | Vector | Gets the the dominant vector (orientation) of an Element1D based on its lines lengths. | - | Spatial_Engine |
| ElementCurves | List<ICurve> | Queries the defining curves of an IElement1D. | - | Spatial_Engine |
| ElementVertices | List<Point> | Returns the discontinuity points from the defining ICurve of the IElement1D. | - | Spatial_Engine |
| Geometry | ICurve | Gets the geometry of a IEdge as its Curve. Method required for automatic display in UI packages. | - | Analytical_Engine |
| IArea | double | Queries the area of the geometrical representation of an IElement. | Area [m²] | Spatial_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 |
| IElements0D | List<IElement0D> | Queries the IElement0Ds from a IElement1D. Returns null if no IElement0Ds are defined for the type of IElement1D. | - | Spatial_Engine |
| IElementVertices | List<Point> | Returns the discontinuity points from the defining ICurves of the IElement. | - | Spatial_Engine |
| IGeometry | ICurve | Queries the defining geometrical object which all spatial operations will act on. | - | Spatial_Engine |
| IIsPlanar | bool | Checks whether all control points of an element lie in a single plane. | - | Spatial_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 |
| IPrimaryPropertyName | string | Returns the name of an elements primary defining property | - | Facade_Engine |
| IsPlanar | bool | Checks whether all control points of an element lie in a single plane. | - | Spatial_Engine |
| IsSelfIntersecting | bool | Checks if the one dimensional representation of the IElement1D is closer to itself than the tolerance at any two points. | - | Spatial_Engine |
| Length | double | Returns the length of the IElement1Ds curve. | Length [m] | Spatial_Engine |
| PrimaryPropertyName | string | Returns the name of a frameEdge's primary defining property | - | Facade_Engine |
Code and Schema¶
C# implementation¶
C#
public interface IEdge : BH.oM.Base.IBHoMObject,
BH.oM.Base.IObject,
BH.oM.Analytical.IAnalytical,
BH.oM.Dimensional.IElement1D,
BH.oM.Dimensional.IElement
Assembly: Analytical_oM.dll
The C# interface 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/Analytical_oM/Elements/IEdge.json"
}
The JSON Schema is available on github here: