An AnnotationStory is a Story that contains a list of Annotations accompanied by a panel of text containing links that activate them.

• AnnotationStory text is provided as markdown.
• Words in the text can be linked to xeogl storytelling functions, to fly the camera to Annotation vantage points, show labels etc.

Authoring Mode

• SHIFT-click to place an Annotation
• ESC to clear
• ENTER to dump

Examples

• Tron Tank Program AnnotationStory

Usage

// Load a Tron Tank model from SceneJS format. Give the model an ID - this
// gets prefixed to the IDs of it's Meshes.

var model = new xeogl.SceneJSModel({
           id: "tank",
           src: "models/scenejs/tronTank/tronTank.json"
       });

model.scene.camera.eye = [15, 20, -25];

// When the model has loaded, create a story with annotations

model.on("loaded", function () {

       new xeogl.AnnotationStory({
           speaking: false, // Set true to have a voice announce each annotation
           authoring: true, // Set true to author the annotations
           text: [
               "# [Stories](../docs/classes/AnnotationStory.html) : Tron Tank Program",
               "This is a Light Tank from the 1982 Disney movie *Tron*.",
               "The [orange tracks](focusAnnotation(0)) on this tank indicate that ....",
               "![](./images/Clu_Program.png)",
               "The [cannon](focusAnnotation(1)) is the tank's main armament, which  ....",
               "The [pilot hatch](focusAnnotation(2)) is where Clu enters and exits the tank.",
               "At the back of the tank is the [antenna](focusAnnotation(3)) through ....",
               "*\"I fight for the users!\" -- Clu*"
           ],
           annotations: [
               {
                   primIndex: 204,
                   bary: [0.05, 0.16, 0.79],
                   occludable: true,
                   glyph: "A",
                   title: "Orange tracks",
                   desc: "Indicates that the pilot is the rebel hacker, Clu",
                   eye: [14.69, 17.89, -26.88],
                   look: [5.35, 4.14, -15.44],
                   up: [-0.09, 0.99, 0.11],
                   pinShown: true,
                   labelShown: true,
                   mesh: "tank.entity2"
               },
               {
                   primIndex: 468,
                   bary: [0.05, 0.16, 0.79],
                   occludable: true,
                   glyph: "B",
                   title: "Cannon",
                   desc: "Fires chevron-shaped bolts of de-rezzing energy",
                   eye: [-0.66, 20.84, -21.59],
                   look: [-0.39, 6.84, -9.18],
                   up: [0.01, 0.97, 0.24],
                   pinShown: true,
                   labelShown: true,
                   mesh: "tank.entity9"
               },
               {
                   primIndex: 216,
                   bary: [0.05, 0.16, 0.79],
                   occludable: true,
                   glyph: "C",
                   title: "Pilot hatch",
                   desc: "Clu hops in and out of the tank program here",
                   eye: [1.48, 11.79, -15.13],
                   look: [1.62, 5.04, -9.14],
                   up: [0.01, 0.97, 0.24],
                   pinShown: true,
                   labelShown: true,
                   mesh: "tank.entity6"
               },
               {
                   primIndex: 4464,
                   bary: [0.05, 0.16, 0.79],
                   occludable: true,
                   glyph: "D",
                   title: "Antenna",
                   desc: "Links the tank program to the Master Control Program",
                   eye: [13.63, 16.79, 13.87],
                   look: [1.08, 7.72, 3.07],
                   up: [0.08, 0.99, 0.07],
                   pinShown: true,
                   labelShown: true,
                   mesh: "tank.entity9"
               }
           ]
       });
    });