place()

Scrollable & MayaFlux::Portal::Forma::Scrollable::place	(	FormaTarget	in_buf,
		Surface &	surface,
		Kinesis::AABB2D	viewport
	)

Register the viewport element, wire wheel scrolling, and populate scroll, offset, buf, and cursor_out.

Parameters

in_buf	Pre-created buffer for the viewport background. Its render processor is scissored to viewport, so give a slice of a create_buffer() buffer and create the tracked elements as slices of the same buffer: one scissor then clips them all. Elements on buffers of their own are scissored individually by track(), as before. Do not share this buffer with anything that must draw outside the viewport.
surface	Surface to register the viewport on.
viewport	NDC region: hit-test bounds, wheel-scroll trigger region, background quad, and the Scissor clip every track()ed element with a buffer gets.

Returns

*this, with results populated.

Definition at line 47 of file Scrollable.cpp.

{
    buf = std::move(in_buf);
    viewport_bounds = viewport;
 
    buf.submit(Kinesis::filled_rect(viewport, m_background));
 
    if (buf) {
        if (auto render = buf->get_render_processor())
            render->set_scissor(Kinesis::Scissor::from(viewport));
    }
 
    Element el = Element {}
                     .with_name("scrollable_viewport")
                     .with_bounds(viewport)
                     .with_buffer(buf);
 
    viewport_id = surface.layer().add(el);
 
    scroll = std::make_shared<Kinesis::ScrollState>();
    scroll->viewport_bounds = viewport;
    scroll->content_bounds = viewport;
 
    offset = std::make_shared<MappedState<glm::vec2>>();
 
    m_tracked = std::make_shared<std::vector<Tracked>>();
    m_indicator = std::make_shared<Mapped<glm::vec2>>();
 
    cursor_out = LayoutCursor(viewport.max.y, viewport.min.x, viewport.max.x);
    cursor_out.bind_scroll(offset);
 
    surface.ctx().on_scroll(viewport_id, wheel_handler(surface));
 
    return *this;
}

References MayaFlux::Portal::Forma::Layer::add(), MayaFlux::Portal::Forma::LayoutCursor::bind_scroll(), buf, MayaFlux::Portal::Forma::Surface::ctx(), cursor_out, MayaFlux::Kinesis::filled_rect(), MayaFlux::Kinesis::Scissor::from(), MayaFlux::Buffers::VKBuffer::get_render_processor(), MayaFlux::Portal::Forma::Surface::layer(), m_background, m_indicator, m_tracked, MayaFlux::Kinesis::AABB2D::max, MayaFlux::Kinesis::AABB2D::min, offset, MayaFlux::Portal::Forma::Context::on_scroll(), scroll, MayaFlux::Portal::Forma::FormaTarget::submit(), viewport_bounds, viewport_id, wheel_handler(), MayaFlux::Portal::Forma::Element::with_bounds(), MayaFlux::Portal::Forma::Element::with_buffer(), and MayaFlux::Portal::Forma::Element::with_name().

Referenced by MayaFlux::Portal::Forma::create_text_field(), and MayaFlux::Portal::Forma::make_scrollable().

Here is the call graph for this function:

Here is the caller graph for this function: