Skip to main content

Crate vizij_graph_core

Crate vizij_graph_core 

Source
Expand description

Vizij’s node graph on Arora’s behavior tree.

This crate defines the graph format (types), the editor registry (schema) and topology helpers (topo); the functions of the graph format’s own module, @vizij/graph (vizij_functions); the importer from a graph to a behavior tree (import); and TreeRuntime, which runs a graph on the tree. A graph’s nodes are calls of arora-dataflow-nodes’ functions, whose modules this crate re-exports.

Re-exports§

pub use eval::PortValue;
pub use schema::registry;
pub use topo::topo_order;
pub use types::*;

Modules§

eval
The per-node code is arora-dataflow-nodes’ (arora_dataflow_nodes::eval, re-exported here). What belongs to Vizij’s graph format is this crate’s:
functions
The node vocabulary as the functions of three Arora modules: DATAFLOW holds the general node kinds, GEOMETRY the three-vector ones, and KINEMATICS the kinematics nodes (module_of).
import
The importer: a Vizij node graph (GraphSpec, its JSON form) as the nodes of a behavior tree, run by arora-behavior-tree.
kind
The node kinds the module’s functions compute: one function per kind.
params
A node’s parameters, as the node functions read them.
ports
The ports each node kind’s function declares: its fixed inputs and outputs, in order, and its variadic groups. A node’s port layouts start from these, and Vizij’s editor registry describes the same ports.
schema
Static node schema metadata exposed to tooling and wasm wrappers.
select
Selectors: the part of a value a path of field names and indices names, what the select function applies to an edge’s value.
task
The behavior Status vocabulary a TaskRun node speaks on the value plane.
topo
Topological ordering helpers for graph execution planning.
tree_runtime
A node graph run on the behavior tree: stage inputs and set the clock, evaluate, then read every node’s ports and the writes of its output nodes.
types
Canonical graph specification types shared across all Vizij graph hosts.
vizij_functions
What Vizij’s graph format does on the tree, as the functions of the module MODULE: an input node reading its store key and fitting the value to its declared shape, an output node passing its value to its sink, and the check of a node’s declared output shapes, which the importer places after each node that declares them.
vocab
The records, enumerations and plain values the node functions compute on, over arora_types::value::Value.

Structs§

Context
What a node’s evaluation reads and writes besides its ports: one call’s clock, the node’s state, and the runs it requests.
NodeFunctionRegistry
A registry of NodeFunctions keyed by their stable id.

Traits§

NodeFunction
A single external function a node can invoke.
NodeFunctions
The host the graph consults to invoke a node-function by id.