Options
All
  • Public
  • Public/Protected
  • All
Menu

Manage the movement of the camera along the journey and story

Hierarchy

  • navigation

Index

Constructors

constructor

  • new navigation(system: system, scrollCatcher: scrollCatcher, mouseCatcher: mouseCatcher, pipeline: pipeline, progressBar: progressBar): navigation
  • Parameters

    • system: system

      System of the 3D scene

    • scrollCatcher: scrollCatcher

      Used to manage journey progress depending on scroll

    • mouseCatcher: mouseCatcher

      Used when camera has to follow mouse movement

    • pipeline: pipeline

      Used to make journey pipeline transition depending on pointofviews options

    • progressBar: progressBar

      Used to set the number of step to show on the progress bar

    Returns navigation

Properties

camera

camera: FreeCamera | VRDeviceOrientationFreeCamera

Scene Camera to be used in movement changes

currentMousePosition

currentMousePosition: Vector2

The mouse position currently followed

currentPosition

currentPosition: Vector3

Current position of the cameras

currentRotation

currentRotation: Vector3

Current rotation of the cameras

duration

duration: number = 1

Duration between two point of view to make it more or less precise and quick

followmouse

followmouse: boolean = false

Is the cameras following mouse movement

guicamera

guicamera: FreeCamera | VRDeviceOrientationFreeCamera

GUI Camera to be used in movement changes so that hotspot labels stay located at the right place

pointofviews

pointofviews: any

List of all journey point of views

positions

positions: Array<Vector3>

Determine the spline of the journey in the 3D scene

rotations

rotations: Array<Vector3>

Determine the spline of the journey in the 3D scene

sortedPointofViews

sortedPointofViews: Array<string>

The list of point of view sorted by their position in the journey path

Methods

addPointOfView

animViewPercentage

  • animViewPercentage(perc: number): void
  • Set the navigation along the journey changing the position and rotation of the cameras, plus the pipeline corresponding of the point of view

    Parameters

    • perc: number

      Progress in the journey

    Returns void

checkOption

getSortedPointofViews

  • getSortedPointofViews(): Array<string>

getSpline

  • getSpline(pointofviewsSorted: Array<string>): void
  • Determine the spline of the journey in the 3D scene

    Parameters

    • pointofviewsSorted: Array<string>

    Returns void

initialize

  • initialize(): void

moveToPointofView

  • moveToPointofView(pointofviewName: string): void

setCameraPosition

  • setCameraPosition(position: Vector3): void
  • Set the cameras position in the 3D scene

    Parameters

    • position: Vector3

      Position to set

    Returns void

setCameraRotation

  • setCameraRotation(rotation: Vector3): void
  • Set the cameras rotation in the 3D scene

    Parameters

    • rotation: Vector3

      Rotation to set

    Returns void

setNormalCamera

  • setNormalCamera(): void

setPipelineChange

  • setPipelineChange(perc: number): void
  • Set pipeline effects along the journey

    Parameters

    • perc: number

      Progress in the journey

    Returns void

setPointOfViews

showPointofview

showStartPointofview

  • showStartPointofview(): void

start

  • start(callback?: Function): void
  • Start navigation with a small animation which will put the camera at the beginning of the journey

    Parameters

    • Optional callback: Function

      call when animation is finished

    Returns void

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc