place_adornments()

void MayaFlux::Portal::Forma::internal::Atelier::place_adornments	(	Surface &	surface,
		const Plot::SeriesSpec &	spec,
		uint32_t	relate_to,
		const std::shared_ptr< Buffers::FormaBuffer > &	batch = {}
	)

Create and place every adornment declared on spec.

Makes a target for each axis label, tick label, legend swatch, and legend label, then hands each to the corresponding Plot placement function. Each adornment is related to relate_to so removal and visibility cascade from the series element.

Lives here rather than in Plot because it constructs buffers, which requires the BufferManager. Plot composes placement from arguments it is given.

Parameters

surface	Surface to place on.
spec	Series spec carrying the adornment declarations.
relate_to	Element id the adornments are related to.
batch	Shared plot buffer for swatches and labels. With labels, it needs a text slot and forma_plot.frag. When empty, one buffer is created for all adornments.

Definition at line 183 of file Atelier.cpp.

{
    const bool has_labels = !spec.labels.empty() || !spec.tick_labels.empty()
        || (spec.legend && !spec.legend->entries.empty());
    std::shared_ptr<Buffers::FormaBuffer> owned_batch;
    const auto target_of = [&](Graphics::PrimitiveTopology topology) -> FormaTarget {
        if (!batch && !owned_batch) {
            Graphics::RenderConfig render = surface.render_config();
            if (has_labels) {
                render.fragment_shader = "forma_plot.frag.spv";
                render.additional_textures.emplace_back("text", nullptr);
            }
            owned_batch = create_buffer(std::move(render));
        }
        const auto& target_batch = batch ? batch : owned_batch;
        return FormaTarget::slice_of(target_batch, topology);
    };
 
    const auto legend = spec.legend
        ? std::optional<Plot::LegendLayout>(Plot::layout_legend(*spec.legend))
        : std::nullopt;
    if (legend) {
        for (const auto& swatch : legend->swatches) {
            (void)Plot::place_rect(surface,
                target_of(Graphics::PrimitiveTopology::TRIANGLE_STRIP), swatch, relate_to);
        }
    }
 
    for (const auto& label : spec.labels) {
        (void)Plot::place_label(surface,
            target_of(Graphics::PrimitiveTopology::TRIANGLE_LIST), label, relate_to);
    }
 
    for (const auto& ticks : spec.tick_labels) {
        for (const auto& label : Plot::plot_tick_labels(ticks)) {
            (void)Plot::place_label(surface,
                target_of(Graphics::PrimitiveTopology::TRIANGLE_LIST), label, relate_to);
        }
    }
 
    if (legend) {
        for (const auto& label : legend->labels) {
            (void)Plot::place_label(surface,
                target_of(Graphics::PrimitiveTopology::TRIANGLE_LIST), label, relate_to);
        }
    }
}

References MayaFlux::Portal::Graphics::RenderConfig::additional_textures, create_buffer(), MayaFlux::Portal::Graphics::RenderConfig::fragment_shader, label, MayaFlux::Portal::Forma::Plot::SeriesSpec::labels, MayaFlux::Portal::Forma::Plot::layout_legend(), MayaFlux::Portal::Forma::Plot::SeriesSpec::legend, MayaFlux::Portal::Forma::Plot::place_label(), MayaFlux::Portal::Forma::Plot::place_rect(), MayaFlux::Portal::Forma::Plot::plot_tick_labels(), MayaFlux::Portal::Forma::Surface::render_config(), MayaFlux::Portal::Forma::FormaTarget::slice_of(), MayaFlux::Portal::Forma::Plot::SeriesSpec::tick_labels, topology, MayaFlux::Portal::Graphics::TRIANGLE_LIST, and MayaFlux::Portal::Graphics::TRIANGLE_STRIP.

Referenced by MayaFlux::Portal::Forma::plot().

Here is the call graph for this function:

Here is the caller graph for this function: