Description | API | Development Configuration | Deployment Configuration | FAQ

STK Java API - STK Graphics Plugin

Description

Custom graphics are used to visualize rasters, projections, and custom image globe overlays in a 3D display. Custom graphics can be defined by developers and users of STK via a plugin architecture in many software programming languages including Java.

What's included in this API?

The API to develop/run/deploy an STK Graphics Java Plugin based on the STK Java API includes the following lists of libraries/packages/javadocs:

JAR libraries:

• agi.core.jar
• agi.stk.plugin.util.jar
• agi.stk.plugin.graphics.ar
• agi.stkutil.jar
• agi.stkvgt.jar
• agi.stkgraphics.jar
• agi.stkstkobjects.jar
• agi.stkobjects.astrogator.jar

JNI native libraries:

• AgJNICore.dll/libagjnicore.so
• AgJNIStkPluginUtil.dll/libagjnistkpluginutil.so
• AgJNIStkPluginGraphics.dll/libagjnistkplugingraphics.so
• AgJNIStkUtil.dll/libagjnistkutil.so
• AgJNIStkVGT.dll/libagjnistkvgt.so
• AgJNIStkGraphics.dll/libagjnistkgraphics.so
• AgJNIStkObjects.dll/libagjnistkobjects.so
• AgJNIStkGator.dll/libagjnistkgator.so

Packages:

• agi.*
• agi.core.*
• agi.stk.plugin.util.*
• agi.stk.plugin.graphics.*
• agi.stkutil.*
• agi.stkvgt.*
• agi.stkgraphics.*
• agi.stkobjects.*
• agi.stkobjects.astrogator.*

Documentation

• Graphics ProjectionStream and RasterStream
• Documentation for including Javadocs in Eclipse IDE
• 
  
• The following STK Graphics Java Plugin samples are provided within the STK and STK engine install:
• • Extend_STK_Plugin_Graphics_Common - Sample that shows common reusable code and configuration for all Graphics plugins.
  • Extend_STK_Plugin_Graphics_ProjectionStream_Basic - Sample that shows how to implement a generic projection stream graphics plugin.
  • Extend_STK_Plugin_Graphics_RasterStream_Basic - Sample that shows how to implement a generic raster stream graphics plugin.
  • Extend_STK_Plugin_Graphics_CustomImageGlobeOverlay_OpenStreetMap - Sample that shows how to implement a Open Street Map custom image globe overlay.

To use these samples:

1. Build these samples in Eclipse by referring to the Eclipse samples configuration page.
2. Locate the STK installation's Graphics.xml. The default installation location for instance:

3. Platform	Path
   Windows 32bit	C:\Program Files\AGI\<STKVERSION>\CodeSamples\Extend\Graphics\Graphics.xml
   Windows 64bit	C:\Program Files\AGI\<STKVERSION>\CodeSamples\Extend\Graphics\Graphics.xml
   Windows 32bit on 64bit	C:\Program Files (x86)\AGI\<STKVERSION>\CodeSamples\Extend\Graphics\Graphics.xml
   Linux 32/64	<STK_INSTALL_DIR>/CodeSamples/Extend/Graphics/Graphics.xml

3. Copy this file to your STK plugin configuration user directory, which typically is C:\Documents and Settings\<user account name>\My Documents\<STKVERSION>\Config\Plugins on windows and <STK_CONFIG_DIR>/<STKVERSION>/Config/Plugins on LINUX.
4. Locate the three sample Graphics JavaPlugin entries for your chosen platform in the comment block that start with the following:

5. <JavaPlugin ProgID="AgJNISTKPluginGraphicsDriver10.Driver" ...

5. Copy the three entries to the uncommented section under the Graphics Plugins category element within the XML file.
6. In the copied JavaPlugin element entries, if the sample plugin's compiled .class files (and package structure) are not located in the directory specified by the ClassPath entry, then change it to the directory location of the plugin's *.class file's base package space.
7. Refer to STK documentation for configuration of Graphics during display time to use the above plugin samples.

Development/Runtime Configuration

Development Environments

Use the above listed JAR and JNI native libraries as input to the following development environment configurations:

• Standalone environment - Instructions to configure a non-gui development environment for developing the Java plugin application.

• Eclipse IDE - Instructions to configure an Eclipse Java plugin application development project.

Use the samples listed above as reference for implementing the IAgStkGraphicsPluginRasterStream, IAgStkGraphicsPluginProjectionStream, IAgStkGraphicsPluginCustomImageGlobeOverlay and IAgStkGraphicsPluginWithSite interfaces.

Deployment

Deployment instructions for a STK Graphics Java Plugin application:

1. Follow the appropriate installation instructions for the STK or STK Engine product.
2. Install your STK Graphics Java Plugin JAR file and its dependent JAR files to your preferred installation location.
3. Create an Graphics Plugin XML file.

4. Note: Make sure the name of your Graphics XML file is unique as to not conflict with other plugin xml files.

   • Create a JavaPlugin element entry within the Graphics Plugin category element scope.
   • Change the DisplayName attribute to a meaningful name for your plugin that will be displayed in the STK GUI.
   • Change the ClassName attribute to the fully package qualified name of your plugin Java class.
   • Change the ClassPath attribute to contain a semi-colon separated list of the absolute file paths to the JAR files that contain your plugin as well as JARs that your plugin depend upon.

   • Note: Do NOT include the AGI Plugin JARs, as these are automatically configured/loaded by STK at runtime.

4. Copy your Graphics Plugin XML file to the STK or STK Engine installation's Plugins directory if it is writable. The default installation location for instance:

5. Platform	Path
   Windows 32bit	C:\Program Files\AGI\<STKVERSION>\Plugins\<Name of plugin xml file>.xml
   Windows 64bit	C:\Program Files\AGI\<STKVERSION>\Plugins\<Name of plugin xml file>.xml
   Windows 32bit on 64bit	C:\Program Files (x86)\AGI\<STKVERSION>\Plugins\<Name of plugin xml file>.xml
   Linux 32/64	<STK_INSTALL_DIR>/Plugins/<Name of plugin xml file>.xml

   If this is not a writable location, copy your Graphics Plugin XML file to the STK Plugin configuration user directory, which typically is C:\Documents and Settings\<user account name>\My Documents\<STKVERSION>\Config\Plugins on windows and <STK_CONFIG_DIR>/<STKVERSION>/Config/Plugins on LINUX.

5. Refer to the STK documentation on how to configure your scenario to use your Graphics Java plugin during display.

FAQ

A set of frequently asked questions/issues and their answers/solutions.

Topics

• How/when do I run my Graphics Java plugin application?
• Do I need a main method declared?

How/when do I run my Graphics Java plugin application?

STK is responsible for creating and initializing your plugin when necessary during 3D Graphics window redraw.

Do I need a main method declared?

You do NOT need to declare a main method within your plugin. The latest installed JRE on the deployed machine fill be embedded/started within STK, your Java plugin class which you indicated in the ClassName attribute of your JavaPlugin entry within your plugin xml file.

STK Programming Interface 11.0.1