Struct Renderer

pub struct Renderer<'a> {
    roots: Vec<EntryPoint<'a>>,
    depth_map: HashMap<EntityRef, usize>,
    path: &'a Path,
    data: &'a GameData,
    grapher: Option<&'a Grapher>,
    state: &'a GameState,
    initial_depth: usize,
}

A struct that renders objects into html pages. It is meant to be used as a worker object that collects objects and renders them all at once. The objects are rendered in a BFS order, with the depth of the objects being determined by the BFS algorithm.

Fields

roots: Vec<EntryPoint<'a>>

depth_map: HashMap<EntityRef, usize>

path: &'a Path

The path where the objects will be rendered to. This usually takes the form of ’./{username}‘s history/’.

data: &'a GameData

The loaded game data object.

grapher: Option<&'a Grapher>

The grapher object, if it exists. It may be utilized during the rendering process to render a variety of graphs.

state: &'a GameState

The game state object. It is used to access the game state during rendering, especially for gathering of data for rendering of optional graphs.

initial_depth: usize

Implementations

impl<'a> Renderer<'a>

pub fn new( path: &'a Path, state: &'a GameState, data: &'a GameData, grapher: Option<&'a Grapher>, initial_depth: usize, ) -> Self

Create a new Renderer. create_dir_maybe is called on the path to ensure that the directory exists, and the subdirectories are created.

Arguments

• path - The root path where the objects will be rendered to. Usually takes the form of ’./{username}‘s history/’.
• state - The game state object.
• game_map - The game map object, if it exists.
• grapher - The grapher object, if it exists.
• initial_depth - The initial depth of the objects that are added to the renderer.

Returns

A new Renderer object.

fn render<T: Renderable, D: Deref<Target = T>>( &self, obj: D, env: &Environment<'_>, )

Renders the Renderable object.

fn render_enum(&self, obj: &RenderableType, env: &Environment<'_>)

Renders the RenderableType object.

pub fn add_object<G: GameObjectDerived + Renderable>( &mut self, obj: &'a G, ) -> usize

where EntryPoint<'a>: From<&'a G>,

Adds an object to the renderer, and returns the number of objects that were added. This method uses a BFS algorithm to determine the depth of the object.

pub fn render_all(self, env: &mut Environment<'_>) -> usize

Renders all the objects that have been added to the renderer. This method consumes the renderer object.

Arguments

• env - The [Environment] object that is used to render the templates.

Returns

The number of objects that were rendered.