RepeaterBounds.AreCoordinatesInBounds
Method
Description:
Determines whether given coordinates are within the bounds.
Determines whether given coordinates are within the bounds.
Remarks:
The coordinates must have the same number of dimensions as the bounds. This method does not apply to zero dimensional bounds.
The coordinates must have the same number of dimensions as the bounds. This method does not apply to zero dimensional bounds.
Syntax
public bool AreCoordinatesInBounds(
RepeaterCoordinates coordinates,
bool treatCyclicalBoundsAsInfinite
)
Parameters
Parameter | Type | Description |
---|---|---|
coordinates | RepeaterCoordinates | The coordinates. |
treatCyclicalBoundsAsInfinite | Boolean | True if cyclical directions should be treated as unbounded. |
Return Value
Type | Description |
---|---|
Boolean | True if the coordinates are within the bounds. |
Exceptions
Exception | Condition |
---|---|
ArgumentException | The coordinates coordinates have incompatible number of dimensions. |
ArgumentNullException | A non-optional argument was null |
InvalidOperationException | The bounds must have at least one dimension. |