Class BuildingRegion
Building region
Namespace: Scripting
Syntax
public class BuildingRegion
Constructors
BuildingRegion()
Creates an instance of the BuildingRegion class.
Declaration
public BuildingRegion()
Properties
Bounds
Gets the bounding box of this building region.
Declaration
public Rect Bounds { get; }
Property Value
Type | Description |
---|---|
Rect |
BuildingBoundaryType
Declaration
public BuildingBoundaryType BuildingBoundaryType { get; set; }
Property Value
Type | Description |
---|---|
BuildingBoundaryType |
Height
Declaration
public double Height { get; set; }
Property Value
Type | Description |
---|---|
System.Double |
Name
Name of the Building region
Declaration
public string Name { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Points
Gets the points that define the boundary of the building region.
Declaration
public IEnumerable<IReadable2DLocation> Points { get; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<IReadable2DLocation> |
Methods
AddParapets(Double, Double, Boolean)
Adds parapets to the building.
Declaration
public void AddParapets(double parapetHeight, double parapetWidth, bool createSeparateParapetPerEdge)
Parameters
Type | Name | Description |
---|---|---|
System.Double | parapetHeight | Height of the parapet. |
System.Double | parapetWidth | Width of the parapet. |
System.Boolean | createSeparateParapetPerEdge | if set to |
Equals(BuildingRegion)
Tests a BuildingRegion against this current BuildingRegion for equality.
Declaration
public bool Equals(BuildingRegion val)
Parameters
Type | Name | Description |
---|---|---|
BuildingRegion | val |
Returns
Type | Description |
---|---|
System.Boolean | True if equal otherwise false is returned. |
Equals(Object)
Tests a System.Object against this current BuildingRegion for equality.
Declaration
public override bool Equals(object toCompare)
Parameters
Type | Name | Description |
---|---|---|
System.Object | toCompare |
Returns
Type | Description |
---|---|
System.Boolean | True if object is equal otherwise false is returned. |
Overrides
GetHashCode()
Gets the hash code for this object.
Declaration
public override int GetHashCode()
Returns
Type | Description |
---|---|
System.Int32 | The hash code for this object. |
Overrides
Operators
Equality(BuildingRegion, BuildingRegion)
Tests a BuildingRegion against this current BuildingRegion for equality.
Declaration
public static bool operator ==(BuildingRegion a, BuildingRegion b)
Parameters
Type | Name | Description |
---|---|---|
BuildingRegion | a | |
BuildingRegion | b |
Returns
Type | Description |
---|---|
System.Boolean | True if equal otherwise false is returned. |
Inequality(BuildingRegion, BuildingRegion)
Tests a BuildingRegion against this current BuildingRegion for inequality.
Declaration
public static bool operator !=(BuildingRegion a, BuildingRegion b)
Parameters
Type | Name | Description |
---|---|---|
BuildingRegion | a | |
BuildingRegion | b |
Returns
Type | Description |
---|---|
System.Boolean | True if not equal otherwise false is returned. |