SceneTimelineGenerator.h header

#include <ew/app/SceneTimelineGenerator.h>

Namespace ew::app

GeneratedScene struct

struct ew::app::GeneratedScene

A planned timeline event derived from a dated scene document: its title, its start instant, and the entities mentioned in the scene (the auto-detected participants).

Members

QString ew::app::GeneratedScene::title

The scene document's title (becomes the event title).

qint64 ew::app::GeneratedScene::instant = 0

The scene's start instant (minutes since the story epoch).

std::vector<ew::core::ContentId> ew::app::GeneratedScene::participants

The entities mentioned in the scene body, in id order.

GeneratedTimeline struct

struct ew::app::GeneratedTimeline

A planned timeline: a title and the scenes to place on it, in chronological order.

Members

QString ew::app::GeneratedTimeline::title

The timeline title.

std::vector<GeneratedScene> ew::app::GeneratedTimeline::scenes

The scenes to create as events, ordered by instant.

Functions

GeneratedTimeline ew::app::generateSceneTimeline(const ew::core::Project &project)

Plans a timeline from project's dated scenes: one event per document that has a scene instant, titled by the document, with participants taken from the entities the document mentions (via the backlink index). Returns a description for the caller to create as undoable objects; it does not modify the project.