BH.oM.Environment.IEnvironmentObject¶
Interface structure¶
Implemented interfaces and base types¶
The IEnvironmentObject is inheriting from the following base type(s) and implements the following interfaces:
- BH.oM.Base.IBHoMObject
- BH.oM.Base.IObject
Interfaces implementing this interface¶
The following interfaces are implementing this interface:
- BH.oM.Environment.IClimateObject
Classes implementing this interface¶
The following classes are implementing this interface:
- BH.oM.Environment.SpaceCriteria.Profile
- BH.oM.Environment.SpaceCriteria.Thermostat
- BH.oM.Environment.Elements.BoundaryZone
- BH.oM.Environment.Elements.Building
- BH.oM.Environment.Elements.Edge
- BH.oM.Environment.Elements.Mesh
- BH.oM.Environment.Elements.Opening
- BH.oM.Environment.Elements.Panel
- BH.oM.Environment.Elements.Space
- BH.oM.Environment.Climate.Location
- BH.oM.Environment.Climate.Sun
- BH.oM.Environment.Climate.Time
Properties¶
Derived properties¶
The following properties are defined as extension methods in one of the BHoM_Engines
| Name | Type | Description | Quantity | Engine |
|---|---|---|---|---|
| Altitude | double | Returns the minimum altitude of an Environment Object as the minimum z value from the bounding box of the geometry | - | Environment_Engine |
| AltitudeRange | double | Returns the range of altitude of an Environment Object taken as the maximum z value minus minimum z value from the bounding box of the geometry | - | Environment_Engine |
| Bottom | ICurve | Returns the bottom of a given environment object. | - | Environment_Engine |
| ExplodeToParts | Output<List<ICurve>, List<ICurve>, List<ICurve>> | Returns the sides, top and bottom of a given environment object. | - | Environment_Engine |
| Height | double | Returns the height of a generic Environment Object | - | Environment_Engine |
| Inclination | double | Returns the inclination of a generic Environment Object | - | Environment_Engine |
| Orientation | Nullable<double> | Returns the angle to north of a given environmental object on an xyPlane | - | Environment_Engine |
| Polyline | Polyline | Returns the external boundary from a generic Environment Object | - | Environment_Engine |
| Sides | List<ICurve> | Returns the sides of a given environment object. | - | Environment_Engine |
| Tilt | double | Returns the tilt of an Environment Object | - | Environment_Engine |
| ToLines | List<Line> | Returns the external boundary from a generic Environment Object | - | Environment_Engine |
| Top | ICurve | Returns the top of a given environment object. | - | Environment_Engine |
| Width | double | Returns the width of a generic Environment Object | - | Environment_Engine |
Code and Schema¶
C# implementation¶
Assembly: Environment_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/Environment_oM/IEnvironmentObject.json"
}
The JSON Schema is available on github here: