Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TourDocument

A WWT tour.

Hierarchy

  • TourDocument

Index

Constructors

Methods

Constructors

constructor

Methods

elapsedTimeTillTourstop

  • elapsedTimeTillTourstop(index: number): number

  • Calculate how much time must elapse in the tour playback to reach the specified tour stop.

    Parameters

    • index: number

      The index number of the tour stop to query

    Returns number

    The amount of time, in seconds.

getTourStopIndexByID

  • getTourStopIndexByID(id: string): number

  • Get the stop index of a tour stop, given its identifier.

    If the ID is the empty string or "Next", the current tour stop index will be incremented and returned.

    Parameters

    • id: string

      The tour stop ID, or an empty string or "Next"

    Returns number

    The tour stop index

getTourXML

  • getTourXML(): string

get_attributesAndCredits

  • get_attributesAndCredits(): string

  • Get this tour's "attributes and credits" text.

    TODO: determine and document any markup / formatting semantics.

    Returns string

get_authorUrl

  • get_authorUrl(): string

get_currentTourstopIndex

  • get_currentTourstopIndex(): number

  • Get the index number of the currently active tour stop.

    In principle, this should maybe be a property of a tour player, not a tour document, but here we are. This will be negative if the tour isn't currently playing.

    Returns number

get_description

  • get_description(): string

get_runTime

  • get_runTime(): number

get_title

  • get_title(): string

get_tourStops

saveToBlob

  • saveToBlob(): Blob

set_attributesAndCredits

  • set_attributesAndCredits(aandc: string): string

set_authorUrl

  • set_authorUrl(title: string): string

set_description

  • set_description(desc: string): string

set_title

  • set_title(title: string): string

Generated using TypeDoc