STK X Send comments on this topic.
AgUiAx2DCntrl Object

Description

The 2D Map window control.

By default, you can use the mouse in the following ways to interact with the 2D Graphics window:

  • The latitude and longitude of the cursor position on the 2D map window is displayed in the status bar. To activate the status bar select View > Status Bar from the Menu bar. The latitude and longitude are shown in the scenario lat-lon units which can be found and changed in the Scenario > Basic > Units properties window.
  • Select the Zoom In button on the default toolbar or 2D window default tool bar and drag it across the area of the 2D map window you want to zoom in to. Using the Zoom In button changes the map center.
  • Click on the Zoom Out button on the default toolbar or 2D window default toolbar to zoom out of the 2D window one zoom level. You can continue to click the Zoom Out button until the 2D map fills the display window.
  • Use the mouse scroll wheel to zoom in and out of the 2D map window. Using the mouse scroll wheel does not add any zoom levels to the zoom stack so after zooming in using the mouse scroll wheel hitting the Zoom Out button will zoom all the way out to a global view.
  • To move the central body in grab mode, click the Grab Globe button on the default toolbar or the 2D window default toolbar and click and drag in the 2D window. To leave grab mode, click the Grab Globe button again.

Object Model








Public Methods

Public Method CopyFromWinIDCopies an existing window's scene into this control. The Window ID of the source window can be obtained from the WinID on this control.
Public Method GetWindowProjectedPositionGet the window projected position for given values.
Public Method PickInfoGet detailed information about a mouse pick.
Public Method RestoreMouseCursorRestores mouse cursor back to normal.
Public Method RubberBandPickInfoGet detailed information about a rubber-band mouse pick. The values must be within the 2D window (0 to width-1 for left and right, 0 to height-1 for top and bottom).
Public Method SetMouseCursorFromFileSets mouse cursor to the selected cursor file.
Public Method SetMouseCursorFromHandleSets mouse cursor to the passed cursor handle.
Public Method ZoomInEnter zoom-in mode. User must left click-and-drag mouse to define area to zoom.
Public Method ZoomOutZoom out to view a larger portion of a previously magnified map.

Public Properties

Public Property AdvancedPickModeWhen set to True, appends the extended information as described below to the strings returned by ObjPath property of AgPickInfoData.

- For MTO objects, track ID associated with a Multi-Track is returned. For instance: "/Application/STK/Scenario/Test/MTO/tle-08747 2", where 2 is the track ID associated with a Multi-Track Object.

- For Satellites, the event ID for graphics time event is returned.
Public Property ApplicationReference to the STK X application object.
Public Property BackColorThe background color of the control.
Public Property InZoomModeReturns true if in zoom in mode.
Public Property MouseModeWhether this control responds to mouse events.
Public Property NoLogoIf true, the splash logo is not shown.
Public Property OLEDropModeHow the control handles drop operations.
Public Property PanModeEnabledEnables/disables pan mode for map control.
Public Property PictureThe splash logo graphic to be displayed in the control.
Public Property PictureFromFileThe splash logo graphic file to be displayed in the control.
Public Property ProgressImageFileThe complete image file name/path for animated progress image.
Public Property ProgressImageXOffsetThe horizontal X offset for animated progress image.
Public Property ProgressImageXOriginThe X origin alignment for animated progress image.
Public Property ProgressImageYOffsetThe vertical Y offset for animated progress image.
Public Property ProgressImageYOriginThe Y origin alignment for animated progress image.
Public Property ShowProgressImageThe animated progress image type.
Public Property VendorIDThe identifier of the vendor.
Public Property WinIDWindow identifier (for Connect commands).

Events

Public Event ClickOccurs when the user presses and then releases a mouse button over the control.
Public Event DblClickOccurs when the user presses and releases a mouse button and then presses and releases it again over the control.
Public Event KeyDownOccurs when the user presses a key while the control has the focus.
Public Event KeyPressOccurs when the user presses and releases a key or key combination that corresponds to an ANSI code.
Public Event KeyUpOccurs when the user releases a key while the control has the focus.
Public Event MouseDownOccur when the user presses a mouse button.
Public Event MouseMoveOccurs when the mouse pointer is moved across the control.
Public Event MouseUpOccur when the user releases a mouse button.
Public Event MouseWheelOccurs when the mouse wheel is rotated on the control.
Public Event OLEDragDropFired when a source component is dropped onto the control

Remarks

The Map control can be created as any regular ActiveX control.

GUID{5920236B-C284-44A3-8A33-93B65FB5CDBC}

 

The STK Objects library is also available with STK X. You can instantiate the root object and from it navigate and manipulate the STK scenario. Please see STK Objects for more  details.

Click here for instructions on adding STK X controls to a Visual Studio project.


© 2018 Analytical Graphics, Inc. All Rights Reserved.