Class ExclusionRegion
Exclusion region
Namespace: Scripting
Syntax
public class ExclusionRegion
Constructors
ExclusionRegion()
Creates an instance of the ExclusionRegion class.
Declaration
public ExclusionRegion()
Properties
ActualHeight
Gets the actual height of the bounding rectangle of this exclusion region.
Declaration
public double ActualHeight { get; }
Property Value
Type | Description |
---|---|
System.Double |
ActualWidth
Gets the actual width (of the bounding rectangle) of this exclusion region.
Declaration
public double ActualWidth { get; }
Property Value
Type | Description |
---|---|
System.Double |
Bounds
Gets the bounding box of this exclusion region.
Declaration
public Rect Bounds { get; }
Property Value
Type | Description |
---|---|
Rect |
Name
Name of the exclusion region
Declaration
public string Name { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Points
Gets the points that define the boundary of the exclusion region.
Declaration
public IEnumerable<IReadable2DLocation> Points { get; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<IReadable2DLocation> |
Methods
Equals(ExclusionRegion)
Tests a ExclusionRegion against this current ExclusionRegion for equality.
Declaration
public bool Equals(ExclusionRegion val)
Parameters
Type | Name | Description |
---|---|---|
ExclusionRegion | val |
Returns
Type | Description |
---|---|
System.Boolean | True if equal otherwise false is returned. |
Equals(Object)
Tests a System.Object against this current ExclusionRegion 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(ExclusionRegion, ExclusionRegion)
Tests a ExclusionRegion against this current ExclusionRegion for equality.
Declaration
public static bool operator ==(ExclusionRegion a, ExclusionRegion b)
Parameters
Type | Name | Description |
---|---|---|
ExclusionRegion | a | |
ExclusionRegion | b |
Returns
Type | Description |
---|---|
System.Boolean | True if equal otherwise false is returned. |
Inequality(ExclusionRegion, ExclusionRegion)
Tests a ExclusionRegion against this current ExclusionRegion for inequality.
Declaration
public static bool operator !=(ExclusionRegion a, ExclusionRegion b)
Parameters
Type | Name | Description |
---|---|---|
ExclusionRegion | a | |
ExclusionRegion | b |
Returns
Type | Description |
---|---|
System.Boolean | True if not equal otherwise false is returned. |