Automata.Cell< T > Class Template Reference

Generic base cell class. More...

Inherits Node2D.

Public Member Functions
abstract T	GetAliveValue ()
	Get alive cell value. More...
abstract T	GetDeadValue ()
	Get dead cell value. More...
virtual bool	IsAlive ()
	Check if cell is alive (based on State). More...
virtual bool	WasAlive ()
	Check if cell was alive (based on PreviousState). More...
virtual T	RandomizeState ()
	Return a randomized state. More...

Protected Member Functions
virtual ? Color	GetStateColor ()
	Get state color. Returns null if cell is discarded. More...

Properties
T	PreviousState [get, set]
	Previous state More...
T	State [get, set]
	Current state More...
Vector2	Size [get, set]
	Cell size More...
Color	CellColor = Colors.LightBlue [get, set]
	Cell color More...
bool	HighlightTransitions [get, set]
	Highlight when a cell is transitioning from life to death More...

Detailed Description

Generic base cell class.

Type Constraints

T

:

System.IEquatable<T>

Definition at line 36 of file CellularAutomata2D.cs.

Member Function Documentation

GetAliveValue()

abstract T Automata.Cell< T >.GetAliveValue ( )

pure virtual

Get alive cell value.

Returns

Alive cell value

Implemented in Automata.BoolCell.

GetDeadValue()

abstract T Automata.Cell< T >.GetDeadValue ( )

pure virtual

Get dead cell value.

Returns

Dead cell value

Implemented in Automata.BoolCell.

GetStateColor()

virtual ? Color Automata.Cell< T >.GetStateColor ( )

inlineprotectedvirtual

Get state color. Returns null if cell is discarded.

Returns

State color

Definition at line 124 of file CellularAutomata2D.cs.

        {
            var wasAlive = WasAlive();
            var isAlive = IsAlive();
 
            if (HighlightTransitions)
            {
                if (!wasAlive && isAlive)
                {
                    // Cell just lived
                    return Colors.Blue;
                }
                else if (wasAlive && !isAlive)
                {
                    // Cell just died
                    return Colors.Red;
                }
                else if (!isAlive)
                {
                    // Cell already dead
                    return null;
                }
            }
            else if (!isAlive)
            {
                // Cell already dead
                return null;
            }
 
            return CellColor;
        }

IsAlive()

virtual bool Automata.Cell< T >.IsAlive ( )

inlinevirtual

Check if cell is alive (based on State).

Returns

Live state

Definition at line 70 of file CellularAutomata2D.cs.

        {
            return State.Equals(GetAliveValue());
        }

RandomizeState()

virtual T Automata.Cell< T >.RandomizeState ( )

inlinevirtual

Return a randomized state.

Returns

Randomized state

Definition at line 88 of file CellularAutomata2D.cs.

        {
            if (MathUtils.Randf() <= 0.5f)
            {
                return GetAliveValue();
            }
            else
            {
                return GetDeadValue();
            }
        }

WasAlive()

virtual bool Automata.Cell< T >.WasAlive ( )

inlinevirtual

Check if cell was alive (based on PreviousState).

Returns

Previous live state

Definition at line 79 of file CellularAutomata2D.cs.

        {
            return PreviousState.Equals(GetAliveValue());
        }

Property Documentation

CellColor

Color Automata.Cell< T >.CellColor = Colors.LightBlue

getset

Cell color

Definition at line 49 of file CellularAutomata2D.cs.

{ set; get; } = Colors.LightBlue;

HighlightTransitions

bool Automata.Cell< T >.HighlightTransitions

getset

Highlight when a cell is transitioning from life to death

Definition at line 52 of file CellularAutomata2D.cs.

{ set; get; }

PreviousState

T Automata.Cell< T >.PreviousState

getset

Previous state

Definition at line 40 of file CellularAutomata2D.cs.

{ set; get; }

Size

Vector2 Automata.Cell< T >.Size

getset

Cell size

Definition at line 46 of file CellularAutomata2D.cs.

{ set; get; }

State

T Automata.Cell< T >.State

getset

Current state

Definition at line 43 of file CellularAutomata2D.cs.

{ set; get; }

---

The documentation for this class was generated from the following file:

• scripts/automata/CellularAutomata2D.cs