STK X Send comments on this topic.
Project Overview

Description

STK X allows developers to add advanced STK 2D, 3D visualization and analytical capabilities to applications with little effort.

 

The top of the STK X object model presents the following creatable components:

  • The Application  component interfaces to the STK analytical engine. It can be used by itself (in a GUI-less mode), or through the Application property on the Globe and Map controls.
    The main way to communicate with the engine is to send Connect commands. Connect is a language for accessing and manipulating STK (see the  ExecuteCommand method).
    The Application  object also exposes connection points that you can sink to receive notification about the state of the STK engine (for instance a scenario has been loaded; an animation step is performed, etc.).
    Notice that you can instantiate many application objects, but they all refer to the same unique STK engine.
  • The  Globe control  enables you to insert a 3D view into your application.
    You can use several Globe controls if you wish to have different views of the same scenario. By default the STK keyboard and mouse interaction mechanism are used, but various events are available, allowing your application to implement specific keyboard and mouse interactions and modes.
  • The  Map control can be used to insert a 2D view into your application.
    The Map control gives your application a 2D view of the scenario. You can use several Map controls if you wish to have different views of the same scenario. By default the STK keyboard and mouse interaction mechanism are used, but various events are available, allowing your application to implement specific keyboard and mouse interactions and modes.
  • The Graphics Analysis control allows you to insert graphics analysis capability into your application. The Graphics Analysis Control can perform various analyses when set in any of the following four analysis modes.
    • Area Tool
    • AzElMask Tool
    • Obscuration Tool
    • Solar Panel Tool

Classes

Objects Description
AgDataObject Data Object for OLE drag & drop operations.
AgDataObjectFiles Collection of files for OLE drag & drop operations.
AgDrawElemCollection Collection of elements to draw on the control.
AgDrawElemLine Defines a line in window coordinates.
AgDrawElemRect Defines a rectangle in window coordinates.
AgExecCmdResult Collection of strings returned by the ExecuteCommand.
AgExecMultiCmdResult Collection of objects returned by the ExecuteMultipleCommands.
AgObjPathCollection Collection of object paths.
AgPickInfoData Single mouse pick result.
AgRubberBandPickInfoData Rubber-band mouse pick result.
AgSTKXApplication STK X Application object.
AgSTKXConControlQuitReceivedEventArgs Arguments for the OnConControlQuitReceived event.
AgSTKXSSLCertificateErrorEventArgs Provides information about an SSL certificate that is expired or invalid.
AgUiAx2DCntrl 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.
AgUiAxGfxAnalysisCntrl AGI Graphics Analysis Control
AgUiAxVOCntrl The 3D Globe window control.

By default, you can use the mouse in the following ways to manipulate the 3D Graphics window:

  • Double-click the left mouse button on any spot on the globe to display the latitude and longitude of the selected spot. 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.
  • Use the left mouse button to rotate the globe.
  • Use the right mouse button to zoom in and out. You can also zoom into a portion of the 3D Graphics window by clicking the zoom button  and then using the left mouse button to drag out a region to view on the 3D Graphics window.
  • Use the Shift-left mouse button to pan and tilt the virtual camera; that is, keep the camera in a fixed point in space and change its orientation.
  • Use the mouse and the 3D Object Editor to edit an object in the 3D Graphics window.

The mouse works as follows in Grab mode:

  • Moving the mouse while the left button is depressed rotates the globe.
  • Moving the mouse while the right button is depressed zooms in and out.
  • Moving the mouse while the left button and shift key are depressed grabs the central globe and rotates it.
  • When you go into Grab mode, you are placed in the lat/lon/alt view mode, if you are not already in it.

If the Constrained "Up" Vector is selected on the View From/To dialog box, the view may shift slightly to keep the "up" vector up.

AgWinProjPos Projected window postion result.

Interfaces

Objects Description
IAgDrawElem Draw element.
IAgDrawElemLine Defines a line in control coordinates.
IAgExecCmdResult Collection of strings returned by the ExecuteCommand.
IAgExecMultiCmdResult Collection of objects returned by the ExecuteMultipleCommands.
IAgSTKXApplicationRawEvents STK X Application Raw Events.
IAgSTKXConControlQuitReceivedEventArgs Arguments for the OnConControlQuitReceived event.
IAgSTKXSSLCertificateErrorEventArgs Provides information about an SSL certificate that is expired or invalid.
IAgUiAxGfxAnalysisCntrl AGI Gfx Analysis control.
IAgUiAxGfxAnalysisCntrlEvents AGI Gfx Analysis control events.
IAgUiAxStockRawEvents AGI Map & Globe control raw stock events.
IAgUiAxVOCntrlRawEvents AGI Globe control raw events.
IAgWinProjPos Projected window postion detail.

Enumerations

Enumeration Description
AgEButtonValues Numeric value of the mouse button pressed.
AgEExecMultiCmdResultAction Enumeration defines a set of actions when an error occurs while executing a command batch.
AgEFeatureCodes The enumeration values are used to check availability of a given feature.
AgEGfxAnalysisMode Specifies the mode of Gfx Analysis Control.
AgEGfxDrawCoords Specifies the draw coordinates for Map Control.
AgELineStyle Line Style
AgELoggingMode Specifies the state of the log file.
AgELogMsgDispID Log message destination options.
AgELogMsgType Log message types.
AgEMouseMode Mouse modes.
AgEOLEDropMode Specifies how to handle OLE drop operations.
AgEProgressImageXOrigin Specifies to align progress image X origin.
AgEProgressImageYOrigin Specifies to align progress image Y origin.
AgEShiftValues State of the Shift/Ctrl/Alt keys.
AgEShowProgressImage Specifies to show progress image.
© 2017 Analytical Graphics, Inc. All Rights Reserved.

STK Engine for UNIX 11.2