Interface IReadOnlySenseMap
Read-only interface of an ISenseMap.
Namespace: GoRogue.SenseMapping
Assembly: GoRogue.dll
Syntax
public interface IReadOnlySenseMap
Properties
View SourceCurrentSenseMap
IEnumerable of only positions currently "in" the sense map, eg. all positions that have a value other than 0.0.
Declaration
IEnumerable<Point> CurrentSenseMap { get; }
Property Value
Type | Description |
---|---|
IEnumerable<Point> |
NewlyInSenseMap
IEnumerable of positions that DO have a non-zero value in the sense map as of the most current Calculate call, but DID NOT have a non-zero value after the previous time Calculate was called.
Declaration
IEnumerable<Point> NewlyInSenseMap { get; }
Property Value
Type | Description |
---|---|
IEnumerable<Point> |
NewlyOutOfSenseMap
IEnumerable of positions that DO NOT have a non-zero value in the sense map as of the most current Calculate call, but DID have a non-zero value after the previous time Calculate was called.
Declaration
IEnumerable<Point> NewlyOutOfSenseMap { get; }
Property Value
Type | Description |
---|---|
IEnumerable<Point> |
ResistanceView
The resistance map used to perform calculations.
Declaration
IGridView<double> ResistanceView { get; }
Property Value
Type | Description |
---|---|
IGridView<double> |
ResultView
A view of the sense map's calculation results.
Declaration
IGridView<double> ResultView { get; }
Property Value
Type | Description |
---|---|
IGridView<double> |
SenseSources
Read-only list of all sources currently considered part of the sense map. Some may have their Enabled flag set to false, so all of these may or may not be counted when Calculate is called.
Declaration
IReadOnlyList<ISenseSource> SenseSources { get; }
Property Value
Type | Description |
---|---|
IReadOnlyList<ISenseSource> |
Methods
View SourceAsReadOnly()
Returns a read-only representation of the sensory map.
Declaration
IReadOnlySenseMap AsReadOnly()
Returns
Type | Description |
---|---|
IReadOnlySenseMap | This sensory map object as IReadOnlySenseMap. |