Source: Widgets/HomeButton/HomeButtonViewModel.js

  1. /*global define*/
  2. define([
  3.         '../../Core/Cartesian3',
  4.         '../../Core/defaultValue',
  5.         '../../Core/defined',
  6.         '../../Core/defineProperties',
  7.         '../../Core/DeveloperError',
  8.         '../../Core/Matrix4',
  9.         '../../Core/Rectangle',
  10.         '../../Scene/Camera',
  11.         '../../Scene/SceneMode',
  12.         '../../ThirdParty/knockout',
  13.         '../createCommand'
  14.     ], function(
  15.         Cartesian3,
  16.         defaultValue,
  17.         defined,
  18.         defineProperties,
  19.         DeveloperError,
  20.         Matrix4,
  21.         Rectangle,
  22.         Camera,
  23.         SceneMode,
  24.         knockout,
  25.         createCommand) {
  26.     'use strict';
  28.     /**
  29.      * The view model for {@link HomeButton}.
  30.      * @alias HomeButtonViewModel
  31.      * @constructor
  32.      *
  33.      * @param {Scene} scene The scene instance to use.
  34.      * @param {Number} [duration] The duration of the camera flight in seconds.
  35.      */
  36.     function HomeButtonViewModel(scene, duration) {
  37.         //>>includeStart('debug', pragmas.debug);
  38.         if (!defined(scene)) {
  39.             throw new DeveloperError('scene is required.');
  40.         }
  41.         //>>includeEnd('debug');
  43.         this._scene = scene;
  44.         this._duration = duration;
  46.         var that = this;
  47.         this._command = createCommand(function() {
  48.             that._scene.camera.flyHome(that._duration);
  49.         });
  51.         /**
  52.          * Gets or sets the tooltip.  This property is observable.
  53.          *
  54.          * @type {String}
  55.          */
  56.         this.tooltip = 'View Home';
  58.         knockout.track(this, ['tooltip']);
  59.     }
  61.     defineProperties(HomeButtonViewModel.prototype, {
  62.         /**
  63.          * Gets the scene to control.
  64.          * @memberof HomeButtonViewModel.prototype
  65.          *
  66.          * @type {Scene}
  67.          */
  68.         scene : {
  69.             get : function() {
  70.                 return this._scene;
  71.             }
  72.         },
  74.         /**
  75.          * Gets the Command that is executed when the button is clicked.
  76.          * @memberof HomeButtonViewModel.prototype
  77.          *
  78.          * @type {Command}
  79.          */
  80.         command : {
  81.             get : function() {
  82.                 return this._command;
  83.             }
  84.         },
  86.         /**
  87.          * Gets or sets the the duration of the camera flight in seconds.
  88.          * A value of zero causes the camera to instantly switch to home view.
  89.          * The duration will be computed based on the distance when undefined.
  90.          * @memberof HomeButtonViewModel.prototype
  91.          *
  92.          * @type {Number|undefined}
  93.          */
  94.         duration : {
  95.             get : function() {
  96.                 return this._duration;
  97.             },
  98.             set : function(value) {
  99.                 //>>includeStart('debug', pragmas.debug);
  100.                 if (defined(value) && value < 0) {
  101.                     throw new DeveloperError('value must be positive.');
  102.                 }
  103.                 //>>includeEnd('debug');
  105.                 this._duration = value;
  106.             }
  107.         }
  108.     });
  110.     return HomeButtonViewModel;
  111. });