Entity types

Entity types

entity_circle(seed = use_seed(1), grain = 50, id = NULL, ...)

entity_line(seed = use_seed(1), grain = 50, id = NULL, ...)

entity_heart(seed = use_seed(1), grain = 50, id = NULL, ...)

entity_droplet(seed = use_seed(1), grain = 50, id = NULL, shape = 3, ...)

entity_lissajous(
  seed = use_seed(1),
  grain = 500,
  id = NULL,
  start = 0,
  end = 30,
  shape = list(a = 1, b = 1, w = 0.3, d = 1),
  ...
)

entity_gaussian(seed = use_seed(1), grain = 50, id = NULL, ...)

entity_null(seed = use_seed(1), ...)

Arguments

seed	Parameter specifying seed (default = NULL)
grain	The number of points that comprise the entity
id	A numeric identifier for the entity
...	Parameters to be passed to locate_entity
shape	Parameter controlling the shape of the entity (droplet, lissajous)
start	Parameter controlling a start location for a line (lissajous)
end	Parameter controlling an end location for a line (lissajous)

Value

A tibble with four columns: x, y, id and type

Details

Primitive entities in jasmines are tibbles with four columns: x and y specify co-ordinate values, the id is a number identifying the object, and the type is a character label indicating what kind of entity it is. By default, entities are assigned a random integer as the id code, but it is often wise for the calling function to assign the id in a more predictable fashion. The shape parameter can sometimes be a list.