Class ManualAdjustmentRegion
Implements
Namespace: Scripting
Syntax
public class ManualAdjustmentRegion : INamedItem
Constructors
ManualAdjustmentRegion(String, Region, ISpeedAdjustment)
Construct a new Manual Adjustment Region
Declaration
public ManualAdjustmentRegion(string name, Region regionToClone, ISpeedAdjustment adjustment)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | The name of the region |
Region | regionToClone | A Region to construct this manual adjustment region from (copies the points) |
ISpeedAdjustment | adjustment | The speedup value for the region |
ManualAdjustmentRegion(String, IEnumerable<IReadable2DLocation>, ISpeedAdjustment)
Construct a new Manual Adjustment Region
Declaration
public ManualAdjustmentRegion(string name, IEnumerable<IReadable2DLocation> points, ISpeedAdjustment adjustment)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | The name of the region |
System.Collections.Generic.IEnumerable<IReadable2DLocation> | points | The enumeration of points defining the region |
ISpeedAdjustment | adjustment | The speedup value for the region |
Properties
Adjustment
Get or sets the Adjustment for this region. Deprecated in favour of WindFlowAdjustmentMode
Declaration
public ISpeedAdjustment Adjustment { get; set; }
Property Value
Type | Description |
---|---|
ISpeedAdjustment |
Name
Declaration
public string Name { get; set; }
Property Value
Type | Description |
---|---|
System.String |
WindFlowAdjustmentMode
Gets the wind flow adjustment mode.
Declaration
public WindFlowRegionAdjustmentMode WindFlowAdjustmentMode { get; }
Property Value
Type | Description |
---|---|
WindFlowRegionAdjustmentMode |
Methods
Equals(ManualAdjustmentRegion)
Tests a ManualAdjustmentRegion against this current ManualAdjustmentRegion for equality.
Declaration
public bool Equals(ManualAdjustmentRegion val)
Parameters
Type | Name | Description |
---|---|---|
ManualAdjustmentRegion | val |
Returns
Type | Description |
---|---|
System.Boolean | True if equal otherwise false is returned. |
Equals(Object)
Tests a System.Object against this current ManualAdjustmentRegion 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(ManualAdjustmentRegion, ManualAdjustmentRegion)
Tests a ManualAdjustmentRegion against this current ManualAdjustmentRegion for equality.
Declaration
public static bool operator ==(ManualAdjustmentRegion a, ManualAdjustmentRegion b)
Parameters
Type | Name | Description |
---|---|---|
ManualAdjustmentRegion | a | |
ManualAdjustmentRegion | b |
Returns
Type | Description |
---|---|
System.Boolean | True if equal otherwise false is returned. |
Inequality(ManualAdjustmentRegion, ManualAdjustmentRegion)
Tests a ManualAdjustmentRegion against this current ManualAdjustmentRegion for inequality.
Declaration
public static bool operator !=(ManualAdjustmentRegion a, ManualAdjustmentRegion b)
Parameters
Type | Name | Description |
---|---|---|
ManualAdjustmentRegion | a | |
ManualAdjustmentRegion | b |
Returns
Type | Description |
---|---|
System.Boolean | True if not equal otherwise false is returned. |