BaseLayerPickerViewModel.js 9.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303
  1. import defaultValue from "../../Core/defaultValue.js";
  2. import defined from "../../Core/defined.js";
  3. import DeveloperError from "../../Core/DeveloperError.js";
  4. import EllipsoidTerrainProvider from "../../Core/EllipsoidTerrainProvider.js";
  5. import knockout from "../../ThirdParty/knockout.js";
  6. import createCommand from "../createCommand.js";
  7. /**
  8. * The view model for {@link BaseLayerPicker}.
  9. * @alias BaseLayerPickerViewModel
  10. * @constructor
  11. *
  12. * @param {Object} options Object with the following properties:
  13. * @param {Globe} options.globe The Globe to use.
  14. * @param {ProviderViewModel[]} [options.imageryProviderViewModels=[]] The array of ProviderViewModel instances to use for imagery.
  15. * @param {ProviderViewModel} [options.selectedImageryProviderViewModel] The view model for the current base imagery layer, if not supplied the first available imagery layer is used.
  16. * @param {ProviderViewModel[]} [options.terrainProviderViewModels=[]] The array of ProviderViewModel instances to use for terrain.
  17. * @param {ProviderViewModel} [options.selectedTerrainProviderViewModel] The view model for the current base terrain layer, if not supplied the first available terrain layer is used.
  18. *
  19. * @exception {DeveloperError} imageryProviderViewModels must be an array.
  20. * @exception {DeveloperError} terrainProviderViewModels must be an array.
  21. */
  22. function BaseLayerPickerViewModel(options) {
  23. options = defaultValue(options, defaultValue.EMPTY_OBJECT);
  24. const globe = options.globe;
  25. const imageryProviderViewModels = defaultValue(
  26. options.imageryProviderViewModels,
  27. []
  28. );
  29. const terrainProviderViewModels = defaultValue(
  30. options.terrainProviderViewModels,
  31. []
  32. );
  33. //>>includeStart('debug', pragmas.debug);
  34. if (!defined(globe)) {
  35. throw new DeveloperError("globe is required");
  36. }
  37. //>>includeEnd('debug');
  38. this._globe = globe;
  39. /**
  40. * Gets or sets an array of ProviderViewModel instances available for imagery selection.
  41. * This property is observable.
  42. * @type {ProviderViewModel[]}
  43. */
  44. this.imageryProviderViewModels = imageryProviderViewModels.slice(0);
  45. /**
  46. * Gets or sets an array of ProviderViewModel instances available for terrain selection.
  47. * This property is observable.
  48. * @type {ProviderViewModel[]}
  49. */
  50. this.terrainProviderViewModels = terrainProviderViewModels.slice(0);
  51. /**
  52. * Gets or sets whether the imagery selection drop-down is currently visible.
  53. * @type {Boolean}
  54. * @default false
  55. */
  56. this.dropDownVisible = false;
  57. knockout.track(this, [
  58. "imageryProviderViewModels",
  59. "terrainProviderViewModels",
  60. "dropDownVisible",
  61. ]);
  62. const imageryObservable = knockout.getObservable(
  63. this,
  64. "imageryProviderViewModels"
  65. );
  66. const imageryProviders = knockout.pureComputed(function () {
  67. const providers = imageryObservable();
  68. const categories = {};
  69. let i;
  70. for (i = 0; i < providers.length; i++) {
  71. const provider = providers[i];
  72. const category = provider.category;
  73. if (defined(categories[category])) {
  74. categories[category].push(provider);
  75. } else {
  76. categories[category] = [provider];
  77. }
  78. }
  79. const allCategoryNames = Object.keys(categories);
  80. const result = [];
  81. for (i = 0; i < allCategoryNames.length; i++) {
  82. const name = allCategoryNames[i];
  83. result.push({
  84. name: name,
  85. providers: categories[name],
  86. });
  87. }
  88. return result;
  89. });
  90. this._imageryProviders = imageryProviders;
  91. const terrainObservable = knockout.getObservable(
  92. this,
  93. "terrainProviderViewModels"
  94. );
  95. const terrainProviders = knockout.pureComputed(function () {
  96. const providers = terrainObservable();
  97. const categories = {};
  98. let i;
  99. for (i = 0; i < providers.length; i++) {
  100. const provider = providers[i];
  101. const category = provider.category;
  102. if (defined(categories[category])) {
  103. categories[category].push(provider);
  104. } else {
  105. categories[category] = [provider];
  106. }
  107. }
  108. const allCategoryNames = Object.keys(categories);
  109. const result = [];
  110. for (i = 0; i < allCategoryNames.length; i++) {
  111. const name = allCategoryNames[i];
  112. result.push({
  113. name: name,
  114. providers: categories[name],
  115. });
  116. }
  117. return result;
  118. });
  119. this._terrainProviders = terrainProviders;
  120. /**
  121. * Gets the button tooltip. This property is observable.
  122. * @type {String}
  123. */
  124. this.buttonTooltip = undefined;
  125. knockout.defineProperty(this, "buttonTooltip", function () {
  126. const selectedImagery = this.selectedImagery;
  127. const selectedTerrain = this.selectedTerrain;
  128. const imageryTip = defined(selectedImagery)
  129. ? selectedImagery.name
  130. : undefined;
  131. const terrainTip = defined(selectedTerrain)
  132. ? selectedTerrain.name
  133. : undefined;
  134. if (defined(imageryTip) && defined(terrainTip)) {
  135. return `${imageryTip}\n${terrainTip}`;
  136. } else if (defined(imageryTip)) {
  137. return imageryTip;
  138. }
  139. return terrainTip;
  140. });
  141. /**
  142. * Gets the button background image. This property is observable.
  143. * @type {String}
  144. */
  145. this.buttonImageUrl = undefined;
  146. knockout.defineProperty(this, "buttonImageUrl", function () {
  147. const selectedImagery = this.selectedImagery;
  148. if (defined(selectedImagery)) {
  149. return selectedImagery.iconUrl;
  150. }
  151. });
  152. /**
  153. * Gets or sets the currently selected imagery. This property is observable.
  154. * @type {ProviderViewModel}
  155. * @default undefined
  156. */
  157. this.selectedImagery = undefined;
  158. const selectedImageryViewModel = knockout.observable();
  159. this._currentImageryProviders = [];
  160. knockout.defineProperty(this, "selectedImagery", {
  161. get: function () {
  162. return selectedImageryViewModel();
  163. },
  164. set: function (value) {
  165. if (selectedImageryViewModel() === value) {
  166. this.dropDownVisible = false;
  167. return;
  168. }
  169. let i;
  170. const currentImageryProviders = this._currentImageryProviders;
  171. const currentImageryProvidersLength = currentImageryProviders.length;
  172. const imageryLayers = this._globe.imageryLayers;
  173. let hadExistingBaseLayer = false;
  174. for (i = 0; i < currentImageryProvidersLength; i++) {
  175. const layersLength = imageryLayers.length;
  176. for (let x = 0; x < layersLength; x++) {
  177. const layer = imageryLayers.get(x);
  178. if (layer.imageryProvider === currentImageryProviders[i]) {
  179. imageryLayers.remove(layer);
  180. hadExistingBaseLayer = true;
  181. break;
  182. }
  183. }
  184. }
  185. if (defined(value)) {
  186. const newProviders = value.creationCommand();
  187. if (Array.isArray(newProviders)) {
  188. const newProvidersLength = newProviders.length;
  189. for (i = newProvidersLength - 1; i >= 0; i--) {
  190. imageryLayers.addImageryProvider(newProviders[i], 0);
  191. }
  192. this._currentImageryProviders = newProviders.slice(0);
  193. } else {
  194. this._currentImageryProviders = [newProviders];
  195. if (hadExistingBaseLayer) {
  196. imageryLayers.addImageryProvider(newProviders, 0);
  197. } else {
  198. const baseLayer = imageryLayers.get(0);
  199. if (defined(baseLayer)) {
  200. imageryLayers.remove(baseLayer);
  201. }
  202. imageryLayers.addImageryProvider(newProviders, 0);
  203. }
  204. }
  205. }
  206. selectedImageryViewModel(value);
  207. this.dropDownVisible = false;
  208. },
  209. });
  210. /**
  211. * Gets or sets the currently selected terrain. This property is observable.
  212. * @type {ProviderViewModel}
  213. * @default undefined
  214. */
  215. this.selectedTerrain = undefined;
  216. const selectedTerrainViewModel = knockout.observable();
  217. knockout.defineProperty(this, "selectedTerrain", {
  218. get: function () {
  219. return selectedTerrainViewModel();
  220. },
  221. set: function (value) {
  222. if (selectedTerrainViewModel() === value) {
  223. this.dropDownVisible = false;
  224. return;
  225. }
  226. let newProvider;
  227. if (defined(value)) {
  228. newProvider = value.creationCommand();
  229. }
  230. this._globe.depthTestAgainstTerrain = !(
  231. newProvider instanceof EllipsoidTerrainProvider
  232. );
  233. this._globe.terrainProvider = newProvider;
  234. selectedTerrainViewModel(value);
  235. this.dropDownVisible = false;
  236. },
  237. });
  238. const that = this;
  239. this._toggleDropDown = createCommand(function () {
  240. that.dropDownVisible = !that.dropDownVisible;
  241. });
  242. this.selectedImagery = defaultValue(
  243. options.selectedImageryProviderViewModel,
  244. imageryProviderViewModels[0]
  245. );
  246. this.selectedTerrain = defaultValue(
  247. options.selectedTerrainProviderViewModel,
  248. terrainProviderViewModels[0]
  249. );
  250. }
  251. Object.defineProperties(BaseLayerPickerViewModel.prototype, {
  252. /**
  253. * Gets the command to toggle the visibility of the drop down.
  254. * @memberof BaseLayerPickerViewModel.prototype
  255. *
  256. * @type {Command}
  257. */
  258. toggleDropDown: {
  259. get: function () {
  260. return this._toggleDropDown;
  261. },
  262. },
  263. /**
  264. * Gets the globe.
  265. * @memberof BaseLayerPickerViewModel.prototype
  266. *
  267. * @type {Globe}
  268. */
  269. globe: {
  270. get: function () {
  271. return this._globe;
  272. },
  273. },
  274. });
  275. export default BaseLayerPickerViewModel;