-
Notifications
You must be signed in to change notification settings - Fork 0
/
Documentation.xml
4000 lines (4000 loc) · 183 KB
/
Documentation.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0"?>
<doc>
<assembly>
<name>FC.GEPluginCtrls</name>
</assembly>
<members>
<member name="T:FC.GEPluginCtrls.GEOptions">
<summary>
Wrapper for the GEOptions com object.
Acts as a proxy and maps all the getter and setter methods to managed properties.
</summary>
</member>
<member name="F:FC.GEPluginCtrls.GEOptions.options">
<summary>
The options object
</summary>
</member>
<member name="M:FC.GEPluginCtrls.GEOptions.#ctor(System.Object)">
<summary>
Initializes a new instance of the GEOptions class.
</summary>
<param name="ge">the plugin object</param>
</member>
<member name="M:FC.GEPluginCtrls.GEOptions.SetMapType(FC.GEPluginCtrls.MapType)">
<summary>
Sets the map type to Earth or sky mode.
</summary>
<param name="mapType">The MapType to use in the plug-in</param>
</member>
<member name="P:FC.GEPluginCtrls.GEOptions.AtmosphereVisibility">
<summary>
Gets or sets a value indicating whether to show the blue atmosphere that appears around the perimeter of the Earth
On by default.
</summary>
</member>
<member name="P:FC.GEPluginCtrls.GEOptions.AutoGroundLevelViewEnabled">
<summary>
Gets or sets a value indicating whether automatic ground level view is enabled.
When enabled, the view will change to 'ground level view' when the camera reaches ground level.
This view provides pan and lookAt controls, but no zoom slider.
The tilt will be set to 90, or parallel with level ground.
</summary>
</member>
<member name="P:FC.GEPluginCtrls.GEOptions.BuildingHighlightingEnabled">
<summary>
Gets or sets a value indicating whether building highlighting is enabled.
When enabled, buildings will be highlighted when a mouse-over event occurs on them.
Disabled by default
</summary>
</member>
<member name="P:FC.GEPluginCtrls.GEOptions.BuildingSelectionEnabled">
<summary>
Gets or sets a value indicating whether building selection is enabled.
If enabled, clicking a building will pop a feature balloon containing information from the Google 3D Warehouse database.
</summary>
</member>
<member name="P:FC.GEPluginCtrls.GEOptions.FadeInOutEnabled">
<summary>
Gets or sets a value indicating whether animation of a features when added/removed from the plugin is enabled
The animation consists of a slight change of scale.
Default is true.
</summary>
</member>
<member name="P:FC.GEPluginCtrls.GEOptions.FlyToSpeed">
<summary>
Gets or sets a value indicating the speed at which the camera moves (0 to 5.0).
Set to SPEED_TELEPORT to immediately appear at selected destination.
</summary>
</member>
<member name="P:FC.GEPluginCtrls.GEOptions.GridVisibility">
<summary>
Gets or sets a value indicating whether the grid is visible. Disabled by default.
</summary>
</member>
<member name="P:FC.GEPluginCtrls.GEOptions.MouseNavigationEnabled">
<summary>
Gets or sets a value indicating whether user mouse control is enabled. Enabled by default.
Note: This also enables and disables keyboard navigation (arrow keys, page-up/page-down, etc).
</summary>
</member>
<member name="P:FC.GEPluginCtrls.GEOptions.OverviewMapVisibility">
<summary>
Gets or sets a value indicating whether the overview map is visible. Disabled by default.
</summary>
</member>
<member name="P:FC.GEPluginCtrls.GEOptions.ScaleLegendVisibility">
<summary>
Gets or sets a value indicating whether the scale legend is visible. Disabled by default.
</summary>
</member>
<member name="P:FC.GEPluginCtrls.GEOptions.ScrollWheelZoomSpeed">
<summary>
Gets or sets a value indicating the speed of zoom when user rolls the mouse wheel.
Default is 1. Set to a negative number to reverse the zoom direction.
</summary>
</member>
<member name="P:FC.GEPluginCtrls.GEOptions.StatusBarVisibility">
<summary>
Gets or sets a value indicating whether the status bar is visible. Disabled by default.
</summary>
</member>
<member name="P:FC.GEPluginCtrls.GEOptions.TerrainExaggeration">
<summary>
Gets or sets a value indicating the terrain exaggeration value.
Valid values are in the range of 1.0 through 3.0.
Attempting to set outside of this range will result in the value being clamped.
</summary>
</member>
<member name="P:FC.GEPluginCtrls.GEOptions.UnitsFeetMiles">
<summary>
Gets or sets a value indicating whether to display units in imperial (feet and miles)
or metric (meters and kilometres). A value of true uses imperial, false metric.
This setting affects only the values displayed in the status bar and the scale bar.
The values passed and returned with an object's properties are always metric.
Default value is false (metric)
</summary>
</member>
<member name="T:FC.GEPluginCtrls.Geo.Maths">
<summary>
Various Geodesic methods to work with the plugin api
This class is based on the JavaScript library geojs by Roman Nurik
See http://code.google.com/p/geojs/
</summary>
</member>
<member name="F:FC.GEPluginCtrls.Geo.Maths.EarthMeanRadiusKilometres">
<summary>
Earth’s mean radius in Kilometres
</summary>
</member>
<member name="F:FC.GEPluginCtrls.Geo.Maths.EarthMeanRadiusMiles">
<summary>
Earth’s mean radius in miles
</summary>
</member>
<member name="F:FC.GEPluginCtrls.Geo.Maths.MilesToKilometresRatio">
<summary>
Miles To Kilometres Conversion ratio.
</summary>
<remarks>divide by to get miles to km, multiply to get km to miles</remarks>
</member>
<member name="F:FC.GEPluginCtrls.Geo.Maths.FeetToMetresRatio">
<summary>
Feet to Metres conversion ratio.
</summary>
</member>
<member name="M:FC.GEPluginCtrls.Geo.Maths.BearingFinal(FC.GEPluginCtrls.Geo.Coordinate,FC.GEPluginCtrls.Geo.Coordinate)">
<summary>
Get the final bearing from one Coordinate to another
</summary>
<param name="origin">the start Coordinate</param>
<param name="destination">the destination Coordinate</param>
<returns>The final bearing from start to destination</returns>
<remarks>See: http://williams.best.vwh.net/avform.htm for the original function </remarks>
</member>
<member name="M:FC.GEPluginCtrls.Geo.Maths.BearingInitial(FC.GEPluginCtrls.Geo.Coordinate,FC.GEPluginCtrls.Geo.Coordinate)">
<summary>
Get the initial bearing from one location to another
</summary>
<param name="origin">the starting location</param>
<param name="destination">the destination location</param>>
<remarks>See: http://williams.best.vwh.net/avform.htm for the original function </remarks>
<returns>The initial bearing from origin to destination</returns>
</member>
<member name="M:FC.GEPluginCtrls.Geo.Maths.ConvertDegreesToRadians(System.Double)">
<summary>
Converts decimal degrees to radians
</summary>
<param name="degrees">value in degrees</param>
<returns>value in radians</returns>
</member>
<member name="M:FC.GEPluginCtrls.Geo.Maths.ConvertRadiansToDegrees(System.Double)">
<summary>
Converts radians to decimal degrees
</summary>
<param name="radians">value in radians</param>
<returns>value in degrees</returns>
</member>
<member name="M:FC.GEPluginCtrls.Geo.Maths.ConvertHeadingToBearing(System.Double)">
<summary>
Converts a heading in the range [-180,180] to a bearing in the range [0,360]
</summary>
<param name="heading">heading in the range [-180,180]</param>
<returns>bearing in the range [0,360]</returns>
</member>
<member name="M:FC.GEPluginCtrls.Geo.Maths.ConvertKilometresToMiles(System.Double)">
<summary>
Convert Kilometres To Miles
</summary>
<param name="kilometres">distance in kilometres</param>
<returns>distance in miles</returns>
</member>
<member name="M:FC.GEPluginCtrls.Geo.Maths.ConvertMilesToKilometres(System.Double)">
<summary>
Convert Miles To Kilometres
</summary>
<param name="miles">distance in miles</param>
<returns>distance in kilometres</returns>
</member>
<member name="M:FC.GEPluginCtrls.Geo.Maths.Destination(FC.GEPluginCtrls.Geo.Coordinate,System.Double,System.Double,FC.GEPluginCtrls.UnitSystem)">
<summary>
Destination point given distance and bearing from start point
</summary>
<param name="origin">the start point</param>
<param name="distance">the given distance in km or m</param>
<param name="bearing">the bearing in radians, clockwise from north</param>
<param name="units">The unit system to use, default is metric</param>
<returns>destination location as a Tuple(double lat, double lng)</returns>
</member>
<member name="M:FC.GEPluginCtrls.Geo.Maths.DistanceCosine(System.Object,System.Object,FC.GEPluginCtrls.UnitSystem)">
<summary>
Returns the distance in miles or kilometres of any two latitude / longitude points.
</summary>
<param name="origin">The start api object </param>
<param name="destination">The destination api object</param>
<param name="units">The unit system to use, default is metric</param>
<returns>Distance in kilometres</returns>
</member>
<member name="M:FC.GEPluginCtrls.Geo.Maths.DistanceCosine(FC.GEPluginCtrls.Geo.Coordinate,FC.GEPluginCtrls.Geo.Coordinate,FC.GEPluginCtrls.UnitSystem)">
<summary>
Returns the distance in miles or kilometres of any two latitude / longitude points.
</summary>
<param name="origin">The start latitude and longitude </param>
<param name="destination">The destination latitude and longitude </param>
<param name="units">The unit system to use, default is metric</param>
<returns>Distance in kilometres</returns>
</member>
<member name="M:FC.GEPluginCtrls.Geo.Maths.DistanceHaversine(FC.GEPluginCtrls.Geo.Coordinate,FC.GEPluginCtrls.Geo.Coordinate,FC.GEPluginCtrls.UnitSystem)">
<summary>
Returns the distance in miles or kilometres of any two latitude / longitude points.
</summary>
<param name="origin">The start latitude and longitude </param>
<param name="destination">The destination latitude and longitude </param>
<param name="units">The unit system to use, default is metric</param>
<returns>Distance in kilometres</returns>
</member>
<member name="M:FC.GEPluginCtrls.Geo.Maths.DistanceHaversine(System.Object,System.Object,FC.GEPluginCtrls.UnitSystem)">
<summary>
Returns the distance in miles or kilometres of any two latitude / longitude points.
</summary>
<param name="origin">The start latitude and longitude </param>
<param name="destination">The destination latitude and longitude </param>
<param name="units">The unit system to use, default is metric</param>
<returns>Distance in kilometres</returns>
</member>
<member name="M:FC.GEPluginCtrls.Geo.Maths.NormalizeAngle(System.Double)">
<summary>
Keep a number in the [0,PI] range
</summary>
<param name="radians">value in radians</param>
<returns>normalised angle in radians</returns>
</member>
<member name="M:FC.GEPluginCtrls.Geo.Maths.FixLatitude(System.Double)">
<summary>
Normalises a latitude to the [-90,90] range.
Latitudes above 90 or below -90 are constrained rather than wrapped.
</summary>
<param name="latitude">The latitude in degrees to normalize.</param>
<returns>Latitude within the [-90,90] range</returns>
</member>
<member name="M:FC.GEPluginCtrls.Geo.Maths.FixLongitude(System.Double)">
<summary>
Normalizes a longitude to the [-180,180] range.
Longitudes above 180 or below -180 are wrapped.
If the wrapped value is exactly equal to min or max, favours max, unless favorMin is true.
</summary>
<param name="longitude">The longitude in degrees to normalize</param>
<returns>Longitude within the [-180,180] range</returns>
</member>
<member name="M:FC.GEPluginCtrls.Geo.Maths.ReverseAngle(System.Double)">
<summary>
Reverses a number in the [0,PI] range
</summary>
<param name="radians">value in radians</param>
<returns>The opposite angle</returns>
</member>
<member name="M:FC.GEPluginCtrls.Geo.Maths.WrapValue(System.Double,System.Double,System.Double,System.Boolean)">
<summary>
Wraps the given number to the given range.
If the wrapped value is exactly equal to min or max, favors max, unless favorMin is true.
</summary>
<param name="value">The value to wrap</param>
<param name="min">The minimum bound of the range</param>
<param name="max">The maximum bound of the range</param>
<param name="favorMin">Whether or not to favor min over max in the case of ambiguity. Default is false</param>
<returns>The value in the given range.</returns>
</member>
<member name="M:FC.GEPluginCtrls.Geo.Maths.ConstrainValue(System.Double,System.Double,System.Double)">
<summary>
Constrains the given number to the given range.
</summary>
<param name="value">The value to wrap</param>
<param name="min">The minimum bound of the range</param>
<param name="max">The maximum bound of the range</param>
<returns>The value constrained to the given range</returns>
</member>
<member name="T:FC.GEPluginCtrls.External">
<summary>
This COM Visible class contains all the public methods to be called from JavaScript.
The various events are used by the <see cref="T:FC.GEPluginCtrls.GEWebBrowser"/> when dealing with the plug-in
</summary>
</member>
<member name="F:FC.GEPluginCtrls.External.AutoResetDictionary">
<summary>
Cache of kml event objects
</summary>
</member>
<member name="F:FC.GEPluginCtrls.External.KmlObjectDictionary">
<summary>
Stores fetched Kml Objects
</summary>
</member>
<member name="M:FC.GEPluginCtrls.External.DebugMessage(System.String,System.String)">
<summary>
Allows JavaScript to send debug messages
</summary>
<param name="category">the category of the message</param>
<param name="message">the debug message</param>
</member>
<member name="M:FC.GEPluginCtrls.External.Ready(System.Object)">
<summary>
Called from JavaScript when the plugin is ready
</summary>
<param name="ge">the plugin instance</param>
</member>
<member name="M:FC.GEPluginCtrls.External.SendError(System.String,System.String)">
<summary>
Called from JavaScript when there is an error
</summary>
<param name="type">the error message</param>
<param name="message">the error type</param>
</member>
<member name="M:FC.GEPluginCtrls.External.KmlEventCallback(System.Object,System.String)">
<summary>
Called from JavaScript when there is a kml event
</summary>
<param name="kmlEvent">the kml event</param>
<param name="action">the event id</param>
</member>
<member name="M:FC.GEPluginCtrls.External.PluginEventCallback(System.Object,System.String)">
<summary>
Called from JavaScript when there is a GEPlugin event
</summary>
<param name="sender">The plugin object</param>
<param name="action">The event action</param>
</member>
<member name="M:FC.GEPluginCtrls.External.ViewEventCallback(System.Object,System.String)">
<summary>
Called from JavaScript when there is a View event
</summary>
<param name="sender">The plug-in object</param>
<param name="action">The event action</param>
</member>
<member name="M:FC.GEPluginCtrls.External.FetchKmlCallback(System.Object)">
<summary>
Called from JavaScript when Kml has been fetched
</summary>
<param name="KmlObject">The fetched Kml object</param>
</member>
<member name="M:FC.GEPluginCtrls.External.FetchKmlSynchronousCallback(System.Object,System.String)">
<summary>
Called from JavaScript when Kml has been synchronously fetched
</summary>
<param name="KmlObject">The fetched Kml object</param>
<param name="url">The url that the object was fetched from</param>
</member>
<member name="M:FC.GEPluginCtrls.External.OnPluginReady(System.Object,FC.GEPluginCtrls.GEEventArgs)">
<summary>
Protected method for raising the PluginReady event
</summary>
<param name="sender">The object that raised the event.</param>
<param name="e">Event arguments.</param>
</member>
<member name="M:FC.GEPluginCtrls.External.OnKmlEvent(System.Object,FC.GEPluginCtrls.GEEventArgs)">
<summary>
Protected method for raising the KmlEvent event
</summary>
<param name="kmlEvent">The kmlEvent object</param>
<param name="e">The Event arguments</param>
</member>
<member name="M:FC.GEPluginCtrls.External.OnFetchKml(FC.GEPluginCtrls.GEEventArgs)">
<summary>
Protected method for raising the KmlLoaded event
</summary>
<param name="e">The Event arguments</param>
</member>
<member name="M:FC.GEPluginCtrls.External.OnFetchKmlSynchronous(FC.GEPluginCtrls.GEEventArgs)">
<summary>
Protected method for capturing fetched IKmlObjects
</summary>
<param name="e">The Event arguments</param>
</member>
<member name="M:FC.GEPluginCtrls.External.OnScriptError(System.Object,FC.GEPluginCtrls.GEEventArgs)">
<summary>
Protected method for raising the ScriptError event
</summary>
<param name="sender">The object that raised the event.</param>
<param name="e">Event arguments.</param>
</member>
<member name="M:FC.GEPluginCtrls.External.OnPluginEvent(System.Object,FC.GEPluginCtrls.GEEventArgs)">
<summary>
Protected method for raising the PluginEvent event
</summary>
<param name="sender">The object that raised the event.</param>
<param name="e">Event arguments.</param>
</member>
<member name="M:FC.GEPluginCtrls.External.OnViewEvent(System.Object,FC.GEPluginCtrls.GEEventArgs)">
<summary>
Protected method for raising the ViewEvent event
</summary>
<param name="sender">The object that raised the event.</param>
<param name="e">Event arguments.</param>
</member>
<member name="E:FC.GEPluginCtrls.External.PluginReady">
<summary>
Raised when the plugin is ready
</summary>
</member>
<member name="E:FC.GEPluginCtrls.External.KmlEvent">
<summary>
Raised when there is a kml event
</summary>
</member>
<member name="E:FC.GEPluginCtrls.External.KmlLoaded">
<summary>
Raised when a KML/KMZ file has loaded
</summary>
</member>
<member name="E:FC.GEPluginCtrls.External.ScriptError">
<summary>
Raised when there is a script error in the document
</summary>
</member>
<member name="E:FC.GEPluginCtrls.External.PluginEvent">
<summary>
Raised when there is a GEPlugin event (frameend, balloonclose)
</summary>
</member>
<member name="E:FC.GEPluginCtrls.External.ViewEvent">
<summary>
Raised when there is a viewchangebegin, viewchange or viewchangeend event
</summary>
</member>
<member name="P:FC.GEPluginCtrls.External.KmlDictionary">
<summary>
Gets the store of fetched IKmlObjects.
Used in the process of synchronously loading network links
</summary>
</member>
<member name="T:FC.GEPluginCtrls.EventId">
<summary>
The various plugin event ids
</summary>
</member>
<member name="F:FC.GEPluginCtrls.EventId.None">
<summary>
No action (none)
</summary>
</member>
<member name="F:FC.GEPluginCtrls.EventId.Click">
<summary>
The click event id
</summary>
</member>
<member name="F:FC.GEPluginCtrls.EventId.DblClick">
<summary>
The double click event id
</summary>
</member>
<member name="F:FC.GEPluginCtrls.EventId.MouseOver">
<summary>
The mouse over event id
</summary>
</member>
<member name="F:FC.GEPluginCtrls.EventId.MouseDown">
<summary>
The mouse down event id
</summary>
</member>
<member name="F:FC.GEPluginCtrls.EventId.MouseUp">
<summary>
The mouse up event id
</summary>
</member>
<member name="F:FC.GEPluginCtrls.EventId.MouseOut">
<summary>
The mouse out event id
</summary>
</member>
<member name="F:FC.GEPluginCtrls.EventId.MouseMove">
<summary>
The mouse move event id
</summary>
</member>
<member name="F:FC.GEPluginCtrls.EventId.FrameEnd">
<summary>
The frame end event id
</summary>
</member>
<member name="F:FC.GEPluginCtrls.EventId.BalloonClose">
<summary>
The balloon close event id
</summary>
</member>
<member name="F:FC.GEPluginCtrls.EventId.BalloonOpening">
<summary>
The balloon opening event id
</summary>
</member>
<member name="F:FC.GEPluginCtrls.EventId.ViewChangeBegin">
<summary>
The view change begin event id
</summary>
</member>
<member name="F:FC.GEPluginCtrls.EventId.ViewChange">
<summary>
The view change event id
</summary>
</member>
<member name="F:FC.GEPluginCtrls.EventId.ViewChangeEnd">
<summary>
The view change end event id
</summary>
</member>
<member name="T:FC.GEPluginCtrls.KmlColor">
<summary>
Wrapper for the KmlColor object, maps all the getter and setter methods to managed properties.
<para>
The range of values for any one colour component is 0 to 255 (0x00 to 0xff).
For alpha, 0x00 is fully transparent and 0xff is fully opaque.
</para>
</summary>
</member>
<member name="F:FC.GEPluginCtrls.KmlColor.alpha">
<summary>
Alpha (opacity) value
</summary>
</member>
<member name="F:FC.GEPluginCtrls.KmlColor.blue">
<summary>
Blue value
</summary>
</member>
<member name="F:FC.GEPluginCtrls.KmlColor.green">
<summary>
Green value
</summary>
</member>
<member name="F:FC.GEPluginCtrls.KmlColor.red">
<summary>
Red value
</summary>
</member>
<member name="M:FC.GEPluginCtrls.KmlColor.#ctor(System.Byte,System.Byte,System.Byte,System.Byte)">
<summary>
Initializes a new instance of the KmlColor struct.
</summary>
<param name="alpha"> the alpha value, Default 255 </param>
<param name="blue"> the blue value, Default 255 </param>
<param name="green"> the green value, Default 255 </param>
<param name="red"> the red value, Default 255 </param>
</member>
<member name="M:FC.GEPluginCtrls.KmlColor.#ctor(System.Drawing.Color,System.Double)">
<summary>
Initializes a new instance of the KmlColor struct from a system colour and alpha value.
</summary>
<param name="color"> the colour to base the new kml colour on </param>
<param name="alpha"> Optional alpha value in the range [0-1]. <para>
Where 0 is fully transparent and 1 is fully opaque. Default value is 1
</para>
</param>
</member>
<member name="M:FC.GEPluginCtrls.KmlColor.#ctor(System.String,System.Double)">
<summary>
Initializes a new instance of the KmlColor struct from a colour name and alpha value.
<para>
Named colours are listed here:
http://msdn.microsoft.com/en-us/library/system.drawing.knowncolor.aspx
If the name parameter is not the valid name of a predefined colour,
the KmlColour defaults to black (0x000000)
</para>
</summary>
<param name="name"> The name of the colour </param>
<param name="alpha"> Optional alpha value in the range [0-1]. <para>
Where 0 is fully transparent and 1 is fully opaque. Default value is 1
</para>
</param>
</member>
<member name="M:FC.GEPluginCtrls.KmlColor.#ctor(System.Object)">
<summary>
Initializes a new instance of the KmlColor struct from a Google API KmlColor object.
</summary>
<param name="color">A Google API KmlColor object to base the new colour on</param>
</member>
<member name="M:FC.GEPluginCtrls.KmlColor.op_Equality(FC.GEPluginCtrls.KmlColor,FC.GEPluginCtrls.KmlColor)">
<summary>
KmlColor equality operator
</summary>
<param name="color1"> The first KmlColor </param>
<param name="color2"> The Second KmlColor </param>
<returns> True if the two KmlColors are equal </returns>
</member>
<member name="M:FC.GEPluginCtrls.KmlColor.op_Inequality(FC.GEPluginCtrls.KmlColor,FC.GEPluginCtrls.KmlColor)">
<summary>
KmlColor inequality operator
</summary>
<param name="color1"> The first KmlColor </param>
<param name="color2"> The Second KmlColor </param>
<returns> True if the two KmlColors are unequal </returns>
</member>
<member name="M:FC.GEPluginCtrls.KmlColor.Equals(System.Object)">
<summary>
KmlColor equality
</summary>
<param name="obj"> the object to check against </param>
<returns> True if the KmlColor are equal </returns>
</member>
<member name="M:FC.GEPluginCtrls.KmlColor.Equals(FC.GEPluginCtrls.KmlColor)">
<summary>
KmlColor equality
</summary>
<param name="other"> the KmlColor to check against </param>
<returns> True if the KmlColor are equal </returns>
</member>
<member name="M:FC.GEPluginCtrls.KmlColor.GetHashCode">
<summary>
Returns the hash code for this instance.
</summary>
<returns> the hash code for this instance. </returns>
</member>
<member name="M:FC.GEPluginCtrls.KmlColor.ToString">
<summary>
Overrides the ToString method
</summary>
<returns> The KmlColor object in the aabbggrr format </returns>
</member>
<member name="M:FC.GEPluginCtrls.KmlColor.AlphaRangeFix(System.Double)">
<summary>
Converts a System.double in the range [0.0-1.0] to a System.byte [0-255]
</summary>
<param name="input"> The alpha value as a double </param>
<returns> The alpha value as a byte </returns>
</member>
<member name="P:FC.GEPluginCtrls.KmlColor.Alpha">
<summary>
Gets the Alpha (opacity) value
</summary>
</member>
<member name="P:FC.GEPluginCtrls.KmlColor.Blue">
<summary>
Gets the Blue value
</summary>
</member>
<member name="P:FC.GEPluginCtrls.KmlColor.Green">
<summary>
Gets the Green value
</summary>
</member>
<member name="P:FC.GEPluginCtrls.KmlColor.Red">
<summary>
Gets the Red value
</summary>
</member>
<member name="T:FC.GEPluginCtrls.GEWindow">
<summary>
Wrapper for the GEWindow com object.
Maps all its getter and setter methods to managed properties
</summary>
</member>
<member name="F:FC.GEPluginCtrls.GEWindow.window">
<summary>
The options object
</summary>
</member>
<member name="M:FC.GEPluginCtrls.GEWindow.#ctor(System.Object)">
<summary>
Initializes a new instance of the GEWindow class.
</summary>
<param name="ge">the plug-in object</param>
</member>
<member name="M:FC.GEPluginCtrls.GEWindow.Focus">
<summary>
Gives the Google Earth object focus.
</summary>
</member>
<member name="M:FC.GEPluginCtrls.GEWindow.Blur">
<summary>
Removes focus from the Google Earth object.
</summary>
</member>
<member name="P:FC.GEPluginCtrls.GEWindow.Visibility">
<summary>
Gets or sets a value indicating whether Google Earth is visible inside the browser
</summary>
</member>
<member name="T:FC.GEPluginCtrls.IHtmlScriptElement">
<summary>
A COM interface is needed because .NET does not provide a way
to set the properties of a HTML script element.
This negates the need to reference MSHTML
</summary>
</member>
<member name="P:FC.GEPluginCtrls.IHtmlScriptElement.Text">
<summary>
Sets the text property
</summary>
</member>
<member name="P:FC.GEPluginCtrls.IHtmlScriptElement.Src">
<summary>
Sets the src property
</summary>
</member>
<member name="T:FC.GEPluginCtrls.GEWebBrowser">
<summary>
Designer file
</summary>
<summary>
This browser control holds the Google Earth Plug-in,
it also provides wrapper methods to work with the Google.Earth namespace
</summary>
</member>
<member name="F:FC.GEPluginCtrls.GEWebBrowser.components">
<summary>
Required designer variable.
</summary>
</member>
<member name="M:FC.GEPluginCtrls.GEWebBrowser.Dispose(System.Boolean)">
<summary>
Clean up any resources being used.
</summary>
<param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
</member>
<member name="M:FC.GEPluginCtrls.GEWebBrowser.InitializeComponent">
<summary>
Required method for Designer support - do not modify
the contents of this method with the code editor.
</summary>
</member>
<member name="F:FC.GEPluginCtrls.GEWebBrowser.external">
<summary>
External is A COM Visible class that holds all the public methods
to be called from JavaScript. An instance of this is set
to the base object's ObjectForScripting property in the constructor.
</summary>
</member>
<member name="F:FC.GEPluginCtrls.GEWebBrowser.plugin">
<summary>
Use the IGEPlugin COM interface.
Equivalent to QueryInterface for COM objects
</summary>
</member>
<member name="F:FC.GEPluginCtrls.GEWebBrowser.imageryBase">
<summary>
Current plug-in Imagery database - uses INotifyPropertyChanged
</summary>
</member>
<member name="F:FC.GEPluginCtrls.GEWebBrowser.pluginIsReady">
<summary>
Current plug-in state - uses INotifyPropertyChanged
</summary>
</member>
<member name="M:FC.GEPluginCtrls.GEWebBrowser.#ctor">
<summary>
Initializes a new instance of the GEWebBrowser class.
</summary>
</member>
<member name="M:FC.GEPluginCtrls.GEWebBrowser.KillPlugin(System.Boolean)">
<summary>
Kills the current plug-in processes on the system.
</summary>
<param name="all">Optionally kill all Google Earth plug-in processes on the system. Default is False</param>
</member>
<member name="M:FC.GEPluginCtrls.GEWebBrowser.AddEventListener(System.Object,FC.GEPluginCtrls.EventId,System.String,System.Boolean)">
<summary>
Wrapper for the the google.earth.addEventListener method
</summary>
<param name="feature">The target feature</param>
<param name="action">The event Id</param>
<param name="callback">Optional, the name of JavaScript callback function to use, or an anonymous function</param>
<param name="useCapture">Optionally use event capture</param>
<example>GEWebBrowser.AddEventListener(object, "click", "someFunction");</example>
<example>GEWebBrowser.AddEventListener(object, "click", "function(event){alert(event.getType);}");</example>
</member>
<member name="M:FC.GEPluginCtrls.GEWebBrowser.CreateInstance(FC.GEPluginCtrls.ImageryBase)">
<summary>
Wrapper for the google.earth.createInstance method
See: http://code.google.com/apis/earth/documentation/reference/google_earth_namespace.html#70288485024d8129dd1c290fb2e5553b
</summary>
<param name="database">The database name</param>
<example>Example: GEWebBrowser.CreateInstance(ImageryBase.Moon);</example>
</member>
<member name="M:FC.GEPluginCtrls.GEWebBrowser.ExecuteBatch(System.String,System.Object)">
<summary>
Wrapper for the google.earth.executeBatch method
Efficiently executes an arbitrary, user-defined function (the batch function),minimizing
the amount of overhead incurred during cross-process communication between the browser
and Google Earth Plug-in.
</summary>
<param name="method">The JavaScript method to execute</param>
<param name="context">An optional parameter to pass to the method</param>
</member>
<member name="M:FC.GEPluginCtrls.GEWebBrowser.FetchKml(System.String)">
<summary>
Asynchronously load a remote KML/KMZ file
This function invokes "google.earth.fetchKml"
</summary>
<param name="url">path to a KML/KMZ file</param>
</member>
<member name="M:FC.GEPluginCtrls.GEWebBrowser.FetchKml(System.Uri)">
<summary>
Synchronously load a remote KML/KMZ file.
The result of the synchronous request is parsed by the plug-in and the resultant object is returned.
This function invokes "google.earth.fetchKml"
</summary>
<param name="url">path to a KML/KMZ file</param>
</member>
<member name="M:FC.GEPluginCtrls.GEWebBrowser.FetchKmlSynchronous(System.String,System.Int32)">
<summary>
Synchronously load a remote KML/KMZ file.
The result of the synchronous request is parsed by the plug-in and the resultant object is returned.
</summary>
<param name="url">path to a KML/KMZ file</param>
<param name="timeout">time to wait for return in milliseconds</param>
<returns>A KmlObject or null.</returns>
</member>
<member name="M:FC.GEPluginCtrls.GEWebBrowser.FetchKmlSynchronous(System.Uri,System.Int32)">
<summary>
Synchronously load a remote KML/KMZ file.
The result of the synchronous request is parsed by the plug-in and the resultant object is returned.
</summary>
<param name="url">Uri of a KML/KMZ file</param>
<param name="timeout">time to wait for return in milliseconds</param>
<returns>The KML as a KmlObject</returns>
</member>
<member name="M:FC.GEPluginCtrls.GEWebBrowser.FetchAndParse(System.String,System.Int32)">
<summary>
As FetchKmlSynchronous - but uses a native HttpWebRequest rather than google.earth.fetchKml.
The result of the synchronous request is parsed by the plug-in and the resultant object is returned.
</summary>
<param name="url">path to a KML file</param>
<param name="timeout">time to wait for return in milliseconds</param>
<returns>A KmlObject or null</returns>
</member>
<member name="M:FC.GEPluginCtrls.GEWebBrowser.FetchAndParse(System.Uri,System.Int32)">
<summary>
Same as FetchKmlSynchronous but uses a native HttpWebRequest rather than google.earth.fetchKml.
The result of the synchronous request is parsed by the plug-in and the resultant object is returned.
</summary>
<param name="url">Uri of a KML file</param>
<param name="timeout">time to wait for return in milliseconds</param>
<returns>A KmlObject or null</returns>
</member>
<member name="M:FC.GEPluginCtrls.GEWebBrowser.FetchKmlLocal(System.String)">
<summary>
Loads KML file from the local file system and attempts to parse the data into the plug-in.
</summary>
<param name="path">path to a KML file</param>
<returns>A KmlObject or null</returns>
</member>
<member name="M:FC.GEPluginCtrls.GEWebBrowser.ParseKml(System.String)">
<summary>
GEPlugin.parseKml() wrapper
Parse a string of KML and return a handle to the root of the KML object structure that was created
</summary>
<param name="kml">a string of KML to process</param>
<returns>The KML object structure that was created</returns>
</member>
<member name="M:FC.GEPluginCtrls.GEWebBrowser.ParseKmlObject(System.Object)">
<summary>
Parses a KmlObject and loads it into the plugin.
</summary>
<param name="kml">kml object to parse</param>
</member>
<member name="M:FC.GEPluginCtrls.GEWebBrowser.InvokeDoGeocode(System.String)">
<summary>
Invokes the JavaScript function 'jsDoGeocode'
Automatically flies to the location if one is found for the input
</summary>
<param name="input">the location to geocode</param>
<returns>the KmlPoint object for the geocode, or an empty object</returns>
</member>
<member name="M:FC.GEPluginCtrls.GEWebBrowser.InjectJavaScript(System.String)">
<summary>
Inject a JavaScript element into the document head
</summary>
<param name="javaScript">the script code</param>
</member>
<member name="M:FC.GEPluginCtrls.GEWebBrowser.InvokeJavaScript(System.String,System.Object[])">
<summary>
Executes a script function that is defined in the currently loaded document.
</summary>
<param name="function">The name of the function to invoke</param>
<param name="args">any arguments</param>
<returns>The result of the evaluated function</returns>
</member>
<member name="M:FC.GEPluginCtrls.GEWebBrowser.LoadEmbeddedPlugin">
<summary>
Load the embedded html document into the browser
</summary>
</member>
<member name="M:FC.GEPluginCtrls.GEWebBrowser.RemoveEventListener(System.Object,FC.GEPluginCtrls.EventId,System.Boolean)">
<summary>
Wrapper for the the google.earth.removeEventListener method
See: https://developers.google.com/earth/documentation/reference/google_earth_namespace#a4367d554eb492adcafa52925ddbf0c71
</summary>
<param name="feature">The target feature</param>
<param name="action">The event Id</param>
<param name="useCapture">Optional, use event capture</param>
</member>
<member name="M:FC.GEPluginCtrls.GEWebBrowser.ScreenGrab">
<summary>
Take a 'screen grab' of the current GEWebBrowser view
</summary>
<returns>bitmap image</returns>
</member>
<member name="M:FC.GEPluginCtrls.GEWebBrowser.SetLanguage(System.String)">
<summary>
Set the plug-in language
</summary>
<param name="code">The language code to use</param>
</member>
<member name="M:FC.GEPluginCtrls.GEWebBrowser.Refresh">
<summary>
Reloads the document currently displayed in the control
Overrides the default WebBrowser Refresh method
</summary>
</member>
<member name="M:FC.GEPluginCtrls.GEWebBrowser.OnNavigating(System.Windows.Forms.WebBrowserNavigatingEventArgs)">
<summary>
Handles any navigation events in the browser based on the <see cref="P:FC.GEPluginCtrls.GEWebBrowser.RedirectLinksToSystemBrowser"/> property
</summary>
<param name="e">The navigation event arguments</param>
<summary>
Handles any navigation events in the browser based on the <see cref="P:FC.GEPluginCtrls.GEWebBrowser.RedirectLinksToSystemBrowser"/> property
</summary>
<param name="e">The navigation event arguments</param>
</member>
<member name="M:FC.GEPluginCtrls.GEWebBrowser.OnDocumentCompleted(System.Windows.Forms.WebBrowserDocumentCompletedEventArgs)">
<summary>
Handles any document completed events in the browser.
Wires up the custom error handling.
</summary>
<param name="e">The document completed event arguments</param>
</member>
<member name="M:FC.GEPluginCtrls.GEWebBrowser.OnExternal_PluginReady(System.Object,FC.GEPluginCtrls.GEEventArgs)">
<summary>
Handles the external plug-in ready event.
Sets the various fields and raise the PluginReady event.
Wires up the form closing event
</summary>
<param name="sender">The external class</param>
<param name="e">The event arguments</param>
</member>
<member name="M:FC.GEPluginCtrls.GEWebBrowser.OnForm_Closing(System.Object,System.Windows.Forms.FormClosingEventArgs)">
<summary>
Handles the parent form closing.
Kill the plug-in and clears the HTML document
</summary>
<param name="sender"></param>
<param name="e"></param>
</member>
<member name="M:FC.GEPluginCtrls.GEWebBrowser.OnWindow_Error(System.Object,System.Windows.Forms.HtmlElementErrorEventArgs)">
<summary>
Handles any native errors in the window and raises a custom script error in their place.
</summary>
<param name="w">the window object</param>
<param name="we">the error arguments</param>
</member>
<member name="M:FC.GEPluginCtrls.GEWebBrowser.OnPropertyChanged(System.String)">
<summary>
Used to raise the property changed event.
</summary>
<param name="name"></param>
</member>
<member name="E:FC.GEPluginCtrls.GEWebBrowser.PluginReady">
<summary>
Raised when the plugin is ready
</summary>
</member>
<member name="E:FC.GEPluginCtrls.GEWebBrowser.KmlEvent">
<summary>
Raised when there is a kmlEvent
</summary>
</member>
<member name="E:FC.GEPluginCtrls.GEWebBrowser.KmlLoaded">
<summary>
Raised when a KML/KMZ file has loaded
</summary>
</member>
<member name="E:FC.GEPluginCtrls.GEWebBrowser.ScriptError">
<summary>
Raised when there is a script error in the document
</summary>
</member>
<member name="E:FC.GEPluginCtrls.GEWebBrowser.PluginEvent">
<summary>
Raised when there is a GEPlugin event
</summary>
</member>
<member name="E:FC.GEPluginCtrls.GEWebBrowser.ViewEvent">
<summary>