Interface ISplicedPoint<TPoint, TBasePoint>
Interface for working with compound points.
Spliced points are used for periodic grids where not all faces are identical(see AbstractSplicedGrid).
Every spliced grid can be seen as a uniform regular grid, where each cell has been divided.Therefore, a spliced point consists of a coordinate on the base grid, and an index denoting the particular cell.
[Version(1, 0, 0)]
public interface ISplicedPoint<TPoint, TBasePoint> : IGridPoint<TPoint>, IEquatable<TPoint>, IGridPoint, ISplicedVectorPoint<TPoint, TBasePoint> where TPoint : ISplicedVectorPoint<TPoint, TBasePoint>, IGridPoint<TPoint> where TBasePoint : IVectorPoint<TBasePoint>, IGridPoint<TBasePoint>
Type Parameters
TPoint
The type that implements this interface
TBasePoint
The type of the refular grid that underlies this grid.For example, a hexagonal grid underlies regular triangular grids
- Inherited Members
- Extension Methods
Properties
BasePoint
Why is this public? - Convenience - Algorithm Design Otherwise the user will just make a new basepoint in any case, and perhaps make a mistake.
TBasePoint BasePoint { get; }
Property Value
- TBasePoint
I
Returns the splice idnex for this point.
int I { get; }
Property Value
X
Returns the X-coordinate of this point.
[Version(1, 2, 0)]
int X { get; }
Property Value
Y
Returns the Y-coordinate of this point.
[Version(1, 2, 0)]
int Y { get; }
Property Value
Methods
DecIndex(int)
TPoint DecIndex(int n)
Parameters
n
int
Returns
- TPoint
IncIndex(int)
TPoint IncIndex(int n)
Parameters
n
int
Returns
- TPoint
InvertIndex()
TPoint InvertIndex()
Returns
- TPoint