Struct fj_host::Model

pub struct Model { /* private fields */ }

Represents a Fornjot model

Implementations

impl Model

pub fn from_path(path: PathBuf) -> Result<Self, Error>

Initialize the model using the path to its crate (i.e. the folder containing Cargo.toml).

Optionally, the target directory where plugin files are compiled to can be provided. If it is not provided, the target directory is assumed to be located within the model path.

pub fn load_once(&self, arguments: &Parameters) -> Result<Shape, Error>

Load the model once

The passed arguments are provided to the model. Returns the shape that the model returns.

Please refer to Model::load_and_watch, if you want to watch the model for changes, reloading it continually.

pub fn load_and_watch(self, parameters: Parameters) -> Result<Watcher, Error>

Load the model, then watch it for changes

Whenever a change is detected, the model is being reloaded.

Consumes this instance of Model and returns a Watcher, which can be queried for changes to the model.