MayaFlux 1.0.0
Digital-First Multimedia Processing Framework
Loading...
Searching...
No Matches

◆ instantiate_document() [1/3]

template<typename Source, typename Access = Reflect::RecordAccess<Source>>
std::optional< PlacedInstances > MayaFlux::Portal::Forma::instantiate_document ( const FactoryTable< Source, Access > & table,
const ActionTable< Source, Access > & actions,
const Source & root,
SurfaceMap & surfaces,
std::string & error )
nodiscard

Place a document whose instances attach host actions to events.

As the overload without actions, and an instance may also hold on children. Each names an event (press, release, drag, move, enter, leave or scroll), a button for press, release and drag (left by default), and an action registered in actions, with that action's own parameters as further attributes. The names and parameters are resolved with the rest of the document, so an unknown action fails before anything is placed. The actions are subscribed beside the element's own wiring, so they never replace it.

Parameters
actionsActions by name.

Definition at line 798 of file Instantiate.hpp.

801{
802 return Detail::instantiate<Source, Access>(table, &actions, nullptr, root, surfaces, error);
803}
std::optional< PlacedInstances > instantiate(const FactoryTable< Source, Access > &table, const ActionTable< Source, Access > *actions, const CallTable< Source, Access > *calls, const Source &root, SurfaceMap &surfaces, std::string &error)

References MayaFlux::Portal::Forma::Detail::instantiate(), and instantiate_document().

Here is the call graph for this function: