 | ISplicedPointTPoint, TBasePoint Interface |
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.
Namespace: Gamelogic.Grids
Assembly: Assembly-CSharp (in Assembly-CSharp.dll) Version: 0.0.0.0
SyntaxC#
[VersionAttribute(1, 0, 0)] public interface ISplicedPoint<TPoint, TBasePoint> : IGridPoint<TPoint>, IEquatable<TPoint>, IGridPoint, ISplicedVectorPoint<TPoint, TBasePoint> where TPoint : Object, ISplicedVectorPoint<TPoint, TBasePoint>, IGridPoint<TPoint> where TBasePoint : Object, 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
The ISplicedPointTPoint, TBasePoint type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | 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.
|
| I |
Returns the splice idnex for this point.
|
| SpliceCount |
For spliced grids, this is the number of slices for all points.
For Uniform grids, this is always 1.
(Inherited from IGridPointTPoint.) |
| SpliceIndex |
For spliced grids, this is the index of the splice.
For Uniform grids, this is always 0.
(Inherited from IGridPointTPoint.) |
| X |
Returns the X-coordinate of this point.
|
| Y |
Returns the Y-coordinate of this point.
|
Methods| Name | Description | |
|---|---|---|
 | DecIndex | |
| DistanceFrom |
The lattice distance between two points.
Two points should have a distance of 1 if and only if they are neighbors.
(Inherited from IGridPointTPoint.) |
| Equals | (Inherited from IEquatableTPoint.) |
| IncIndex | |
| InvertIndex | |
| MoveBackBy |
If a spliced vectors u and v has base vector B and index I
(Inherited from ISplicedVectorPointTPoint, TVectorPoint.) |
| MoveBy |
If a spliced vectors u and v has base vector B and index I,
(Inherited from ISplicedVectorPointTPoint, TVectorPoint.) |
| Negate |
Returns a new point with the vector component negated.
(Inherited from ISplicedVectorPointTPoint, TVectorPoint.) |
| Subtract |
Translates this point by the negation of the given vector.
(Inherited from ISplicedVectorPointTPoint, TVectorPoint.) |
| Translate |
Translate this point by the given vector.
(Inherited from ISplicedVectorPointTPoint, TVectorPoint.) |
See Also