Skip to content

BH.oM.Spatial.Layouts.ExplicitLayout

Layout for freeform control over the point distribution

Class structure

Implemented interfaces and base types

The ExplicitLayout 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
Points ReadOnlyCollection<Point> The explicit grid of points in the layout -

Inherited properties

The following properties are inherited from the base class of the object

Name Type Description Quantity
BHoM_Guid Guid - -
Name string - -
Fragments FragmentSet - -
Tags HashSet<string> - -
CustomData Dictionary<string, object> - -

Derived properties

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

Name Type Description Quantity Engine
IsNull bool Checks if an Layout2D is null and outputs relevant error message. - Spatial_Engine
PointLayout List<Point> Returns the points in the layout. For ExplicitLayouts, the host geometry will be ignored. - Spatial_Engine

Code and Schema

C# implementation

C#
public class ExplicitLayout : BH.oM.Base.BHoMObject, BH.oM.Base.IBHoMObject, BH.oM.Base.IObject, BH.oM.Spatial.Layouts.ILayout2D, BH.oM.Base.IImmutable

Assembly: Spatial_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/Spatial_oM/Layouts/ExplicitLayout.json"
}

The JSON Schema is available on github here: