Class SquareCellType

Handles cell information about squares. This is a a customized version of NGonCellType and behaves virtually identically.

The canonical shape (for use with deformations) is a unit square in the XY centered at the origin, with normal pointing Z-forward.

Inheritance
object
SquareCellType
Implements
Inherited Members
Namespace: Sylves
Assembly: Sylves.dll
Syntax
public class SquareCellType : ICellType

Properties

Instance

Declaration
public static SquareCellType Instance { get; }
Property Value
Type Description
SquareCellType

N

Declaration
public int N { get; }
Property Value
Type Description
int

RotateCCW

Declaration
public CellRotation RotateCCW { get; }
Property Value
Type Description
CellRotation

RotateCW

Declaration
public CellRotation RotateCW { get; }
Property Value
Type Description
CellRotation

Methods

Format(CellCorner)

Declaration
public string Format(CellCorner corner)
Parameters
Type Name Description
CellCorner corner
Returns
Type Description
string

Format(CellDir)

Declaration
public string Format(CellDir dir)
Parameters
Type Name Description
CellDir dir
Returns
Type Description
string

Format(CellRotation)

Declaration
public string Format(CellRotation rotation)
Parameters
Type Name Description
CellRotation rotation
Returns
Type Description
string

GetCellCorners()

Gets all the CellCorner used by this cell type.

Declaration
public IEnumerable<CellCorner> GetCellCorners()
Returns
Type Description
IEnumerable<CellCorner>

GetCellDirs()

Gets all the CellDir used by this cell type.

Declaration
public IEnumerable<CellDir> GetCellDirs()
Returns
Type Description
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
public Vector3 GetCornerPosition(CellCorner corner)
Parameters
Type Name Description
CellCorner corner
Returns
Type Description
Vector3

GetIdentity()

Returns the rotation that leaves everything unchanged

Declaration
public CellRotation GetIdentity()
Returns
Type Description
CellRotation

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
public Matrix4x4 GetMatrix(CellRotation cellRotation)
Parameters
Type Name Description
CellRotation cellRotation
Returns
Type Description
Matrix4x4

GetRotations(bool)

Gets all possible rotations of this cell type.

Declaration
public IList<CellRotation> GetRotations(bool includeReflections = false)
Parameters
Type Name Description
bool includeReflections
Returns
Type Description
IList<CellRotation>

Invert(CellDir)

Returns the dir pointing in the opposite direction, if it exists.

Declaration
public CellDir? Invert(CellDir dir)
Parameters
Type Name Description
CellDir dir
Returns
Type Description
CellDir?

Invert(CellRotation)

Gets the inverse rotation. i.e. GetIdentity() == Multiply(a, Invert(a)) == Multiply(Invert(a), a)

Declaration
public CellRotation Invert(CellRotation a)
Parameters
Type Name Description
CellRotation a
Returns
Type Description
CellRotation

Multiply(CellRotation, CellRotation)

Composes two rotations/reflections together, doing b first, then a.

Declaration
public CellRotation Multiply(CellRotation a, CellRotation b)
Parameters
Type Name Description
CellRotation a
CellRotation b
Returns
Type Description
CellRotation

Rotate(CellCorner, CellRotation)

Declaration
public CellCorner Rotate(CellCorner corner, CellRotation rotation)
Parameters
Type Name Description
CellCorner corner
CellRotation rotation
Returns
Type Description
CellCorner

Rotate(CellDir, CellRotation)

Rotates a dir by the given rotation.

Declaration
public CellDir Rotate(CellDir dir, CellRotation rotation)
Parameters
Type Name Description
CellDir dir
CellRotation rotation
Returns
Type Description
CellDir

Rotate(CellDir, CellRotation, out CellDir, out Connection)

Declaration
public void Rotate(CellDir dir, CellRotation rotation, out CellDir resultDir, out Connection connection)
Parameters
Type Name Description
CellDir dir
CellRotation rotation
CellDir resultDir
Connection connection

TryGetRotation(CellDir, CellDir, Connection, out CellRotation)

Inverse of Rotate(CellDir, CellRotation, out CellDir, out Connection)

Declaration
public bool TryGetRotation(CellDir fromDir, CellDir toDir, Connection connection, out CellRotation rotation)
Parameters
Type Name Description
CellDir fromDir
CellDir toDir
Connection connection
CellRotation rotation
Returns
Type Description
bool

Implements