Interface ICellType
An ICellType gives summarized info about a single cell in isolation of the grid it comes from.
ICellType allows you to enumerate the edges/faces/corners of a cell, and work with cell symmetries (called CellRotation).
ICellType's are always singletons, e.g. SquareCellType.Instance is used for all square cells.
Note that cells can share an cell type, even if they are different shapes. Thus any methods that refer to positions, such as GetMatrix,
don't refer to the specific cell in the grid, but the "canonical" cell.
You must use IGrid methods like GetPolygon or GetDeformation to get the shape of a specific cell.
The canonical cell is usually a regular polygon or polyhedron of unit size centered on the origin. See the docs for more details
Assembly: Sylves.dll
Syntax
public interface ICellType
Properties
RotateCCW
Declaration
CellRotation RotateCCW { get; }
Property Value
RotateCW
Declaration
CellRotation RotateCW { get; }
Property Value
Methods
Declaration
string Format(CellCorner corner)
Parameters
Returns
| Type |
Description |
| System.String |
|
Declaration
string Format(CellDir dir)
Parameters
Returns
| Type |
Description |
| System.String |
|
Declaration
string Format(CellRotation rotation)
Parameters
Returns
| Type |
Description |
| System.String |
|
GetCellCorners()
Gets all the CellCorner used by this cell type.
Declaration
IEnumerable<CellCorner> GetCellCorners()
Returns
| Type |
Description |
| System.Collections.Generic.IEnumerable<CellCorner> |
|
GetCellDirs()
Gets all the CellDir used by this cell type.
Declaration
IEnumerable<CellDir> GetCellDirs()
Returns
| Type |
Description |
| System.Collections.Generic.IEnumerable<CellDir> |
|
GetCornerPosition(CellCorner)
Returns the position of a given corner in the canonical cell shape.
Note: This method describes the canonical cell shape, but many shapes of cell might reference this cell type.
Declaration
Vector3 GetCornerPosition(CellCorner corner)
Parameters
Returns
GetIdentity()
Returns the rotation that leaves everything unchanged
Declaration
CellRotation GetIdentity()
Returns
GetMatrix(CellRotation)
Returns the matrix a given rotation corresponds to.
Note: This method works for the canonical cell shape, but many shapes of cell might reference this cell type.
Declaration
Matrix4x4 GetMatrix(CellRotation cellRotation)
Parameters
Returns
GetRotations(Boolean)
Gets all possible rotations of this cell type.
Declaration
IList<CellRotation> GetRotations(bool includeReflections = false)
Parameters
| Type |
Name |
Description |
| System.Boolean |
includeReflections |
|
Returns
| Type |
Description |
| System.Collections.Generic.IList<CellRotation> |
|
Invert(CellDir)
Returns the dir pointing in the opposite direction, if it exists.
Declaration
Nullable<CellDir> Invert(CellDir dir)
Parameters
Returns
| Type |
Description |
| System.Nullable<CellDir> |
|
Invert(CellRotation)
Gets the inverse rotation.
i.e. GetIdentity() == Multiply(a, Invert(a)) == Multiply(Invert(a), a)
Declaration
CellRotation Invert(CellRotation a)
Parameters
Returns
Multiply(CellRotation, CellRotation)
Composes two rotations/reflections together, doing b first, then a.
Declaration
CellRotation Multiply(CellRotation a, CellRotation b)
Parameters
Returns
Rotate(CellCorner, CellRotation)
Declaration
CellCorner Rotate(CellCorner dir, CellRotation rotation)
Parameters
Returns
Rotate(CellDir, CellRotation)
Rotates a dir by the given rotation.
Declaration
CellDir Rotate(CellDir dir, CellRotation rotation)
Parameters
Returns
Rotate(CellDir, CellRotation, out CellDir, out Connection)
Declaration
void Rotate(CellDir dir, CellRotation rotation, out CellDir resultDir, out Connection connection)
Parameters
TryGetRotation(CellDir, CellDir, Connection, out CellRotation)
Declaration
bool TryGetRotation(CellDir fromDir, CellDir toDir, Connection connection, out CellRotation cellRotation)
Parameters
Returns
| Type |
Description |
| System.Boolean |
|