Scenic

v0.7.0

Scenic v0.7.0 Scenic.Primitive behaviour

Link to this section Summary

Types

t()

Functions

build(module, data, opts \\ [])
contains_point?(primitive, point)
delete_style(primitive, type)
delete_transform(primitive, tx_type)
do_put(p, data)
get(primitive)
get_style(primitive, type, default \\ nil)
get_styles(primitive)
get_transform(primitive, tx_type, default \\ nil)
get_transforms(primitive)
put(primitive, data, opts \\ [])
put_opts(primitive, opts)
put_style(p, list)
put_style(p, type, data)
put_styles(primitve, styles)
put_transform(p, tx_list)
put_transform(p, tx_type, data)
put_transforms(primitve, transforms)

Callbacks

add_to_graph(map, any, opts)
contains_point?(any, {})
default_pin(any)
expand(any)
filter_styles(map)
info(data)
valid_styles()
verify(any)

Link to this section Types

Link to this type t() 
t() :: %Scenic.Primitive{
  data: any(),
  id: any(),
  module: atom(),
  parent_uid: integer(),
  styles: map(),
  transforms: map()
}

Link to this section Functions

Link to this function build(module, data, opts \\ []) 
build(module :: atom(), data :: any(), opts :: keyword()) ::
  Scenic.Primitive.t()
Link to this function contains_point?(primitive, point) 
contains_point?(primitive :: Scenic.Primitive.t(), point :: Scenic.Math.point()) ::
  map()
Link to this function delete_style(primitive, type) 
delete_style(primitive :: Scenic.Primitive.t(), type :: atom()) ::
  Scenic.Primitive.t()
Link to this function delete_transform(primitive, tx_type) 
delete_transform(primitive :: Scenic.Primitive.t(), type :: atom()) ::
  Scenic.Primitive.t()
Link to this function do_put(p, data)
Link to this function get(primitive) 
get(primitive :: Scenic.Primitive.t()) :: any()
Link to this function get_style(primitive, type, default \\ nil) 
get_style(primitive :: Scenic.Primitive.t(), type :: atom(), default :: any()) ::
  any()
Link to this function get_styles(primitive) 
get_styles(primitive :: Scenic.Primitive.t()) :: map()
Link to this function get_transform(primitive, tx_type, default \\ nil) 
get_transform(
  primitive :: Scenic.Primitive.t(),
  type :: atom(),
  default :: any()
) :: any()
Link to this function get_transforms(primitive) 
get_transforms(primitive :: Scenic.Primitive.t()) :: map()
Link to this function put(primitive, data, opts \\ []) 
put(primitive :: Scenic.Primitive.t(), data :: any(), opts :: list()) ::
  Scenic.Primitive.t()
Link to this function put_opts(primitive, opts) 
put_opts(primitive :: Scenic.Primitive.t(), opts :: keyword()) ::
  Scenic.Primitive.t()
Link to this function put_style(p, list)
Link to this function put_style(p, type, data) 
put_style(primitive :: Scenic.Primitive.t(), type :: atom(), data :: any()) ::
  Scenic.Primitive.t()
Link to this function put_styles(primitve, styles) 
put_styles(primitive :: Scenic.Primitive.t(), styles :: map()) ::
  Scenic.Primitive.t()
Link to this function put_transform(p, tx_list)
Link to this function put_transform(p, tx_type, data) 
put_transform(
  primitive :: Scenic.Primitive.t(),
  type :: atom(),
  transform :: any()
) :: Scenic.Primitive.t()
Link to this function put_transforms(primitve, transforms) 
put_transforms(primitive :: Scenic.Primitive.t(), transforms :: map()) ::
  Scenic.Primitive.t()

Link to this section Callbacks

Link to this callback add_to_graph(map, any, opts) 
add_to_graph(map(), any(), opts :: keyword()) :: map()
Link to this callback contains_point?(any, {}) 
contains_point?(any(), {float(), float()}) :: true | false
Link to this callback default_pin(any) 
default_pin(any()) :: {float(), float()}
Link to this callback expand(any) 
expand(any()) :: any()
Link to this callback filter_styles(map) 
filter_styles(map()) :: map()
Link to this callback info(data) 
info(data :: any()) :: bitstring()
Link to this callback valid_styles() 
valid_styles() :: list()
Link to this callback verify(any) 
verify(any()) :: any()