Figler.Scene.Graph.Nodes (figler v0.1.0-beta.1)

Graph node mutation helpers.

Summary

Functions

child(graph, parent, child)

Adds child to parent if not already present.

children(graph, parent, children)

Adds already-ordered children to parent in one append.

clear_children(graph, parent_guid, opts \\ [])

Removes all direct children under a parent in one batch.

put(graph, guid, node, seed \\ nil)

Inserts or replaces a node and keeps type/name indexes current.

reindex(graph)

Rebuilds type/name lookup indexes from current graph nodes.

remove(graph, guid, opts \\ [])

Removes a subtree rooted at guid.

remove_many(graph, root_guids, opts \\ [])

Removes multiple subtrees in one batch.

subtree(graph, guid)

Returns subtree GUIDs in descendants-first order.

Functions

child(graph, parent, child)

@spec child(
  Figler.Scene.Graph.t(),
  Figler.Scene.Graph.GUID.graph_guid(),
  Figler.Scene.Graph.GUID.graph_guid()
) :: Figler.Scene.Graph.t()

Adds child to parent if not already present.

children(graph, parent, children)

@spec children(Figler.Scene.Graph.t(), Figler.Scene.Graph.GUID.graph_guid(), [
  Figler.Scene.Graph.GUID.graph_guid()
]) :: Figler.Scene.Graph.t()

Adds already-ordered children to parent in one append.

clear_children(graph, parent_guid, opts \\ [])

@spec clear_children(
  Figler.Scene.Graph.t(),
  Figler.Scene.Graph.GUID.graph_guid(),
  keyword()
) ::
  Figler.Scene.Graph.t()

Removes all direct children under a parent in one batch.

put(graph, guid, node, seed \\ nil)

@spec put(
  Figler.Scene.Graph.t(),
  Figler.Scene.Graph.GUID.graph_guid(),
  Figler.Scene.Node.t(),
  Figler.Scene.Graph.Seed.Node.t() | nil
) :: Figler.Scene.Graph.t()

Inserts or replaces a node and keeps type/name indexes current.

reindex(graph)

@spec reindex(Figler.Scene.Graph.t()) :: Figler.Scene.Graph.t()

Rebuilds type/name lookup indexes from current graph nodes.

remove(graph, guid, opts \\ [])

@spec remove(Figler.Scene.Graph.t(), Figler.Scene.Graph.GUID.graph_guid(), keyword()) ::
  Figler.Scene.Graph.t()

Removes a subtree rooted at guid.

remove_many(graph, root_guids, opts \\ [])

@spec remove_many(
  Figler.Scene.Graph.t(),
  [Figler.Scene.Graph.GUID.graph_guid()],
  keyword()
) ::
  Figler.Scene.Graph.t()

Removes multiple subtrees in one batch.

subtree(graph, guid)

@spec subtree(Figler.Scene.Graph.t(), Figler.Scene.Graph.GUID.graph_guid()) :: [
  Figler.Scene.Graph.GUID.graph_guid()
]

Returns subtree GUIDs in descendants-first order.