Click or drag to resize

PointyHexGridTCell Class

A grid for pointy hexagons, that is, hexagons with two vertical edges.
Inheritance Hierarchy
SystemObject
  Gamelogic.GridsAbstractUniformGridTCell, PointyHexPoint
    Gamelogic.GridsPointyHexGridTCell

Namespace:  Gamelogic.Grids
Assembly:  Assembly-CSharp (in Assembly-CSharp.dll) Version: 0.0.0.0
Syntax
C#
Copy
[SerializableAttribute]
[VersionAttribute(1, 0, 0)]
public class PointyHexGrid<TCell> : AbstractUniformGrid<TCell, PointyHexPoint>, 
	IEvenGrid<TCell, PointyHexPoint, PointyHexPoint>, IVectorGrid<TCell, PointyHexPoint, PointyHexPoint>, 
	IGrid<TCell, PointyHexPoint>, IGrid<PointyHexPoint>, IGridSpace<PointyHexPoint>, 
	IEnumerable<PointyHexPoint>, IEnumerable, ISupportsVertexGrid<FlatTriPoint>, 
	ISupportsEdgeGrid<PointyRhombPoint>

Type Parameters

TCell

The PointyHexGridTCell type exposes the following members.

Constructors
  NameDescription
Public methodPointyHexGridTCell(Int32, Int32)
Construct a new grid in the default shape with the given width and height. No transformations are applied to the grid. Normally, the static factory methods or shape building methods should be used to create grids. These constructors are provided for advanced usage.
Public methodPointyHexGridTCell(Int32, Int32, FuncPointyHexPoint, Boolean)
Construct a new grid whose cells are determined by the given test function. The test function should only return true for points within the bounds of the default shape. No transformations are applied to the grid. Normally, the static factory methods or shape building methods should be used to create grids. These constructors are provided for advanced usage.
Public methodPointyHexGridTCell(Int32, Int32, FuncPointyHexPoint, Boolean, PointyHexPoint)
Construct a new grid whose cells are determined by the given test function. The function should only return true for points within the bounds of the rectangle when the given transforms are applied to them. Normally, the static factory methods or shape building methods should be used to create grids. These constructors are provided for advanced usage.
Public methodPointyHexGridTCell(Int32, Int32, FuncPointyHexPoint, Boolean, FuncPointyHexPoint, PointyHexPoint, FuncPointyHexPoint, PointyHexPoint)
Public methodPointyHexGridTCell(Int32, Int32, FuncPointyHexPoint, Boolean, FuncPointyHexPoint, PointyHexPoint, FuncPointyHexPoint, PointyHexPoint, IEnumerablePointyHexPoint)
Top
Properties
Methods
  NameDescription
