Apecs.Util

Utility

initStore :: Store s => IO s

runGC :: System w ()

Explicitly invoke the garbage collector

proxy :: Entity c

A proxy entity for TODO

EntityCounter

data EntityCounter

Secretly just an int in a newtype

Instances

Eq EntityCounter

Methods

(==) :: EntityCounter -> EntityCounter -> Bool

(/=) :: EntityCounter -> EntityCounter -> Bool

Num EntityCounter

Methods

(+) :: EntityCounter -> EntityCounter -> EntityCounter

(-) :: EntityCounter -> EntityCounter -> EntityCounter

(*) :: EntityCounter -> EntityCounter -> EntityCounter

negate :: EntityCounter -> EntityCounter

abs :: EntityCounter -> EntityCounter

signum :: EntityCounter -> EntityCounter

fromInteger :: Integer -> EntityCounter

Show EntityCounter

Methods

showsPrec :: Int -> EntityCounter -> ShowS

show :: EntityCounter -> String

showList :: [EntityCounter] -> ShowS

Monoid EntityCounter

Methods

mempty :: EntityCounter

mappend :: EntityCounter -> EntityCounter -> EntityCounter

mconcat :: [EntityCounter] -> EntityCounter

Component EntityCounter

Associated Types

type Storage EntityCounter :: *

type Storage EntityCounter

type Storage EntityCounter = Global EntityCounter

nextEntity :: Has w EntityCounter => System w (Entity ())

Bumps the EntityCounter and yields its value

newEntity :: (Store (Storage c), Has w c, Has w EntityCounter) => c -> System w (Entity c)

Writes the given components to a new entity, and yields that entity

Spatial hashing

The following functions are for spatial hashing. The idea is that your spatial hash is defined by two vectors;

• The cell size vector contains real components and dictates how large each cell in your table is in world space units. It is used by quantize to translate a world space coordinate into a table space index vector
• The table size vector contains integral components and dictates how many cells your field consists of in each direction. It is used by flatten to translate a table-space index vector into a flat integer

There is currently no dedicated spatial hashing log, but you can use an EnumTable by defining an instance Enum Vec with > fromEnum = flatten size . quantize cell

quantize

Arguments

:: (Fractional (v a), Integral b, RealFrac a, Functor v)

=> v a

Quantization cell size

-> v a

Vector to be quantized

-> v b

Quantize turns a world-space coordinate into a table-space coordinate by dividing by the given cell size and rounding towards negative infinity.

flatten :: (Applicative v, Integral a, Foldable v) => v a -> v a -> Maybe a

Turns a table-space vector into an integral index, given some table size vector. Yields Nothing for out-of-bounds queries

inbounds :: (Num a, Ord a, Applicative v, Foldable v) => v a -> v a -> Bool

Tests whether a vector is in the region given by 0 and the size vector (inclusive)

region

Arguments

:: (Enum a, Applicative v, Traversable v)

=> v a

Lower bound for the region

-> v a

Higher bound for the region

-> [v a]

For two table-space vectors indicating a region's bounds, gives a list of the vectors contained between them. This is useful for querying a spatial hash.

flatten' :: (Applicative v, Integral a, Foldable v) => v a -> v a -> a

flatten, but yields garbage for out-of-bounds vectors.

Timing

timeSystem :: System w a -> System w (Double, a)

Runs a system and gives its execution time in seconds

timeSystem_ :: System w a -> System w Double

Runs a system, discards its output, and gives its execution time in seconds

List functions

listAllE :: Has w c => System w [Entity c]

imapM return

listAllC :: Has w c => System w [c]

cmapM return

listAllEC :: Has w c => System w [(Entity c, c)]

cimapM return