+/*! \file
+ * \brief Metascene implementation
+ *
+ * Loading starts at `MetaScene::load`, which calls `ts_load` (libtreestore)
+ * to load the metascene description tree into memory. Then `proc_node` is
+ * called at the root to recursively process the tree. `scenefile` nodes are
+ * handed over to `proc_scenefile`, which will trigger scene loading for any
+ * nodes with a `file` attribute. Scene loading is handled by requesting the
+ * filename from the scene resource manager, which is of type [SceneSet](\ref SceneSet).
+ */
#include <assert.h>
#include <string>
#include <regex>
delete music;
}
-
bool MetaScene::load(const char *fname)
{
struct ts_node *root = ts_load(fname);
std::vector<MaterialEdit> mtledit;
};
+/*! Processes a `scenefile` node. And kicks off scene loading (if necessary) by
+ * calling `SceneSet::get`.
+ */
static bool proc_scenefile(MetaScene *mscn, struct ts_node *node)
{
const char *fname = ts_get_attr_str(node, "file");
fname = namebuf;
}
- // material edits
+ // material edits are kept in a list to be applied when the scene has been loaded
struct ts_node *child = node->child_list;
while(child) {
MaterialEdit medit;