MayaFlux 1.0.0
Digital-First Multimedia Processing Framework
Loading...
Searching...
No Matches
MayaFlux::Portal::Forma::ContainmentTable Class Reference

Hit region providers by name. More...

#include <Containment.hpp>

Collaboration diagram for MayaFlux::Portal::Forma::ContainmentTable:

Public Member Functions

bool contains (std::string_view name) const
void expose (std::string name, ContainmentProvider provider)
 Register a provider, replacing any of the same name.
bool merge (const ContainmentTable &other, std::string_view prefix, std::string &error, bool replace=false)
 Add another table under a prefix, as FlatMap::merge_prefixed.
std::vector< std::string > names () const
 Registered names in sorted order.
std::optional< Containment > resolve (std::string_view name, const ContainmentSource &source, std::string &error) const
 Run the provider of this name on a source.
std::optional< Containment > resolve_or (std::string_view name, const ContainmentSource &source, Containment fallback, std::string &error) const
 The named containment, or the fallback when the name is empty.

Private Attributes

Memory::FlatMap< std::string, ContainmentProvider, std::less<> > m_providers

Detailed Description

Hit region providers by name.

A plain value like every table here: nothing is registered until its builder adds it, and a host, a library or a user each build their own. A factory that lets a document choose its hit region declares a name among its described inputs and resolves it here.

Definition at line 117 of file Containment.hpp.


The documentation for this class was generated from the following file: