Class TourDocument

A WWT tour.

Hierarchy

TourDocument

Index

Constructors

Methods

elapsedTimeTillTourstop getTourStopIndexByID getTourXML get_attributesAndCredits get_authorUrl get_currentTourstopIndex get_description get_runTime get_title get_tourStops saveToBlob set_attributesAndCredits set_authorUrl set_description set_title

Constructors

constructor

new TourDocument(): TourDocument
Returns TourDocument

Methods

elapsedTimeTillTourstop

elapsedTimeTillTourstop(index): 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.
- Defined in engine/src/index.d.ts:2008

getTourStopIndexByID

getTourStopIndexByID(id): 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
- Defined in engine/src/index.d.ts:2018

getTourXML

getTourXML(): string
Get the tour document as an XML string

Returns string
- Defined in engine/src/index.d.ts:2021

get_attributesAndCredits

get_attributesAndCredits(): string
Get this tour's "attributes and credits" text.

TODO: determine and document any markup / formatting semantics.

Returns string
- Defined in engine/src/index.d.ts:1938

get_authorUrl

get_authorUrl(): string
Get the "author URL" of this tour.

Returns string
- Defined in engine/src/index.d.ts:1944

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
- Defined in engine/src/index.d.ts:1955

get_description

get_description(): string
Get this tour's description.

TODO: document any markup semantics, etc.

Returns string
- Defined in engine/src/index.d.ts:1961

get_runTime

get_runTime(): number
Get the tour's run-time, in milliseconds. An integer.

Returns number
- Defined in engine/src/index.d.ts:1967

get_title

get_title(): string
Get this tour's title.

Returns string
- Defined in engine/src/index.d.ts:1970

get_tourStops

get_tourStops(): TourStop[]
Get the set of stops that comprise this tour.

Returns TourStop[]
- Defined in engine/src/index.d.ts:1976

saveToBlob

saveToBlob(): Blob
Get a representation of the tour as a blob

Returns Blob
- Defined in engine/src/index.d.ts:2024

set_attributesAndCredits

set_attributesAndCredits(aandc): string
Set this tour's "attributes and credits" text".
Parameters
- aandc: string
Returns string
- Defined in engine/src/index.d.ts:1941

set_authorUrl

set_authorUrl(title): string
Set the "author URL" of this tour.
Parameters
- title: string
Returns string
- Defined in engine/src/index.d.ts:1947

set_description

set_description(desc): string
Set this tour's description.
Parameters
- desc: string
Returns string
- Defined in engine/src/index.d.ts:1964

set_title

set_title(title): string
Set this tour's title.
Parameters
- title: string
Returns string
- Defined in engine/src/index.d.ts:1973

Generated using TypeDoc