Public methodStatic memberArrayPointFromGridPoint
Protected methodArrayPointFromPoint(PointyHexPoint) (Overrides AbstractUniformGridTCell, TPointArrayPointFromPoint(TPoint).)
Protected methodArrayPointFromPoint(Int32, Int32) (Overrides AbstractUniformGridTCell, TPointArrayPointFromPoint(Int32, Int32).)
Public methodStatic memberBeginShape
Use this method to begin a shape building sequence.
Public methodStatic memberCalculateStorage
Public methodCloneStructureTNewCellType
Returns a grid in the same shape, but with contents in the new type.
(Overrides AbstractUniformGridTCell, TPointCloneStructureTNewCell.)
Public methodContains
Checks whether the given point is inside the grid, or not. This function must be consistent with the enumerator that is returned with GetEnumerator(all points returned by the enumerator must be Inside, and all points that are inside must be returned by the enumerator).
(Inherited from AbstractUniformGridTCell, TPoint.)
Public methodStatic memberDefault
Public methodStatic memberDefaultContains
Public methodStatic memberDiamond
Public methodStatic memberDownTriangle
Public methodEquals (Inherited from Object.)
Public methodStatic memberFatRectangle
Protected methodFinalize (Inherited from Object.)
Public methodGetAllNeighbors (Inherited from AbstractUniformGridTCell, TPoint.)
Public methodGetEnumerator (Inherited from AbstractUniformGridTCell, TPoint.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetLargeSet
This functions returns a large number of points around the origin. This is useful(when used with big enough n) to determine whether a grid that is missing points is doing so becuase of an incorrect test function, or an incorrect storage rectangle. Use for debugging.
(Inherited from AbstractUniformGridTCell, TPoint.)
Public methodGetNeighborDirections
The only legal cellIndex to pass to this methid is 0
(Inherited from AbstractUniformGridTCell, TPoint.)
Public methodGetPrincipleNeighborDirections
Public methodGetSpiralIterator(Int32)
An iterator that spirals anti-clockwise around the grid origin (0, 0).
Public methodCode exampleGetSpiralIterator(PointyHexPoint, Int32)
An iterator that spirals anti-clockwise around the given origin.
Public methodGetStoragePoints
This method returns all points that can be contined by the storage rectangle for this grid. This is useful for debuggong shape functions.
(Inherited from AbstractUniformGridTCell, TPoint.)
Public methodGetType (Inherited from Object.)
Public methodStatic memberGridPointFromArrayPoint
Public methodStatic memberHexagon(Int32)
Public methodStatic memberHexagon(PointyHexPoint, Int32)
Public methodStatic memberHorizontallyWrappedParallelogram
Returns a grid wrapped horizontally along a parallelogram. Since version 1.7
Public methodStatic memberHorizontallyWrappedRectangle
Returns a grid wrapped horizontally along a parallelogram.
Public methodMakeEdgeGridTNewCell
Makes an edge grid for this grid.
Public methodMakeVertexGridTNewCell
Protected methodMemberwiseClone (Inherited from Object.)
Public methodStatic memberParallelogram
Protected methodPointFromArrayPoint (Overrides AbstractUniformGridTCell, TPointPointFromArrayPoint(Int32, Int32).)
Public methodStatic memberRectangle
Public methodSetGridPointTransforms
Set the GridPointTransform and InverseGridPointTransform.
(Inherited from AbstractUniformGridTCell, TPoint.)
Public methodStatic memberSingle
Public methodStatic memberThinRectangle
Public methodToString (Overrides ObjectToString.)
Public methodStatic memberUpTriangle
Public methodStatic memberVerticallyWrappedParallelogram
Returns a grid wrapped vertically along a parallelogram. Since version 1.7
Public methodStatic memberWrappedHexagon
Returns a new grid, wrapped along a Hexagon with the given side length.
Public methodStatic memberWrappedParallelogram
Returns a grid wrapped along a parallelogram. Since version 1.7
Top
Fields
Extension Methods
  NameDescription
Public Extension MethodButFirstPointyHexPoint
Returns an enumerable of all elements of the given list but the first, keeping them in order.
(Defined by CollectionExtensions.)
Public Extension MethodButLastPointyHexPoint
Returns an enumerable of all elements in the given list but the last, keeping them in order.
(Defined by CollectionExtensions.)
Public Extension MethodCombinationsPointyHexPoint
Generates all combinations of m elements selected from the list.
(Defined by Combinatorial.)
Public Extension MethodListToStringPointyHexPoint
Returns a pretty string representation of the given list. The resulting string looks something like [a, b, c].
(Defined by CollectionExtensions.)
Public Extension MethodMaxByPointyHexPoint(FuncPointyHexPoint, IComparable)Overloaded.
Finds the maximum element in the source as scored by the given function.
(Defined by CollectionExtensions.)
Public Extension MethodMaxByPointyHexPoint, TKey(FuncPointyHexPoint, TKey)Overloaded.
Finds the minimum element in the source as scored by its projection.
(Defined by CollectionExtensions.)
Public Extension MethodMaxByPointyHexPoint, TKey(FuncPointyHexPoint, TKey, IComparerTKey)Overloaded.
Finds the minimum element in the source as scored by the given function applied to a projection on the elements.
(Defined by CollectionExtensions.)
Public Extension MethodMinByPointyHexPoint, TKey(FuncPointyHexPoint, TKey)Overloaded.
Finds the minimum element in the source as scored by its projection.
(Defined by CollectionExtensions.)
Public Extension MethodMinByPointyHexPoint, TKey(FuncPointyHexPoint, TKey, IComparerTKey)Overloaded.
Finds the minimum element in the source as scored by the given function applied to a projection on the elements.
(Defined by CollectionExtensions.)
Public Extension MethodPartitionsPointyHexPoint
Returns a list of all the partitions of a list.
(Defined by Combinatorial.)
Public Extension MethodPermutationsPointyHexPoint
Generates all permutations of the list of elements.
(Defined by Combinatorial.)
Public Extension MethodPowerSetPointyHexPoint
Returns the power set of the input, that is, the set of all subsets of the input.
(Defined by Combinatorial.)
Public Extension MethodRandomItemPointyHexPointOverloaded.
Returns a random element from a source.
(Defined by CollectionExtensions.)
Public Extension MethodRandomItemPointyHexPoint(IRandom)Overloaded.
Returns a random element from a source.
(Defined by CollectionExtensions.)
Public Extension MethodRotateLeftPointyHexPoint
Returns a enumerable with elements in order, but the first element is moved to the end.
(Defined by CollectionExtensions.)
Public Extension MethodRotateRightPointyHexPoint
Returns a enumerable with elements in order, but the last element is moved to the front.
(Defined by CollectionExtensions.)
Public Extension MethodSampleRandomPointyHexPoint(Int32)Overloaded.
Returns a random sample from a source.
(Defined by CollectionExtensions.)
Public Extension MethodSampleRandomPointyHexPoint(Int32, IRandom)Overloaded.
Returns a random sample from a source.
(Defined by CollectionExtensions.)
Public Extension MethodTakeHalfPointyHexPoint
Returns the first half of elements from a source.
(Defined by CollectionExtensions.)
Public Extension MethodTakeLastPointyHexPoint
Returns the last n elements from a source.
(Defined by CollectionExtensions.)
Public Extension MethodThrowIfNull
Throws a NullReferenceException if the object is null.
(Defined by ObjectExtensions.)
Public Extension MethodToPeriodicGeneratorPointyHexPoint (Defined by GeneratorExtensions.)
Public Extension MethodToRandomElementGeneratorPointyHexPoint (Defined by GeneratorExtensions.)
Public Extension MethodTuplesPointyHexPoint (Defined by Combinatorial.)
Top
Explicit Interface Implementations
See Also