models

type CellularAutomataConfig struct {
	// NSpecies is the number of different types of species that exist
	NSpecies int

	// PredatorThreshold is the amount of neighboring predators cells it takes
	// to eat a prey cell
	PredatorThreshold int

	// PredatorDirs contains the cardinal directions that predators may attack
	// prey cells from
	PredatorDirs []string
}

type Features struct {

	// SpeciesID identifies the species type of a cell
	SpeciesID int
	// Neighbors stores pointers to an organism's neighbors
	Neighbors []*Organism

	// XPos is a float that represents an organisms location within the Grid.
	// Positions are floats so that organisms can be at locations that are between
	// Spaces. This allows them to travel in any direction (otherwise they would
	// be limited to 45˚ increments). Their visible location will still be one
	// discrete Space (whichever Space they are closest to).
	XPos float64

	// YPos is a float that represents an organisms location within the Grid.
	// Positions are floats so that organisms can be at locations that are between
	// Spaces. This allows them to travel in any direction (otherwise they would
	// be limited to 45˚ increments). Their visible location will still be one
	// discrete Space (whichever Space they are closest to).
	YPos float64

	// direction represents the angular direction (in degrees) that an organism
	// is facing.
	Direction gridphysics.DegreeAngle
}

type Grid struct {
	// Rows is a 2-dimensional array that contains Spaces in the inner-array.
	Rows [][]*Space
}

type NextFeatures struct {
	SpeciesID int
	XPos      float64
	YPos      float64
}

type Organism struct {
	ID int

	Features     *Features
	NextFeatures *NextFeatures
}

type Simulation interface {
	OutputName() (string, error)
	InitializeGrid(g *Grid) error
	AdvanceFrame(g *Grid) error
	DrawSpace(sp *Space, img *image.Paletted, x int, y int) error
	GetPalette() color.Palette
}

type SimulationConfig struct {
	CellularAutomata CellularAutomataConfig
	SlimeMold        SlimeMoldConfig
}

type SlimeMoldConfig struct {
	ScentDecay        float64
	ScentSpreadFactor float64
	SenseReach        int
	SenseDegree       int
}

type Space struct {
	Organism  *Organism
	Neighbors []*Space

	Features *SpaceFeatures
}

type SpaceFeatures struct {
	// Scent represents the strength of a scent that may be left behind by organisms.
	Scent float64
}