Interface IReadOnlyFOV
Read-only interface of IFOV.
Namespace: GoRogue.FOV
Assembly: GoRogue.dll
Syntax
public interface IReadOnlyFOVProperties
View SourceBooleanResultView
A view of the calculation results in boolean form, where true indicates a location is in field of view, and false indicates it is not.
Declaration
IGridView<bool> BooleanResultView { get; }Property Value
| Type | Description |
|---|---|
| IGridView<bool> |
CalculationsPerformed
A list of the parameters passed to each call to Calculate/CalculateAppend that has been performed since the last reset, in the order in which they were called.
Declaration
IReadOnlyList<FOVCalculateParameters> CalculationsPerformed { get; }Property Value
| Type | Description |
|---|---|
| IReadOnlyList<FOVCalculateParameters> |
CurrentFOV
IEnumerable of only positions currently in the field of view.
Declaration
IEnumerable<Point> CurrentFOV { get; }Property Value
| Type | Description |
|---|---|
| IEnumerable<Point> |
DoubleResultView
A view of the calculation results in double form, where a value greater than 0.0 indicates that the value is inside of FOV, and a value of 1.0 indicates the center point. All other values vary between 0.0 and 1.0, decreasing as positions get farther away from the center point.
Declaration
IGridView<double> DoubleResultView { get; }Property Value
| Type | Description |
|---|---|
| IGridView<double> |
NewlySeen
IEnumerable of positions that ARE in field of view as of the most current Calculate call, but were NOT in field of view after the previous time Calculate was called.
Declaration
IEnumerable<Point> NewlySeen { get; }Property Value
| Type | Description |
|---|---|
| IEnumerable<Point> |
NewlyUnseen
IEnumerable of positions that are NOT in field of view as of the most current Calculate call, but WERE in field of view after the previous time Calculate was called.
Declaration
IEnumerable<Point> NewlyUnseen { get; }Property Value
| Type | Description |
|---|---|
| IEnumerable<Point> |
TransparencyView
The values used to calculate field of view. Values of true are considered non-blocking (transparent) to line of sight, while false values are considered to be blocking.
Declaration
IGridView<bool> TransparencyView { get; }Property Value
| Type | Description |
|---|---|
| IGridView<bool> |
Methods
View SourceAsReadOnly()
Returns a read-only representation of the field of view.
Declaration
IReadOnlyFOV AsReadOnly()Returns
| Type | Description |
|---|---|
| IReadOnlyFOV | This FOV object, as an IReadOnlyFOV instance. |
ToString(char, char)
ToString overload that customizes the characters used to represent the map.
Declaration
string ToString(char normal = '-', char sourceValue = '+')Parameters
| Type | Name | Description |
|---|---|---|
| char | normal | The character used for any location not in FOV. |
| char | sourceValue | The character used for any location that is in FOV. |
Returns
| Type | Description |
|---|---|
| string | The string representation of FOV, using the specified characters. |
ToString(int)
Returns a string representation of the map, with the actual values in the FOV, rounded to the given number of decimal places.
Declaration
string ToString(int decimalPlaces)Parameters
| Type | Name | Description |
|---|---|---|
| int | decimalPlaces | The number of decimal places to round to. |
Returns
| Type | Description |
|---|---|
| string | A string representation of FOV, rounded to the given number of decimal places. |