plot()

MAYAFLUX_API std::pair< Mapped< std::shared_ptr< Kakshya::PlotContainer > >, Surface > MayaFlux::Portal::Forma::plot	(	std::string	title,
		uint32_t	width,
		uint32_t	height,
		std::shared_ptr< Kakshya::PlotContainer >	container,
		Plot::SeriesSpec	spec
	)

Create a live plot in a new window.

Creates the window, shows it, constructs the Surface, and places the plot in a slice of one batch. Background, legend swatches and labels use slices of that batch; a plot with labels selects the glyph-capable plot shader. Returns the Mapped<shared_ptr<PlotContainer>> from Plot::place, plus the Surface owning the window and layer.

Parameters

title	Window title.
width	Window width in pixels.
height	Window height in pixels.
container	Ready PlotContainer from Plot::source().build().
spec	SeriesSpec from Plot::series()...done().

Returns

Pair of { Mapped<shared_ptr<PlotContainer>>, Surface } for the created plot.

Definition at line 113 of file Forma.cpp.

{
    auto& atelier = internal::atelier();
 
    auto window = atelier.create_window(
        Core::WindowCreateInfo { .title = std::move(title), .width = width, .height = height });
 
    auto surface = atelier.create_surface(SurfaceConfig {
        .window = window,
        .name = window->get_create_info().title,
    });
 
    const bool has_labels = !spec.labels.empty() || !spec.tick_labels.empty()
        || (spec.legend && !spec.legend->entries.empty());
    Graphics::RenderConfig render = surface.render_config();
    if (has_labels) {
        render.fragment_shader = "forma_plot.frag.spv";
        render.additional_textures.emplace_back("text", nullptr);
    }
    const auto batch = atelier.create_buffer(std::move(render));
 
    std::optional<uint32_t> background_id;
    if (spec.background_fn) {
        auto bg = atelier.create_element<float>(
            surface,
            FormaTarget::slice_of(batch, Graphics::PrimitiveTopology::TRIANGLE_STRIP),
            *spec.background_fn, 0.F);
        background_id = bg.element.id;
    }
 
    auto mapped = Plot::place(
        surface, FormaTarget::slice_of(batch, spec.topology), spec, std::move(container));
 
    if (background_id) {
        surface.layer().relate(mapped.element.id, *background_id);
        surface.layer().send_to_back(*background_id);
    }
 
    internal::atelier().place_adornments(surface, spec, mapped.element.id, batch);
 
    return { std::move(mapped), std::move(surface) };
}

References MayaFlux::Portal::Graphics::RenderConfig::additional_textures, MayaFlux::Portal::Forma::internal::atelier(), MayaFlux::Portal::Forma::Plot::SeriesSpec::background_fn, MayaFlux::Portal::Forma::internal::Atelier::create_buffer(), MayaFlux::Portal::Forma::internal::Atelier::create_element(), MayaFlux::Portal::Forma::internal::Atelier::create_surface(), MayaFlux::Portal::Forma::internal::Atelier::create_window(), MayaFlux::Portal::Graphics::RenderConfig::fragment_shader, height, MayaFlux::Portal::Forma::Plot::SeriesSpec::labels, MayaFlux::Portal::Forma::Plot::SeriesSpec::legend, MayaFlux::Portal::Forma::Plot::place(), MayaFlux::Portal::Forma::internal::Atelier::place_adornments(), MayaFlux::Portal::Forma::FormaTarget::slice_of(), MayaFlux::Portal::Forma::Plot::SeriesSpec::tick_labels, MayaFlux::Core::WindowCreateInfo::title, MayaFlux::Portal::Forma::Plot::SeriesSpec::topology, MayaFlux::Portal::Graphics::TRIANGLE_STRIP, width, window, and MayaFlux::Portal::Forma::SurfaceConfig::window.

Here is the call graph for this function: