PlotId Structure
Represents the identity of a plot in a PlotLayer.
Namespace: Carmenta.Engine
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECore assembly)
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECore assembly)
Thread safety: Members defined in this class are thread-safe.
Syntax
public struct PlotId :
System.IComparable<PlotId>,
System.IEquatable<PlotId>Remarks
An PlotId is used to identify a plot in a PlotLayer. It consists of the layer identity, the batch identity in that layer, and the index of the plot in that batch. The type is immutable.
Platforms
Windows, Linux, Android
PlotId Members
The PlotId type has the following members.
Constructors
| Name | Description |
|---|---|
| PlotId | Overloaded. Creates a new PlotId. |
Properties
| Name | Description |
|---|---|
| BatchId | Gets the batch identity in this PlotId. |
| Index | Gets the plot index. |
| LayerId | Gets the layer identity in this PlotId. |
Methods
| Name | Description |
|---|---|
| CompareTo | Compares this PlotId with another PlotId. |
| Equals | Overloaded. Determines whether two PlotId objects have the same value. |
| GetHashCode | Returns the hash code for this PlotId. |
 Operator == | Determines whether two specified PlotId objects have the same value. |
| Operator != | Determines whether two specified PlotId objects have different values. |
| ToString | Converts this PlotId to a human readable string. |